Class: Ansible::Ruby::Modules::Ops_template

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

Overview

The OpenSwitch platform provides a library for pushing JSON structured configuration files into the current running-config. This module will read the current configuration from OpenSwitch and compare it against a provided candidate configuration. If there are changes, the candidate configuration is merged with the current configuration and pushed into OpenSwitch

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

#backup ⇒ Boolean?

Returns When this argument is configured true, the module will backup the running-config from the node prior to making any changes. The backup file will be written to backups/ in the root of the playbook directory.

Returns:

  • (Boolean, nil) —

    When this argument is configured true, the module will backup the running-config from the node prior to making any changes. The backup file will be written to backups/ in the root of the playbook directory.



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

attribute :backup

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



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

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.



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

attribute :force

#src ⇒ String

Returns The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.

Returns:

  • (String) —

    The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.



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

attribute :src