nsxt_policy_bfd_profile – Create or Delete a Policy BFD Profile

New in version 2.8.

Synopsis

  • Creates or deletes a Policy BFD Profile. Required attributes include id and display_name.

Parameters

Parameter Choices/Defaults Comments
ca_path
string
Path to the CA bundle to be used to verify host's SSL certificate
description
string
BFD Profile description.
display_name
string
Display name.
If resource ID is not specified, display_name will be used as ID.
do_wait_till_create
boolean
    Choices:
  • no ←
  • yes
Can be used to wait for the realization of subresource before the request to create the next resource is sent to the Manager.
Can be specified for each subresource.
hostname
string / required
Deployed NSX manager hostname.
id
string / required
The id of the BFD Profile.
interval
integer
Default:
500
Time interval between heartbeat packets in milliseconds
Should be in the range [50-60000]
multiple
integer
Default:
3
Declare dead multiple.
Number of times heartbeat packet is missed before BFD declares the neighbor is down.
Should be in the range [2-16]
nsx_cert_path
string
Path to the certificate created for the Principal Identity using which the CRUD operations should be performed
nsx_key_path
string
Path to the certificate key created for the Principal Identity using which the CRUD operations should be performed
Must be specified if nsx_cert_path is specified
password
string
The password to authenticate with the NSX manager.
Must be specified if username is specified
request_headers
dictionary
HTTP request headers to be sent to the host while making any request
state
- / required
    Choices:
  • present
  • absent
State can be either 'present' or 'absent'. 'present' is used to create or update resource. 'absent' is used to delete resource.
tags
dictionary
Opaque identifiers meaningful to the API user.
scope
string / required
Tag scope.
tag
string / required
Tag value.
username
string
The username to authenticate with the NSX manager.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Enable server certificate verification.

Examples

- name: Update BFD Profile
  nsxt_policy_bfd_profile:
    hostname: "10.10.10.10"
    nsx_cert_path: /root/com.vmware.nsx.ncp/nsx.crt
    nsx_key_path: /root/com.vmware.nsx.ncp/nsx.key
    validate_certs: False
    display_name: test-bfd-profile
    state: present
    interval: 200
    multiple: 10

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by the Ansible Community. [community]

Authors

  • Gautam Verma