saltext.vmware.states.nsxt_uplink_profiles#

State module for NSX-T uplink profiles

saltext.vmware.states.nsxt_uplink_profiles.present(name, hostname, username, password, display_name, teaming, verify_ssl=True, cert=None, cert_common_name=None, lags=None, mtu=None, named_teamings=None, overlay_encap=None, required_capabilities=None, tags=None, transport_vlan=None, description=None, resource_type=None)[source]#

Creates or Updates(if present with same display_name) uplink profiles(resource_type:UplinkHostSwitchProfile). Fails if multiple uplink profiles are found with same display_name

CLI Example:

salt vm_minion nsxt_uplink_profiles.create hostname=nsxt-manager.local username=admin ...

create_uplink_profile:
  nsxt_uplink_profiles.present:
    - name: Create uplink profile
      hostname: {{ pillar['nsxt_manager_hostname'] }}
      username: {{ pillar['nsxt_manager_username'] }}
      password: {{ pillar['nsxt_manager_password'] }}
      cert: {{ pillar['nsxt_manager_certificate'] }}
      verify_ssl: <False/True>
      display_name: <uplink profile name>
      description: <uplink profile description>
      resource_type: UplinkHostSwitchProfile
      teaming:
        active_list:
          -  uplink_name: <Name of the uplink>
             uplink_type: <PNIC/LAG>
          -  uplink_name: <Name of the uplink>
             uplink_type: <PNIC/LAG>
        policy: <FAILOVER_ORDER/LOADBALANCE_SRCID/LOADBALANCE_SRC_MAC>
        standby_list:
          -  uplink_name: <Name of the uplink>
             uplink_type: <PNIC/LAG>
      tags:
        - tag: <tag-key-1>
          scope: <tag-value-1>
        - tag: <tag-key-2>
          scope: <tag-value-2>
      mtu: <mtu value>
      transport_vlan: <vlan_id>
      lags:
        -  load_balance_algorithm: <SRCMAC/DESTMAC/SRCDESTMAC/SRCDESTIPVLAN/SRCDESTMACIPPORT>
           mode: <ACTIVE/PASSIVE>
           name: <name of the lag>
           number_of_uplinks: <Integer>
           timeout_type: <SLOW/FAST>
        -  load_balance_algorithm: <SRCMAC/DESTMAC/SRCDESTMAC/SRCDESTIPVLAN/SRCDESTMACIPPORT>
           mode: <ACTIVE/PASSIVE>
           name: <name of the lag>
           number_of_uplinks: <Integer>
           timeout_type: <SLOW/FAST>
      named_teamings:
        -  name: <Name of the teaming>
           active_list:
             -  uplink_name: <Name of the uplink>
                uplink_type: <PNIC/LAG>
             -  uplink_name: <Name of the uplink>
                uplink_type: <PNIC/LAG>
           policy: <FAILOVER_ORDER/LOADBALANCE_SRCID/LOADBALANCE_SRC_MAC>
           standby_list:
             -  uplink_name: <Name of the uplink>
                uplink_type: <PNIC/LAG>

name

Name of the operation

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

The name of the uplink profile

resource_type

Must be set to the value UplinkHostSwitchProfile. Default is UplinkHostSwitchProfile in Salt Module

teaming

Default TeamingPolicy associated with this UplinkProfile. Object with following parameters:

{'standby_list':[],'active_list':[{'uplink_name':'uplink3','uplink_type':'PNIC'}],'policy':'FAILOVER_ORDER'}

active_list

List of Uplinks used in active list. Array of Uplink objects.

 active_list='[
    {
    "uplink_name": "uplink3",
    "uplink_type": "PNIC"
    }
]'

Parameters as follows:

uplink_name: Name of this uplink
uplink_type: Type of the uplink. PNIC or LAG

policy

Teaming policy. Required field. Values could be one among FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC

standby_list

List of Uplinks used in standby list. Array of Uplink objects.
standby_list=[
    {
    "uplink_name": "uplink2",
    "uplink_type": "PNIC"
    }
]

Parameters as follows:

uplink_name
Name of this uplink

uplink_type
Type of the uplink. PNIC or LAG

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 client 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

lags

(Optional) list of LACP group

mtu

(Optional) Maximum Transmission Unit used for uplinks

named_teamings

(Optional) List of named uplink teaming policies that can be used by logical switches.: Array of NamedTeamingPolicy

overlay_encap

(Optional) The protocol used to encapsulate overlay traffic

required_capabilities

(Optional) List of string

tags

(Optional) Opaque identifier meaninful to API user. Array of Tag

transport_vlan

(Optional) VLAN used for tagging Overlay traffic of associated HostSwitch. Type: integer

description

(Optional) Description for the resource

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

Deletes uplink profile with provided display_name in NSX-T Manager, if present. Fails if multiple uplink profiles are found with same display_name