Note
This plugin is part of the cisco.ios collection (version 2.3.0).
Cisco Webex Meetings delivers over 25 billion meetings per month, offering industry-leading video and audio conferencing with sharing, chat, and more. Experience why Webex Meetings is the most trusted video conferencing solution today. Join and present from any meeting, event, or training session directly from your iPhone, iPad, or Apple Watch. Cisco IOS XR Ethernet VPN Implementation and Verification Data Sheet. Cisco IOS XR Software Release 6.0 Operational Enhancements Data Sheet. End-of-Life and End-of-Sale Notices. End-of-Sale and End-of-Life Announcement for the Cisco IOS XR Software Release 7.1 22-Mar-2021. Not only did Cisco and Apple come to terms over the precious iPhone name, but in 2010 Apple also licensed the iOS trademark from Cisco for its iPhone software. Cisco uses iOS to refer to its. Jul 21, 2021 ioscommand – Run commands on remote devices running Cisco IOS. Iosconfig – Manage Cisco IOS configuration sections. Iosfacts – Collect facts from remote devices running Cisco IOS. Iosinterface – (deprecated, removed after 2022-06-01) Manage Interface on Cisco IOS network devices. Iosinterfaces – Interfaces resource module. Cisco IOS routers support a number of banners, here they are: MOTD banner: the “message of the day” banner is presented to everyone that connects to the router.; Login banner: this one is displayed just before the authentication prompt.
To install it use: ansible-galaxycollectioninstallcisco.ios.
To use it in a playbook, specify: cisco.ios.ios_config.
Cisco IOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS configuration sections in a deterministic way.
Note
This module has a corresponding action plugin.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| after list / elements=string | The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set. | ||
| backup boolean |
| This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the 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. | |
| backup_options dictionary | This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to yes, if backup is set to no this option will be silently ignored. | ||
| dir_path path | This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory. | ||
| filename string | The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time> | ||
| before list / elements=string | 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. | ||
| defaults boolean |
| This argument specifies whether or not to collect all defaults when getting the remote device running config. When enabled, the module will get the current config by issuing the command show running-config all. | |
| diff_against string |
| When using the ansible-playbook --diff command line argument the module can generate diffs against different sources.When this option is configure as startup, the module will return the diff of the running-config against the startup-config. When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the intended_config argument.When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. | |
| diff_ignore_lines list / elements=string | 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. | ||
| intended_config string | The 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 diff_against value and set it to intended. The configuration lines for this value should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure correct diff. | ||
| lines list / elements=string | 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 to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. | ||
| match |
| 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 line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device. | |
| multiline_delimiter string | Default: | This argument is used when pushing a multiline configuration element to the IOS device. It specifies the character to use as the delimiting character. This only applies to the configuration action. | |
| parents list / elements=string | 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. | ||
| provider dictionary | Starting with Ansible 2.5 we recommend using connection: network_cli.For more information please see the IOS Platform Options guide. A dict object containing connection details. | ||
| auth_pass string | 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 boolean |
| 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. | |
| host string | 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. | ||
| password string | 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 integer | Specifies the port to use when building the connection to the remote device. | ||
| ssh_keyfile path | 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 integer | 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. | ||
| username string | 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. | ||
| replace string |
| Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct. | |
| running_config string | 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 running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. The configuration lines for this option should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff. | ||
| save_when |
| 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 always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to 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 never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change. changed was added in Ansible 2.5. | |
| src string | Specifies the source path to the file that contains the configuration or configuration template to load. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook or role root directory. This argument is mutually exclusive with lines, parents. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including the indentation to ensure idempotency and correct diff. | ||
Note
Tested against IOS 15.6
Abbreviated commands are NOT idempotent, see L (Network FAQ,../network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands).
To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation.
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Common return values are documented here, the following are the fields unique to this module:
Cisco Ios Images For Gns3
| Key | Returned | Description |
|---|---|---|
| backup_path string | when backup is yes | Sample: |
| commands | always | The set of commands that will be pushed to the remote device ['hostname foo', 'router ospf 1', 'router-id 192.0.2.1'] |
| date string | when backup is yes | Sample: |
| filename | when backup is yes and filename is not specified in backup options | The name of the backup file [email protected]:28:34 |
| shortname string | when backup is yes and filename is not specified in backup options | The full path to the backup file excluding the timestamp /playbooks/ansible/backup/ios_config |
| time string | when backup is yes | Sample: |
| updates | always | The set of commands that will be pushed to the remote device ['hostname foo', 'router ospf 1', 'router-id 192.0.2.1'] |
Cisco Ios Download
Cisco Ios Images For Gns3
Note
This plugin is part of the cisco.ios collection (version 2.3.0).
To install it use: ansible-galaxycollectioninstallcisco.ios.
To use it in a playbook, specify: cisco.ios.ios_facts.
Collects a base set of device facts from a remote device that is running IOS. This module prepends all of the base network fact keys with
ansible_net_<fact>. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.
Note
This module has a corresponding action plugin.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| available_network_resources boolean |
| When 'True' a list of network resources for which resource modules are available will be provided. | |
| gather_network_resources list / elements=string | When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces, vlans etc. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'l2_interfaces', 'vlans', 'lag_interfaces', 'lacp', 'lacp_interfaces', 'lldp_global', 'lldp_interfaces', 'l3_interfaces', 'acl_interfaces', 'static_routes', 'acls'. | ||
| gather_subset list / elements=string | Default: | When supplied, this argument restricts the facts collected to a given subset. Possible values for this argument include all, min, hardware, config, and interfaces.Specify a list of values to include a larger subset. Use a value with an initial ! to collect all facts except that subset. | |
| provider dictionary | Starting with Ansible 2.5 we recommend using connection: network_cli.For more information please see the IOS Platform Options guide. A dict object containing connection details. | ||
| auth_pass string | 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 boolean |
| 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. | |
| host string | 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. | ||
| password string | 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 integer | Specifies the port to use when building the connection to the remote device. | ||
| ssh_keyfile path | 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 integer | 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. | ||
| username string | 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. | ||
Note
Tested against IOS 15.6
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| ansible_net_all_ipv4_addresses list / elements=string | when interfaces is configured | |
| ansible_net_all_ipv6_addresses | when interfaces is configured | All IPv6 addresses configured on the device |
| ansible_net_api string | always | |
| ansible_net_config | when config is configured | The current active config from the device |
| ansible_net_filesystems list / elements=string | when hardware is configured | |
| ansible_net_filesystems_info | when hardware is configured | A hash of all file systems containing info about each file system (e.g. free and total space) |
| ansible_net_gather_network_resources list / elements=string | when the resource is configured | The list of fact for network resource subsets collected from the device |
| ansible_net_gather_subset list / elements=string | always | The list of fact subsets collected from the device |
| ansible_net_hostname string | always | |
| ansible_net_image | always | The image file the device is running |
| ansible_net_interfaces dictionary | when interfaces is configured | |
| ansible_net_iostype | always | The operating system type (IOS or IOS-XE) running on the remote device |
| ansible_net_memfree_mb integer | when hardware is configured | The available free memory on the remote device in Mb |
| ansible_net_memtotal_mb integer | when hardware is configured | |
| ansible_net_model | always | The model name returned from the device |
| ansible_net_neighbors dictionary | when interfaces is configured | The list of CDP and LLDP neighbors from the remote device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred. |
| ansible_net_python_version string | always | |
| ansible_net_serialnum | always | The serial number of the remote device |
| ansible_net_stacked_models list / elements=string | when multiple devices are configured in a stack | |
| ansible_net_stacked_serialnums | when multiple devices are configured in a stack | The serial numbers of each device in the stack |
| ansible_net_version string | always | The operating system version running on the remote device |
Authors¶
Cisco Ios/xr
Peter Sprygada (@privateip)
Sumit Jaiswal (@justjais)