This integration enables the management of Cisco NXOS Switches and Routers directly from XSOAR using Ansible modules. The Ansible engine is self-contained and pre-configured as part of this pack onto your XSOAR server, all you need to do is provide credentials you are ready to use the feature rich commands. This integration functions without any agents or additional software installed on the hosts by utilising SSH.

To use this integration, configure an instance of this integration. This will associate a credential to be used to access hosts when commands are run. The commands from this integration will take the NXOS host address(es) as an input, and use the saved credential associated to the instance to execute. Create separate instances if multiple credentials are required.

Credentials

This integration supports a number of methods of authenticating with the network device:

1. Username & Password entered into the integration
2. Username & Password credential from the XSOAR credential manager
3. Username and SSH Key from the XSOAR credential manager

Permissions

Whilst possible to use a Network-Operator (read-only) role, most commands require read and write access. It is recommended to use Network-Admin or appropriately scoped custom role.

Network Requirements

By default, TCP port 22 will be used to initiate a SSH connection to the NXOS host.

The connection will be initiated from the XSOAR engine/server specified in the instance settings.

Configure Ansible Cisco NXOS in Cortex

Testing

This integration does not support testing from the integration management screen. Instead it is recommended to use the !nxos-factscommand providing an example host as the command argument. This command will connect to the specified network device with the configured credentials in the integration, and if successful output general information about the device.

Idempotence

The action commands in this integration are idempotent. This means that the result of performing it once is exactly the same as the result of performing it repeatedly without any intervening actions.

State Arguement

Some of the commands in this integration take a state argument. These define the desired end state of the object being managed. As a result these commands are able to perform multiple management operations depending on the desired state value. Common state values are:

Complex Command Inputs

Some commands may require structured input arguments such as lists or dictionary, these can be provided in standard JSON notation wrapped in double curly braces. For example a argument called dns_servers that accepts a list of server IPs 8.8.8.8 and 8.8.4.4 would be entered as dns_servers="{{ ['8.8.8.8', '8.8.4.4'] }}".

Other more advanced data manipulation tools such as Ansible/Jinja2 filters can also be used in-line. For example to get a random number between 0 and 60 you can use {{ 60 | random }}.

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

nxos-aaa-server

Manages AAA server global configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_aaa_server_module.html

Base Command

nxos-aaa-server

Input

Context Output

Command Example

!nxos-aaa-server host="192.168.1.19" server_type="radius" server_timeout="9" deadtime="20" directed_request="enabled"

Context Example

