Documentation

nxos_template - Manage Cisco NXOS device configurations

New in version 2.1.

Synopsis

Manages network device configurations over SSH or NXAPI. This module allows implementors to work with the device running-config. It provides a way to push a set of commands onto a network device by evaluting the current running-config and only pushing configuration commands that are not already configured. The config source can be a set of commands or a template.

Options

parameter required default choices comments
backup
no
  • true
  • false
When this argument is configured true, the module will backup the running-config from the node prior to making any changes. The backup file will be written to backup_{{ hostname }} in the root of the playbook directory.
config
no
    The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The config argument allows the implementer to pass in the configuruation to use as the base config for comparision.
    force
    no
    • true
    • false
    The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of src into the device without first checking if already configured.
    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.
      include_defaults
      no
      • true
      • false
      The module, by default, will collect the current device running-config to use as a base for comparision to the commands in src. Setting this value to true will cause the module to issue the command `show running-config all` to include all device settings.
      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.
            src
            no
              The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.
              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.
                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: push a configuration onto the device
                      nxos_template:
                        src: config.j2
                    
                    - name: forceable push a configuration onto the device
                      nxos_template:
                        src: config.j2
                        force: yes
                    
                    - name: provide the base configuration for comparision
                      nxos_template:
                        src: candidate_config.txt
                        config: current_config.txt
                    

                    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
                    updates The set of commands that will be pushed to the remote device always list ['...', '...']
                    responses The set of responses from issuing the commands on the device list ['...', '...']


                    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.