nxos

78Modules234Plugins1Dependency

Overview

Description

Ansible Network Collection for Cisco NXOS devices.

Readme

Cisco NX-OS Collection

Codecov CI

The Ansible Cisco NX-OS collection includes a variety of Ansible content to help automate the management of Cisco NX-OS network appliances.

The Cisco NX-OS connection plugins combined with Cisco NX-OS resource modules aligns the Cisco NX-OS experience with the other core networking platforms supported by Ansible.

This collection has been tested against Cisco N9K-C9300v chassis running NX-OS 9.3.6. The modules with full support for Cisco MDS are tested against NX-OS 8.4(1) on MDS Switches.

Support

As a Red Hat Ansible Certified Content, this collection is entitled to support through Ansible Automation Platform (AAP).

If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there is community support available at no charge.

You can join us on #network:ansible.com room or the Ansible Forum Network Working Group.

For more information you can check the communication section below.

Communication

For more information about communication, see the Ansible communication guide.

Ansible version compatibility

This collection has been tested against the following Ansible versions: >=2.16.0.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Supported connections

The Cisco NX-OS collection supports network_cli and httpapi connections. A detailed platform guide can be found here.

Included content

Cliconf plugins

NameDescription
cisco.nxos.nxosUse NX-OS cliconf to run commands on Cisco NX-OS platform

Httpapi plugins

NameDescription
cisco.nxos.nxosUse NX-API to run commands on Cisco NX-OS platform

Netconf plugins

NameDescription
cisco.nxos.nxosUse nxos netconf plugin to run netconf commands on Cisco NX-OS platform.

Modules

NameDescription
cisco.nxos.nxos_aaa_serverManages AAA server global configuration.
cisco.nxos.nxos_aaa_server_hostManages AAA server host-specific configuration.
cisco.nxos.nxos_acl_interfacesACL interfaces resource module
cisco.nxos.nxos_aclsACLs resource module
cisco.nxos.nxos_bannerManage multiline banners on Cisco NXOS devices
cisco.nxos.nxos_bfd_globalBidirectional Forwarding Detection (BFD) global-level configuration
cisco.nxos.nxos_bfd_interfacesBFD interfaces resource module
cisco.nxos.nxos_bgp_address_familyBGP Address Family resource module.
cisco.nxos.nxos_bgp_globalBGP Global resource module.
cisco.nxos.nxos_bgp_neighbor_address_familyBGP Neighbor Address Family resource module.
cisco.nxos.nxos_bgp_templatesBGP Templates resource module.
cisco.nxos.nxos_commandRun arbitrary command on Cisco NXOS devices
cisco.nxos.nxos_configManage Cisco NXOS configuration sections
cisco.nxos.nxos_devicealiasConfiguration of device alias for Cisco NXOS MDS Switches.
cisco.nxos.nxos_evpn_globalHandles the EVPN control plane for VXLAN.
cisco.nxos.nxos_evpn_vniManages Cisco EVPN VXLAN Network Identifier (VNI).
cisco.nxos.nxos_factsGets facts about NX-OS switches
cisco.nxos.nxos_fc_interfacesFc Interfaces resource module
cisco.nxos.nxos_featureManage features in NX-OS switches.
cisco.nxos.nxos_file_copyCopy a file to a remote NXOS device.
cisco.nxos.nxos_girTrigger a graceful removal or insertion (GIR) of the switch.
cisco.nxos.nxos_gir_profile_managementCreate a maintenance-mode or normal-mode profile for GIR.
cisco.nxos.nxos_hostnameHostname resource module.
cisco.nxos.nxos_hsrp(deprecated, removed after 2028-06-01) Manages HSRP configuration on NX-OS switches.
cisco.nxos.nxos_hsrp_interfacesHSRP interfaces resource module
cisco.nxos.nxos_igmpManages IGMP global configuration.
cisco.nxos.nxos_igmp_interfaceManages IGMP interface configuration.
cisco.nxos.nxos_igmp_snoopingManages IGMP snooping global configuration.
cisco.nxos.nxos_install_osSet boot options like boot, kickstart image and issu.
cisco.nxos.nxos_interfacesInterfaces resource module
cisco.nxos.nxos_l2_interfacesL2 interfaces resource module
cisco.nxos.nxos_l3_interfacesL3 interfaces resource module
cisco.nxos.nxos_lacpLACP resource module
cisco.nxos.nxos_lacp_interfacesLACP interfaces resource module
cisco.nxos.nxos_lag_interfacesLAG interfaces resource module
cisco.nxos.nxos_lldp_globalLLDP resource module
cisco.nxos.nxos_lldp_interfacesLLDP interfaces resource module
cisco.nxos.nxos_logging_globalLogging resource module.
cisco.nxos.nxos_ntp_globalNTP Global resource module.
cisco.nxos.nxos_nxapiManage NXAPI configuration on an NXOS device.
cisco.nxos.nxos_ospf_interfacesOSPF Interfaces Resource Module.
cisco.nxos.nxos_ospfv2OSPFv2 resource module
cisco.nxos.nxos_ospfv3OSPFv3 resource module
cisco.nxos.nxos_overlay_globalConfigures anycast gateway MAC of the switch.
cisco.nxos.nxos_pimManages configuration of a PIM instance.
cisco.nxos.nxos_pim_interfaceManages PIM interface configuration.
cisco.nxos.nxos_pim_rp_addressManages configuration of an PIM static RP address instance.
cisco.nxos.nxos_pingTests reachability using ping from Nexus switch.
cisco.nxos.nxos_prefix_listsPrefix-Lists resource module.
cisco.nxos.nxos_rebootReboot a network device.
cisco.nxos.nxos_rollbackSet a checkpoint or rollback to a checkpoint.
cisco.nxos.nxos_route_mapsRoute Maps resource module.
cisco.nxos.nxos_rpmInstall patch or feature rpms on Cisco NX-OS devices.
cisco.nxos.nxos_snapshotManage snapshots of the running states of selected features.
cisco.nxos.nxos_snmp_serverSNMP Server resource module.
cisco.nxos.nxos_static_routesStatic routes resource module
cisco.nxos.nxos_systemManage the system attributes on Cisco NXOS devices
cisco.nxos.nxos_telemetryTELEMETRY resource module
cisco.nxos.nxos_udldManages UDLD global configuration params.
cisco.nxos.nxos_udld_interfaceManages UDLD interface configuration params.
cisco.nxos.nxos_userManage the collection of local users on Nexus devices
cisco.nxos.nxos_vlansVLANs resource module
cisco.nxos.nxos_vpcManages global VPC configuration
cisco.nxos.nxos_vpc_interfaceManages interface VPC configuration
cisco.nxos.nxos_vrf(deprecated, removed after 2026-07-25) Manages global VRF configuration.
cisco.nxos.nxos_vrf_address_familyResource module to configure VRF address family definitions.
cisco.nxos.nxos_vrf_afManages VRF AF.
cisco.nxos.nxos_vrf_globalResource module to configure VRF definitions.
cisco.nxos.nxos_vrf_interface(deprecated, removed after 2028-06-01) Manages interface specific VRF configuration.
cisco.nxos.nxos_vrf_interfacesResource module to configure VRF interfaces.
cisco.nxos.nxos_vrrpManages VRRP configuration on NX-OS switches.
cisco.nxos.nxos_vsanConfiguration of vsan for Cisco NXOS MDS Switches.
cisco.nxos.nxos_vtp_domainManages VTP domain configuration.
cisco.nxos.nxos_vtp_passwordManages VTP password configuration.
cisco.nxos.nxos_vtp_versionManages VTP version configuration.
cisco.nxos.nxos_vxlan_vtepManages VXLAN Network Virtualization Endpoint (NVE).
cisco.nxos.nxos_vxlan_vtep_vniCreates a Virtual Network Identifier member (VNI)
cisco.nxos.nxos_zone_zonesetConfiguration of zone/zoneset for Cisco NXOS MDS Switches.

