New in version 2.1.
Deprecated in 2.2. Use eos_config instead
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 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 |
|
By default when the eos_template connects to the remote device to retrieve the configuration it will issue the show running-config command. If this option is set to True then the issued command will be show running-config all . | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider |
no | A dict object containing connection details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replace |
no |
|
This argument will cause the provided configuration to be replaced on the destination node. The use of the replace argument will always cause the task to set changed to true and will implies force=true . This argument is only valid with transport=eos_local . | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 search for the source file in role or playbook root folder in templates directory. |
- name: Push a configuration onto the device eos_template: src: config.j2 - name: Forceable push a configuration onto the device eos_template: src: config.j2 force: yes - name: Provide the base configuration for comparison eos_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.