New in version 2.1.
Deprecated in 2.2. Use ios_config instead
Manages Cisco IOS network device configurations over SSH. This module allows implementers to work with the device running-config. It provides a way to push a set of commands onto a network device by evaluating 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.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| auth_pass | no | none | Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead. |
|
| authorize | no |
| Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead. |
|
| 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. 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 not to consider the current device 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 | yes |
| The module, by default, will collect the current device running-config to use as a base for comparison to the commands in src. Setting this value to true will cause the command issued to add any necessary flags to collect all defaults as well as the device configuration. If the destination device does not support such a flag, this argument is silently ignored. |
|
| password | no | Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. |
||
| port | no | 22 | Specifies the port to use when building the connection to the remote. device. |
|
| provider | no | Convenience method that allows all ios 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 | yes | 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 first search for the source file in role or playbook root folder in templates unless a full path to the file is given. |
||
| ssh_keyfile | no | Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
| timeout | no | 10 | Specifies idle timeout for the connection, in seconds. Useful if the console freezes before continuing. For example when saving configurations. |
|
| username | no | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. |
- name: push a configuration onto the device
ios_template:
host: hostname
username: foo
src: config.j2
- name: forceable push a configuration onto the device
ios_template:
host: hostname
username: foo
src: config.j2
force: yes
- name: provide the base configuration for comparison
ios_template:
host: hostname
username: foo
src: candidate_config.txt
config: current_config.txt
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 | when not check_mode | list | ['...', '...'] |
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/ios_template_module.html