module – Manage Extreme VOSS configuration sections


This module is part of the collection (version 5.0.2).

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

To use it in a playbook, specify:


  • Extreme VOSS configurations use a simple flat text file syntax. This module provides an implementation for working with EXOS configuration lines in a deterministic way.

Aliases: network.voss.voss_config






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.



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.


  • false ← (default)

  • true



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.



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.



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 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 verbose.


  • false ← (default)

  • true



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.


  • "running"

  • "startup"

  • "intended"



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.



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.


aliases: commands


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.


  • "line" ← (default)

  • "strict"

  • "exact"

  • "none"



The parent line that uniquely identifies the section the commands should be checked against. If this argument is omitted, the commands are checked against the set of top level or global commands. Note that VOSS configurations only support one level of nested 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.


  • "line" ← (default)

  • "block"


aliases: config


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.



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 behavior. If the argument is set to always, then the running-config will always be saved and the modified flag will always be set to True. If the argument is set to modified, then the running-config will only be saved if it has changed since the last save to startup-config. If the argument is set to never, the running-config will never be saved. If the argument is set to changed, then the running-config will only be saved if the task has made a change.


  • "always"

  • "never" ← (default)

  • "modified"

  • "changed"



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.



  • Tested against VOSS 7.0.0

  • Abbreviated commands are NOT idempotent, see Network FAQ.


- name: Configure system name
    lines: prompt "{{ inventory_hostname }}"

- name: Configure interface settings
      - name "ServerA"
    backup: true
    parents: interface GigabitEthernet 1/1

- name: Check the running-config against master config
    diff_against: intended
    intended_config: "{{ lookup('file', 'master.cfg') }}"

- name: Check the startup-config against the running-config
    diff_against: startup
      - qos queue-profile .*

- name: Save running to startup when modified
    save_when: modified

- name: Configurable backup path
    backup: true
      filename: backup.cfg
      dir_path: /home/user

Return Values

Common return values are documented here, the following are the fields unique to this module:





The full path to the backup file

Returned: when backup is yes

Sample: "/playbooks/ansible/backup/vsp200_config.2018-08-21@15:00:21"


list / elements=string

The set of commands that will be pushed to the remote device

Returned: always

Sample: ["interface GigabitEthernet 1/1", "name \"ServerA\"", "exit"]


list / elements=string

The set of commands that will be pushed to the remote device

Returned: always

Sample: ["prompt \"VSP200\""]


  • Lindsay Hill (@LindsayHill)