Class: Ansible::Ruby::Modules::Vyos_config

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb

Overview

This module provides configuration file management of VyOS devices. It provides arguments for managing both the configuration file and state of the active configuration. All configuration statements are based on ‘set` and `delete` commands in the device configuration.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#backup ⇒ :yes, ...

Returns The C(backup) argument will backup the current devices active configuration to the Ansible control host prior to making any changes. The backup file will be located in 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.

Returns:

  • (:yes, :no, nil) —

    The C(backup) argument will backup the current devices active configuration to the Ansible control host prior to making any changes. The backup file will be located in 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.



24
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb', line 24

attribute :backup

#comment ⇒ String?

Returns Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored.

Returns:

  • (String, nil) —

    Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored.



28
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb', line 28

attribute :comment

#config ⇒ Object?

Returns The C(config) argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device.

Returns:

  • (Object, nil) —

    The C(config) argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device.



32
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb', line 32

attribute :config

#lines ⇒ Array<String>, ...

Returns The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device.

Returns:

  • (Array<String>, String, nil) —

    The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device.



12
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb', line 12

attribute :lines

#match ⇒ :line, ...

Returns The C(match) argument controls the method used to match against the current active configuration. By default, the desired config is matched against the active config and the deltas are loaded. If the C(match) argument is set to C(none) the active configuration is ignored and the configuration is always loaded.

Returns:

  • (:line, :none, nil) —

    The C(match) argument controls the method used to match against the current active configuration. By default, the desired config is matched against the active config and the deltas are loaded. If the C(match) argument is set to C(none) the active configuration is ignored and the configuration is always loaded.



20
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb', line 20

attribute :match

#save ⇒ :yes, ...

Returns The C(save) argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to True, the active configuration is saved.

Returns:

  • (:yes, :no, nil) —

    The C(save) argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to True, the active configuration is saved.



35
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb', line 35

attribute :save

#src ⇒ String?

Returns The C(src) argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables.

Returns:

  • (String, nil) —

    The C(src) argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables.



16
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_config.rb', line 16

attribute :src