You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Cisco.Nxos

Collection version 4.4.0

Description

Ansible Network Collection for Cisco NXOS devices.

Author:

• Ansible Network Community (ansible-network)

Supported ansible-core versions:

• 2.9.10 or newer

• Issue Tracker
• Repository (Sources)

Plugin Index

These are the plugins in the cisco.nxos collection:

Modules

• nxos_aaa_server module – Manages AAA server global configuration.

• nxos_aaa_server_host module – Manages AAA server host-specific configuration.

• nxos_acl_interfaces module – ACL interfaces resource module

• nxos_acls module – ACLs resource module

• nxos_banner module – Manage multiline banners on Cisco NXOS devices

• nxos_bfd_global module – Bidirectional Forwarding Detection (BFD) global-level configuration

• nxos_bfd_interfaces module – BFD interfaces resource module

• nxos_bgp module – (deprecated, removed after 2023-01-27) Manages BGP configuration.

• nxos_bgp_address_family module – BGP Address Family resource module.

• nxos_bgp_af module – (deprecated, removed after 2023-02-24) Manages BGP Address-family configuration.

• nxos_bgp_global module – BGP Global resource module.

• nxos_bgp_neighbor module – (deprecated, removed after 2023-01-27) Manages BGP neighbors configurations.

• nxos_bgp_neighbor_address_family module – BGP Neighbor Address Family resource module.

• nxos_bgp_neighbor_af module – (deprecated, removed after 2023-02-24) Manages BGP address-family’s neighbors configuration.

• nxos_command module – Run arbitrary command on Cisco NXOS devices

• nxos_config module – Manage Cisco NXOS configuration sections

• nxos_evpn_global module – Handles the EVPN control plane for VXLAN.

• nxos_evpn_vni module – Manages Cisco EVPN VXLAN Network Identifier (VNI).

• nxos_facts module – Gets facts about NX-OS switches

• nxos_feature module – Manage features in NX-OS switches.

• nxos_file_copy module – Copy a file to a remote NXOS device.

• nxos_gir module – Trigger a graceful removal or insertion (GIR) of the switch.

• nxos_gir_profile_management module – Create a maintenance-mode or normal-mode profile for GIR.

• nxos_hostname module – Hostname resource module.

• nxos_hsrp module – Manages HSRP configuration on NX-OS switches.

• nxos_hsrp_interfaces module – HSRP interfaces resource module

• nxos_igmp module – Manages IGMP global configuration.

• nxos_igmp_interface module – Manages IGMP interface configuration.

• nxos_igmp_snooping module – Manages IGMP snooping global configuration.

• nxos_install_os module – Set boot options like boot, kickstart image and issu.

• nxos_interfaces module – Interfaces resource module

• nxos_l2_interfaces module – L2 interfaces resource module

• nxos_l3_interfaces module – L3 interfaces resource module

• nxos_lacp module – LACP resource module

• nxos_lacp_interfaces module – LACP interfaces resource module

• nxos_lag_interfaces module – LAG interfaces resource module

• nxos_lldp_global module – LLDP resource module

• nxos_lldp_interfaces module – LLDP interfaces resource module

• nxos_logging module – Manage logging on network devices

• nxos_logging_global module – Logging resource module.

• nxos_ntp module – Manages core NTP configuration.

• nxos_ntp_auth module – Manages NTP authentication.

• nxos_ntp_global module – NTP Global resource module.

• nxos_ntp_options module – Manages NTP options.

• nxos_nxapi module – Manage NXAPI configuration on an NXOS device.

• nxos_ospf_interfaces module – OSPF Interfaces Resource Module.

• nxos_ospfv2 module – OSPFv2 resource module

• nxos_ospfv3 module – OSPFv3 resource module

• nxos_overlay_global module – Configures anycast gateway MAC of the switch.

• nxos_pim module – Manages configuration of a PIM instance.

• nxos_pim_interface module – Manages PIM interface configuration.

• nxos_pim_rp_address module – Manages configuration of an PIM static RP address instance.

• nxos_ping module – Tests reachability using ping from Nexus switch.

• nxos_prefix_lists module – Prefix-Lists resource module.

• nxos_reboot module – Reboot a network device.

• nxos_rollback module – Set a checkpoint or rollback to a checkpoint.

• nxos_route_maps module – Route Maps resource module.

• nxos_rpm module – Install patch or feature rpms on Cisco NX-OS devices.

• nxos_snapshot module – Manage snapshots of the running states of selected features.

• nxos_snmp_community module – (deprecated, removed after 2024-01-01) Manages SNMP community configs.

• nxos_snmp_contact module – (deprecated, removed after 2024-01-01) Manages SNMP contact info.

• nxos_snmp_host module – (deprecated, removed after 2024-01-01) Manages SNMP host configuration.

• nxos_snmp_location module – (deprecated, removed after 2024-01-01) Manages SNMP location information.

• nxos_snmp_server module – SNMP Server resource module.

• nxos_snmp_traps module – (deprecated, removed after 2024-01-01) Manages SNMP traps.

• nxos_snmp_user module – (deprecated, removed after 2024-01-01) Manages SNMP users for monitoring.

• nxos_static_routes module – Static routes resource module

• nxos_system module – Manage the system attributes on Cisco NXOS devices

• nxos_telemetry module – TELEMETRY resource module

• nxos_udld module – Manages UDLD global configuration params.

• nxos_udld_interface module – Manages UDLD interface configuration params.

• nxos_user module – Manage the collection of local users on Nexus devices

• nxos_vlans module – VLANs resource module

• nxos_vpc module – Manages global VPC configuration

• nxos_vpc_interface module – Manages interface VPC configuration

• nxos_vrf module – Manages global VRF configuration.

• nxos_vrf_af module – Manages VRF AF.

• nxos_vrf_interface module – Manages interface specific VRF configuration.

• nxos_vrrp module – Manages VRRP configuration on NX-OS switches.

• nxos_vtp_domain module – Manages VTP domain configuration.

• nxos_vtp_password module – Manages VTP password configuration.

• nxos_vtp_version module – Manages VTP version configuration.

• nxos_vxlan_vtep module – Manages VXLAN Network Virtualization Endpoint (NVE).

• nxos_vxlan_vtep_vni module – Creates a Virtual Network Identifier member (VNI)

• storage.nxos_devicealias module – Configuration of device alias for Cisco NXOS MDS Switches.

• storage.nxos_vsan module – Configuration of vsan for Cisco NXOS MDS Switches.

• storage.nxos_zone_zoneset module – Configuration of zone/zoneset for Cisco NXOS MDS Switches.

Cliconf Plugins

• nxos cliconf – Use NX-OS cliconf to run commands on Cisco NX-OS platform

Httpapi Plugins

• nxos httpapi – Use NX-API to run commands on Cisco NX-OS platform

Netconf Plugins

• nxos netconf – Use nxos netconf plugin to run netconf commands on Cisco NX-OS platform.

See also

List of collections with docs hosted here.