Class: Ansible::Ruby::Modules::Iosxr_config

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

Overview

Cisco IOS XR configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS XR 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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#admin ⇒ :yes, ...

Returns Enters into administration configuration mode for making config changes to the device.

Returns:

  • (:yes, :no, nil) —

    Enters into administration configuration mode for making config changes to the device.



53
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 53

attribute :admin

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



27
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 27

attribute :after

#backup ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



45
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 45

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.



24
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 24

attribute :before

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



49
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 49

attribute :comment

#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 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 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 configuration to use as the base config for comparison.



42
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 42

attribute :config

#force ⇒ :yes, ...

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.,Note this argument should be considered deprecated. To achieve the equivalent, set the C(match=none) which is idempotent. This argument will be removed in a future release.

Returns:

  • (:yes, :no, 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.,Note this argument should be considered deprecated. To achieve the equivalent, set the C(match=none) which is idempotent. This argument will be removed in a future release.



38
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 38

attribute :force

#label ⇒ Object?

Returns Allows a commit label to be specified to be included when the configuration is committed. A valid label must begin with an alphabet and not exceed 30 characters, only alphabets, digits, hyphens and underscores are allowed. If the configuration is not changed or committed, this argument is ignored.

Returns:

  • (Object, nil) —

    Allows a commit label to be specified to be included when the configuration is committed. A valid label must begin with an alphabet and not exceed 30 characters, only alphabets, digits, hyphens and underscores are allowed. If the configuration is not changed or committed, this argument is ignored.



57
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 57

attribute :label

#lines ⇒ Array<String>, ...

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:

  • (Array<String>, String, 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 running-config. 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/iosxr/iosxr_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 running 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 running configuration on the remote device.



30
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 30

attribute :match

#parents ⇒ String?

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:

  • (String, 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.



16
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 16

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, :config, 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.



34
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 34

attribute :replace

#src ⇒ String?

Returns 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 I(lines), I(parents).

Returns:

  • (String, nil) —

    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 I(lines), I(parents).



20
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_config.rb', line 20

attribute :src