cisco.nxos.nxos_devicealias – Configuration of device alias for Cisco NXOS MDS Switches.

From Get docs
Ansible/docs/2.11/collections/cisco/nxos/nxos devicealias module


cisco.nxos.nxos_devicealias – Configuration of device alias for Cisco NXOS MDS Switches.

Note

This plugin is part of the cisco.nxos collection (version 1.4.0).

To install it use: ansible-galaxy collection install cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_devicealias.


New in version 1.0.0: of cisco.nxos


Synopsis

  • Configuration of device alias for Cisco MDS NXOS.

Note

This module has a corresponding action plugin.


Parameters

Parameter Choices/Defaults Comments

da

list / elements=dictionary

List of device-alias to be added or removed

name

string / required

Name of the device-alias to be added or removed

pwwn

string

pwwn to which the name needs to be associated with

remove

boolean

  • no

  • yes

Removes the device-alias if set to True

distribute

boolean

  • no
  • yes

Enable/Disable device-alias distribution

mode

string

  • basic
  • enhanced

Mode of devices-alias, basic or enhanced

rename

list / elements=dictionary

List of device-alias to be renamed

new_name

string / required

New name of the device-alias

old_name

string / required

Old name of the device-alias that needs to be renamed



Notes

Note

  • Tested against NX-OS 8.4(1)


Examples

- name: Test that device alias module works
  cisco.nxos.nxos_devicealias:
    da:
    - name: test1_add
      pwwn: 56:2:22:11:22:88:11:67
    - name: test2_add
      pwwn: 65:22:22:11:22:22:11:d
    - name: dev1
      remove: true
    - name: dev2
      remove: true
    distribute: true
    mode: enhanced
    rename:
    - new_name: bcd
      old_name: abc
    - new_name: bcd1
      old_name: abc1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

commands

list / elements=string

always

commands sent to the device


Sample:

['terminal dont-ask', 'device-alias database', 'device-alias name somename pwwn 10:00:00:00:89:a1:01:03', 'device-alias name somename1 pwwn 10:00:00:00:89:a1:02:03', 'device-alias commit', 'no terminal dont-ask']




Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_devicealias_module.html