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

Note

This module is part of the cisco.nxos collection (version 8.1.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.nxos.

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

New in cisco.nxos 1.0.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Configuration of device alias for Cisco MDS NXOS.

Aliases: devicealias

Parameters

Parameter	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	Removes the device-alias if set to True Choices: `false` ← (default) `true`
distribute boolean	Enable/Disable device-alias distribution Choices: `false` `true`
mode string	Mode of devices-alias, basic or enhanced Choices: `"basic"` `"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 Cisco MDS 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	Description
commands list / elements=string	commands sent to the device Returned: always 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

Suhas Bharadwaj (@srbharadwaj)

Collection links

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