cisco.mso.ndo_l3out_routed_sub_interface module – Manage L3Out Routed Sub-Interfaces on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.13.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_routed_sub_interface.

New in cisco.mso 2.11.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage L3Out Routed Sub-Interfaces 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
encapsulation_type aliases: encap_type string	The encapsulation type of the interface. Choices: `"vlan"` `"vxlan"`
encapsulation_value aliases: encap, encapsulation, encapsulation_id integer	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.
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.
interface_group_policy string	The name of the interface group policy.
ipv4_address string	The IPv4 address of the interface.
ipv6_address string	The IPv6 address of the interface.
ipv6_dad string	Whether to enable IPv6 Duplicate Address Detection (DAD). If this parameter is unspecified during create, NDO defaults to `ipv6_dad=enabled`. Choices: `"enabled"` `"disabled"`
ipv6_link_local_address string	The IPv6 link-local address of the interface.
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 string	The MAC address of the interface.
mtu string	The Maximum Transmission Unit (MTU) of the interface. Use `mtu=inherit` to inherit the value configured under the fabric L2 MTU settings. The value must be 1, or in the range 576 - 9216 or `mtu=inherit`.
node_group_policy string	The name of the node group policy.
node_id aliases: node, border_leaf string	The ID of the node (border leaf switch) where to deploy the L3Out routing protocol and node-level protocol configurations. This parameter is required when `path` is specified. When specified, the node configuration is created under the L3Out template when it does not exist. When specified, the node configuration is updated under the L3Out template when it already exists. When specified, the node configuration is deleted under the L3Out template when there are no interfaces referencing it.
node_loopback_ip aliases: loopback_ip string	The loopback IP address of the node.
node_router_id aliases: router_id string	The router ID of the node.
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.
path aliases: interface string	The path of the interface. The path must be an existing physical port (eg. eth1/1).
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.
port_channel aliases: pc dictionary	The port channel details.
reference aliases: ref dictionary	The reference details of the port channel. This parameter or `port_channel.uuid` is required.
name string / required	The name of the port channel.
template string	The name of the template that contains the port channel. This parameter or `port_channel.reference.template_id` is required.
template_id string	The ID of the template that contains the port channel. This parameter or `port_channel.reference.template` is required.
uuid string	The UUID of the port channel. This parameter or `port_channel.reference` is required.
ptp dictionary	The Precision Time Protocol (PTP) configuration for the interface. Providing an empty dictionary `ptp={}` will remove the PTP configuration from the interface.
mode string	The PTP mode. If this parameter is unspecified, NDO defaults to `ptp.mode=multicast_dynamic`. Choices: `"multicast_dynamic"` `"multicast_master"` `"unicast_master"`
source_address string	The PTP source address. If this parameter is unspecified, NDO defaults to `ptp.source_address=0.0.0.0`.
unicast_destinations list / elements=string	The PTP unicast destination IP addresses. The old `ptp.unicast_destinations` will be replaced with the new `ptp.unicast_destinations` during an update. The PTP unicast destinations IP addresses can only be configured if `ptp.mode=unicast_master`.
user_profile dictionary	The PTP user profile.
reference aliases: ref dictionary	The reference details of the PTP user profile.
name string / required	The name of the PTP user profile.
template string	The name of the template that contains the PTP user profile. This parameter or `ptp.user_profile.reference.template_id` is required.
template_id string	The ID of the template that contains the PTP user profile. This parameter or `ptp.user_profile.reference.template` is required.
uuid string	The UUID of the PTP user profile.
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"`
target_dscp string	The target Differentiated Services Code Point (DSCP) of the interface. If this parameter is unspecified during create, NDO defaults to `target_dscp=unspecified`. Choices: `"af11"` `"af12"` `"af13"` `"af21"` `"af22"` `"af23"` `"af31"` `"af32"` `"af33"` `"af41"` `"af42"` `"af43"` `"cs0"` `"cs1"` `"cs2"` `"cs3"` `"cs4"` `"cs5"` `"cs6"` `"cs7"` `"expedited_forwarding"` `"unspecified"` `"voice_admit"`
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_router_id_as_loopback boolean	Whether to use the router ID as the loopback address of the node. 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 node_group_policy must exist before using this module in your playbook. The cisco.mso.ndo_l3out_node_group_policy module can be used for this.
The interface_group_policy must exist before using this module in your playbook. The cisco.mso.ndo_l3out_interface_group_policy module can be used for this.
The port_channel must exist before using this module in your playbook. The cisco.mso.ndo_port_channel_interface module can be used for this.
The ptp.user_profile must exist before using this module in your playbook. The cisco.mso.ndo_ptp_policy_profiles 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.

