nsxt_transport_zones – Create a Transport Zone

New in version 2.7.

Synopsis

  • Creates a new transport zone. The required parameters are host_switch_name and transport_type (OVERLAY or VLAN). The optional parameters are description and display_name.

Parameters

Parameter Choices/Defaults Comments
description
-
Description
display_name
string / required
Display name
host_switch_id
string
The host switch id generated by the system.
host_switch_mode
string
STANDARD mode applies to all the hypervisors. ENS mode stands for Enhanced Networking Stack. This feature is only available for ESX hypervisor. It is not available on KVM, EDGE and Public Cloud Gateway etc. When a Transport Zone mode is set to ENS, only Transport Nodes of type ESX can participate in such a Transport Zone.
host_switch_name
string
If this name is unset or empty then the default host switch name will be used.
hostname
string / required
Deployed NSX manager hostname.
is_default
boolean
Only one transport zone can be the default one for a given transport zone type. APIs that need transport zone can choose to use the default transport zone if a transport zone is not given by the user.
nested_nsx
boolean
The flag only need to be set in nested NSX environment.
password
string / required
The password to authenticate with the NSX manager.
resource_type
-
Selects the type of the transport zone profile
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
Array of Tag
Opaque identifier meaningful to API user
transport_type
string / required
The transport type of this transport zone.
transport_zone_profile_ids
array of TransportZoneProfileTypeIdEntry
Identifiers of the transport zone profiles associated with this TransportZone.
uplink_teaming_policy_names
list
The names of switching uplink teaming policies that all transport nodes in this transport zone must support. An exception will be thrown if a transport node within the transport zone does not support a named teaming policy. The user will need to first ensure all trasnport nodes support the desired named teaming policy before assigning it to the transport zone. If the field is not specified, the host switch's default teaming policy will be used.
username
string / required
The username to authenticate with the NSX manager.

Examples

- name: Create transport zone
  nsxt_transport_zones:
    hostname: "10.192.167.137"
    username: "admin"
    password: "Admin!23Admin"
    validate_certs: False
    resource_type: "TransportZone"
    display_name: "TZ1"
    description: "NSX configured Test Transport Zone"
    transport_type: "OVERLAY"
    host_switch_name: "hostswitch4"
    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