W3cubDocs

/Ansible

cisco.nxos.nxos_vsan – Configuration of vsan for Cisco NXOS MDS Switches.

Note

This plugin is part of the cisco.nxos collection (version 2.7.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_vsan.

New in version 1.0.0: of cisco.nxos

Synopsis

  • Configuration of vsan for Cisco MDS NXOS.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
vsan
list / elements=dictionary
List of vsan details to be added or removed
id
integer / required
Vsan id
interface
list / elements=string
List of vsan's interfaces to be added
name
string
Name of the vsan
remove
boolean
    Choices:
  • no
  • yes
Removes the vsan if True
suspend
boolean
    Choices:
  • no
  • yes
suspend the vsan if True

Notes

Note

  • Tested against Cisco MDS NX-OS 8.4(1)

Examples

- name: Test that vsan module works
  cisco.nxos.nxos_vsan:
    vsan:
    - id: 922
      interface:
      - fc1/1
      - fc1/2
      - port-channel 1
      name: vsan-SAN-A
      remove: false
      suspend: false
    - id: 923
      interface:
      - fc1/11
      - fc1/21
      - port-channel 2
      name: vsan-SAN-B
      remove: false
      suspend: true
    - id: 1923
      name: vsan-SAN-Old
      remove: true

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', 'vsan database', 'vsan 922 interface fc1/40', 'vsan 922 interface port-channel 155', '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/latest/collections/cisco/nxos/nxos_vsan_module.html