Class: Ansible::Ruby::Modules::Ce_config

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

Overview

Huawei CloudEngine configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with CloudEngine configuration sections in a deterministic way. This module works with CLI transports.

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

#after ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



24
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 24

attribute :after

#backup ⇒ :yes, ...

Returns This argument will cause the module to create a full backup of the current C(current-configuration) from the remote device before any changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created.

Returns:

  • (:yes, :no, nil) —

    This argument will cause the module to create a full backup of the current C(current-configuration) from the remote device before any changes are made. The backup file is written to the C(backup) folder in the playbook root directory. If the directory does not exist, it is created.



35
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 35

attribute :backup

#before ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



21
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 21

attribute :before

#config ⇒ Object?

Returns The module, by default, will connect to the remote device and retrieve the current current-configuration 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-configuration for every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison.

Returns:

  • (Object, nil) —

    The module, by default, will connect to the remote device and retrieve the current current-configuration 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-configuration for every task in a playbook. The I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison.



39
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 39

attribute :config

#defaults ⇒ :yes, ...

Returns The I(defaults) argument will influence how the current-configuration is collected from the device. When the value is set to true, the command used to collect the current-configuration is append with the all keyword. When the value is set to false, the command is issued without the all keyword.

Returns:

  • (:yes, :no, nil) —

    The I(defaults) argument will influence how the current-configuration is collected from the device. When the value is set to true, the command used to collect the current-configuration is append with the all keyword. When the value is set to false, the command is issued without the all keyword.



42
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 42

attribute :defaults

#lines ⇒ Object?

Returns 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 current-configuration. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.

Returns:

  • (Object, nil) —

    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 current-configuration. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.



12
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 12

attribute :lines

#match ⇒ :line, ...

Returns 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 current-configuration on the remote device.

Returns:

  • (:line, :strict, :exact, :none, nil) —

    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 current-configuration on the remote device.



27
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 27

attribute :match

#parents ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



15
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 15

attribute :parents

#replace ⇒ :line, ...

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

Returns:

  • (:line, :block, nil) —

    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.



31
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 31

attribute :replace

#save ⇒ :yes, ...

Returns The C(save) argument instructs the module to save the current-configuration to saved-configuration. This operation is performed after any changes are made to the current running config. If no changes are made, the configuration is still saved to the startup config. This option will always cause the module to return changed.

Returns:

  • (:yes, :no, nil) —

    The C(save) argument instructs the module to save the current-configuration to saved-configuration. This operation is performed after any changes are made to the current running config. If no changes are made, the configuration is still saved to the startup config. This option will always cause the module to return changed.



46
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 46

attribute :save

#src ⇒ Object?

Returns The I(src) argument provides a path to the configuration file to load into the remote system. The path can either be a full system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the I(lines) and I(parents) arguments.

Returns:

  • (Object, nil) —

    The I(src) argument provides a path to the configuration file to load into the remote system. The path can either be a full system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the I(lines) and I(parents) arguments.



18
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_config.rb', line 18

attribute :src