New in version 2.1.
Deprecated in 2.2. Use nxos_config instead.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| backup |
no |
|
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 configuration to use as the base config for comparison. | ||
| force |
no |
|
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. | |
| include_defaults |
no |
|
The module, by default, will collect the current device running-config to use as a base for comparisons 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. | |
| 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. |
- 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 comparison nxos_template: src: candidate_config.txt config: current_config.txt
Common return values are documented here 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 | when not check_mode | list | ['...', '...'] |
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.