saltext.vmware.states.nsxt_transport_zone#

NSX-T Transport_Zone state module

saltext.vmware.states.nsxt_transport_zone.present(name, hostname, username, password, display_name, host_switch_name, transport_type, is_default=None, description=None, verify_ssl=None, cert=None, cert_common_name=None, host_switch_id=None, host_switch_mode=None, uplink_teaming_policy_names=None, tags=None)[source]#

Registers transport zone in NSX-T Manager or updates the transport zone

CLI Example:

salt vm_minion nsxt_transport_zone.present hostname=nsxt-manager.local username=admin ...

name: name of the operation to perform
hostname: The host name of NSX-T manager
username: Username to connect to NSX-T manager
password: Password to connect to NSX-T manager
host-switch-name: Host switch name for the transport zone
transport-type: Transport type for the transport zone
is_default: (Optional) Flag to indicate if the transport zone is the default one. 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
display_name: Display name for the transport zone
description: (Optional) Description for the transport zone
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.
cert_common_name: (Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against certificate common name.
host_switch_id: (Optional) The host switch id generated by the system.
host_switch_mode: (Optional) Operational mode of the transport zone. 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: (Optional) Name of the host switch on all transport nodes in this transport zone that will be used to run NSX network traffic. If this name is unset or empty then the default host switch name will be used.
uplink_teaming_policy_names: (Optional) Names of the switching uplink teaming policies that are supported by this transport zone.
tags: (Optional) Opaque identifiers meaningful to the API user

saltext.vmware.states.nsxt_transport_zone.absent(name, hostname, username, password, display_name, verify_ssl=None, cert=None, cert_common_name=None)[source]#

Deletes transport zone in NSX-T Manager if present. Requires display_name of the transport zone which user want to delete and also the tranpsort type of the transport zone

CLI Example:

salt vm_minion nsxt_transport_zone.absent hostname=nsxt-manager.local username=admin ...

name: Name of the operation to perform
hostname: The host name of NSX-T manager
username: Username to connect to NSX-T manager
password: Password to connect to NSX-T manager
display_name: display_name of the transport zone to be deleted
transport_type: transport_type of the transport zone to be deleted
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.
cert_common_name: (Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against certificate common name.