Documentation

nxos_nxapi - Manage NXAPI configuration on an NXOS device.

New in version 2.1.

Synopsis

Use to enable or disable NXAPI access, set the port and state of http and https servers, and enable or disable the sandbox. When enabling NXAPI access the default is to enable HTTP on port 80, enable HTTPS on port 443, and enable the web based UI sandbox. Use the options below to override the default configuration.

Options

parameter required default choices comments
host
 yes
    Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
    http
    		 no True
      Enable/disable HTTP server.

      aliases: enable_http
      http_port
      		 no 80
        Port on which the HTTP server will listen.
        https
        		 no True
          Enable/disable HTTPS server.

          aliases: enable_https
          https_port
          		 no 443
            Port on which the HTTPS server will listen.
            password
            		 no
              Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
              port
              		 no 0 (use common port)
                Specifies the port to use when buiding the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the approriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
                provider
                		 no
                  Convience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
                  sandbox
                  		 no True
                    Enable/disable NXAPI web based UI for entering commands.

                    aliases: enable_sandbox
                    ssh_keyfile
                    		 no
                      Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
                      state
                      		 no started
                      • started
                      • stopped
                      Set to started or stopped. A state of started will enable NXAPI access, and a state of stopped will disable or shutdown all NXAPI access.
                      transport
                      		 yes cli
                        Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
                        use_ssl
                        		 no
                        • yes
                        • no
                        Configures the transport to use SSL if set to true only when the transport argument is configured as nxapi. If the transport argument is not nxapi, this value is ignored
                        username
                        		 no
                          Configures the usename to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

                          Examples

                          - name: Enable NXAPI access with default configuration
  nxos_nxapi:
      provider: {{ provider }}

- name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled
  nxos_nxapi:
      enable_http: false
      https_port: 9443
      enable_sandbox: no
      provider: {{ provider }}

- name: shutdown NXAPI access
  nxos_nxapi:
      state: stopped
      provider: {{ provider }}

                          Return Values

                          Common return values are documented here Common Return Values, the following are the fields unique to this module:

                          name description returned type sample
                          commands ['Set of commands to be executed on remote device. If run in check mode, commands will not be executed.'] always list ['nxapi feature', 'nxapi http port 8080']
                          changed ['Indicates if commands were sent to the device.'] always boolean False
                          _config ['Configuration found on the device prior ro any commands being executed.'] always object {'...': None}


                          This is a Core Module

                          For more information on what this means please read Core Modules

                          For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.