Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
1864 lines (1155 sloc) 69.7 KB

Cisco NX-OS Ansible Module Docs

Network Automation with Cisco and Ansible


Requirements

  • Check

Modules


nxos_igmp_snooping

Manages IGMP snooping global configuration

  • Synopsis
  • Options
  • Examples

Synopsis

Manages IGMP snooping global configuration

Options

Parameter required default choices comments
link_local_grp_supp no
  • true
  • false
Global link-local groups suppression
username no
    Username used to login to the switch
    report_supp no
      Global IGMPv1/IGMPv2 Report Suppression
      protocol no http
      • http
      • https
      Dictates connection protocol to use for NX-API
      snooping no
      • true
      • false
      enables/disables IGMP snooping on the switch
      group_timeout no
        Group membership timeout value for all VLANs on the device
        v3_report_supp no
        • true
        • false
        Global IGMPv3 Report Suppression and Proxy Reporting
        optimize_mcast_flood no
        • true
        • false
        Optimizes OMF on all VLANs on the device.
        state yes present
        • present
        • default
        Manages desired state of the resource
        host yes
          IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
          password no
            Password used to login to the switch

            Examples

            # ensure igmp snooping params supported in this module are in there default state
            - nxos_igmp_snooping: state=default host={{ inventory_hostname }}
            
            # ensure following igmp snooping params are in the desired state
            - nxos_igmp_snooping:
               group_timeout: never
               snooping: true
               link_local_grp_supp: false
               optimize_mcast_flood: false
               report_supp: true
               v3_report_supp: true
               host: "{{ inventory_hostname }}"
               state: present
            
            
            

            Notes

            • When state=default, params will be reset to a default state

            • group_timeout also accepts "never" as an input

            • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

            • Using the username and password params will override the .netauth file


            nxos_get_interface

            Gets details stats on a particular interface

            • Synopsis
            • Options
            • Examples

            Synopsis

            Gets details stats on a particular interface

            Options

            Parameter required default choices comments
            interface yes False
              Full name of interface, i.e. Ethernet1/1
              username no
                Username used to login to the switch
                host yes
                  IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                  password no
                    Password used to login to the switch
                    protocol no http
                    • http
                    • https
                    Dictates connection protocol to use for NX-API

                    Examples

                    # retrieve details info and stats on an interface (from 'show interface')
                    - nxos_get_interface: interface=Ethernet1/1 host={{ inventory_hostname }}
                    
                    
                    

                    Notes

                    • Equivalent to using 'show interface $INTERFACEX/Y'

                    • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                    • Using the username and password params will override the .netauth file


                    nxos_switchport

                    Manages Layer 2 switchport interfaces

                    • Synopsis
                    • Options
                    • Examples

                    Synopsis

                    Manages Layer 2 interfaces

                    Options

                    Parameter required default choices comments
                    native_vlan no 1
                      if mode=trunk, used as the trunk native vlan id
                      access_vlan no 1
                        if mode=access, used as the access vlan id
                        protocol no http
                        • http
                        • https
                        Dictates connection protocol to use for NX-API
                        state yes
                        • present
                        • absent
                        Manage the state of the resource
                        host yes
                          IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                          username no
                            Username used to login to the switch
                            trunk_vlans no 1-4094
                              if mode=trunk, used as the vlan range to carry over trunk
                              mode yes
                              • access
                              • trunk
                              Mode for the Layer 2 port
                              interface yes
                                Full name of the interface, i.e. Ethernet1/1
                                password no
                                  Password used to login to the switch

                                  Examples

                                  # Config a switchport to be a trunk interface with native vlan 10 and carriers vlan 2-100
                                  - nxos_switchport: interface=Ethernet1/1 mode=trunk native_vlan=10 trunk_vlans=2-100 host={{ inventory_hostname }}
                                  
                                  # Config a switchport to an access port on vlan 20
                                  - nxos_switchport: interface=Ethernet1/2 mode=access access_vlan=20 host={{ inventory_hostname }}
                                  
                                  # Remove existing access port vlan configuration on a switchport (mode is required)
                                  - nxos_switchport: interface=Ethernet1/2 host={{ inventory_hostname }} mode=access state=absent
                                  
                                  # Remove existing trunk port vlan configuration on a switchport (mode is required)
                                  - nxos_switchport: interface=Ethernet1/1 host={{ inventory_hostname }} mode=trunk state=absent
                                  
                                  

                                  Notes

                                  • Interface must be a Layer2 port already. If not, convert to L2 with nxos_interface module

                                  • When state=absent, if the switchport does not have a default config, it is set back to a default config from a vlan configuration perspective. This means, if state=absent, the resulting interface config will be an access port with vlan 1 configured as an access vlan even if the existing config is a trunk port.

                                  • Access and Native VLANs are required to exist on the switch before configuring them with this module

                                  • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                  • Using the username and password params will override the .netauth file


                                  nxos_vrf_interface

                                  Manages interface specific VRF configuration

                                  • Synopsis
                                  • Options
                                  • Examples

                                  Synopsis

                                  Manages interface specific VRF configuration

                                  Options

                                  Parameter required default choices comments
                                  username no
                                    Username used to login to the switch
                                    protocol no http
                                    • http
                                    • https
                                    Dictates connection protocol to use for NX-API
                                    host yes
                                      IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                      state yes present
                                      • present
                                      • absent
                                      Manages desired state of the resource
                                      vrf yes
                                        Name of VRF to be managed
                                        interface yes
                                          Full name of interface to be managed, i.e. Ethernet1/1
                                          password no
                                            Password used to login to the switch

                                            Examples

                                            # ensure vrf yankees exists on Eth1/1
                                            - nxos_vrf_interface: vrf=yankees interface=Ethernet1/1 host={{ inventory_hostname }} state=present
                                            
                                            # ensure yankees VRF does not exist on Eth1/1
                                            - nxos_vrf_interface: vrf=yankees interface=Ethernet1/1 host={{ inventory_hostname }} state=absent
                                            
                                            

                                            Notes

                                            • VRF needs to be added globally with nxos_vrf before adding a VRF to an interface

                                            • Remove a VRF from an interface will still remove all L3 attributes just as it does from CLI

                                            • VRF is not read from an interface until IP address is configured on that interface

                                            • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                            • Using the username and password params will override the .netauth file


                                            nxos_dir

                                            Manage dirs and files in the NX-OS filesystem

                                            • Synopsis
                                            • Options
                                            • Examples

                                            Synopsis

                                            Offers ability to create and delete directories and files on a Nexus switch

                                            Options

                                            Parameter required default choices comments
                                            username no
                                              Username used to login to the switch
                                              protocol no http
                                              • http
                                              • https
                                              Dictates connection protocol to use for NX-API
                                              host yes
                                                IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                state yes
                                                • present
                                                • absent
                                                Desired state of the resource / path
                                                path yes
                                                  Path (with filename if deleting file)
                                                  password no
                                                    Password used to login to the switch

                                                    Examples

                                                    # Ensure directory is created on target device
                                                    - nxos_dir: path='bootflash:new_config_dir' host={{ inventory_hostname }} state=present
                                                    
                                                    # Ensure directory is not on target device
                                                    - nxos_dir: path='bootflash:new_config_dir' host={{ inventory_hostname }} state=absent
                                                    
                                                    # Ensure file is not on target device
                                                    - nxos_dir: path='bootflash:switch_config1.cfg' host={{ inventory_hostname }} state=absent
                                                    
                                                    
                                                    

                                                    Notes

                                                    • state=present should not be used when path is a file

                                                    • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                    • Using the username and password params will override the .netauth file


                                                    nxos_vpc_interface

                                                    Manages interface VPC configuration

                                                    • Synopsis
                                                    • Options
                                                    • Examples

                                                    Synopsis

                                                    Manages interface VPC configuration

                                                    Options

                                                    Parameter required default choices comments
                                                    username no
                                                      Username used to login to the switch
                                                      protocol no http
                                                      • http
                                                      • https
                                                      Dictates connection protocol to use for NX-API
                                                      portchannel yes
                                                        group number of the portchannel that will be configured
                                                        peer_link no
                                                          Set to true/false for peer link config on assoicated portchannel
                                                          state yes present
                                                          • present
                                                          • absent
                                                          Manages desired state of the resource
                                                          vpc no
                                                            vpc group/id that will be configured on associated portchannel
                                                            host yes
                                                              IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                              password no
                                                                Password used to login to the switch

                                                                Examples

                                                                # config portchannel10 to be the peerlink
                                                                #- nxos_vpc_interface: portchannel=10 peer_link=true host={{ inventory_hostname }}
                                                                
                                                                # config portchannel20 to be vpc20
                                                                #- nxos_vpc_interface: portchannel=20 vpc=20 host={{ inventory_hostname }}
                                                                
                                                                # remove whatever VPC config is on portchannel if any exists (vpc xx or vpc peer-link)
                                                                - nxos_vpc_interface: portchannel=80 host={{ inventory_hostname }} state=absent
                                                                
                                                                

                                                                Notes

                                                                • Either vpc or peer_link param is required, but not both.

                                                                • State=absent removes whatever VPC config is on a port-channel if one exists.

                                                                • Re-assigning a vpc or peerlink from one portchannel to another is not supported. The module will force the user to unconfigure an existing vpc/pl before configuring the same value on a new portchannel

                                                                • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                • Using the username and password params will override the .netauth file


                                                                nxos_snmp_host

                                                                Manages SNMP host configuration

                                                                • Synopsis
                                                                • Options
                                                                • Examples

                                                                Synopsis

                                                                Manages SNMP host configuration parameters

                                                                Options

                                                                Parameter required default choices comments
                                                                username no
                                                                  Username used to login to the switch
                                                                  vrf_filter no
                                                                    Name of VRF to filter
                                                                    udp no
                                                                      UDP port number (0-65535)
                                                                      protocol no http
                                                                      • http
                                                                      • https
                                                                      Dictates connection protocol to use for NX-API
                                                                      src_intf no
                                                                        Source interface
                                                                        snmp_host yes
                                                                          IP address of hostname of target host
                                                                          host yes
                                                                            IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                            community no
                                                                              Community string or v3 username
                                                                              state yes present
                                                                              • present
                                                                              • absent
                                                                              Manage the state of the resource
                                                                              version no v2c
                                                                              • v2c
                                                                              • v3
                                                                              SNMP version
                                                                              vrf no
                                                                                VRF to use to source traffic to source
                                                                                password no
                                                                                  Password used to login to the switch
                                                                                  type no traps
                                                                                  • trap
                                                                                  • inform
                                                                                  type of message to send to host

                                                                                  Examples

                                                                                  
                                                                                  
                                                                                  

                                                                                  Notes

                                                                                  • state=absent removes the host configuration if it is configured

                                                                                  • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                  • Using the username and password params will override the .netauth file


                                                                                  nxos_ping

                                                                                  Tests reachability using ping from Nexus switch

                                                                                  • Synopsis
                                                                                  • Options
                                                                                  • Examples

                                                                                  Synopsis

                                                                                  Tests reachability using ping from switch to a remote destination

                                                                                  Options

                                                                                  Parameter required default choices comments
                                                                                  count no 4
                                                                                    Number of packets to send
                                                                                    username no
                                                                                      Username used to login to the switch
                                                                                      protocol no http
                                                                                      • http
                                                                                      • https
                                                                                      Dictates connection protocol to use for NX-API
                                                                                      dest yes
                                                                                        IP address or hostname (resolvable by switch) of remote node
                                                                                        source no
                                                                                          Source IP Address
                                                                                          host yes
                                                                                            IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                            vrf no
                                                                                              Outgoing VRF
                                                                                              password no
                                                                                                Password used to login to the switch

                                                                                                Examples

                                                                                                # test reachability to 8.8.8.8 using mgmt vrf
                                                                                                - nxos_ping: dest=8.8.8.8 vrf=management host={{ inventory_hostname }}
                                                                                                
                                                                                                # Test reachability to a few different public IPs using mgmt vrf
                                                                                                - nxos_ping: dest={{ item }} vrf=management host={{ inventory_hostname }}
                                                                                                  with_items:
                                                                                                    - 8.8.8.8
                                                                                                    - 4.4.4.4
                                                                                                    - 198.6.1.4
                                                                                                
                                                                                                
                                                                                                

                                                                                                Notes

                                                                                                • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                • Using the username and password params will override the .netauth file


                                                                                                nxos_snmp_community

                                                                                                Manages SNMP community configs

                                                                                                • Synopsis
                                                                                                • Options
                                                                                                • Examples

                                                                                                Synopsis

                                                                                                Manages SNMP community configuration

                                                                                                Options

                                                                                                Parameter required default choices comments
                                                                                                username no
                                                                                                  Username used to login to the switch
                                                                                                  group no
                                                                                                    Group to which the community belongs
                                                                                                    host yes
                                                                                                      IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                      community yes
                                                                                                        Case-sensitive community string
                                                                                                        acl no 1
                                                                                                          acl name to filter snmp requests
                                                                                                          access no
                                                                                                          • ro
                                                                                                          • rw
                                                                                                          Access type for community
                                                                                                          state yes present
                                                                                                          • present
                                                                                                          • absent
                                                                                                          Manage the state of the resource
                                                                                                          protocol no http
                                                                                                          • http
                                                                                                          • https
                                                                                                          Dictates connection protocol to use for NX-API
                                                                                                          password no
                                                                                                            Password used to login to the switch

                                                                                                            Examples

                                                                                                            
                                                                                                            
                                                                                                            

                                                                                                            Notes

                                                                                                            • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                            • Using the username and password params will override the .netauth file


                                                                                                            nxos_static_routes

                                                                                                            Manages static route configuration

                                                                                                            • Synopsis
                                                                                                            • Options
                                                                                                            • Examples

                                                                                                            Synopsis

                                                                                                            Manages static route configuration

                                                                                                            Options

                                                                                                            Parameter required default choices comments
                                                                                                            username no
                                                                                                              Username used to login to the switch
                                                                                                              next_hop yes
                                                                                                                Next hop address or interface of static route
                                                                                                                protocol no http
                                                                                                                • http
                                                                                                                • https
                                                                                                                Dictates connection protocol to use for NX-API
                                                                                                                state yes present
                                                                                                                • present
                                                                                                                • absent
                                                                                                                Manage the state of the resource
                                                                                                                pref no
                                                                                                                  {u'Preference or administrative difference of route (range': u'1-255)'}
                                                                                                                  route_name no
                                                                                                                    Name of the route. Used with the "name" parameter on the CLI.
                                                                                                                    prefix yes
                                                                                                                      Destination prefix of static route
                                                                                                                      tag no
                                                                                                                        Route tag value (numeric).
                                                                                                                        vrf no default
                                                                                                                          VRF for static route
                                                                                                                          host yes
                                                                                                                            IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                            password no
                                                                                                                              Password used to login to the switch

                                                                                                                              Examples

                                                                                                                              # Static route with tag and preference set
                                                                                                                              - nxos_static_routes: prefix=1.1.1.0/24 next_hop=2.2.2.2 tag=90 pref=80 host={{ inventory_hostname }}
                                                                                                                              
                                                                                                                              

                                                                                                                              Notes

                                                                                                                              • If no vrf is supplied, vrf is set to "default"

                                                                                                                              • If state=absent, the route will be removed, regardless of the non-required parameters.

                                                                                                                              • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                              • Using the username and password params will override the .netauth file


                                                                                                                              nxos_snmp_location

                                                                                                                              Manages SNMP location information

                                                                                                                              • Synopsis
                                                                                                                              • Options
                                                                                                                              • Examples

                                                                                                                              Synopsis

                                                                                                                              Manages SNMP location configuration

                                                                                                                              Options

                                                                                                                              Parameter required default choices comments
                                                                                                                              username no
                                                                                                                                Username used to login to the switch
                                                                                                                                protocol no http
                                                                                                                                • http
                                                                                                                                • https
                                                                                                                                Dictates connection protocol to use for NX-API
                                                                                                                                state yes present
                                                                                                                                • present
                                                                                                                                • absent
                                                                                                                                Manage the state of the resource
                                                                                                                                host yes
                                                                                                                                  IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                  location yes
                                                                                                                                    location information
                                                                                                                                    password no
                                                                                                                                      Password used to login to the switch

                                                                                                                                      Examples

                                                                                                                                      
                                                                                                                                      
                                                                                                                                      

                                                                                                                                      Notes

                                                                                                                                      • state=absent removes the location configuration if it is configured

                                                                                                                                      • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                      • Using the username and password params will override the .netauth file


                                                                                                                                      nxos_vrf

                                                                                                                                      Manages global VRF configuration

                                                                                                                                      • Synopsis
                                                                                                                                      • Options
                                                                                                                                      • Examples

                                                                                                                                      Synopsis

                                                                                                                                      Manages global VRF configuration

                                                                                                                                      Options

                                                                                                                                      Parameter required default choices comments
                                                                                                                                      username no
                                                                                                                                        Username used to login to the switch
                                                                                                                                        protocol no http
                                                                                                                                        • http
                                                                                                                                        • https
                                                                                                                                        Dictates connection protocol to use for NX-API
                                                                                                                                        description no
                                                                                                                                          Description of the VRF
                                                                                                                                          state yes present
                                                                                                                                          • present
                                                                                                                                          • absent
                                                                                                                                          Manages desired state of the resource
                                                                                                                                          host yes
                                                                                                                                            IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                            admin_state no up
                                                                                                                                            • up
                                                                                                                                            • down
                                                                                                                                            Administrative state of the VRF
                                                                                                                                            vrf yes
                                                                                                                                              Name of VRF to be managed
                                                                                                                                              password no
                                                                                                                                                Password used to login to the switch

                                                                                                                                                Examples

                                                                                                                                                # ensure yankees VRF exists on switch
                                                                                                                                                - nxos_vrf: vrf=yankees host={{ inventory_hostname }}
                                                                                                                                                
                                                                                                                                                # ensure yankees VRF does not exist on switch
                                                                                                                                                - nxos_vrf: vrf=yankees host={{ inventory_hostname }} state=absent
                                                                                                                                                
                                                                                                                                                

                                                                                                                                                Notes

                                                                                                                                                • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                • Using the username and password params will override the .netauth file


                                                                                                                                                nxos_save_config

                                                                                                                                                Saves running configuration

                                                                                                                                                • Synopsis
                                                                                                                                                • Options
                                                                                                                                                • Examples

                                                                                                                                                Synopsis

                                                                                                                                                Saves running config to startup-config or file of your choice

                                                                                                                                                Options

                                                                                                                                                Parameter required default choices comments
                                                                                                                                                username no
                                                                                                                                                  Username used to login to the switch
                                                                                                                                                  path no
                                                                                                                                                    {u'Path of destination. Ex': u'bootflash:config.cfg, etc.'}
                                                                                                                                                    host yes
                                                                                                                                                      IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                      password no
                                                                                                                                                        Password used to login to the switch
                                                                                                                                                        protocol no http
                                                                                                                                                        • http
                                                                                                                                                        • https
                                                                                                                                                        Dictates connection protocol to use for NX-API

                                                                                                                                                        Examples

                                                                                                                                                        # save running config to startup-config
                                                                                                                                                        - nxos_save_config: host={{ inventory_hostname }}
                                                                                                                                                        
                                                                                                                                                        # save running config to dir in bootflash
                                                                                                                                                        - nxos_save_config: path='bootflash:configs/my_config.cfg' host={{ inventory_hostname }}
                                                                                                                                                        
                                                                                                                                                        
                                                                                                                                                        

                                                                                                                                                        Notes

                                                                                                                                                        • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                        • Using the username and password params will override the .netauth file


                                                                                                                                                        nxos_udld

                                                                                                                                                        Manages UDLD global configuration params

                                                                                                                                                        • Synopsis
                                                                                                                                                        • Options
                                                                                                                                                        • Examples

                                                                                                                                                        Synopsis

                                                                                                                                                        Manages UDLD global configuration params

                                                                                                                                                        Options

                                                                                                                                                        Parameter required default choices comments
                                                                                                                                                        reset no
                                                                                                                                                        • true
                                                                                                                                                        • false
                                                                                                                                                        Ability to reset UDLD down interfaces
                                                                                                                                                        username no
                                                                                                                                                          Username used to login to the switch
                                                                                                                                                          protocol no http
                                                                                                                                                          • http
                                                                                                                                                          • https
                                                                                                                                                          Dictates connection protocol to use for NX-API
                                                                                                                                                          state yes present
                                                                                                                                                          • present
                                                                                                                                                          • absent
                                                                                                                                                          Manage the state of the resource
                                                                                                                                                          msg_time no
                                                                                                                                                            Message time in seconds for UDLD packets
                                                                                                                                                            host yes
                                                                                                                                                              IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                              aggressive no
                                                                                                                                                              • enabled
                                                                                                                                                              • disabled
                                                                                                                                                              Toggles aggressive mode
                                                                                                                                                              password no
                                                                                                                                                                Password used to login to the switch

                                                                                                                                                                Examples

                                                                                                                                                                # ensure udld aggressive mode is globally disabled and se global message interval is 20
                                                                                                                                                                - nxos_udld: aggressive=disabled msg_time=20 host={{ inventory_hostname }}
                                                                                                                                                                
                                                                                                                                                                # Ensure agg mode is globally enabled and msg time is 15
                                                                                                                                                                - nxos_udld: aggressive=enabled msg_time=15 host={{ inventory_hostname }} state=present
                                                                                                                                                                
                                                                                                                                                                # Ensure msg_time is unconfigured (if it is already 25- basically defaults back to 15 anyway)
                                                                                                                                                                
                                                                                                                                                                
                                                                                                                                                                

                                                                                                                                                                Notes

                                                                                                                                                                • When state=absent, it unconfigures existing setings if they already exist on the switch. It is cleaner to always use state=present.

                                                                                                                                                                • Module will fail if the udld feature has not been previously enabled

                                                                                                                                                                • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                • Using the username and password params will override the .netauth file


                                                                                                                                                                nxos_snmp_trap

                                                                                                                                                                Manages SNMP traps

                                                                                                                                                                • Synopsis
                                                                                                                                                                • Options
                                                                                                                                                                • Examples

                                                                                                                                                                Synopsis

                                                                                                                                                                Manages SNMP traps configurations

                                                                                                                                                                Options

                                                                                                                                                                Parameter required default choices comments
                                                                                                                                                                username no
                                                                                                                                                                  Username used to login to the switch
                                                                                                                                                                  protocol no http
                                                                                                                                                                  • http
                                                                                                                                                                  • https
                                                                                                                                                                  Dictates connection protocol to use for NX-API
                                                                                                                                                                  host yes
                                                                                                                                                                    IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                    state yes present
                                                                                                                                                                    • enabled
                                                                                                                                                                    • disabled
                                                                                                                                                                    Manage the state of the resource
                                                                                                                                                                    group yes
                                                                                                                                                                    • aaa
                                                                                                                                                                    • bridge
                                                                                                                                                                    • callhome
                                                                                                                                                                    • cfs
                                                                                                                                                                    • config
                                                                                                                                                                    • entity
                                                                                                                                                                    • feature-control
                                                                                                                                                                    • hsrp
                                                                                                                                                                    • license
                                                                                                                                                                    • link
                                                                                                                                                                    • lldp
                                                                                                                                                                    • ospf
                                                                                                                                                                    • rf
                                                                                                                                                                    • rmon
                                                                                                                                                                    • snmp
                                                                                                                                                                    • storm-control
                                                                                                                                                                    • stpx
                                                                                                                                                                    • sysmgr
                                                                                                                                                                    • system
                                                                                                                                                                    • upgrade
                                                                                                                                                                    • vtp
                                                                                                                                                                    • all
                                                                                                                                                                    location information
                                                                                                                                                                    password no
                                                                                                                                                                      Password used to login to the switch

                                                                                                                                                                      Examples

                                                                                                                                                                      
                                                                                                                                                                      
                                                                                                                                                                      

                                                                                                                                                                      Notes

                                                                                                                                                                      • This module works at the group level for traps. If you need to only enable/disable 1 specific trap within a group, use the nxos_command module.

                                                                                                                                                                      • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                      • Using the username and password params will override the .netauth file


                                                                                                                                                                      nxos_snmp_user

                                                                                                                                                                      Manages SNMP users for monitoring

                                                                                                                                                                      • Synopsis
                                                                                                                                                                      • Options
                                                                                                                                                                      • Examples

                                                                                                                                                                      Synopsis

                                                                                                                                                                      Manages SNMP user configuration

                                                                                                                                                                      Options

                                                                                                                                                                      Parameter required default choices comments
                                                                                                                                                                      username no
                                                                                                                                                                        Username used to login to the switch
                                                                                                                                                                        encrypt no
                                                                                                                                                                          enables aes-128 bit encryption when using privacy pw
                                                                                                                                                                          privacy no
                                                                                                                                                                            prviacy password for the user
                                                                                                                                                                            state yes present
                                                                                                                                                                            • present
                                                                                                                                                                            • absent
                                                                                                                                                                            Manage the state of the resource
                                                                                                                                                                            auth no
                                                                                                                                                                            • md5
                                                                                                                                                                            • sha
                                                                                                                                                                            Auth parameters for the user
                                                                                                                                                                            pwd no
                                                                                                                                                                              auth password when using md5 or sha
                                                                                                                                                                              user yes
                                                                                                                                                                                name of the user
                                                                                                                                                                                host yes
                                                                                                                                                                                  IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                  group no
                                                                                                                                                                                    Group to which the user will belong to
                                                                                                                                                                                    password no
                                                                                                                                                                                      Password used to login to the switch
                                                                                                                                                                                      protocol no http
                                                                                                                                                                                      • http
                                                                                                                                                                                      • https
                                                                                                                                                                                      Dictates connection protocol to use for NX-API

                                                                                                                                                                                      Examples

                                                                                                                                                                                      
                                                                                                                                                                                      
                                                                                                                                                                                      

                                                                                                                                                                                      Notes

                                                                                                                                                                                      • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                      • Using the username and password params will override the .netauth file


                                                                                                                                                                                      nxos_mtu

                                                                                                                                                                                      Manages MTU settings on Nexus switch

                                                                                                                                                                                      • Synopsis
                                                                                                                                                                                      • Options
                                                                                                                                                                                      • Examples

                                                                                                                                                                                      Synopsis

                                                                                                                                                                                      Manages MTU settings on Nexus switch

                                                                                                                                                                                      Options

                                                                                                                                                                                      Parameter required default choices comments
                                                                                                                                                                                      username no
                                                                                                                                                                                        Username used to login to the switch
                                                                                                                                                                                        protocol no http
                                                                                                                                                                                        • http
                                                                                                                                                                                        • https
                                                                                                                                                                                        Dictates connection protocol to use for NX-API
                                                                                                                                                                                        sysmtu no
                                                                                                                                                                                          System jumbo MTU
                                                                                                                                                                                          host yes
                                                                                                                                                                                            IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                            mtu no
                                                                                                                                                                                              MTU for a specific interface
                                                                                                                                                                                              state yes present
                                                                                                                                                                                              • present
                                                                                                                                                                                              • absent
                                                                                                                                                                                              Specify desired state of the resource
                                                                                                                                                                                              interface yes
                                                                                                                                                                                                Full name of interface, i.e. Ethernet1/1
                                                                                                                                                                                                password no
                                                                                                                                                                                                  Password used to login to the switch

                                                                                                                                                                                                  Examples

                                                                                                                                                                                                  # Ensure system mtu is 9126
                                                                                                                                                                                                  - nxos_mtu: sysmtu=9216 host={{ inventory_hostname }}
                                                                                                                                                                                                  
                                                                                                                                                                                                  # Config mtu on Eth1/1 (routed interface)
                                                                                                                                                                                                  - nxos_mtu: interface=Ethernet1/1 mtu=1600 host={{ inventory_hostname }}
                                                                                                                                                                                                  
                                                                                                                                                                                                  # Config mtu on Eth1/3 (switched interface)
                                                                                                                                                                                                  - nxos_mtu: interface=Ethernet1/3 mtu=9216 host={{ inventory_hostname }}
                                                                                                                                                                                                  
                                                                                                                                                                                                  # Unconfigure mtu on a given interface
                                                                                                                                                                                                  - nxos_mtu: interface=Ethernet1/3 mtu=9216 host={{ inventory_hostname }} state=absent
                                                                                                                                                                                                  
                                                                                                                                                                                                  
                                                                                                                                                                                                  

                                                                                                                                                                                                  Notes

                                                                                                                                                                                                  • Either sysmtu param is required or interface AND mtu params are req'd

                                                                                                                                                                                                  • Absent unconfigures a given MTU if that value is currently present

                                                                                                                                                                                                  • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                  • Using the username and password params will override the .netauth file


                                                                                                                                                                                                  nxos_ipv4_interface

                                                                                                                                                                                                  Manages L3 attributes for IPv4 interfaces

                                                                                                                                                                                                  • Synopsis
                                                                                                                                                                                                  • Options
                                                                                                                                                                                                  • Examples

                                                                                                                                                                                                  Synopsis

                                                                                                                                                                                                  Manages Layer 3 attributes for IPv4 interfaces

                                                                                                                                                                                                  Options

                                                                                                                                                                                                  Parameter required default choices comments
                                                                                                                                                                                                  username no
                                                                                                                                                                                                    Username used to login to the switch
                                                                                                                                                                                                    ip_addr yes
                                                                                                                                                                                                      IPv4 IP Address
                                                                                                                                                                                                      mask yes
                                                                                                                                                                                                        Subnet mask for IPv4 IP Address
                                                                                                                                                                                                        host yes
                                                                                                                                                                                                          IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                          state yes present
                                                                                                                                                                                                          • present
                                                                                                                                                                                                          • absent
                                                                                                                                                                                                          Specify desired state of the resource
                                                                                                                                                                                                          interface yes
                                                                                                                                                                                                            Full name of interface, i.e. Ethernet1/1, vlan10
                                                                                                                                                                                                            protocol no http
                                                                                                                                                                                                            • http
                                                                                                                                                                                                            • https
                                                                                                                                                                                                            Dictates connection protocol to use for NX-API
                                                                                                                                                                                                            password no
                                                                                                                                                                                                              Password used to login to the switch

                                                                                                                                                                                                              Examples

                                                                                                                                                                                                              # Ensure Eth1/1 has an IP address of 10.1.100.2/24
                                                                                                                                                                                                              - nxos_ipv4_interface: interface=Ethernet1/1 ip_addr=10.1.100.2 mask=24 host={{ inventory_hostname }} state=absent
                                                                                                                                                                                                              
                                                                                                                                                                                                              # Ensure vlan10 has an IP address of 100.1.1.3/24
                                                                                                                                                                                                              - nxos_ipv4_interface: interface=vlan10 ip_addr=10.1.100.3 mask=22 host={{ inventory_hostname }}
                                                                                                                                                                                                              
                                                                                                                                                                                                              # Ensure vlan10 does not have an IP address
                                                                                                                                                                                                              - nxos_ipv4_interface: interface=vlan10 host={{ inventory_hostname }} state=absent
                                                                                                                                                                                                              
                                                                                                                                                                                                              
                                                                                                                                                                                                              

                                                                                                                                                                                                              Notes

                                                                                                                                                                                                              • Interface must already be a L3 port when using this module. Use nxos_interface to convert an interface from L2 to L3, if needed.

                                                                                                                                                                                                              • Logical interfaces (po, loop, svi) must be created first with the nxos_interface module prior to configuring the ipv4 address

                                                                                                                                                                                                              • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                              • Using the username and password params will override the .netauth file


                                                                                                                                                                                                              nxos_vtp

                                                                                                                                                                                                              Manages VTP configuration

                                                                                                                                                                                                              • Synopsis
                                                                                                                                                                                                              • Options
                                                                                                                                                                                                              • Examples

                                                                                                                                                                                                              Synopsis

                                                                                                                                                                                                              Manages VTP configuration

                                                                                                                                                                                                              Options

                                                                                                                                                                                                              Parameter required default choices comments
                                                                                                                                                                                                              username no
                                                                                                                                                                                                                Username used to login to the switch
                                                                                                                                                                                                                domain no
                                                                                                                                                                                                                  VTP domain name
                                                                                                                                                                                                                  protocol no http
                                                                                                                                                                                                                  • http
                                                                                                                                                                                                                  • https
                                                                                                                                                                                                                  Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                  vtp_password no
                                                                                                                                                                                                                    VTP password
                                                                                                                                                                                                                    state yes present
                                                                                                                                                                                                                    • present
                                                                                                                                                                                                                    • absent
                                                                                                                                                                                                                    Manage the state of the resource
                                                                                                                                                                                                                    version no
                                                                                                                                                                                                                    • 1
                                                                                                                                                                                                                    • 2
                                                                                                                                                                                                                    VTP version number
                                                                                                                                                                                                                    host yes
                                                                                                                                                                                                                      IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                      password no
                                                                                                                                                                                                                        Password used to login to the switch

                                                                                                                                                                                                                        Examples

                                                                                                                                                                                                                          # set all three parameters
                                                                                                                                                                                                                          - nxos_vtp: domain=ntc vtp_password=vpass version=1 host={{ inventory_hostname }}
                                                                                                                                                                                                                        
                                                                                                                                                                                                                        

                                                                                                                                                                                                                        Notes

                                                                                                                                                                                                                        • state=absent can only be used to remove the VTP password. If state=absent, and parameters other than VTP password are supplied the module will fail.

                                                                                                                                                                                                                        • A VTP password must be set at the same time or after the VTP domain name is set.

                                                                                                                                                                                                                        • If a VTP version number isn't, supplied the switch defaults to version 1.

                                                                                                                                                                                                                        • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                        • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                        nxos_vpc

                                                                                                                                                                                                                        Manages global VPC configuration

                                                                                                                                                                                                                        • Synopsis
                                                                                                                                                                                                                        • Options
                                                                                                                                                                                                                        • Examples

                                                                                                                                                                                                                        Synopsis

                                                                                                                                                                                                                        Manages global VPC configuration

                                                                                                                                                                                                                        Options

                                                                                                                                                                                                                        Parameter required default choices comments
                                                                                                                                                                                                                        username no
                                                                                                                                                                                                                          Username used to login to the switch
                                                                                                                                                                                                                          domain yes
                                                                                                                                                                                                                            VPC domain
                                                                                                                                                                                                                            protocol no http
                                                                                                                                                                                                                            • http
                                                                                                                                                                                                                            • https
                                                                                                                                                                                                                            Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                            system_priority no
                                                                                                                                                                                                                              System priority device. Remember they must match between peers.
                                                                                                                                                                                                                              role_priority no
                                                                                                                                                                                                                                Role priority for device. Remember lower is better.
                                                                                                                                                                                                                                auto_recovery no
                                                                                                                                                                                                                                • true
                                                                                                                                                                                                                                • false
                                                                                                                                                                                                                                Enables/Disables auto recovery
                                                                                                                                                                                                                                pkl_vrf no management
                                                                                                                                                                                                                                  VRF used for peer keepalive link
                                                                                                                                                                                                                                  delay_restore no
                                                                                                                                                                                                                                    manages delay restore command and config value in seconds
                                                                                                                                                                                                                                    peer_gw no
                                                                                                                                                                                                                                    • true
                                                                                                                                                                                                                                    • false
                                                                                                                                                                                                                                    Enables/Disables peer gateway
                                                                                                                                                                                                                                    state yes present
                                                                                                                                                                                                                                    • present
                                                                                                                                                                                                                                    • absent
                                                                                                                                                                                                                                    Manages desired state of the resource
                                                                                                                                                                                                                                    host yes
                                                                                                                                                                                                                                      IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                      password no
                                                                                                                                                                                                                                        Password used to login to the switch
                                                                                                                                                                                                                                        pkl_dest no
                                                                                                                                                                                                                                          Destination (remote) IP address used for peer keepalive link
                                                                                                                                                                                                                                          pkl_src no
                                                                                                                                                                                                                                            Source IP address used for peer keepalive link

                                                                                                                                                                                                                                            Examples

                                                                                                                                                                                                                                            # ensure vpc domain 100 is configured
                                                                                                                                                                                                                                            - nxos_vpc: domain=100 role_priority=1000 system_priority=2000 pkl_src=192.168.100.1 pkl_dest=192.168.100.2 host={{ inventory_hostname }}
                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                            # ensure peer gateway is enabled for vpc domain 100
                                                                                                                                                                                                                                            - nxos_vpc: domain=100 peer_gw=true host={{ inventory_hostname }}
                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                            # ensure vpc domain does not exist on switch
                                                                                                                                                                                                                                            - nxos_vpc: domain=100 host={{ inventory_hostname }} state=absent
                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                            Notes

                                                                                                                                                                                                                                            • The feature vpc must be enabled before this module can be used

                                                                                                                                                                                                                                            • If not using management vrf, vrf must be globally on the device before using in the pkl config

                                                                                                                                                                                                                                            • Although source IP isn't required on the command line it is required when using this module. The PKL VRF must also be configured prior to using this module.

                                                                                                                                                                                                                                            • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                            • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                            nxos_copy

                                                                                                                                                                                                                                            Copy file from remote server to Nexus switch

                                                                                                                                                                                                                                            • Synopsis
                                                                                                                                                                                                                                            • Options
                                                                                                                                                                                                                                            • Examples

                                                                                                                                                                                                                                            Synopsis

                                                                                                                                                                                                                                            Commands executed locally on the switch to copy a file from a remote server to a particular path/dir on the Nexus switch

                                                                                                                                                                                                                                            Options

                                                                                                                                                                                                                                            Parameter required default choices comments
                                                                                                                                                                                                                                            username no
                                                                                                                                                                                                                                              Username used to login to the switch
                                                                                                                                                                                                                                              server_path yes
                                                                                                                                                                                                                                                Absolute path including file name
                                                                                                                                                                                                                                                password no
                                                                                                                                                                                                                                                  Password used to login to the switch
                                                                                                                                                                                                                                                  protocol no http
                                                                                                                                                                                                                                                  • http
                                                                                                                                                                                                                                                  • https
                                                                                                                                                                                                                                                  Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                  server_pw yes
                                                                                                                                                                                                                                                    Password used to login to the server from the switch
                                                                                                                                                                                                                                                    server_un yes
                                                                                                                                                                                                                                                      Username used to login to the server from the switch
                                                                                                                                                                                                                                                      server_host yes
                                                                                                                                                                                                                                                        IP Address or hostname (resolvable by switch) of the remote server that has currently has the file needed
                                                                                                                                                                                                                                                        host yes
                                                                                                                                                                                                                                                          IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                          local_path yes
                                                                                                                                                                                                                                                            Path on the switch where the file should be stored upon transfer
                                                                                                                                                                                                                                                            vrf no default
                                                                                                                                                                                                                                                              VRF used to source communication to the remote file server
                                                                                                                                                                                                                                                              copy_type no scp
                                                                                                                                                                                                                                                              • scp
                                                                                                                                                                                                                                                              Protocol used to copy file from remote server to switch

                                                                                                                                                                                                                                                              Examples

                                                                                                                                                                                                                                                              # copy config file from server to switch
                                                                                                                                                                                                                                                              - nxos_copy:
                                                                                                                                                                                                                                                                  server_host=192.168.200.56
                                                                                                                                                                                                                                                                  server_path='/home/cisco/Public/switch_config.cfg'
                                                                                                                                                                                                                                                                  server_un=cisco
                                                                                                                                                                                                                                                                  server_pw=cisco
                                                                                                                                                                                                                                                                  copy_type=scp
                                                                                                                                                                                                                                                                  local_path='bootflash:switch_config.cfg'
                                                                                                                                                                                                                                                                  vrf=management
                                                                                                                                                                                                                                                                  host={{ inventory_hostname }}
                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                              Notes

                                                                                                                                                                                                                                                              • This module was tested with a remote Ubuntu 14.04 machine using SCP.

                                                                                                                                                                                                                                                              • Cannot override files on the switch with this module. User should ensure the file does not exist first with nxos_dir if needed or change the name of the dest file name.

                                                                                                                                                                                                                                                              • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                              • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                              nxos_interface

                                                                                                                                                                                                                                                              Manages physical attributes of interfaces

                                                                                                                                                                                                                                                              • Synopsis
                                                                                                                                                                                                                                                              • Options
                                                                                                                                                                                                                                                              • Examples

                                                                                                                                                                                                                                                              Synopsis

                                                                                                                                                                                                                                                              Manages physical attributes on interface of NX-API enabled devices

                                                                                                                                                                                                                                                              Options

                                                                                                                                                                                                                                                              Parameter required default choices comments
                                                                                                                                                                                                                                                              username no
                                                                                                                                                                                                                                                                Username used to login to the switch
                                                                                                                                                                                                                                                                protocol no http
                                                                                                                                                                                                                                                                • http
                                                                                                                                                                                                                                                                • https
                                                                                                                                                                                                                                                                Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                description no
                                                                                                                                                                                                                                                                  Interface description
                                                                                                                                                                                                                                                                  duplex no
                                                                                                                                                                                                                                                                    Manage duplex settings on an interface
                                                                                                                                                                                                                                                                    host yes
                                                                                                                                                                                                                                                                      IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                      state yes present
                                                                                                                                                                                                                                                                      • present
                                                                                                                                                                                                                                                                      • absent
                                                                                                                                                                                                                                                                      • default
                                                                                                                                                                                                                                                                      Specify desired state of the resource
                                                                                                                                                                                                                                                                      admin_state no up
                                                                                                                                                                                                                                                                      • up
                                                                                                                                                                                                                                                                      • down
                                                                                                                                                                                                                                                                      Administrative state of the interface
                                                                                                                                                                                                                                                                      mode no
                                                                                                                                                                                                                                                                      • layer2
                                                                                                                                                                                                                                                                      • layer3
                                                                                                                                                                                                                                                                      Manage Layer 2 or Layer 3 state of the interface
                                                                                                                                                                                                                                                                      interface yes
                                                                                                                                                                                                                                                                        Full name of interface, i.e. Ethernet1/1, port-channel10. Also supports non-idempotent keywords including all, ethernet, loopback, svi, portchannel
                                                                                                                                                                                                                                                                        password no
                                                                                                                                                                                                                                                                          Password used to login to the switch
                                                                                                                                                                                                                                                                          speed no
                                                                                                                                                                                                                                                                            Manage speed settings on an interface

                                                                                                                                                                                                                                                                            Examples

                                                                                                                                                                                                                                                                            # Ensure an interface is a Layer 3 port and that it has the proper description
                                                                                                                                                                                                                                                                            - nxos_interface: interface=Ethernet1/1 description='Configured by Ansible' mode=layer3 host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                            # Admin down an interface
                                                                                                                                                                                                                                                                            - nxos_interface: interface=Ethernet2/1 host={{ inventory_hostname }} admin_state=down
                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                            # Remove all loopback interfaces
                                                                                                                                                                                                                                                                            - nxos_interface: interface=loopback state=absent host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                            # Remove all logical interfaces
                                                                                                                                                                                                                                                                            - nxos_interface: interface={{ item }} state=absent host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                              with_items:
                                                                                                                                                                                                                                                                                - loopback
                                                                                                                                                                                                                                                                                - portchannel
                                                                                                                                                                                                                                                                                - svi
                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                            # Admin up all ethernet interfaces
                                                                                                                                                                                                                                                                            - nxos_interface: interface=ethernet host={{ inventory_hostname }} admin_state=up
                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                            # Admin down ALL interfaces (physical and logical)
                                                                                                                                                                                                                                                                            - nxos_interface: interface=all host={{ inventory_hostname }} admin_state=down
                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                            Notes

                                                                                                                                                                                                                                                                            • When using one of the five special keywords for the interface param, the module is not non-idempotent. Keywords include all, ethernet, loopback, svi, and portchannel.

                                                                                                                                                                                                                                                                            • This module is also used to create logical interfaces such as svis and loopbacks.

                                                                                                                                                                                                                                                                            • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                            • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                            nxos_vlan

                                                                                                                                                                                                                                                                            Manages VLAN resources and attributes

                                                                                                                                                                                                                                                                            • Synopsis
                                                                                                                                                                                                                                                                            • Options
                                                                                                                                                                                                                                                                            • Examples

                                                                                                                                                                                                                                                                            Synopsis

                                                                                                                                                                                                                                                                            Manages VLAN configurations on NX-API enabled switches

                                                                                                                                                                                                                                                                            Options

                                                                                                                                                                                                                                                                            Parameter required default choices comments
                                                                                                                                                                                                                                                                            username no
                                                                                                                                                                                                                                                                              Username used to login to the switch
                                                                                                                                                                                                                                                                              vlan_state no active
                                                                                                                                                                                                                                                                              • active
                                                                                                                                                                                                                                                                              • suspend
                                                                                                                                                                                                                                                                              Manage the vlan oper state of the VLAN (equiv to state {active
                                                                                                                                                                                                                                                                              protocol no http
                                                                                                                                                                                                                                                                              • http
                                                                                                                                                                                                                                                                              • https
                                                                                                                                                                                                                                                                              Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                              name no
                                                                                                                                                                                                                                                                                name of VLAN (not supported when using range of VLANs)
                                                                                                                                                                                                                                                                                state no present
                                                                                                                                                                                                                                                                                • present
                                                                                                                                                                                                                                                                                • absent
                                                                                                                                                                                                                                                                                Manage the state of the resource
                                                                                                                                                                                                                                                                                host yes
                                                                                                                                                                                                                                                                                  IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                  admin_state no up
                                                                                                                                                                                                                                                                                  • up
                                                                                                                                                                                                                                                                                  • down
                                                                                                                                                                                                                                                                                  Manage the vlan admin state of the VLAN (equiv to shut/no shut in vlan config mode
                                                                                                                                                                                                                                                                                  password no
                                                                                                                                                                                                                                                                                    Password used to login to the switch
                                                                                                                                                                                                                                                                                    vlan_id yes
                                                                                                                                                                                                                                                                                      vlan id or range of VLANs

                                                                                                                                                                                                                                                                                      Examples

                                                                                                                                                                                                                                                                                      # Ensure VLAN 50 exists with the name WEB and is in the shutdown state
                                                                                                                                                                                                                                                                                       - nxos_vlan: vlan_id=50 host={{ inventory_hostname }} admin_state=down name=WEB
                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                      # Ensure VLAN is NOT on the device
                                                                                                                                                                                                                                                                                      - nxos_vlan: vlan_id=50 host={{ inventory_hostname }} state=absent
                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                      # Ensure a range of VLANs are present on the switch
                                                                                                                                                                                                                                                                                      - nxos_vlan: vlan_id="2-10,20,50,55-60" host={{ inventory_hostname }} state=present
                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                      # Ensure a group of VLANs are present with the given names
                                                                                                                                                                                                                                                                                      - nxos_vlan: vlan_id={{ item.vlan_id }} name={{ item.name }} host={{ inventory_hostname }} state=present
                                                                                                                                                                                                                                                                                        with_items:
                                                                                                                                                                                                                                                                                          - vlan_id: 10
                                                                                                                                                                                                                                                                                            name: web
                                                                                                                                                                                                                                                                                          - vlan_id: 20
                                                                                                                                                                                                                                                                                            name: app
                                                                                                                                                                                                                                                                                          - { vlan_id: 30, name: db }
                                                                                                                                                                                                                                                                                          - vlan_id: 40
                                                                                                                                                                                                                                                                                            name: misc
                                                                                                                                                                                                                                                                                          - vlan_id: 99
                                                                                                                                                                                                                                                                                            name: native_vlan
                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                      Notes

                                                                                                                                                                                                                                                                                      • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                      • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                      nxos_igmp

                                                                                                                                                                                                                                                                                      Manages IGMP global configuration

                                                                                                                                                                                                                                                                                      • Synopsis
                                                                                                                                                                                                                                                                                      • Options
                                                                                                                                                                                                                                                                                      • Examples

                                                                                                                                                                                                                                                                                      Synopsis

                                                                                                                                                                                                                                                                                      Manages IGMP global configuration configuration settings

                                                                                                                                                                                                                                                                                      Options

                                                                                                                                                                                                                                                                                      Parameter required default choices comments
                                                                                                                                                                                                                                                                                      username no
                                                                                                                                                                                                                                                                                        Username used to login to the switch
                                                                                                                                                                                                                                                                                        protocol no http
                                                                                                                                                                                                                                                                                        • http
                                                                                                                                                                                                                                                                                        • https
                                                                                                                                                                                                                                                                                        Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                        enforce_rtr_alert no
                                                                                                                                                                                                                                                                                        • true
                                                                                                                                                                                                                                                                                        • false
                                                                                                                                                                                                                                                                                        Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets
                                                                                                                                                                                                                                                                                        flush_routes no
                                                                                                                                                                                                                                                                                        • true
                                                                                                                                                                                                                                                                                        • false
                                                                                                                                                                                                                                                                                        Removes routes when the IGMP process is restarted. By default, routes are not flushed.
                                                                                                                                                                                                                                                                                        state yes present
                                                                                                                                                                                                                                                                                        • present
                                                                                                                                                                                                                                                                                        • default
                                                                                                                                                                                                                                                                                        Manages desired state of the resource
                                                                                                                                                                                                                                                                                        host yes
                                                                                                                                                                                                                                                                                          IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                          password no
                                                                                                                                                                                                                                                                                            Password used to login to the switch
                                                                                                                                                                                                                                                                                            restart no
                                                                                                                                                                                                                                                                                            • true
                                                                                                                                                                                                                                                                                            • false
                                                                                                                                                                                                                                                                                            restarts the igmp process (using an exec config command)

                                                                                                                                                                                                                                                                                            Examples

                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                            # default igmp global params (all params except restart)
                                                                                                                                                                                                                                                                                            - nxos_igmp: state=default host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                            # ensure the following igmp global config exists on the device
                                                                                                                                                                                                                                                                                            - nxos_igmp: flush_routes=true enforce_rtr_alert=true host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                            # restart the igmp process
                                                                                                                                                                                                                                                                                            - nxos_igmp: restart=true host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                            Notes

                                                                                                                                                                                                                                                                                            • When state=default, all supported params will be reset to a default state

                                                                                                                                                                                                                                                                                            • If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place

                                                                                                                                                                                                                                                                                            • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                            • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                            nxos_portchannel

                                                                                                                                                                                                                                                                                            Manages port-channel interfaces

                                                                                                                                                                                                                                                                                            • Synopsis
                                                                                                                                                                                                                                                                                            • Options
                                                                                                                                                                                                                                                                                            • Examples

                                                                                                                                                                                                                                                                                            Synopsis

                                                                                                                                                                                                                                                                                            Manages port-channel specific configuration parameters

                                                                                                                                                                                                                                                                                            Options

                                                                                                                                                                                                                                                                                            Parameter required default choices comments
                                                                                                                                                                                                                                                                                            username no
                                                                                                                                                                                                                                                                                              Username used to login to the switch
                                                                                                                                                                                                                                                                                              group yes
                                                                                                                                                                                                                                                                                                channel-group number for the port-channel
                                                                                                                                                                                                                                                                                                state yes
                                                                                                                                                                                                                                                                                                • present
                                                                                                                                                                                                                                                                                                • absent
                                                                                                                                                                                                                                                                                                Manage the state of the resource
                                                                                                                                                                                                                                                                                                host yes
                                                                                                                                                                                                                                                                                                  IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                  mode no True
                                                                                                                                                                                                                                                                                                  • active
                                                                                                                                                                                                                                                                                                  • passive
                                                                                                                                                                                                                                                                                                  • on
                                                                                                                                                                                                                                                                                                  Mode for the port-channel, i.e. on, active, passive
                                                                                                                                                                                                                                                                                                  members no
                                                                                                                                                                                                                                                                                                    List of interfaces that will be managed in a given portchannel
                                                                                                                                                                                                                                                                                                    min_links no
                                                                                                                                                                                                                                                                                                      min links required to keep portchannel up
                                                                                                                                                                                                                                                                                                      protocol no http
                                                                                                                                                                                                                                                                                                      • http
                                                                                                                                                                                                                                                                                                      • https
                                                                                                                                                                                                                                                                                                      Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                      password no
                                                                                                                                                                                                                                                                                                        Password used to login to the switch

                                                                                                                                                                                                                                                                                                        Examples

                                                                                                                                                                                                                                                                                                        # Ensure port-channel 99 doesn't exist on the switch
                                                                                                                                                                                                                                                                                                        - nxos_portchannel: group=99 host={{ inventory_hostname }} state=absent
                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                        # Ensure port-channel99 is created, add two members, and set to mode on
                                                                                                                                                                                                                                                                                                        - nxos_portchannel:
                                                                                                                                                                                                                                                                                                            group: 99
                                                                                                                                                                                                                                                                                                            members: ['Ethernet1/1','Ethernet1/2']
                                                                                                                                                                                                                                                                                                            mode: 'active'
                                                                                                                                                                                                                                                                                                            host: "{{ inventory_hostname }}"
                                                                                                                                                                                                                                                                                                            state: present
                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                        Notes

                                                                                                                                                                                                                                                                                                        • Absent removes the portchannel config and interface if it already exists

                                                                                                                                                                                                                                                                                                        • Members must be a list

                                                                                                                                                                                                                                                                                                        • LACP needs to be enabled first if active/passive modes are used

                                                                                                                                                                                                                                                                                                        • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                        • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                        nxos_command

                                                                                                                                                                                                                                                                                                        Send raw commands to Cisco NX-API enabled devices

                                                                                                                                                                                                                                                                                                        • Synopsis
                                                                                                                                                                                                                                                                                                        • Options
                                                                                                                                                                                                                                                                                                        • Examples

                                                                                                                                                                                                                                                                                                        Synopsis

                                                                                                                                                                                                                                                                                                        Raw show and config commands can be sent to NX-API enabled devices. For show commands there is the ability to return structured or raw text data. The command param when type=config can be a list or string with commands separated by a comma.

                                                                                                                                                                                                                                                                                                        Options

                                                                                                                                                                                                                                                                                                        Parameter required default choices comments
                                                                                                                                                                                                                                                                                                        username no
                                                                                                                                                                                                                                                                                                          Username used to login to the switch
                                                                                                                                                                                                                                                                                                          protocol no http
                                                                                                                                                                                                                                                                                                          • http
                                                                                                                                                                                                                                                                                                          • https
                                                                                                                                                                                                                                                                                                          Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                          text no
                                                                                                                                                                                                                                                                                                          • True
                                                                                                                                                                                                                                                                                                          • False
                                                                                                                                                                                                                                                                                                          Dictates how data will be returned for show commands. Set to true if NX-API doesn't support structured output for a given command
                                                                                                                                                                                                                                                                                                          host yes
                                                                                                                                                                                                                                                                                                            IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                            command yes
                                                                                                                                                                                                                                                                                                              Show command as a string or a string of config commands separated by a comma or a list of config commands (complex args in Ansible)
                                                                                                                                                                                                                                                                                                              password no
                                                                                                                                                                                                                                                                                                                Password used to login to the switch
                                                                                                                                                                                                                                                                                                                type yes
                                                                                                                                                                                                                                                                                                                • show
                                                                                                                                                                                                                                                                                                                • config
                                                                                                                                                                                                                                                                                                                Represents the type of command being sent to the device

                                                                                                                                                                                                                                                                                                                Examples

                                                                                                                                                                                                                                                                                                                # Get CLI raw text output for a given command
                                                                                                                                                                                                                                                                                                                - nxos_command: command='show run interface mgmt0 | inc description' host={{ inventory_hostname }} text=true type=show
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                # Get structured JSON data for given command
                                                                                                                                                                                                                                                                                                                - nxos_command: command='show interface Ethernet1/1' host={{ inventory_hostname }} type=show
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                # Configure secondary interface on Eth1/2 with command as string
                                                                                                                                                                                                                                                                                                                - nxos_command: command='interface Eth1/2,ip address 5.5.5.5/24 secondary' host={{ inventory_hostname }} type=config
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                # Configure secondary interface on Eth1/2 with command as list
                                                                                                                                                                                                                                                                                                                - nxos_command:
                                                                                                                                                                                                                                                                                                                    host: "{{ inventory_hostname }}"
                                                                                                                                                                                                                                                                                                                    type: config
                                                                                                                                                                                                                                                                                                                    command: ['interface Eth1/2','ip address 5.3.3.5/24 secondary']
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                Notes

                                                                                                                                                                                                                                                                                                                • Only a single show command can be sent per task while multiple config commands can be sent.

                                                                                                                                                                                                                                                                                                                • Single show command or list of config commands or series of config commands separated by a comma supported

                                                                                                                                                                                                                                                                                                                • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                nxos_hsrp

                                                                                                                                                                                                                                                                                                                Manages HSRP configuration on NX-API enabled devices

                                                                                                                                                                                                                                                                                                                • Synopsis
                                                                                                                                                                                                                                                                                                                • Options
                                                                                                                                                                                                                                                                                                                • Examples

                                                                                                                                                                                                                                                                                                                Synopsis

                                                                                                                                                                                                                                                                                                                Manages HSRP configuration on NX-API enabled devices

                                                                                                                                                                                                                                                                                                                Options

                                                                                                                                                                                                                                                                                                                Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                auth_type no
                                                                                                                                                                                                                                                                                                                • text
                                                                                                                                                                                                                                                                                                                • md5
                                                                                                                                                                                                                                                                                                                Authentication type
                                                                                                                                                                                                                                                                                                                username no
                                                                                                                                                                                                                                                                                                                  Username used to login to the switch
                                                                                                                                                                                                                                                                                                                  group yes
                                                                                                                                                                                                                                                                                                                    hsrp group number
                                                                                                                                                                                                                                                                                                                    state yes present
                                                                                                                                                                                                                                                                                                                    • present
                                                                                                                                                                                                                                                                                                                    • absent
                                                                                                                                                                                                                                                                                                                    Specify desired state of the resource
                                                                                                                                                                                                                                                                                                                    auth_string no
                                                                                                                                                                                                                                                                                                                      Authentication string
                                                                                                                                                                                                                                                                                                                      vip yes
                                                                                                                                                                                                                                                                                                                        hsrp virtual IP address
                                                                                                                                                                                                                                                                                                                        priority no
                                                                                                                                                                                                                                                                                                                          hsrp priority
                                                                                                                                                                                                                                                                                                                          host yes
                                                                                                                                                                                                                                                                                                                            IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                            version no 2
                                                                                                                                                                                                                                                                                                                            • 1
                                                                                                                                                                                                                                                                                                                            • 2
                                                                                                                                                                                                                                                                                                                            nxos_hsrp version
                                                                                                                                                                                                                                                                                                                            interface yes
                                                                                                                                                                                                                                                                                                                              Full name of interface that is being managed for HSRP
                                                                                                                                                                                                                                                                                                                              protocol no http
                                                                                                                                                                                                                                                                                                                              • http
                                                                                                                                                                                                                                                                                                                              • https
                                                                                                                                                                                                                                                                                                                              Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                              password no
                                                                                                                                                                                                                                                                                                                                Password used to login to the switch

                                                                                                                                                                                                                                                                                                                                Examples

                                                                                                                                                                                                                                                                                                                                # ensure hsrp is configured with following params on a SVI
                                                                                                                                                                                                                                                                                                                                - nxos_hsrp: group=10 vip=10.1.1.1 priority=150 interface=vlan10 preempt=enabled host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                # ensure hsrp is configured with following params on a SVI
                                                                                                                                                                                                                                                                                                                                - nxos_hsrp: group=10 vip=10.1.1.1 priority=150 interface=vlan10 preempt=enabled host={{ inventory_hostname }} auth_type=text auth_string=CISCO
                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                # removing hsrp config for given interface, group, and vip
                                                                                                                                                                                                                                                                                                                                - nxos_hsrp: group=10 interface=vlan10 vip=10.1.1.1 host={{ inventory_hostname }} state=absent
                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                Notes

                                                                                                                                                                                                                                                                                                                                • HSRP feature needs to be enabled first on the system

                                                                                                                                                                                                                                                                                                                                • SVIs must exist before using this module

                                                                                                                                                                                                                                                                                                                                • Interface must be a L3 port before using this module

                                                                                                                                                                                                                                                                                                                                • Even when md5 is selected, only UNENCRYPTED key strings are supported in this release

                                                                                                                                                                                                                                                                                                                                • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                                nxos_udld_interface

                                                                                                                                                                                                                                                                                                                                Manages UDLD interface configuration params

                                                                                                                                                                                                                                                                                                                                • Synopsis
                                                                                                                                                                                                                                                                                                                                • Options
                                                                                                                                                                                                                                                                                                                                • Examples

                                                                                                                                                                                                                                                                                                                                Synopsis

                                                                                                                                                                                                                                                                                                                                Manages UDLD interface configuration params

                                                                                                                                                                                                                                                                                                                                Options

                                                                                                                                                                                                                                                                                                                                Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                                username no
                                                                                                                                                                                                                                                                                                                                  Username used to login to the switch
                                                                                                                                                                                                                                                                                                                                  protocol no http
                                                                                                                                                                                                                                                                                                                                  • http
                                                                                                                                                                                                                                                                                                                                  • https
                                                                                                                                                                                                                                                                                                                                  Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                                  host yes
                                                                                                                                                                                                                                                                                                                                    IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                                    state yes present
                                                                                                                                                                                                                                                                                                                                    • present
                                                                                                                                                                                                                                                                                                                                    • absent
                                                                                                                                                                                                                                                                                                                                    Manage the state of the resource
                                                                                                                                                                                                                                                                                                                                    mode yes
                                                                                                                                                                                                                                                                                                                                    • enabled
                                                                                                                                                                                                                                                                                                                                    • disabled
                                                                                                                                                                                                                                                                                                                                    • aggressive
                                                                                                                                                                                                                                                                                                                                    Manages udld mode for an interface
                                                                                                                                                                                                                                                                                                                                    interface yes
                                                                                                                                                                                                                                                                                                                                      FULL name of the interface, i.e. Ethernet1/1
                                                                                                                                                                                                                                                                                                                                      password no
                                                                                                                                                                                                                                                                                                                                        Password used to login to the switch

                                                                                                                                                                                                                                                                                                                                        Examples

                                                                                                                                                                                                                                                                                                                                        # ensure Ethernet1/1 is configured to be in aggressive mode
                                                                                                                                                                                                                                                                                                                                        - nxos_udld_interface: interface=Ethernet1/1 mode=aggressive state=present host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                        # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default)
                                                                                                                                                                                                                                                                                                                                        - nxos_udld_interface: interface=Ethernet1/1 mode=aggressive state=absent host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                        # ensure Ethernet1/1 has aggressive mode enabled
                                                                                                                                                                                                                                                                                                                                        - nxos_udld_interface: interface=Ethernet1/1 mode=enabled host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                        # ensure Ethernet1/1 has aggressive mode disabled
                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        Notes

                                                                                                                                                                                                                                                                                                                                        • When state=absent, it unconfigures existing setings if they already exist on the switch. It is much cleaner to use state=present for all options.

                                                                                                                                                                                                                                                                                                                                        • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                        • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                                        nxos_feature

                                                                                                                                                                                                                                                                                                                                        Manage features in NX-API enabled devices

                                                                                                                                                                                                                                                                                                                                        • Synopsis
                                                                                                                                                                                                                                                                                                                                        • Options
                                                                                                                                                                                                                                                                                                                                        • Examples

                                                                                                                                                                                                                                                                                                                                        Synopsis

                                                                                                                                                                                                                                                                                                                                        Offers ability to enable and disable features in NX-OS

                                                                                                                                                                                                                                                                                                                                        Options

                                                                                                                                                                                                                                                                                                                                        Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                                        username no
                                                                                                                                                                                                                                                                                                                                          Username used to login to the switch
                                                                                                                                                                                                                                                                                                                                          protocol no http
                                                                                                                                                                                                                                                                                                                                          • http
                                                                                                                                                                                                                                                                                                                                          • https
                                                                                                                                                                                                                                                                                                                                          Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                                          state yes
                                                                                                                                                                                                                                                                                                                                          • enabled
                                                                                                                                                                                                                                                                                                                                          • disabled
                                                                                                                                                                                                                                                                                                                                          Desired state of the feature
                                                                                                                                                                                                                                                                                                                                          feature yes
                                                                                                                                                                                                                                                                                                                                            Name of feature
                                                                                                                                                                                                                                                                                                                                            host yes
                                                                                                                                                                                                                                                                                                                                              IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                                              password no
                                                                                                                                                                                                                                                                                                                                                Password used to login to the switch

                                                                                                                                                                                                                                                                                                                                                Examples

                                                                                                                                                                                                                                                                                                                                                # Ensure lacp is enabled
                                                                                                                                                                                                                                                                                                                                                - nxos_feature: feature=lacp state=enabled host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                # Ensure ospf is disabled
                                                                                                                                                                                                                                                                                                                                                - nxos_feature: feature=ospf state=disabled host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                # Ensure vpc is enabled
                                                                                                                                                                                                                                                                                                                                                - nxos_feature: feature=vpc state=enabled host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                Notes

                                                                                                                                                                                                                                                                                                                                                • feature name must match that from the CLI

                                                                                                                                                                                                                                                                                                                                                • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                                • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                                                nxos_get_facts

                                                                                                                                                                                                                                                                                                                                                Gets facts about Nexus NX-API enabled switch

                                                                                                                                                                                                                                                                                                                                                • Synopsis
                                                                                                                                                                                                                                                                                                                                                • Options
                                                                                                                                                                                                                                                                                                                                                • Examples

                                                                                                                                                                                                                                                                                                                                                Synopsis

                                                                                                                                                                                                                                                                                                                                                Offers ability to extract facts from device

                                                                                                                                                                                                                                                                                                                                                Options

                                                                                                                                                                                                                                                                                                                                                Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                                                username no
                                                                                                                                                                                                                                                                                                                                                  Username used to login to the switch
                                                                                                                                                                                                                                                                                                                                                  host yes
                                                                                                                                                                                                                                                                                                                                                    IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                                                    password no
                                                                                                                                                                                                                                                                                                                                                      Password used to login to the switch
                                                                                                                                                                                                                                                                                                                                                      protocol no http
                                                                                                                                                                                                                                                                                                                                                      • http
                                                                                                                                                                                                                                                                                                                                                      • https
                                                                                                                                                                                                                                                                                                                                                      Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                                                      detail no False
                                                                                                                                                                                                                                                                                                                                                      • true
                                                                                                                                                                                                                                                                                                                                                      • false
                                                                                                                                                                                                                                                                                                                                                      if set to true, returns detailed statistics for interfaces equivalent to 'show interface status'

                                                                                                                                                                                                                                                                                                                                                      Examples

                                                                                                                                                                                                                                                                                                                                                      # retrieve facts
                                                                                                                                                                                                                                                                                                                                                      - nxos_get_facts: host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                      # retrieve facts with detailed info for interfaces (from 'show interface status')
                                                                                                                                                                                                                                                                                                                                                      - nxos_get_facts: host={{ inventory_hostname }} detail=true
                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      Notes

                                                                                                                                                                                                                                                                                                                                                      • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                                      • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                                                      nxos_get_neighbors

                                                                                                                                                                                                                                                                                                                                                      Gets neighbor detail from a NX-API enabled switch

                                                                                                                                                                                                                                                                                                                                                      • Synopsis
                                                                                                                                                                                                                                                                                                                                                      • Options
                                                                                                                                                                                                                                                                                                                                                      • Examples

                                                                                                                                                                                                                                                                                                                                                      Synopsis

                                                                                                                                                                                                                                                                                                                                                      Gets CDP or LLDP information from the switch

                                                                                                                                                                                                                                                                                                                                                      Options

                                                                                                                                                                                                                                                                                                                                                      Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                                                      username no
                                                                                                                                                                                                                                                                                                                                                        Username used to login to the switch
                                                                                                                                                                                                                                                                                                                                                        protocol yes http
                                                                                                                                                                                                                                                                                                                                                        • http
                                                                                                                                                                                                                                                                                                                                                        • https
                                                                                                                                                                                                                                                                                                                                                        Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                                                        host yes
                                                                                                                                                                                                                                                                                                                                                          IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                                                          password no
                                                                                                                                                                                                                                                                                                                                                            Password used to login to the switch
                                                                                                                                                                                                                                                                                                                                                            type yes
                                                                                                                                                                                                                                                                                                                                                            • cdp
                                                                                                                                                                                                                                                                                                                                                            • lldp
                                                                                                                                                                                                                                                                                                                                                            Specify neighbor protocol on how information should be gathered from switch

                                                                                                                                                                                                                                                                                                                                                            Examples

                                                                                                                                                                                                                                                                                                                                                            # retrieve cdp neighbors
                                                                                                                                                                                                                                                                                                                                                            - nxos_get_neighbors: type=cdp host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                            # retrieve lldp neighbors
                                                                                                                                                                                                                                                                                                                                                            - nxos_get_neighbors: type=lldp host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                            Notes

                                                                                                                                                                                                                                                                                                                                                            • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                                            • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                                                            nxos_ntp

                                                                                                                                                                                                                                                                                                                                                            Manages core NTP configuration

                                                                                                                                                                                                                                                                                                                                                            • Synopsis
                                                                                                                                                                                                                                                                                                                                                            • Options
                                                                                                                                                                                                                                                                                                                                                            • Examples

                                                                                                                                                                                                                                                                                                                                                            Synopsis

                                                                                                                                                                                                                                                                                                                                                            Manages core NTP configuration

                                                                                                                                                                                                                                                                                                                                                            Options

                                                                                                                                                                                                                                                                                                                                                            Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                                                            username no
                                                                                                                                                                                                                                                                                                                                                              Username used to login to the switch
                                                                                                                                                                                                                                                                                                                                                              password no
                                                                                                                                                                                                                                                                                                                                                                Password used to login to the switch
                                                                                                                                                                                                                                                                                                                                                                source_addr no
                                                                                                                                                                                                                                                                                                                                                                  Local source address from which NTP messages are sent
                                                                                                                                                                                                                                                                                                                                                                  prefer no
                                                                                                                                                                                                                                                                                                                                                                  • enabled
                                                                                                                                                                                                                                                                                                                                                                  • disabled
                                                                                                                                                                                                                                                                                                                                                                  Makes given NTP server or peer the preferred NTP server or peer for the device
                                                                                                                                                                                                                                                                                                                                                                  host yes
                                                                                                                                                                                                                                                                                                                                                                    IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                                                                    protocol no http
                                                                                                                                                                                                                                                                                                                                                                    • http
                                                                                                                                                                                                                                                                                                                                                                    • https
                                                                                                                                                                                                                                                                                                                                                                    Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                                                                    server no
                                                                                                                                                                                                                                                                                                                                                                      Network address of NTP server
                                                                                                                                                                                                                                                                                                                                                                      state yes present
                                                                                                                                                                                                                                                                                                                                                                      • present
                                                                                                                                                                                                                                                                                                                                                                      • absent
                                                                                                                                                                                                                                                                                                                                                                      Manage the state of the resource
                                                                                                                                                                                                                                                                                                                                                                      vrf_name no
                                                                                                                                                                                                                                                                                                                                                                        Makes the device communicate with the given NTP server or peer over a specific VRF
                                                                                                                                                                                                                                                                                                                                                                        peer no
                                                                                                                                                                                                                                                                                                                                                                          Network address of NTP peer
                                                                                                                                                                                                                                                                                                                                                                          key_id no
                                                                                                                                                                                                                                                                                                                                                                            Authentication key identifier to use with given NTP server or peer
                                                                                                                                                                                                                                                                                                                                                                            source_int no
                                                                                                                                                                                                                                                                                                                                                                              Local source interface from which NTP messages are sent

                                                                                                                                                                                                                                                                                                                                                                              Examples

                                                                                                                                                                                                                                                                                                                                                                              # Set NTP Server with parameters
                                                                                                                                                                                                                                                                                                                                                                              - nxos_ntp: server=1.2.3.4 key_id=32 prefer=enabled host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                              Notes

                                                                                                                                                                                                                                                                                                                                                                              • At most one of server or peer parameters may be given.

                                                                                                                                                                                                                                                                                                                                                                              • At most one of source_addr and source_int parameters may be given.

                                                                                                                                                                                                                                                                                                                                                                              • When state=absent, a given NTP server or peer will be removed, regardless of other supplied parameters.

                                                                                                                                                                                                                                                                                                                                                                              • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                                                              • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                                                                              nxos_vrrp

                                                                                                                                                                                                                                                                                                                                                                              Manages VRRP configuration on NX-API enabled devices

                                                                                                                                                                                                                                                                                                                                                                              • Synopsis
                                                                                                                                                                                                                                                                                                                                                                              • Options
                                                                                                                                                                                                                                                                                                                                                                              • Examples

                                                                                                                                                                                                                                                                                                                                                                              Synopsis

                                                                                                                                                                                                                                                                                                                                                                              Manages VRRP configuration on NX-API enabled devices

                                                                                                                                                                                                                                                                                                                                                                              Options

                                                                                                                                                                                                                                                                                                                                                                              Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                                                                              username no
                                                                                                                                                                                                                                                                                                                                                                                Username used to login to the switch
                                                                                                                                                                                                                                                                                                                                                                                group yes
                                                                                                                                                                                                                                                                                                                                                                                  vrrp group number
                                                                                                                                                                                                                                                                                                                                                                                  state yes present
                                                                                                                                                                                                                                                                                                                                                                                  • present
                                                                                                                                                                                                                                                                                                                                                                                  • absent
                                                                                                                                                                                                                                                                                                                                                                                  Specify desired state of the resource
                                                                                                                                                                                                                                                                                                                                                                                  vip yes
                                                                                                                                                                                                                                                                                                                                                                                    hsrp virtual IP address
                                                                                                                                                                                                                                                                                                                                                                                    auth no
                                                                                                                                                                                                                                                                                                                                                                                      clear text authentication string
                                                                                                                                                                                                                                                                                                                                                                                      priority no
                                                                                                                                                                                                                                                                                                                                                                                        vrrp priority
                                                                                                                                                                                                                                                                                                                                                                                        host yes
                                                                                                                                                                                                                                                                                                                                                                                          IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                                                                                          interface yes
                                                                                                                                                                                                                                                                                                                                                                                            Full name of interface that is being managed for vrrp
                                                                                                                                                                                                                                                                                                                                                                                            protocol no http
                                                                                                                                                                                                                                                                                                                                                                                            • http
                                                                                                                                                                                                                                                                                                                                                                                            • https
                                                                                                                                                                                                                                                                                                                                                                                            Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                                                                                            password no
                                                                                                                                                                                                                                                                                                                                                                                              Password used to login to the switch

                                                                                                                                                                                                                                                                                                                                                                                              Examples

                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                              # ensure vrrp group 100 and vip 10.1.100.1 is on vlan10
                                                                                                                                                                                                                                                                                                                                                                                              - nxos_vrrp: interface=vlan10 group=100 vip=10.1.100.1 host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                              # ensure removal of the vrrp group config # vip is required to ensure the user knows what they are removing
                                                                                                                                                                                                                                                                                                                                                                                              - nxos_vrrp: interface=vlan10 group=100 vip=10.1.100.1 state=absent host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                              # re-config with more params
                                                                                                                                                                                                                                                                                                                                                                                              - nxos_vrrp: interface=vlan10 group=100 vip=10.1.100.1 preempt=false priority=130 auth=AUTHKEY host={{ inventory_hostname }}
                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                              Notes

                                                                                                                                                                                                                                                                                                                                                                                              • VRRP feature needs to be enabled first on the system

                                                                                                                                                                                                                                                                                                                                                                                              • SVIs must exist before using this module

                                                                                                                                                                                                                                                                                                                                                                                              • Interface must be a L3 port before using this module

                                                                                                                                                                                                                                                                                                                                                                                              • state=absent removes the vrrp group if it exists on the device

                                                                                                                                                                                                                                                                                                                                                                                              • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                                                                              • Using the username and password params will override the .netauth file


                                                                                                                                                                                                                                                                                                                                                                                              nxos_snmp_contact

                                                                                                                                                                                                                                                                                                                                                                                              Manages SNMP contact info

                                                                                                                                                                                                                                                                                                                                                                                              • Synopsis
                                                                                                                                                                                                                                                                                                                                                                                              • Options
                                                                                                                                                                                                                                                                                                                                                                                              • Examples

                                                                                                                                                                                                                                                                                                                                                                                              Synopsis

                                                                                                                                                                                                                                                                                                                                                                                              Manages SNMP contact information

                                                                                                                                                                                                                                                                                                                                                                                              Options

                                                                                                                                                                                                                                                                                                                                                                                              Parameter required default choices comments
                                                                                                                                                                                                                                                                                                                                                                                              username no
                                                                                                                                                                                                                                                                                                                                                                                                Username used to login to the switch
                                                                                                                                                                                                                                                                                                                                                                                                protocol no http
                                                                                                                                                                                                                                                                                                                                                                                                • http
                                                                                                                                                                                                                                                                                                                                                                                                • https
                                                                                                                                                                                                                                                                                                                                                                                                Dictates connection protocol to use for NX-API
                                                                                                                                                                                                                                                                                                                                                                                                host yes
                                                                                                                                                                                                                                                                                                                                                                                                  IP Address or hostname (resolvable by Ansible control host) of the target NX-API enabled switch
                                                                                                                                                                                                                                                                                                                                                                                                  state yes present
                                                                                                                                                                                                                                                                                                                                                                                                  • present
                                                                                                                                                                                                                                                                                                                                                                                                  • absent
                                                                                                                                                                                                                                                                                                                                                                                                  Manage the state of the resource
                                                                                                                                                                                                                                                                                                                                                                                                  contact yes
                                                                                                                                                                                                                                                                                                                                                                                                    contact information
                                                                                                                                                                                                                                                                                                                                                                                                    password no
                                                                                                                                                                                                                                                                                                                                                                                                      Password used to login to the switch

                                                                                                                                                                                                                                                                                                                                                                                                      Examples

                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                      Notes

                                                                                                                                                                                                                                                                                                                                                                                                      • state=absent removes the contact configuration if it is configured

                                                                                                                                                                                                                                                                                                                                                                                                      • While username and password are not required params, they are if you are not using the .netauth file. .netauth file is recommended as it will clean up the each task in the playbook by not requiring the username and password params for every tasks.

                                                                                                                                                                                                                                                                                                                                                                                                      • Using the username and password params will override the .netauth file



                                                                                                                                                                                                                                                                                                                                                                                                      Created by Network to Code, LLC For: 2015