Click the Content button to see the list of content included in this collection.

Installing this collection

You can install the Cisco NX-OS collection with the Ansible Galaxy CLI:

ansible-galaxy collection install cisco.nxos

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: cisco.nxos

Using this collection

This collection includes network resource modules.

Using modules from the Cisco NX-OS collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as cisco.nxos.nxos_l2_interfaces. The following example task replaces configuration changes in the existing configuration on a Cisco NX-OS network device, using the FQCN:

---
  - name: Replace device configuration of specified L2 interfaces with provided configuration.
    cisco.nxos.nxos_l2_interfaces:
      config:
        - name: Ethernet1/1
          trunk:
            native_vlan: 20
            trunk_vlans: 5-10, 15
      state: replaced

NOTE: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.

See Also:

Contributing to this collection

Ongoing development efforts and contributions to this collection are solely focused on enhancements to current resource modules, additional resource modules and enhancements to connection plugins.

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Cisco NX-OS collection repository. See Contributing to Ansible-maintained collections for complete details.

You can also join us on:

  • IRC - the #ansible-network libera.chat channel
  • Slack - https://ansiblenetwork.slack.com

See the Ansible Community Guide for details on contributing to Ansible.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

Release notes

Release notes are available here.

Roadmap

More information

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.

Certification

Product
Red Hat Ansible Automation Platform 2.5
DocumentationDependencies

This collection requires the following collections for use:

NameSummary

This collection is used by the following collections:

NameSummaryVersionType
View in Automation Hub
Red Hat logoLinkedInYouTubeFacebookTwitter

Platforms

Products & services

Try, buy, sell

Help

About Red Hat Ecosystem Catalog

The Red Hat Ecosystem Catalog is the official source for discovering and learning more about the Red Hat Ecosystem of both Red Hat and certified third-party products and services.

We’re the world’s leading provider of enterprise open source solutions—including Linux, cloud, container, and Kubernetes. We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2025 Red Hat