Try SpotterManage Arista EOS configuration sections
| "added in version" 2.1 of ansible.builtin"
Authors: Peter Sprygada (@privateip)
preview | supported by network
pipInstall with pip install ansible==2.6.10
Arista EOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with EOS configuration sections in a deterministic way. This module works with either CLI or eAPI transports.
- name: configure top level settings
eos_config:
lines: hostname {{ inventory_hostname }}
- name: diff against a provided master config
eos_config:
diff_against: config
config: "{{ lookup('file', 'master.cfg') }}"
- name: load an acl into the device
eos_config:
lines:
- 10 permit ip 1.1.1.1/32 any log
- 20 permit ip 2.2.2.2/32 any log
- 30 permit ip 3.3.3.3/32 any log
- 40 permit ip 4.4.4.4/32 any log
parents: ip access-list test
before: no ip access-list test
replace: block
- name: load configuration from file
eos_config:
src: eos.cfg
- name: diff the running config against a master config
eos_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: for idempotency, use full-form commands
eos_config:
lines:
# - shut
- shutdown
# parents: int eth1
parents: interface Ethernet1
src:
description:
- The I(src) argument provides a path to the configuration file to load into the remote
system. The path can either be a full system path to the configuration file if
the value starts with / or relative to the root of the implemented role or playbook.
This argument is mutually exclusive with the I(lines) and I(parents) arguments.
It can be a Jinja2 template as well. src file must have same indentation as a live
switch config. Arista EOS device config has 3 spaces indentation.
version_added: '2.2'
version_added_collection: ansible.builtin
save:
default: 'no'
description:
- The C(save) argument instructs the module to save the running-config to startup-config. This
operation is performed after any changes are made to the current running config. If
no changes are made, the configuration is still saved to the startup config. This
option will always cause the module to return changed.
- This option is deprecated as of Ansible 2.4 and will be removed in Ansible 2.8,
use C(save_when) instead.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
after:
description:
- The ordered set of commands to append to the end of the command stack if a change
needs to be made. Just like with I(before) this allows the playbook designer to
append a set of commands to be executed after the command set.
force:
default: 'no'
description:
- 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 I(src) into the
device without first checking if already configured.
- Note this argument should be considered deprecated. To achieve the equivalent,
set the C(match=none) which is idempotent. This argument will be removed in Ansible
2.6.
type: bool
lines:
aliases:
- commands
description:
- The ordered set of commands that should be configured in the section. The commands
must be the exact same commands as found in the device running-config. Be sure
to note the configuration command syntax as some commands are automatically modified
by the device config parser.
match:
choices:
- line
- strict
- exact
- none
default: line
description:
- Instructs the module on the way to perform the matching of the set of commands against
the current device config. If match is set to I(line), commands are matched line
by line. If match is set to I(strict), command lines are matched with respect to
position. If match is set to I(exact), command lines must be an equal match. Finally,
if match is set to I(none), the module will not attempt to compare the source configuration
with the running configuration on the remote device.
backup:
default: 'no'
description:
- This argument will cause the module to create a full backup of the current C(running-config)
from the remote device before any changes are made. The backup file is written
to the C(backup) folder in the playbook root directory or role root directory, if
playbook is part of an ansible role. If the directory does not exist, it is created.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
before:
description:
- The ordered set of commands to push on to the command stack if a change needs to
be made. This allows the playbook designer the opportunity to perform configuration
commands prior to pushing any changes without affecting how the set of commands
are matched against the system.
parents:
description:
- The ordered set of parents that uniquely identify the section or hierarchy the commands
should be checked against. If the parents argument is omitted, the commands are
checked against the set of top level or global commands.
replace:
choices:
- line
- block
- config
default: line
description:
- Instructs the module on the way to perform the configuration on the device. If
the replace argument is set to I(line) then the modified lines are pushed to the
device in configuration mode. If the replace argument is set to I(block) then the
entire command block is pushed to the device in configuration mode if any line is
not correct.
defaults:
default: 'no'
description:
- The I(defaults) argument will influence how the running-config is collected from
the device. When the value is set to true, the command used to collect the running-config
is append with the all keyword. When the value is set to false, the command is
issued without the all keyword
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for eAPI.'
- This option will be removed in a release after 2022-06-01.
- For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
required: true
type: str
password:
description:
- Specifies the password to use to authenticate the connection to the remote device. This
is a common argument used for either I(cli) or I(eapi) transports. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
default: 0
description:
- Specifies the port to use when building the connection to the remote device. This
value applies to either I(cli) or I(eapi).
- The port value will default to the appropriate transport common port if none
is provided in the task (cli=22, http=80, https=443).
type: int
ssh_keyfile:
description:
- Specifies the SSH keyfile to use to authenticate the connection to the remote
device. This argument is only used for I(cli) transports. If the value is not
specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead.
type: path
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device for
either connecting or sending commands. If the timeout is exceeded before the
operation is completed, the module will error.
type: int
transport:
choices:
- cli
- eapi
default: cli
description:
- Configures the transport connection to use when connecting to the remote device.
required: true
type: str
use_proxy:
default: true
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
ignored.
type: bool
use_ssl:
default: true
description:
- Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=eapi). If
the transport argument is not eapi, this value is ignored.
type: bool
username:
description:
- Configures the username to use to authenticate the connection to the remote
device. This value is used to authenticate either the CLI login or the eAPI
authentication depending on which transport is used. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will
be used instead.
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates. If the transport
argument is not eapi, this value is ignored.
type: bool
type: dict
save_when:
choices:
- always
- never
- modified
- changed
default: never
description:
- When changes are made to the device running-configuration, the changes are not copied
to non-volatile storage by default. Using this argument will change that before. If
the argument is set to I(always), then the running-config will always be copied
to the startup-config and the I(modified) flag will always be set to True. If the
argument is set to I(modified), then the running-config will only be copied to the
startup-config if it has changed since the last save to startup-config. If the
argument is set to I(never), the running-config will never be copied to the startup-config.
If the argument is set to I(changed), then the running-config will only be copied
to the startup-config if the task has made a change. I(changed) was added in Ansible
2.5.
version_added: '2.4'
version_added_collection: ansible.builtin
diff_against:
choices:
- startup
- running
- intended
- session
default: session
description:
- When using the C(ansible-playbook --diff) command line argument the module can generate
diffs against different sources.
- When this option is configure as I(startup), the module will return the diff of
the running-config against the startup-config.
- When this option is configured as I(intended), the module will return the diff of
the running-config against the configuration provided in the C(intended_config)
argument.
- When this option is configured as I(running), the module will return the before
and after diff of the running-config with respect to any changes made to the device
configuration.
- When this option is configured as C(session), the diff returned will be based on
the configuration session.
version_added: '2.4'
version_added_collection: ansible.builtin
running_config:
aliases:
- config
description:
- 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 I(running_config) argument allows the implementer
to pass in the configuration to use as the base config for this module.
version_added: '2.4'
version_added_collection: ansible.builtin
intended_config:
description:
- The C(intended_config) provides the master configuration that the node should conform
to and is used to check the final running-config against. This argument will not
modify any settings on the remote device and is strictly used to check the compliance
of the current device's configuration against. When specifying this argument, the
task should also modify the C(diff_against) value and set it to I(intended).
version_added: '2.4'
version_added_collection: ansible.builtin
diff_ignore_lines:
description:
- Use this argument to specify one or more lines that should be ignored during the
diff. This is used for lines in the configuration that are automatically updated
by the system. This argument takes a list of regular expressions or exact line
matches.
version_added: '2.4'
version_added_collection: ansible.builtin
backup_path: description: The full path to the backup file returned: when backup is yes sample: /playbooks/ansible/backup/eos_config.2016-07-16@22:28:34 type: string commands: description: The set of commands that will be pushed to the remote device returned: always sample: - hostname switch01 - interface Ethernet1 - no shutdown type: list updates: description: The set of commands that will be pushed to the remote device returned: always sample: - hostname switch01 - interface Ethernet1 - no shutdown type: list