Examples

- name: Create a L3Out Routed Sub-Interface of type port
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    ipv4_address: 10.0.0.1/24
    ipv6_address: 2::101/16
    ipv6_link_local_address: FE80::10
    ipv6_dad: enabled
    mac: 00:22:BD:F8:19:FF
    mtu: inherit
    node_id: 101
    path: eth1/1
    encapsulation_type: vlan
    encapsulation_value: 100
    interface_group_policy: interface_group_policy_name
    node_router_id: 1.1.1.1
    node_group_policy: node_group_policy_name
    use_router_id_as_loopback: true
    ptp:
      user_profile:
        uuid: '{{ ptp_profile.current.uuid }}'
    state: present

- name: Create a L3Out Routed Sub-Interface of type port_channel with reference
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    ipv4_address: 10.1.0.1/24
    ipv6_address: 1::112/16
    ipv6_link_local_address: FE80::20
    ipv6_dad: disabled
    mac: 00:22:BD:F8:19:EE
    mtu: 2000
    port_channel:
      reference:
        name: port_channel_interface_name
        template: fabric_resource_template_name
    encapsulation_type: vlan
    encapsulation_value: 100
    interface_group_policy: interface_group_policy_name
    node_router_id: 2.2.2.2
    node_group_policy: node_group_policy_name
    use_router_id_as_loopback: false
    node_loopback_ip: 10.0.0.1
    ptp:
      mode: unicast_master
      user_profile:
        reference:
          name: ptp_profile_name
          template: fabric_policy_template_name
      source_address: 12.0.0.1
      unicast_destinations:
        - 12.0.0.2
        - 12.0.0.3
    state: present

- name: Update a L3Out Routed Sub-Interface of type port_channel with uuid
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: "{{ l3out_template.current.templateId }}"
    l3out_uuid: "{{ l3out.current.uuid }}"
    ipv4_address: 10.1.0.1/24
    ipv6_address: 1::112/16
    ipv6_link_local_address: FE80::20
    ipv6_dad: disabled
    mac: 00:22:BD:F8:19:EE
    mtu: 2000
    port_channel:
      uuid: "{{ port_channel_interface.current.uuid }}"
    encapsulation_type: vlan
    encapsulation_value: 100
    interface_group_policy: interface_group_policy_name
    node_router_id: 2.2.2.2
    node_group_policy: node_group_policy_name
    use_router_id_as_loopback: false
    node_loopback_ip: 10.0.0.1
    state: present

- name: Remove PTP configuration from a L3Out Routed Sub-Interface of type port
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    node_id: 101
    path: eth1/1
    encapsulation_type: vlan
    encapsulation_value: 100
    ptp: {}
    state: present

- name: Query an existing L3Out Routed Sub-Interface of type port
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    node_id: 101
    path: eth1/1
    encapsulation_type: vlan
    encapsulation_value: 100
    state: query
  register: query_with_name

- name: Query an existing L3Out Routed Sub-Interface of type port_channel
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    port_channel:
      reference:
        name: port_channel_interface_name
        template: fabric_resource_template_name
    encapsulation_type: vlan
    encapsulation_value: 100
    state: query
  register: query_with_name

- name: Query all existing Routed Sub-Interfaces of a L3Out
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    state: query

- name: Delete an existing L3Out Routed Sub-Interface
  cisco.mso.ndo_l3out_routed_sub_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out_name
    node_id: 101
    path: eth1/1
    encapsulation_type: vlan
    encapsulation_value: 100
    state: absent

Authors

Akini Ross (@akinross)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/ndo_l3out_routed_sub_interface_module.html