community.network.ironware_config module – Manage configuration sections on Extreme Ironware devices
Note
This module is part of the community.network collection (version 5.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.ironware_config.
Synopsis
Extreme Ironware configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with Ironware configuration sections in a deterministic way.
Parameters
Parameter |
Comments |
|---|---|
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. |
|
Deprecated Starting with Ansible 2.7 we recommend using For more information please see the IronWare Platform Options guide. 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 Choices:
|
|
This argument will cause the module to create a full backup of the current Choices:
|
|
This is a dict object containing configurable options related to backup file path. The value of this option is read only when |
|
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 |
|
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> |
|
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 |
|
This argument specifies the update method to use when applying the configuration changes to the remote node. If the value is set to merge the configuration updates are merged with the running- config. If the value is set to check, no changes are made to the remote host. Choices:
|
|
The |
|
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. |
|
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. Choices:
|
|
The ordered set of parents that uniquely identify the section 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. |
|
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 Choices:
|
|
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 Choices:
|
|
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 update argument controls how the configuration statements are processed on the remote device. Valid choices for the update argument are merge and check. When the argument is set to merge, the configuration changes are merged with the current device running configuration. When the argument is set to check the configuration updates are determined but not actually configured on the remote device. Choices:
|
Notes
Note
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
Examples
- name: Run commands that should be configured in the section
community.network.ironware_config:
lines:
- port-name test
- enable
- load-interval 30
- rate-limit input broadcast unknown-unicast multicast 521216 64000
parents: ['interface ethernet 1/2']
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The full path to the backup file Returned: when backup is yes Sample: |
|
The set of commands that will be pushed to the remote device Returned: always Sample: |