Class: Ansible::Ruby::Modules::Ops_config

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb

Overview

OpenSwitch configurations use a simple block indent file sytanx for segementing configuration into sections. This module provides an implementation for working with ops configuration sections in a deterministic way.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #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 changed 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 changed 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.



21
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb', line 21

attribute :after

#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



18
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb', line 18

attribute :before

#config ⇒ Object?

Returns 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(config) argument allows the implementer to pass in the configuruation to use as the base config for comparision.

Returns:

  • (Object, nil) —

    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(config) argument allows the implementer to pass in the configuruation to use as the base config for comparision.



36
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb', line 36

attribute :config

#force ⇒ Boolean?

Returns The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured.

Returns:

  • (Boolean, nil) —

    The force argument instructs the module to not consider the current devices running-config. When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured.



32
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb', line 32

attribute :force

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

Returns:

  • (Object) —

    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.



11
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb', line 11

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. Finally if match is set to I(exact), command lines must be an equal match.

Returns:

  • (:line, :strict, :exact, 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. Finally if match is set to I(exact), command lines must be an equal match.



24
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb', line 24

attribute :match

#parents ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



15
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_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



28
 
# File 'lib/ansible/ruby/modules/generated/core/network/openswitch/ops_config.rb', line 28

attribute :replace