nsxt_edge_clusters – Create Edge Cluster

New in version 2.7.

Synopsis

  • Creates a new edge cluster. It only supports homogeneous members. The TransportNodes backed by EdgeNode are only allowed in cluster members. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to be the same. EdgeCluster supports members of different deployment types.

Parameters

Parameter Choices/Defaults Comments
allocation_rules
list
Allocation rules for auto placement
cluster_profile_bindings
array of ClusterProfileTypeIdEntry
Edge cluster profile bindings
deployment_type
dictionary
Deplloyment type of the cluster members
description
string
Description of the resource
display_name
string / required
Display name
enable_inter_site_forwarding
boolean
    Choices:
  • no
  • yes
Flag to enable inter site forwarding
hostname
string / required
Deployed NSX manager hostname.
member_node_type
dictionary
Node type of the cluster members
members
array of EdgeClusterMember
EdgeCluster only supports homogeneous members. These member should be backed by either EdgeNode or PublicCloudGatewayNode. TransportNode type of these nodes should be the same. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to be the same. EdgeCluster supports members of different deployment types.
node_rtep_ips
list
Remote tunnel endpoint ip address
password
string / required
The password to authenticate with the NSX manager.
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.
username
string / required
The username to authenticate with the NSX manager.

Examples

- name: Create Edge Cluster
  nsxt_edge_clusters:
    hostname: "10.192.167.137"
    username: "admin"
    password: "Admin!23Admin"
    validate_certs: False
    display_name: edge-cluster-1  `
    cluster_profile_bindings:
      - profile_name: "nsx-edge-profile"
        resource_type: EdgeHighAvailabilityProfile
    members:
      - transport_node_name: "TN_1"
    state: present

Status

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

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

Authors

  • Rahul Raghuvanshi