W3cubDocs

/Ansible

cisco.nxos.nxos_zone_zoneset – Configuration of zone/zoneset 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_zone_zoneset.

New in version 1.0.0: of cisco.nxos

Synopsis

  • Configuration of zone/zoneset for Cisco MDS NXOS.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
zone_zoneset_details
list / elements=dictionary
List of zone/zoneset details to be added or removed
default_zone
string
    Choices:
  • permit
  • deny
default zone behaviour for the vsan
mode
string
    Choices:
  • enhanced
  • basic
mode of the zone for the vsan
smart_zoning
boolean
    Choices:
  • no
  • yes
Removes the vsan if True
vsan
integer / required
vsan id
zone
list / elements=dictionary
List of zone options for that vsan
members
list / elements=dictionary
Members of the zone that needs to be removed or added
devtype
string
    Choices:
  • initiator
  • target
  • both
devtype of the zone member used along with Smart zoning config
pwwn
string / required
pwwn member of the zone, use alias 'device_alias' as option for device_alias member

aliases: device_alias
remove
boolean
    Choices:
  • no ←
  • yes
Removes member from the zone if True
name
string / required
name of the zone
remove
boolean
    Choices:
  • no ←
  • yes
Deletes the zone if True
zoneset
list / elements=dictionary
List of zoneset options for the vsan
action
string
    Choices:
  • activate
  • deactivate
activates/de-activates the zoneset
members
list / elements=dictionary
Members of the zoneset that needs to be removed or added
name
string / required
name of the zone that needs to be added to the zoneset or removed from the zoneset
remove
boolean
    Choices:
  • no ←
  • yes
Removes zone member from the zoneset
name
string / required
name of the zoneset
remove
boolean
    Choices:
  • no ←
  • yes
Removes zoneset if True

Notes

Note

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

Examples

- name: Test that zone/zoneset module works
  cisco.nxos.nxos_zone_zoneset:
    zone_zoneset_details:
    - mode: enhanced
      vsan: 22
      zone:
      - members:
        - pwwn: 11:11:11:11:11:11:11:11
        - device_alias: test123
        - pwwn: 61:61:62:62:12:12:12:12
          remove: true
        name: zoneA
      - members:
        - pwwn: 10:11:11:11:11:11:11:11
        - pwwn: 62:62:62:62:21:21:21:21
        name: zoneB
      - name: zoneC
        remove: true
      zoneset:
      - action: activate
        members:
        - name: zoneA
        - name: zoneB
        - name: zoneC
          remove: true
        name: zsetname1
      - action: deactivate
        name: zsetTestExtra
        remove: true
    - mode: basic
      smart_zoning: true
      vsan: 21
      zone:
      - members:
        - devtype: both
          pwwn: 11:11:11:11:11:11:11:11
        - pwwn: 62:62:62:62:12:12:12:12
        - devtype: both
          pwwn: 92:62:62:62:12:12:1a:1a
          remove: true
        name: zone21A
      - members:
        - pwwn: 10:11:11:11:11:11:11:11
        - pwwn: 62:62:62:62:21:21:21:21
        name: zone21B
      zoneset:
      - action: activate
        members:
        - name: zone21A
        - name: zone21B
        name: zsetname212

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', 'zone name zoneA vsan 923', 'member pwwn 11:11:11:11:11:11:11:11', 'no member device-alias test123', 'zone commit vsan 923', 'no terminal dont-ask']
messages
list / elements=string
always
debug messages

Sample:
['zone mode is already enhanced ,no change in zone mode configuration for vsan 922', "zone member '11:11:11:11:11:11:11:11' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member 'test123' is already present in zone 'zoneA' in vsan 922 hence nothing to add", "zone member '61:61:62:62:12:12:12:12' is not present in zone 'zoneA' in vsan 922 hence nothing to remove", "zone member '10:11:11:11:11:11:11:11' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone member '62:62:62:62:21:21:21:21' is already present in zone 'zoneB' in vsan 922 hence nothing to add", "zone 'zoneC' is not present in vsan 922 , so nothing to remove"]


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_zone_zoneset_module.html