hs0210 / hs0210.fos / 1.0.5 / module / fos_config Manage FUJITSU PSWITCH configuration sections | "added in version" 2.10 of hs0210.fos" Authors: unknown preview | supported by networkhs0210.fos.fos_config (1.0.5) — module
Install with ansible-galaxy collection install hs0210.fos:==1.0.5
collections: - name: hs0210.fos version: 1.0.5
fos configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with PSWITCH configuration sections in a deterministic way.
- name: configure interface settings fos_config: lines: - lldp transmit - lldp receive parents: interface 0/16
- name: save running config to startup config fos_config: save: True
- name: backup configuration file fos_config: backup: yes backup_options: filename: backup.cfg dir_path: /home/user
src: description: - Specifies the source path to the file that contains the configuration or configuration template to load and all the configuration will be send to the device. The path to the source file can either be the full path on the Ansible control host or a relative path from the playbook. This argument is mutually exclusive with I(lines), I(parents). When there are multiple settings, exit cannot be less in the src file. type: path save: default: 'no' description: - The C(save) argument instructs the module to save the running- config to the startup-config at the conclusion of the module running. If check mode is specified, this argument is ignored. type: bool 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. type: list 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 mode Global Config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser. type: list 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. type: str 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. If the C(backup_options) value is not given, 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 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. type: list 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. type: list replace: choices: - line - block 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. type: str backup_options: description: - This is a dict object containing configurable options related to backup file path. The value of this option is read only when C(backup) is set to I(yes), if C(backup) is set to I(no) this option will be silently ignored. suboptions: dir_path: description: - This option provides the path ending with directory name in which the backup configuration file will be stored. The backup path needs to be created in advance. type: path filename: description: - The filename to be used to store the backup configuration. If the the filename is not given it will be generated based on current time and date in format defined by config.<current-date>@<current-time> type: str type: dict 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 comparison. type: str