W3cubDocs

/Ansible

cisco.mso.ndo_virtual_port_channel_interface module – Manage Virtual Port Channel Interfaces on Cisco Nexus Dashboard Orchestrator (NDO).

Note

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

Synopsis

  • Manage Virtual Port Channel Interfaces on Cisco Nexus Dashboard Orchestrator (NDO).
  • This module is only supported on ND v3.2 (NDO v4.4) 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

description

string

The description of the Virtual Port Channel Interface.

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_descriptions

list / elements=dictionary

The list of interface descriptions of the Virtual Port Channel Interface.

Providing a new list of interface_descriptions will completely replace an existing one from the Virtual Port Channel Interface.

Providing an empty list will remove the interface_descriptions=[] from the Virtual Port Channel Interface.

description

string

The description of the interface or group of interfaces.

interface_id

string / required

The interface ID or a range of interface IDs.

Using a range of interface IDs will apply the same interface_descriptions.description for every ID in range.

node

string / required

The node ID.

interface_policy_group

aliases: policy, interface_policy, interface_setting

dictionary

The Port Channel Interface Policy Group.

This parameter can be used instead of interface_policy_group_uuid.

name

string / required

The name of the Interface Policy Group.

template

string / required

The name of the template in which the Interface Policy Group has been created.

interface_policy_group_uuid

aliases: policy_uuid, interface_policy_uuid, interface_setting_uuid

string

The UUID of the Port Channel Interface Policy Group.

This parameter is required when creating a new Virtual Port Channel Interface.

interfaces_node_1

aliases: interfaces_1, members_1

list / elements=string

The list of used Interface IDs for the first node.

Ranges of Interface IDs can be used.

This parameter is required when creating a new Virtual Port Channel Interface.

interfaces_node_2

aliases: interfaces_2, members_2

list / elements=string

The list of used Interface IDs for the second node.

Ranges of Interface IDs can be used.

This parameter is required when creating a new Virtual Port Channel Interface.

If interfaces_node_2=[mirror] and interfaces_node_1 is clearly defined, the interfaces of interfaces_node_1 will be mirrored in interfaces_node_2.

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.

name

aliases: virtual_port_channel_interface, virtual_port_channel, vpc

string

The name of the Virtual Port Channel Interface.

node_1

string

The first node ID.

node_2

string

The second node ID.

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.

state

string

Use absent for removing.

Use query for listing an object or multiple objects.

Use present for creating or updating.

Choices:

  • "absent"
  • "query" ← (default)
  • "present"

template

aliases: fabric_resource_template

string

The name of the Fabric Resource template.

This parameter or template_id is required.

template_id

aliases: fabric_resource_template_id

string

The ID of the Fabric Policy 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.

uuid

aliases: virtual_port_channel_interface_uuid, virtual_port_channel_uuid, vpc_uuid

string

The UUID of the Virtual Port Channel Interface.

This parameter can be used instead of virtual_port_channel_interface when an existing Virtual Port Channel Interface is updated.

This parameter is required when parameter name is updated.

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 must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Fabric Resource template.
  • The interface_policy_group must exist before using this module in your playbook. Use cisco.mso.ndo_interface_setting to create the Interface Policy Group of type Port Channel.
  • 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_interface_setting

Manage Interface Policy Groups on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create a new Virtual Port Channel Interface
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_resource_template
    description: My Ansible Port Channel
    name: ansible_virtual_port_channel_interface
    node_1: 101
    node_2: 102
    interfaces_node_1:
      - 1/1
      - 1/10-11
    interfaces_node_2:
      - 1/2
    interface_policy_group:
      name: ansible_policy_group
      template: ansible_fabric_policy_template
    interface_descriptions:
      - node: 101
        interface_id: 1/1
        description: My single Ansible Interface for first node
      - node: 101
        interface_id: 1/10-11
        description: My group of Ansible Interface for first node
      - node: 102
        interface_id: 1/2
        description: My single Ansible Interface for second node
    state: present
  register: virtual_port_channel_interface_1

- name: Update a Virtual Port Channel Interface's interfaces and their descriptions
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    description: My Ansible Port Channel
    name: ansible_virtual_port_channel_interface
    node_1: 101
    node_2: 102
    interfaces_node_1:
      - 1/1
      - 1/5-7
    interfaces_node_2:
      - 1/1-2
    interface_descriptions:
      - node: 101
        interface_id: 1/1
        description: My single unchanged Ansible Interface for first node
      - node: 101
        interface_id: 1/5-7
        description: My new group of Ansible Interface for first node
      - node: 102
        interface_id: 1/1-2
        description: My new group of Ansible Interfaces for second node
    state: present

- name: Update a Virtual Port Channel Interface by mirroring node 1 and node 2 interfaces
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    description: My Ansible Port Channel
    name: ansible_virtual_port_channel_interface
    node_1: 101
    node_2: 102
    interfaces_node_1:
      - 1/1-9
      - 1/11-15
    interfaces_node_2: mirror
    state: present

- name: Update a Virtual Port Channel Interface's name with UUID
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_resource_template
    name: ansible_virtual_port_channel_interface_changed
    uuid: "{{ virtual_port_channel_interface_1.current.uuid }}"
    state: present

- name: Query a Virtual Port Channel Interface with name
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_resource_template
    name: ansible_virtual_port_channel_interface_changed
    state: query
  register: query_name

- name: Query a Virtual Port Channel Interface with UUID
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_resource_template
    uuid: "{{ virtual_port_channel_interface_1.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all Virtual Port Channel Interfaces in a Fabric Resource Template
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_resource_template
    state: query
  register: query_all

- name: Delete a Virtual Port Channel Interface with name
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_resource_template
    name: ansible_virtual_port_channel_interface_changed
    state: absent

- name: Delete a Virtual Port Channel Interface with UUID
  cisco.mso.ndo_virtual_port_channel_interface:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_fabric_resource_template
    uuid: "{{ virtual_port_channel_interface_1.current.uuid }}"
    state: absent

Authors

  • Gaspard Micol (@gmicol)

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