nsxt_policy_l2_bridge_ep_profile – Create or Delete a Policy L2 Bridge Endpoint Profile

New in version 2.9.

Synopsis

  • Creates or deletes a Policy L2 Bridge Endpoint 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
Resource 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.
edge_nodes_info
list
List of dicts that comprise of information to form policy paths to edge nodes. Edge allocation for L2 bridging
Minimim 1 and Maximum 2 list elements
edge_cluster_display_name
string
display name of the edge cluster
either this or edge_cluster_id must be specified. If both are specified, edge_cluster_id takes precedence
edge_cluster_id
string
edge_cluster_id where edge node is located
edge_node_display_name
string
Display name of the edge node.
either this or edge_node_id must be specified. If both are specified, edge_node_id takes precedence
edge_node_id
string
ID of the edge node
enforcementpoint_id
string
Default:
"default"
enforcementpoint_id where edge node is located
site_id
string
Default:
"default"
site_id where edge node is located
failover_mode
string
    Choices:
  • PREEMPTIVE ←
  • NON_PREEMPTIVE
Failover mode for the edge bridge cluster
ha_mode
string
    Choices:
  • ACTIVE_STANDBY ←
High avaialability mode can be active-active or active-standby. High availability mode cannot be modified after realization
hostname
string / required
Deployed NSX manager hostname.
id
string
The id of the Policy L2 Bridge Endpoint Profile
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: create L2 Bridge Endpoint Profile
  nsxt_policy_l2_bridge_ep_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
    id: test-ep-profile
    display_name: test-ep-profile
    state: present
    edge_nodes_info:
        - edge_cluster_display_name: edge-cluster-1
          edge_node_id: 123471da-3823-11ea-9170-000c291a8262
    failover_mode: PREEMPTIVE
    ha_mode: ACTIVE_STANDBY
    tags:
    - tag: "my-tag"
      scope: "my-scope"

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