cisco.mso.ndo_l3out_floating_svi_interface_path_attributes module – Manage L3Out Floating SVI Interface Path Attributes on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.ndo_l3out_floating_svi_interface_path_attributes.

New in cisco.mso 2.12.0

Synopsis

• Manage L3Out Floating SVI Interface Path Attributes on Cisco Nexus Dashboard Orchestrator (NDO).

• This module is only supported on ND v3.1 (NDO v4.3) and later.

Requirements

The below requirements are needed on the host that executes this module.

• Multi Site Orchestrator v2.1 or newer

Parameters

Parameter	Comments
domain aliases: domain_name string	The name of the domain.
domain_provider string	The provider of the domain. Choices: "cloudfoundry" "kubernetes" "microsoft" "openshift" "openstack" "redhat" "vmware" "nutanix"
domain_type string	The type of the domain. Choices: "vmm" "physical"
encapsulation_type aliases: encap_type string	The encapsulation type of the interface. Choices: "vlan" ← (default) "vxlan"
encapsulation_value aliases: encap, encapsulation, encapsulation_id integer / required	The encapsulation value of the interface. The option encapsulation_type=vlan, specifies VLAN ID which must be in the range 1 - 4094. The option encapsulation_type=vxlan, specifies VXLAN Network Identifier (VNI) which must be in the range 5000 - 16777215.
enhanced_lag_policy aliases: enhanced_lag_policy_name string	The name of the enhanced LAG policy. The enhanced LAG policy must be configured on APIC in the provided VMM domain before using this attribute in your playbook.
forged_transmit boolean	Indicates whether forged transmit is enabled. Choices: false true
host aliases: hostname string	IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable MSO_HOST will be used instead.
l3out aliases: l3out_name string	The name of the L3Out. This parameter or l3out_uuid is required.
l3out_uuid string	The UUID of the L3Out. This parameter or l3out is required.
login_domain string	The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable MSO_LOGIN_DOMAIN will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.
mac_address_change boolean	Indicates whether MAC address change is enabled. Choices: false true
node_id aliases: node, anchor_node_id string / required	The Anchor Node ID of the L3Out Floating SVI Interface.
output_level string	Influence the output of this MSO module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug adds debugging output, incl. filter_string, method, response, status and url information If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead. Choices: "debug" "info" "normal" ← (default)
password string	The password to use for authentication. If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
port integer	Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable MSO_PORT will be used instead.
primary_ipv4_address aliases: primary_ipv4 string	The primary IPv4 address.
primary_ipv6_address aliases: primary_ipv6 string	The primary IPv6 address.
promiscuous_mode boolean	Indicates whether promiscuous mode is enabled. Choices: false true
state string	Determines the desired state of the resource. Use absent to remove the resource. Use query to list the resource. Use present to create or update the resource. Choices: "absent" "query" ← (default) "present"
template aliases: l3out_template string	The name of the template. The template must be an L3Out template. This parameter or template_id is required.
template_id aliases: l3out_template_id string	The ID of the L3Out template. This parameter or template is required.
timeout integer	The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.
use_proxy boolean	If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable MSO_USE_PROXY will be used instead. The default is true. Choices: false true
use_ssl boolean	If false, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable MSO_USE_SSL will be used instead. When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified. The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso). Choices: false true
username string	The username to use for authentication. If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.
validate_certs boolean	If false, SSL certificates will not be validated. This should only set to false when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead. The default is true. Choices: false true

Notes

Note

• The template or template_id must exist before using this module in your playbook. The cisco.mso.ndo_template module can be used for this.

• The l3out or l3out_uuid must exist before using this module in your playbook. The cisco.mso.ndo_l3out_template module can be used for this.

• The L3Out Floating SVI Interface identified by node_id, encapsulation_type, and encapsulation_value must exist before using this module in your playbook. The cisco.mso.ndo_l3out_floating_svi_interface module can be used for this.

• This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_l3out_template

Manage L3Outs on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_l3out_floating_svi_interface

Manage L3Out Floating SVI Interfaces on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create Path Attributes for a L3Out Floating SVI Interface
  cisco.mso.ndo_l3out_floating_svi_interface_path_attributes:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    node_id: 101
    encapsulation_type: vlan
    encapsulation_value: 1200
    domain_type: vmm
    domain_provider: vmware
    domain: domain_name
    forged_transmit: true
    mac_address_change: true
    promiscuous_mode: true
    enhanced_lag_policy: enhanced_lag_policy_name
    primary_ipv4_address: 192.0.2.1
    primary_ipv6_address: 2001:db8::1
    state: present

- name: Update the Path Attributes of a L3Out Floating SVI Interface
  cisco.mso.ndo_l3out_floating_svi_interface_path_attributes:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: "{{ l3out_template.current.templateId }}"
    l3out_uuid: "{{ l3out.current.uuid }}"
    node_id: 101
    encapsulation_type: vlan
    encapsulation_value: 1200
    domain_type: vmm
    domain_provider: vmware
    domain: domain_name
    forged_transmit: false
    mac_address_change: false
    promiscuous_mode: false
    enhanced_lag_policy: enhanced_lag_policy_name
    primary_ipv4_address: 192.0.2.2
    primary_ipv6_address: 2001:db8::2
    state: present

- name: Query the Path Attributes of an existing L3Out Floating SVI Interface
  cisco.mso.ndo_l3out_floating_svi_interface_path_attributes:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    node_id: 101
    encapsulation_type: vlan
    encapsulation_value: 1200
    domain_type: vmm
    domain_provider: vmware
    domain: domain_name
    state: query
  register: query_one

- name: Query all existing Path Attributes of L3Out Floating SVI Interface
  cisco.mso.ndo_l3out_floating_svi_interface_path_attributes:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    node_id: 101
    encapsulation_type: vlan
    encapsulation_value: 1200
    state: query
  register: query_all

- name: Delete the Path Attributes of an existing L3Out Floating SVI Interface
  cisco.mso.ndo_l3out_floating_svi_interface_path_attributes:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    node_id: 101
    encapsulation_type: vlan
    encapsulation_value: 1200
    domain_type: vmm
    domain_provider: vmware
    domain: domain_name
    state: absent

Authors

• Akini Ross (@akinross)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)