Try SpotterFc Interfaces resource module
| "added in version" 5.2.0 of cisco.nxos"
Authors: Suhas Bharadwaj (@srbharadwaj)
Install with ansible-galaxy collection install cisco.nxos:==7.0.0
collections:
- name: cisco.nxos
version: 7.0.0This module manages the interface attributes of NX-OS fc interfaces.
# Using merged
# Before state:
# -------------
#
# switch# show running-config interface all
# interface fc18/10
# analytics type fc-nvme
# switchport speed auto max 16000
# switchport mode auto
# switchport description $
# switchport trunk mode on
# shutdown
- name: Merge provided configuration with device configuration
cisco.nxos.nxos_fc_interfaces:
config:
- name: fc18/10
analytics: fc-scsi
state: merged
# Task Output
# -----------
#
# before:
# - name: fc18/10
# speed: auto max 16000
# mode: auto
# trunk_mode: on
# enabled: true
# description: $
# analytics: fc-nvme
# commands:
# - interface fc18/10
# - analytics type fc-scsi
# after:
# - name: fc18/10
# speed: auto max 16000
# mode: auto
# trunk_mode: on
# enabled: true
# description: $
# analytics: fc-all
# After state:
# ------------
#
# switch# show running-config interface all
# interface fc18/10
# analytics type fc-scsi
# analytics type fc-nvme
# switchport speed auto max 16000
# switchport mode auto
# switchport description $
# switchport trunk mode on
# shutdown
# Using replaced
# Before state:
# -------------
#
# switch# show running-config interface all
# interface fc18/12
# analytics type fc-scsi
# analytics type fc-nvme
# switchport speed auto max 64000
# switchport mode auto
# switchport description 1
# switchport trunk mode on
# no shutdown
- name: Replaces device configuration of listed interfaces with provided configuration
cisco.nxos.nxos_fc_interfaces:
config:
- name: fc18/12
speed: auto max 64000
mode: auto
trunk_mode: "on"
enabled: true
description: 1
analytics: fc-scsi
state: replaced
# Task Output
# -----------
#
# before:
# - name: fc18/12
# speed: auto max 64000
# mode: auto
# trunk_mode: on
# enabled: true
# description: 1
# analytics: fc-all
# commands:
# - interface fc18/12
# - no analytics type fc-all
# - analytics type fc-scsi
# after:
# - name: fc18/12
# speed: auto max 64000
# mode: auto
# trunk_mode: on
# enabled: true
# description: 1
# analytics: fc-scsi
# After state:
# ------------
#
# switch# show running-config interface all
# interface fc18/12
# analytics type fc-scsi
# switchport speed auto max 64000
# switchport mode auto
# switchport description 1
# switchport trunk mode on
# no shutdown
# Using deleted
# Before state:
# -------------
#
# switch# show running-config interface all
# interface fc1/2
# switchport speed 1000
# switchport mode E
# no switchport description
# switchport trunk mode off
# no shutdown
- name: Delete or return interface parameters to default settings
cisco.nxos.nxos_fc_interfaces:
config:
- name: fc1/2
state: deleted
# Task Output
# -----------
#
# before:
# - name: fc1/2
# speed: 1000
# mode: E
# trunk_mode: off
# enabled: true
# commands:
# - interface fc1/2
# - no switchport speed 1000
# - no switchport mode E
# - switchport trunk mode on
# - shutdown
# after:
# - name: fc1/2
# speed: auto
# mode: auto
# trunk_mode: on
# enabled: true
# After state:
# ------------
#
# switch# show running-config interface all
# interface fc1/2
# switchport speed auto
# switchport mode auto
# no switchport description
# switchport trunk mode on
# shutdown
# Using overridden
# Before state:
# -------------
#
# switch# show running-config interface all
# interface fc18/12
# analytics type fc-scsi
# analytics type fc-nvme
# switchport speed auto max 64000
# switchport mode auto
# switchport description 1
# switchport trunk mode on
# no shutdown
# interface fc18/13
# analytics type fc-scsi
# analytics type fc-nvme
# switchport speed auto max 64000
# switchport mode auto
# switchport description 1
# switchport trunk mode on
# no shutdown
- name: Replaces device configuration of listed interfaces with provided configuration
cisco.nxos.nxos_fc_interfaces:
config:
- name: fc18/12
speed: auto max 64000
mode: auto
trunk_mode: "on"
enabled: true
description: 1
analytics: fc-scsi
state: overridden
# Task Output
# -----------
#
# before:
# - name: fc18/12
# speed: auto max 64000
# mode: auto
# trunk_mode: on
# enabled: true
# description: 1
# analytics: fc-all
# - name: fc18/13
# speed: auto max 64000
# mode: auto
# trunk_mode: on
# enabled: true
# description: 1
# analytics: fc-all
# commands:
# - interface fc18/12
# no analytics type fc-all
# analytics type fc-scsi
# - interface fc18/13
# no switchport description
# no switchport speed auto max 64000
# no switchport mode auto
# switchport trunk mode on
# shutdown
# after:
# - name: fc18/12
# speed: auto max 64000
# mode: auto
# trunk_mode: on
# enabled: true
# description: 1
# analytics: fc-scsi
# - name: fc18/13
# speed: auto max 64000
# mode: auto
# trunk_mode: on
# enabled: true
# After state:
# ------------
#
# switch# show running-config interface all
# interface fc18/12
# analytics type fc-scsi
# switchport speed auto max 64000
# switchport mode auto
# switchport description 1
# switchport trunk mode on
# no shutdown
# interface fc18/13
# switchport mode auto
# switchport trunk mode on
# shutdown
# Using rendered
- name: Use rendered state to convert task input to device specific commands
cisco.nxos.nxos_fc_interfaces:
config:
- name: fc1/1
speed: auto
mode: auto
trunk_mode: "on"
enabled: true
description: This is a sample line
- name: fc1/2
speed: 1000
mode: E
trunk_mode: "off"
enabled: true
state: rendered
# Task Output
# -----------
#
# rendered:
# interface fc1/1
# switchport speed auto
# switchport mode auto
# switchport description This is a sample line
# switchport trunk mode on
# no shutdown
#
# interface fc1/2
# switchport speed 1000
# switchport mode E
# no switchport description
# switchport trunk mode off
# no shutdown
# Using parsed
# parsed.cfg
# ------------
#
# interface fc1/1
# switchport speed auto
# switchport mode auto
# switchport description This is a sample line
# switchport trunk mode on
# no shutdown
#
# interface fc1/2
# switchport speed 1000
# switchport mode E
# no switchport description
# switchport trunk mode off
# no shutdown
- name: Use parsed state to convert externally supplied config to structured format
cisco.nxos.nxos_fc_interfaces:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# Task output
# -----------
#
# parsed:
# - name: fc1/1
# speed: auto
# mode: auto
# trunk_mode: on
# enabled: true
# description: This is a sample line
# - name: fc1/2
# speed: 1000
# mode: E
# trunk_mode: off
# enabled: true
# Using gathered
# Before state:
# -------------
#
# switch# show running-config | section interface
# interface fc1/1
# switchport speed auto
# switchport mode auto
# switchport description This is a sample line
# switchport trunk mode on
# no shutdown
#
# interface fc1/2
# switchport speed 1000
# switchport mode E
# no switchport description
# switchport trunk mode off
# no shutdown
#
- name: Gather interfaces facts from the device using nxos_fc_interfaces
cisco.nxos.nxos_fc_interfaces:
state: gathered
state:
choices:
- merged
- replaced
- overridden
- deleted
- gathered
- rendered
- parsed
default: merged
description:
- The state of the configuration after module completion
type: str
config:
description: A dictionary of interface options
elements: dict
suboptions:
analytics:
choices:
- fc-scsi
- fc-nvme
- fc-all
description:
- Analytics type on the fc interface
type: str
description:
description:
- Interface description.
type: str
enabled:
description:
- Administrative state of the interface. Set the value to C(true) to administratively
enable the interface or C(true) to disable it
type: bool
mode:
choices:
- auto
- E
- F
- Fx
- NP
- SD
description:
- Port mode of the fc interface
type: str
name:
description:
- Full name of interface, e.g. fc1/1, fc18/48
required: true
type: str
speed:
choices:
- auto
- '1000'
- '2000'
- '4000'
- '8000'
- '10000'
- '16000'
- '32000'
- '64000'
- auto max 2000
- auto max 4000
- auto max 8000
- auto max 16000
- auto max 32000
- auto max 64000
description:
- Interface link speed.
type: str
trunk_mode:
choices:
- auto
- 'on'
- 'off'
description:
- Trunk mode of the fc interface
type: str
type: list
running_config:
description:
- This option is used only with state I(parsed).
- The value of this option should be the output received from the NX-OS device by
executing the command B(show running-config interface)
- The state I(parsed) reads the configuration from C(running_config) option and transforms
it into Ansible structured data as per the resource module's argspec and the value
is then returned in the I(parsed) key within the result.
type: str
after:
description: The resulting configuration after module execution.
returned: when changed
sample: 'This output will always be in the same format as the module argspec.
'
type: dict
before:
description: The configuration prior to the module execution.
returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or
C(purged)
sample: 'This output will always be in the same format as the module argspec.
'
type: dict
commands:
description: The set of commands pushed to the remote device.
returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or
C(purged)
sample:
- interface fc1/1
- description sample description
- shutdown
type: list
gathered:
description: Facts about the network resource gathered from the remote device as
structured data.
returned: when I(state) is C(gathered)
sample: 'This output will always be in the same format as the module argspec.
'
type: list
parsed:
description: The device native config provided in I(running_config) option parsed
into structured data as per module argspec.
returned: when I(state) is C(parsed)
sample: 'This output will always be in the same format as the module argspec.
'
type: list
rendered:
description: The provided configuration in the task rendered in device-native format
(offline).
returned: when I(state) is C(rendered)
sample:
- interface fc1/1
- description sample description
- shutdown
type: list