{
    "CiscoNXOS": {
        "NxosAaaServer": {
            "changed": true,
            "commands": [
                "radius-server deadtime 20",
                "radius-server timeout 9",
                "radius-server directed-request"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: radius-server deadtime 20
  • 1: radius-server timeout 9
  • 2: radius-server directed-request

nxos-aaa-server-host

Manages AAA server host-specific configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_aaa_server_host_module.html

Base Command

nxos-aaa-server-host

Input

Context Output

Command Example

!nxos-aaa-server-host host="192.168.1.19" state="present" server_type="radius" address="1.2.3.4" acct_port="2084" host_timeout="10"

Context Example

{
    "CiscoNXOS": {
        "NxosAaaServerHost": {
            "changed": true,
            "end_state": {
                "acct_port": "2084",
                "address": "1.2.3.4",
                "auth_port": null,
                "host_timeout": "10",
                "key": null,
                "server_type": "radius"
            },
            "existing": {},
            "host": "192.168.1.19",
            "proposed": {
                "acct_port": "2084",
                "address": "1.2.3.4",
                "host_timeout": "10",
                "server_type": "radius"
            },
            "status": "CHANGED",
            "updates": [
                "radius-server host 1.2.3.4 acct-port 2084 timeout 10"
            ]
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• End_State

  • acct_port: 2084
  • address: 1.2.3.4
  • auth_port: None
  • host_timeout: 10
  • key: None
  • server_type: radius

• Existing

• Proposed

  • acct_port: 2084
  • address: 1.2.3.4
  • host_timeout: 10
  • server_type: radius

• Updates

  • 0: radius-server host 1.2.3.4 acct-port 2084 timeout 10

nxos-acl

Manages access list entries for ACLs.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_acl_module.html

Base Command

nxos-acl

Input

Context Output

Command Example

!nxos-acl host="192.168.1.19" name="ANSIBLE" seq="10" action="permit" proto="tcp" "src"="192.0.2.1/2" dest="any" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosAcl": {
            "changed": true,
            "commands": [
                "ip access-list ANSIBLE",
                "10 permit tcp 192.0.2.1/24 any"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: ip access-list ANSIBLE
  • 1: 10 permit tcp 192.0.2.1/24 any

nxos-acl-interface

Manages applying ACLs to interfaces.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_acl_interface_module.html

Base Command

nxos-acl-interface

Input

Context Output

Command Example

!nxos-acl-interface host="192.168.1.19" name="ANSIBLE" interface="ethernet1/41" direction="egress" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosAclInterface": {
            "changed": true,
            "commands": [
                "interface ethernet1/41",
                "ip access-group ANSIBLE out"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: interface ethernet1/41
  • 1: ip access-group ANSIBLE out

nxos-banner

Manage multiline banners on Cisco NXOS devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_banner_module.html

Base Command

nxos-banner

Input

Context Output

Command Example

!nxos-banner host="192.168.1.19" banner="exec" text="this is my exec banner" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosBanner": {
            "changed": true,
            "commands": [
                "banner exec @\nthis is my exec banner\n@"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: banner exec @
    this is my exec banner
    @

nxos-bfd-global

Bidirectional Forwarding Detection (BFD) global-level configuration
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_bfd_global_module.html

Base Command

nxos-bfd-global

Input

Context Output

Command Example

!nxos-bfd-global host="192.168.1.19" echo_rx_interval="50" interval="{'tx': 50, 'min_rx': 50, 'multiplier': 4}"

Context Example

{
    "CiscoNXOS": {
        "NxosBfdGlobal": {
            "changed": false,
            "check_mode": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• check_mode: False

• Commands

nxos-bfd-interfaces

Manages BFD attributes of nxos interfaces.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_bfd_interfaces_module.html

Base Command

nxos-bfd-interfaces

Input

Context Output

Command Example

!nxos-bfd-interfaces host="192.168.1.19" state="deleted"

Context Example

{
    "CiscoNXOS": {
        "NxosBfdInterfaces": {
            "before": [
                {
                    "bfd": "enable",
                    "echo": "enable",
                    "name": "Ethernet1/1"
                },
                {
                    "bfd": "enable",
                    "echo": "enable",
                    "name": "Ethernet1/2"
                }
            ],
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Before

• Ethernet1/1

  • bfd: enable
  • echo: enable
  • name: Ethernet1/1

• Ethernet1/2

  • bfd: enable
  • echo: enable
  • name: Ethernet1/2

• Commands

nxos-bgp

Manages BGP configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_bgp_module.html

Base Command

nxos-bgp

Input

Context Output

Command Example

!nxos-bgp host="192.168.1.19" asn="65535" vrf="test" router_id="192.0.2.1" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosBgp": {
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Commands

nxos-bgp-af

Manages BGP Address-family configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_bgp_af_module.html

Base Command

nxos-bgp-af

Input

Context Output

nxos-bgp-neighbor

Manages BGP neighbors configurations.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_bgp_neighbor_module.html

Base Command

nxos-bgp-neighbor

Input

Context Output

Command Example

!nxos-bgp-neighbor host="192.168.1.19" asn="65535" neighbor="1.1.1.1" local_as="20" remote_as="30" bfd="enable" description="just a description" update_source="Ethernet1/3" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosBgpNeighbor": {
            "changed": true,
            "commands": [
                "router bgp 65535",
                "neighbor 1.1.1.1",
                "bfd",
                "description just a description",
                "remote-as 30",
                "update-source Ethernet1/3",
                "local-as 20"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: router bgp 65535
  • 1: neighbor 1.1.1.1
  • 2: bfd
  • 3: description just a description
  • 4: remote-as 30
  • 5: update-source Ethernet1/3
  • 6: local-as 20

nxos-bgp-neighbor-af

Manages BGP address-family’s neighbors configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_bgp_neighbor_af_module.html

Base Command

nxos-bgp-neighbor-af

Input

Context Output

Command Example

!nxos-bgp-neighbor-af host="192.168.1.19" asn="65535" neighbor="1.1.1.1" afi="ipv4" safi="unicast" route_reflector_client="True" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosBgpNeighborAf": {
            "changed": true,
            "commands": [
                "router bgp 65535",
                "neighbor 1.1.1.1",
                "address-family ipv4 unicast",
                "route-reflector-client"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: router bgp 65535
  • 1: neighbor 1.1.1.1
  • 2: address-family ipv4 unicast
  • 3: route-reflector-client

nxos-command

Run arbitrary command on Cisco NXOS devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_command_module.html

Base Command

nxos-command

Input

Context Output

Command Example

!nxos-command host="192.168.1.19" commands="show version"

Context Example

{
    "CiscoNXOS": {
        "NxosCommand": {
            "changed": false,
            "host": "192.168.1.19",
            "status": "SUCCESS",
            "stdout": [
                "Cisco Nexus Operating System (NX-OS) Software\nTAC support: http://www.cisco.com/tac\nDocuments: http://www.cisco.com/en/US/products/ps9372/tsd_products_support_series_home.html\nCopyright (c) 2002-2019, Cisco Systems, Inc. All rights reserved.\nThe copyrights to certain works contained herein are owned by\nother third parties and are used and distributed under license.\nSome parts of this software are covered under the GNU Public\nLicense. A copy of the license is available at\nhttp://www.gnu.org/licenses/gpl.html.\n\nNexus 9000v is a demo version of the Nexus Operating System\n\nSoftware\n  BIOS: version \n NXOS: version 9.3(3)\n  BIOS compile time:  \n  NXOS image file is: bootflash:///nxos.9.3.3.bin\n  NXOS compile time:  12/22/2019 2:00:00 [12/22/2019 14:00:37]\n\n\nHardware\n  cisco Nexus9000 C9500v Chassis (\"Supervisor Module\")\n   with 7837092 kB of memory.\n  Processor Board ID 9ESGSKDKPR0\n\n  Device name: n9kv01\n  bootflash:    4287040 kB\nKernel uptime is 0 day(s), 8 hour(s), 56 minute(s), 55 second(s)\n\nLast reset \n  Reason: Unknown\n  System version: \n  Service: \n\nplugin\n  Core Plugin, Ethernet Plugin\n\nActive Package(s):"
            ],
            "stdout_lines": [
                [
                    "Cisco Nexus Operating System (NX-OS) Software",
                    "TAC support: http://www.cisco.com/tac",
                    "Documents: http://www.cisco.com/en/US/products/ps9372/tsd_products_support_series_home.html",
                    "Copyright (c) 2002-2019, Cisco Systems, Inc. All rights reserved.",
                    "The copyrights to certain works contained herein are owned by",
                    "other third parties and are used and distributed under license.",
                    "Some parts of this software are covered under the GNU Public",
                    "License. A copy of the license is available at",
                    "http://www.gnu.org/licenses/gpl.html.",
                    "",
                    "Nexus 9000v is a demo version of the Nexus Operating System",
                    "",
                    "Software",
                    "  BIOS: version ",
                    " NXOS: version 9.3(3)",
                    "  BIOS compile time:  ",
                    "  NXOS image file is: bootflash:///nxos.9.3.3.bin",
                    "  NXOS compile time:  12/22/2019 2:00:00 [12/22/2019 14:00:37]",
                    "",
                    "",
                    "Hardware",
                    "  cisco Nexus9000 C9500v Chassis (\"Supervisor Module\")",
                    "   with 7837092 kB of memory.",
                    "  Processor Board ID 9ESGSKDKPR0",
                    "",
                    "  Device name: n9kv01",
                    "  bootflash:    4287040 kB",
                    "Kernel uptime is 0 day(s), 8 hour(s), 56 minute(s), 55 second(s)",
                    "",
                    "Last reset ",
                    "  Reason: Unknown",
                    "  System version: ",
                    "  Service: ",
                    "",
                    "plugin",
                    "  Core Plugin, Ethernet Plugin",
                    "",
                    "Active Package(s):"
                ]
            ]
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Stdout

  • 0: Cisco Nexus Operating System (NX-OS) Software
    TAC support: http://www.cisco.com/tac
    Documents: http://www.cisco.com/en/US/products/ps9372/tsd_products_support_series_home.html
    Copyright (c) 2002-2019, Cisco Systems, Inc. All rights reserved.
    The copyrights to certain works contained herein are owned by
    other third parties and are used and distributed under license.
    Some parts of this software are covered under the GNU Public
    License. A copy of the license is available at
    http://www.gnu.org/licenses/gpl.html.

Nexus 9000v is a demo version of the Nexus Operating System

Software
BIOS: version
NXOS: version 9.3(3)
BIOS compile time:
NXOS image file is: bootflash:///nxos.9.3.3.bin
NXOS compile time: 12/22/2019 2:00:00 [12/22/2019 14:00:37]

Hardware
cisco Nexus9000 C9500v Chassis (“Supervisor Module”)
with 7837092 kB of memory.
Processor Board ID 9ESGSKDKPR0

Device name: n9kv01
bootflash: 4287040 kB
Kernel uptime is 0 day(s), 8 hour(s), 56 minute(s), 55 second(s)

Last reset
Reason: Unknown
System version:
Service:

plugin
Core Plugin, Ethernet Plugin

Active Package(s):

• Stdout_Lines

• List

  • 0: Cisco Nexus Operating System (NX-OS) Software
  • 1: TAC support: http://www.cisco.com/tac
  • 2: Documents: http://www.cisco.com/en/US/products/ps9372/tsd_products_support_series_home.html
  • 3: Copyright (c) 2002-2019, Cisco Systems, Inc. All rights reserved.
  • 4: The copyrights to certain works contained herein are owned by
  • 5: other third parties and are used and distributed under license.
  • 6: Some parts of this software are covered under the GNU Public
  • 7: License. A copy of the license is available at
  • 8: http://www.gnu.org/licenses/gpl.html.
  • 9:
  • 10: Nexus 9000v is a demo version of the Nexus Operating System
  • 9:
  • 12: Software
  • 13: BIOS: version
  • 14: NXOS: version 9.3(3)
  • 15: BIOS compile time:
  • 16: NXOS image file is: bootflash:///nxos.9.3.3.bin
  • 17: NXOS compile time: 12/22/2019 2:00:00 [12/22/2019 14:00:37]
  • 9:
  • 9:
  • 20: Hardware
  • 21: cisco Nexus9000 C9500v Chassis (“Supervisor Module”)
  • 22: with 7837092 kB of memory.
  • 23: Processor Board ID 9ESGSKDKPR0
  • 9:
  • 25: Device name: n9kv01
  • 26: bootflash: 4287040 kB
  • 27: Kernel uptime is 0 day(s), 8 hour(s), 56 minute(s), 55 second(s)
  • 9:
  • 29: Last reset
  • 30: Reason: Unknown
  • 31: System version:
  • 32: Service:
  • 9:
  • 34: plugin
  • 35: Core Plugin, Ethernet Plugin
  • 9:
  • 37: Active Package(s):

nxos-config

Manage Cisco NXOS configuration sections
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_config_module.html

Base Command

nxos-config

Input

Context Output

Command Example

!nxos-config host="192.168.1.19" lines="hostname n9kv01" save_when="modified" backup=yes

Context Example

{
    "CiscoNXOS": {
        "NxosConfig": {
            "backup_path": "./backup/192.168.1.19_config.2021-07-11@00:43:34",
            "changed": true,
            "commands": [
                "hostname n9kv01"
            ],
            "date": "2021-07-11",
            "filename": "192.168.1.19_config.2021-07-11@00:43:34",
            "host": "192.168.1.19",
            "shortname": "./backup/192.168.1.19_config",
            "status": "CHANGED",
            "time": "00:43:34",
            "updates": [
                "hostname n9kv01"
            ]
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• backup_path: ./backup/192.168.1.19_config.2021-07-11@00:43:34
• changed: True
• date: 2021-07-11
• filename: 192.168.1.19_config.2021-07-11@00:43:34
• shortname: ./backup/192.168.1.19_config

• time: 00:43:34

• Commands

  • 0: hostname n9kv01

• Updates

  • 0: hostname n9kv01

nxos-evpn-global

Handles the EVPN control plane for VXLAN.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_evpn_global_module.html

Base Command

nxos-evpn-global

Input

Context Output

Command Example

!nxos-evpn-global host="192.168.1.19" nv_overlay_evpn="True"

Context Example

{
    "CiscoNXOS": {
        "NxosEvpnGlobal": {
            "changed": true,
            "commands": [
                "nv overlay evpn"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: nv overlay evpn

nxos-evpn-vni

Manages Cisco EVPN VXLAN Network Identifier (VNI).
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_evpn_vni_module.html

Base Command

nxos-evpn-vni

Input

Context Output

nxos-facts

Gets facts about NX-OS switches
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_facts_module.html

Base Command

nxos-facts

Input

Context Output

Command Example

!nxos-facts host="192.168.1.19" gather_subset="all"

Context Example

{
    "CiscoNXOS": {
        "NxosFacts": {
            "discovered_interpreter_python": "/usr/local/bin/python",
            "host": "192.168.1.19",
            "net__hostname": "192.168.1.19",
            "net__os": "9.3(3)",
            "net__platform": "Nexus9000 C9500v Chassis",
            "net_all_ipv4_addresses": [
                "192.168.1.19"
            ],
            "net_all_ipv6_addresses": [],
            "net_api": "cliconf",
            "net_config": "!Command: show running-config\n!Running configuration last done at: Sat Jul 10 23:00:14 2021\n!Time: Sat Jul 10 23:00:57 2021\n\nversion 9.3(3) Bios:version  \nhostname 192.168.1.19\nvdc 192.168.1.19 id 1\n  limit-resource vlan minimum 16 maximum 4094\n  limit-resource vrf minimum 2 maximum 4096\n  limit-resource port-channel minimum 0 maximum 511\n  limit-resource u4route-mem minimum 248 maximum 248\n  limit-resource u6route-mem minimum 96 maximum 96\n  limit-resource m4route-mem minimum 58 maximum 58\n  limit-resource m6route-mem minimum 8 maximum 8\n\nnv overlay evpn\nfeature bfd\nclock protocol none vdc 1\n\nusername admin password 5 $5$GYWPMp8g$uCosvTBewY0RcsJx/XB4e92DceRU8J4mvDI1JztQtG3  role network-admin\nip domain-lookup\nradius-server timeout 9\nradius-server deadtime 20\nradius-server host 1.2.3.4 acct-port 2084 authentication accounting timeout 10 \nsystem default switchport\nip access-list ANSIBLE\n  10 permit tcp 192.0.2.1/24 any \nbfd interval 50 min_rx 50 multiplier 4\nsnmp-server user admin network-admin auth md5 0x4f14136eab1027c832da1709141f5070 priv 0x4f14136eab1027c832da1709141f5070 localizedkey\nrmon event 1 description FATAL(1) owner PMON@FATAL\nrmon event 2 description CRITICAL(2) owner PMON@CRITICAL\nrmon event 3 description ERROR(3) owner PMON@ERROR\nrmon event 4 description WARNING(4) owner PMON@WARNING\nrmon event 5 description INFORMATION(5) owner PMON@INFO\nradius-server directed-request \n\nvlan 1\n\nvrf context management\n  ip domain-name lan\n  ip name-server 192.168.1.1\n  ip route 0.0.0.0/0 192.168.1.1\n\ninterface Ethernet1/1\n\ninterface Ethernet1/2\n\ninterface Ethernet1/3\n\ninterface Ethernet1/4\n\ninterface Ethernet1/5\n\ninterface Ethernet1/6\n\ninterface Ethernet1/7\n\ninterface Ethernet1/8\n\ninterface Ethernet1/9\n\ninterface Ethernet1/10\n\ninterface Ethernet1/11\n\ninterface Ethernet1/12\n\ninterface Ethernet1/13\n\ninterface Ethernet1/14\n\ninterface Ethernet1/15\n\ninterface Ethernet1/16\n\ninterface Ethernet1/17\n\ninterface Ethernet1/18\n\ninterface Ethernet1/19\n\ninterface Ethernet1/20\n\ninterface Ethernet1/21\n\ninterface Ethernet1/22\n\ninterface Ethernet1/23\n\ninterface Ethernet1/24\n\ninterface Ethernet1/25\n\ninterface Ethernet1/26\n\ninterface Ethernet1/27\n\ninterface Ethernet1/28\n\ninterface Ethernet1/29\n\ninterface Ethernet1/30\n\ninterface Ethernet1/31\n\ninterface Ethernet1/32\n\ninterface Ethernet1/33\n\ninterface Ethernet1/34\n\ninterface Ethernet1/35\n\ninterface Ethernet1/36\n\ninterface Ethernet1/37\n\ninterface Ethernet1/38\n\ninterface Ethernet1/39\n\ninterface Ethernet1/40\n\ninterface Ethernet1/41\n\ninterface Ethernet1/42\n\ninterface Ethernet1/43\n\ninterface Ethernet1/44\n\ninterface Ethernet1/45\n\ninterface Ethernet1/46\n\ninterface Ethernet1/47\n\ninterface Ethernet1/48\n\ninterface Ethernet1/49\n\ninterface Ethernet1/50\n\ninterface Ethernet1/51\n\ninterface Ethernet1/52\n\ninterface Ethernet1/53\n\ninterface Ethernet1/54\n\ninterface Ethernet1/55\n\ninterface Ethernet1/56\n\ninterface Ethernet1/57\n\ninterface Ethernet1/58\n\ninterface Ethernet1/59\n\ninterface Ethernet1/60\n\ninterface Ethernet1/61\n\ninterface Ethernet1/62\n\ninterface Ethernet1/63\n\ninterface Ethernet1/64\n\ninterface mgmt0\n  description DHCP Configuration for PnP\n  vrf member management\n  ip address 192.168.1.19/24\nline console\nline vty\nno system default switchport shutdown\n",
            "net_fan_info": [],
            "net_features_enabled": [
                "bfd"
            ],
            "net_filesystems": [
                "bootflash:"
            ],
            "net_gather_network_resources": [],
            "net_gather_subset": [
                "interfaces",
                "config",
                "hardware",
                "legacy",
                "default",
                "features"
            ],
            "net_hostname": "192.168.1.19",
            "net_image": "bootflash:///nxos.9.3.3.bin",
            "net_interfaces": {
                "Ethernet1/1": {
                    "bandwidth": "1000000",
                    "duplex": "full",
                    "macaddress": "0cc2.8a00.0101",
                    "mode": "access",
                    "mtu": "1500",
                    "speed": "1000 Mb/s",
                    "state": "up",
                    "type": "100/1000/10000 Ethernet"
                },
                "mgmt0": {
                    "bandwidth": "1000000",
                    "description": "DHCP Configuration for PnP",
                    "duplex": "full",
                    "ipv4": {
                        "address": "192.168.1.19",
                        "masklen": "24"
                    },
                    "macaddress": "0c05.2bc2.8a00",
                    "mtu": "1500",
                    "speed": "1000 Mb/s",
                    "state": "up",
                    "type": "GigabitEthernet"
                }
            },
            "net_interfaces_list": [
                "mgmt0",
                "Ethernet1/1",
            ],
            "net_license_hostid": "91EMAC025KL",
            "net_memfree_mb": 3965.3359375,
            "net_memtotal_mb": 7653.41015625,
            "net_model": "Nexus9000 C9500v Chassis (\"Supervisor Module\")",
            "net_module": [
                {
                    "model": "N9K-X9564v",
                    "ports": "64",
                    "status": "ok",
                    "type": "Nexus 9000v 64 port Ethernet Module"
                },
                {
                    "model": "N9K-vSUP",
                    "ports": "0",
                    "status": "active *",
                    "type": "Virtual Supervisor Module"
                }
            ],
            "net_neighbors": {},
            "net_platform": "N9K-C9500v",
            "net_python_version": "3.9.5",
            "net_serialnum": "9ESGSKDKPR0",
            "net_system": "nxos",
            "net_version": "9.3(3)",
            "net_vlan_list": [
                "1"
            ],
            "network_resources": {},
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• net__hostname: 192.168.1.19
• net__os: 9.3(3)
• net__platform: Nexus9000 C9500v Chassis
• net_api: cliconf
• net_config: !Command: show running-config
  !Running configuration last done at: Sat Jul 10 23:00:14 2021
  !Time: Sat Jul 10 23:00:57 2021

version 9.3(3) Bios:version
hostname 192.168.1.19
vdc 192.168.1.19 id 1
limit-resource vlan minimum 16 maximum 4094
limit-resource vrf minimum 2 maximum 4096
limit-resource port-channel minimum 0 maximum 511
limit-resource u4route-mem minimum 248 maximum 248
limit-resource u6route-mem minimum 96 maximum 96
limit-resource m4route-mem minimum 58 maximum 58
limit-resource m6route-mem minimum 8 maximum 8

nv overlay evpn
feature bfd
clock protocol none vdc 1

username admin password 5 $5$GYWPMp8g$uCosvTBewY0RcsJx/XB4e92DceRU8J4mvDI1JztQtG3 role network-admin
ip domain-lookup
radius-server timeout 9
radius-server deadtime 20
radius-server host 1.2.3.4 acct-port 2084 authentication accounting timeout 10
system default switchport
ip access-list ANSIBLE
10 permit tcp 192.0.2.1/24 any
bfd interval 50 min_rx 50 multiplier 4
snmp-server user admin network-admin auth md5 0x4f14136eab1027c832da1709141f5070 priv 0x4f14136eab1027c832da1709141f5070 localizedkey
rmon event 1 description FATAL(1) owner PMON@FATAL
rmon event 2 description CRITICAL(2) owner PMON@CRITICAL
rmon event 3 description ERROR(3) owner PMON@ERROR
rmon event 4 description WARNING(4) owner PMON@WARNING
rmon event 5 description INFORMATION(5) owner PMON@INFO
radius-server directed-request

vlan 1

vrf context management
ip domain-name lan
ip name-server 192.168.1.1
ip route 0.0.0.0/0 192.168.1.1

interface Ethernet1/1

interface mgmt0
description DHCP Configuration for PnP
vrf member management
ip address 192.168.1.19/24
line console
line vty
no system default switchport shutdown

• net_hostname: 192.168.1.19
• net_image: bootflash:///nxos.9.3.3.bin
• net_license_hostid: 91EMAC025KL
• net_memfree_mb: 3965.3359375
• net_memtotal_mb: 7653.41015625
• net_model: Nexus9000 C9500v Chassis (“Supervisor Module”)
• net_platform: N9K-C9500v
• net_python_version: 3.9.5
• net_serialnum: 9ESGSKDKPR0
• net_system: nxos
• net_version: 9.3(3)

• discovered_interpreter_python: /usr/local/bin/python

• Net_All_Ipv4_Addresses

  • 0: 192.168.1.19

• Net_All_Ipv6_Addresses

• Net_Fan_Info

• Net_Features_Enabled

  • 0: bfd

• Net_Filesystems

  • 0: bootflash:

• Net_Gather_Network_Resources

• Net_Gather_Subset

  • 0: interfaces
  • 1: config
  • 2: hardware
  • 3: legacy
  • 4: default
  • 5: features

• Net_Interfaces

  • Ethernet1/1

    • bandwidth: 1000000
    • duplex: full
    • macaddress: 0cc2.8a00.0101
    • mode: access
    • mtu: 1500
    • speed: 1000 Mb/s
    • state: up
    • type: 100/1000/10000 Ethernet

  • Mgmt0

    • bandwidth: 1000000
    • description: DHCP Configuration for PnP
    • duplex: full
    • macaddress: 0c05.2bc2.8a00
    • mtu: 1500
    • speed: 1000 Mb/s
    • state: up

    • type: GigabitEthernet

    • Ipv4

      • address: 192.168.1.19
      • masklen: 24

• Net_Interfaces_List

  • 0: mgmt0
  • 1: Ethernet1/1

• Net_Module

• List

  • model: N9K-X9564v
  • ports: 64
  • status: ok
  • type: Nexus 9000v 64 port Ethernet Module

• List

  • model: N9K-vSUP
  • ports: 0
  • status: active *
  • type: Virtual Supervisor Module

• Net_Neighbors

• Net_Vlan_List

  • 0: 1

• Network_Resources

nxos-feature

Manage features in NX-OS switches.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_feature_module.html

Base Command

nxos-feature

Input

Context Output

Command Example

!nxos-feature host="192.168.1.19" feature="lacp" state="enabled"

Context Example

{
    "CiscoNXOS": {
        "NxosFeature": {
            "changed": true,
            "commands": [
                "terminal dont-ask",
                "feature lacp"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: terminal dont-ask
  • 1: feature lacp

nxos-gir

Trigger a graceful removal or insertion (GIR) of the switch.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_gir_module.html

Base Command

nxos-gir

Input

Context Output

Command Example

!nxos-gir host="192.168.1.19" system_mode_maintenance="True"

Context Example

{
    "CiscoNXOS": {
        "NxosGir": {
            "changed": true,
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

nxos-gir-profile-management

Create a maintenance-mode or normal-mode profile for GIR.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_gir_profile_management_module.html

Base Command

nxos-gir-profile-management

Input

Context Output

Command Example

!nxos-gir-profile-management host="192.168.1.19" mode="maintenance" commands="{{ ['router eigrp 11', 'isolate'] }}"

Context Example

{
    "CiscoNXOS": {
        "NxosGirProfileManagement": {
            "changed": true,
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

nxos-hsrp

Manages HSRP configuration on NX-OS switches.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_hsrp_module.html

Base Command

nxos-hsrp

Input

Context Output

nxos-igmp

Manages IGMP global configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_igmp_module.html

Base Command

nxos-igmp

Input

Context Output

Command Example

!nxos-igmp host="192.168.1.19" state="default"

Context Example

{
    "CiscoNXOS": {
        "NxosIgmp": {
            "changed": false,
            "host": "192.168.1.19",
            "status": "SUCCESS",
            "updates": []
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Updates

nxos-igmp-interface

Manages IGMP interface configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_igmp_interface_module.html

Base Command

nxos-igmp-interface

Input

Context Output

nxos-igmp-snooping

Manages IGMP snooping global configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_igmp_snooping_module.html

Base Command

nxos-igmp-snooping

Input

Context Output

Command Example

!nxos-igmp-snooping host="192.168.1.19" state="default"

Context Example

{
    "CiscoNXOS": {
        "NxosIgmpSnooping": {
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Commands

nxos-install-os

Set boot options like boot, kickstart image and issu.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_install_os_module.html

Base Command

nxos-install-os

Input

Context Output

nxos-interface-ospf

Manages configuration of an OSPF interface instance.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_interface_ospf_module.html

Base Command

nxos-interface-ospf

Input

Context Output

nxos-interfaces

Manages interface attributes of NX-OS Interfaces
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_interfaces_module.html

Base Command

nxos-interfaces

Input

Context Output

Command Example

!nxos-interfaces host="192.168.1.19" config="{{ [{'name': 'Ethernet1/1', 'description': 'Configured by Ansible', 'enabled': True}, {'name': 'Ethernet1/2', 'description': 'Configured by Ansible Network', 'enabled': False}] }}" state="merged"

Context Example

{
    "CiscoNXOS": {
        "NxosInterfaces": {
            "before": [
                {
                    "description": "Configured by Ansible",
                    "name": "Ethernet1/1"
                },
                {
                    "description": "Configured by Ansible Network",
                    "enabled": false,
                    "name": "Ethernet1/2"
                },
                {
                    "name": "Ethernet1/3"
                },
                {
                    "name": "Ethernet1/4"
                },
                {
                    "name": "mgmt0"
                }
            ],
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Before

• Ethernet1/1

  • description: Configured by Ansible
  • name: Ethernet1/1

• Ethernet1/2

  • description: Configured by Ansible Network
  • enabled: False
  • name: Ethernet1/2

• Ethernet1/3

  • name: Ethernet1/3

• Ethernet1/4

  • name: Ethernet1/4

• Mgmt0

  • name: mgmt0

• Commands

nxos-l2-interfaces

Manages Layer-2 Interfaces attributes of NX-OS Interfaces
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_l2_interfaces_module.html

Base Command

nxos-l2-interfaces

Input

Context Output

Command Example

!nxos-l2-interfaces host="192.168.1.19" config="{{ [{'name': 'Ethernet1/1', 'trunk': {'native_vlan': 10, 'allowed_vlans': '2,4,15'}}, {'name': 'Ethernet1/2', 'access': {'vlan': 30}}] }}" state="merged"

Context Example

{
    "CiscoNXOS": {
        "NxosL2Interfaces": {
            "before": [
                {
                    "name": "Ethernet1/1",
                    "trunk": {
                        "allowed_vlans": "2,4,15",
                        "native_vlan": 10
                    }
                },
                {
                    "access": {
                        "vlan": 30
                    },
                    "name": "Ethernet1/2"
                },
                {
                    "name": "Ethernet1/3"
                },
                {
                    "name": "Ethernet1/4"
                },
                {
                    "name": "Ethernet1/5"
                },
                {
                    "name": "mgmt0"
                }
            ],
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Before

• Ethernet1/1

  • name: Ethernet1/1

  • Trunk

    • allowed_vlans: 2,4,15
    • native_vlan: 10

• Ethernet1/2

  • name: Ethernet1/2

  • Access

    • vlan: 30

• Ethernet1/3

  • name: Ethernet1/3

• Ethernet1/4

  • name: Ethernet1/4

• Ethernet1/5

  • name: Ethernet1/5

• Mgmt0

  • name: mgmt0

• Commands

nxos-l3-interfaces

Manages Layer-3 Interfaces attributes of NX-OS Interfaces
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_l3_interfaces_module.html

Base Command

nxos-l3-interfaces

Input

Context Output

nxos-lacp

Manage Global Link Aggregation Control Protocol (LACP) on Cisco NX-OS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_lacp_module.html

Base Command

nxos-lacp

Input

Context Output

Command Example

!nxos-lacp host="192.168.1.19" config="{'system': {'priority': 10, 'mac': {'address': '00c1.4c00.bd15'}}}" state="merged"

Context Example

{
    "CiscoNXOS": {
        "NxosLacp": {
            "after": {
                "system": {
                    "mac": {
                        "address": "00c1.4c00.bd15",
                        "role": "primary"
                    },
                    "priority": 10
                }
            },
            "before": {},
            "changed": true,
            "commands": [
                "lacp system-priority 10",
                "lacp system-mac 00c1.4c00.bd15"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• After

  • System

    • priority: 10

    • Mac

      • address: 00c1.4c00.bd15
      • role: primary

• Before

• Commands

  • 0: lacp system-priority 10
  • 1: lacp system-mac 00c1.4c00.bd15

nxos-lacp-interfaces

Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on Cisco NX-OS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_lacp_interfaces_module.html

Base Command

nxos-lacp-interfaces

Input

Context Output

nxos-lag-interfaces

Manages link aggregation groups of NX-OS Interfaces
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_lag_interfaces_module.html

Base Command

nxos-lag-interfaces

Input

Context Output

Command Example

!nxos-lag-interfaces host="192.168.1.19" config="{{ [{'name': 'port-channel99', 'members': [{'member': 'Ethernet1/4'}]}] }}" state="merged"

Context Example

{
    "CiscoNXOS": {
        "NxosLagInterfaces": {
            "after": [
                {
                    "members": [
                        {
                            "member": "Ethernet1/4"
                        }
                    ],
                    "name": "port-channel99"
                }
            ],
            "before": [],
            "changed": true,
            "commands": [
                "interface Ethernet1/4",
                "channel-group 99"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• After

• Port-Channel99

  • name: port-channel99

  • Members

  • List

    • member: Ethernet1/4

• Before

• Commands

  • 0: interface Ethernet1/4
  • 1: channel-group 99

nxos-lldp

Manage LLDP configuration on Cisco NXOS network devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_lldp_module.html

Base Command

nxos-lldp

Input

Context Output

Command Example

!nxos-lldp host="192.168.1.19" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosLldp": {
            "changed": true,
            "commands": [
                "terminal dont-ask",
                "feature lldp"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: terminal dont-ask
  • 1: feature lldp

nxos-lldp-global

Configure and manage Link Layer Discovery Protocol(LLDP) attributes on NX-OS platforms.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_lldp_global_module.html

Base Command

nxos-lldp-global

Input

Context Output

Command Example

!nxos-lldp-global host="192.168.1.19" config="{'timer': 35, 'holdtime': 100}" state="merged"

Context Example

{
    "CiscoNXOS": {
        "NxosLldpGlobal": {
            "after": {
                "holdtime": 100,
                "timer": 35
            },
            "before": {},
            "changed": true,
            "commands": [
                "lldp holdtime 100",
                "lldp timer 35"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• After

  • holdtime: 100
  • timer: 35

• Before

• Commands

  • 0: lldp holdtime 100
  • 1: lldp timer 35

nxos-logging

Manage logging on network devices
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_logging_module.html

Base Command

nxos-logging

Input

Context Output

nxos-ntp

Manages core NTP configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_ntp_module.html

Base Command

nxos-ntp

Input

Context Output

Command Example

!nxos-ntp host="192.168.1.19" server="1.2.3.4" key_id="32" prefer="enabled"

Context Example

{
    "CiscoNXOS": {
        "NxosNtp": {
            "changed": true,
            "end_state": {
                "address": "1.2.3.4",
                "key_id": "32",
                "peer_type": "server",
                "prefer": "enabled",
                "vrf_name": "default"
            },
            "existing": {},
            "host": "192.168.1.19",
            "peer_server_list": [],
            "proposed": {
                "address": "1.2.3.4",
                "key_id": "32",
                "peer_type": "server",
                "prefer": "enabled"
            },
            "status": "CHANGED",
            "updates": [
                "ntp server 1.2.3.4 prefer key 32"
            ]
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• End_State

  • address: 1.2.3.4
  • key_id: 32
  • peer_type: server
  • prefer: enabled
  • vrf_name: default

• Existing

• Peer_Server_List

• Proposed

  • address: 1.2.3.4
  • key_id: 32
  • peer_type: server
  • prefer: enabled

• Updates

  • 0: ntp server 1.2.3.4 prefer key 32

nxos-ntp-auth

Manages NTP authentication.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_ntp_auth_module.html

Base Command

nxos-ntp-auth

Input

Context Output

Command Example

!nxos-ntp-auth host="192.168.1.19" key_id="32" md5string="hello" auth_type="text"

Context Example

{
    "CiscoNXOS": {
        "NxosNtpAuth": {
            "changed": true,
            "end_state": {
                "auth_type": "encrypt",
                "authentication": "off",
                "key_id": "32",
                "md5string": "kapqg",
                "trusted_key": "false"
            },
            "existing": {
                "authentication": "off",
                "trusted_key": "false"
            },
            "host": "192.168.1.19",
            "proposed": {
                "auth_type": "text",
                "key_id": "32",
                "md5string": "hello",
                "trusted_key": "false"
            },
            "status": "CHANGED",
            "updates": [
                "ntp authentication-key 32 md5 hello 0"
            ]
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• End_State

  • auth_type: encrypt
  • authentication: off
  • key_id: 32
  • md5string: kapqg
  • trusted_key: false

• Existing

  • authentication: off
  • trusted_key: false

• Proposed

  • auth_type: text
  • key_id: 32
  • md5string: hello
  • trusted_key: false

• Updates

  • 0: ntp authentication-key 32 md5 hello 0

nxos-ntp-options

Manages NTP options.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_ntp_options_module.html

Base Command

nxos-ntp-options

Input

Context Output

Command Example

!nxos-ntp-options host="192.168.1.19" master="True" stratum="12" logging="False"

Context Example

{
    "CiscoNXOS": {
        "NxosNtpOptions": {
            "changed": true,
            "commands": [
                "ntp master",
                "ntp master 12"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED",
            "updates": [
                "ntp master",
                "ntp master 12"
            ]
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: ntp master
  • 1: ntp master 12

• Updates

  • 0: ntp master
  • 1: ntp master 12

nxos-nxapi

Manage NXAPI configuration on an NXOS device.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_nxapi_module.html

Base Command

nxos-nxapi

Input

Context Output

Command Example

!nxos-nxapi host="192.168.1.19" state="present" sandbox=No

Context Example

{
    "CiscoNXOS": {
        "NxosNxapi": {
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Commands

nxos-ospf

Manages configuration of an ospf instance.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_ospf_module.html

Base Command

nxos-ospf

Input

Context Output

Command Example

!nxos-ospf host="192.168.1.19" ospf="1" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosOspf": {
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Commands

nxos-ospf-vrf

Manages a VRF for an OSPF router.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_ospf_vrf_module.html

Base Command

nxos-ospf-vrf

Input

Context Output

Command Example

!nxos-ospf-vrf host="192.168.1.19" ospf="1" timer_throttle_spf_start="50" timer_throttle_spf_hold="1000" timer_throttle_spf_max="2000" timer_throttle_lsa_start="60" timer_throttle_lsa_hold="1100" timer_throttle_lsa_max="3000" vrf="test" bfd="enable" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosOspfVrf": {
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Commands

nxos-overlay-global

Configures anycast gateway MAC of the switch.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_overlay_global_module.html

Base Command

nxos-overlay-global

Input

Context Output

Command Example

!nxos-overlay-global host="192.168.1.19" anycast_gateway_mac="b.b.b"

Context Example

{
    "CiscoNXOS": {
        "NxosOverlayGlobal": {
            "changed": true,
            "commands": [
                "fabric forwarding anycast-gateway-mac 000B.000B.000B"
            ],
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

• Commands

  • 0: fabric forwarding anycast-gateway-mac 000B.000B.000B

nxos-pim

Manages configuration of a PIM instance.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_pim_module.html

Base Command

nxos-pim

Input

Context Output

Command Example

!nxos-pim host="192.168.1.19" bfd="enable" ssm_range="224.0.0.0/8"

Context Example

{
    "CiscoNXOS": {
        "NxosPim": {
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Commands

nxos-pim-interface

Manages PIM interface configuration.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_pim_interface_module.html

Base Command

nxos-pim-interface

Input

Context Output

nxos-pim-rp-address

Manages configuration of an PIM static RP address instance.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_pim_rp_address_module.html

Base Command

nxos-pim-rp-address

Input

Context Output

Command Example

!nxos-pim-rp-address host="192.168.1.19" rp_address="10.1.1.20" state="present"

Context Example

{
    "CiscoNXOS": {
        "NxosPimRpAddress": {
            "changed": false,
            "commands": [],
            "host": "192.168.1.19",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False

• Commands

nxos-ping

Tests reachability using ping from Nexus switch.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_ping_module.html

Base Command

nxos-ping

Input

Context Output

Command Example

!nxos-ping host="192.168.1.19" dest="8.8.8.8" vrf="management"

Context Example

{
    "CiscoNXOS": {
        "NxosPing": {
            "changed": false,
            "commands": [
                "ping 8.8.8.8 count 5 vrf management"
            ],
            "host": "192.168.1.19",
            "packet_loss": "0.00%",
            "packets_rx": 5,
            "packets_tx": 5,
            "rtt": {
                "avg": 11.171,
                "max": 11.845,
                "min": 10.811
            },
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

192.168.1.19 - SUCCESS

• changed: False
• packet_loss: 0.00%
• packets_rx: 5

• packets_tx: 5

• Commands

  • 0: ping 8.8.8.8 count 5 vrf management

• Rtt

  • avg: 11.171
  • max: 11.845
  • min: 10.811

nxos-reboot

Reboot a network device.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_reboot_module.html

Base Command

nxos-reboot

Input

Context Output

Command Example

!nxos-reboot host="192.168.1.19" confirm="True"

Context Example

{
    "CiscoNXOS": {
        "NxosReboot": {
            "changed": true,
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True

nxos-rollback

Set a checkpoint or rollback to a checkpoint.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_rollback_module.html

Base Command

nxos-rollback

Input

Context Output

Command Example

!nxos-rollback host="192.168.1.19" checkpoint_file="backup.cfg"

Context Example

{
    "CiscoNXOS": {
        "NxosRollback": {
            "changed": true,
            "filename": "backup.cfg",
            "host": "192.168.1.19",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

192.168.1.19 - CHANGED

• changed: True
• filename: backup.cfg
• status: checkpoint file created

nxos-rpm

Install patch or feature rpms on Cisco NX-OS devices.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/nxos_rpm_module.html

Base Command

nxos-rpm

Input

Context Output