Class: Ansible::Ruby::Modules::Netconf_config

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

Overview

Netconf is a network management protocol developed and standardized by the IETF. It is documented in RFC 6241. This module allows the user to send a configuration XML file to a netconf device, and detects if there was a configuration change.

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



52
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 52

attribute :backup

#commit ⇒ Boolean?

Returns This boolean flag controls if the configuration changes should be committed or not after editing the candidate datastore. This option is supported only if remote Netconf server supports :candidate capability. If the value is set to I(False) commit won’t be issued after edit-config operation and user needs to handle commit or discard-changes explicitly.

Returns:

  • (Boolean, nil) —

    This boolean flag controls if the configuration changes should be committed or not after editing the candidate datastore. This option is supported only if remote Netconf server supports :candidate capability. If the value is set to I(False) commit won’t be issued after edit-config operation and user needs to handle commit or discard-changes explicitly.



60
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 60

attribute :commit

#confirm ⇒ Integer?

Returns This argument will configure a timeout value for the commit to be confirmed before it is automatically rolled back. If the C(confirm_commit) argument is set to False, this argument is silently ignored. If the value of this argument is set to 0, the commit is confirmed immediately. The remote host MUST support :candidate and :confirmed-commit capability for this option to .

Returns:

  • (Integer, nil) —

    This argument will configure a timeout value for the commit to be confirmed before it is automatically rolled back. If the C(confirm_commit) argument is set to False, this argument is silently ignored. If the value of this argument is set to 0, the commit is confirmed immediately. The remote host MUST support :candidate and :confirmed-commit capability for this option to .



36
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 36

attribute :confirm

#confirm_commit ⇒ :yes, ...

Returns This argument will execute commit operation on remote device. It can be used to confirm a previous commit.

Returns:

  • (:yes, :no, nil) —

    This argument will execute commit operation on remote device. It can be used to confirm a previous commit.



40
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 40

attribute :confirm_commit

#content ⇒ String?

Returns The configuration data as defined by the device’s data models, the value can be either in xml string format or text format. The format of the configuration should be supported by remote Netconf server.

Returns:

  • (String, nil) —

    The configuration data as defined by the device’s data models, the value can be either in xml string format or text format. The format of the configuration should be supported by remote Netconf server



13
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 13

attribute :content

#default_operation ⇒ :merge, ...

Returns The default operation for <edit-config> rpc, valid values are I(merge), I(replace) and I(none). If the default value is merge, the configuration data in the C(content) option is merged at the corresponding level in the C(target) datastore. If the value is replace the data in the C(content) option completely replaces the configuration in the C(target) datastore. If the value is none the C(target) datastore is unaffected by the configuration in the config option, unless and until the incoming configuration data uses the C(operation) operation to request a different operation.

Returns:

  • (:merge, :replace, :none, nil) —

    The default operation for <edit-config> rpc, valid values are I(merge), I(replace) and I(none). If the default value is merge, the configuration data in the C(content) option is merged at the corresponding level in the C(target) datastore. If the value is replace the data in the C(content) option completely replaces the configuration in the C(target) datastore. If the value is none the C(target) datastore is unaffected by the configuration in the config option, unless and until the incoming configuration data uses the C(operation) operation to request a different operation.



32
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 32

attribute :default_operation

#delete ⇒ :yes, ...

Returns It instructs the module to delete the configuration from value mentioned in C(target) datastore.

Returns:

  • (:yes, :no, nil) —

    It instructs the module to delete the configuration from value mentioned in C(target) datastore.



56
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 56

attribute :delete

#error_option ⇒ :"stop-on-error", ...

Returns This option control the netconf server action after a error is occured while editing the configuration. If the value is I(stop-on-error) abort the config edit on first error, if value is I(continue-on-error) it continues to process configuration data on error, error is recorded and negative response is generated if any errors occur. If value is C(rollback-on-error) it rollback to the original configuration in case any error occurs, this requires the remote Netconf server to support the :rollback-on-error capability.

Returns:

  • (:"stop-on-error", :"continue-on-error", :"rollback-on-error", nil) —

    This option control the netconf server action after a error is occured while editing the configuration. If the value is I(stop-on-error) abort the config edit on first error, if value is I(continue-on-error) it continues to process configuration data on error, error is recorded and negative response is generated if any errors occur. If value is C(rollback-on-error) it rollback to the original configuration in case any error occurs, this requires the remote Netconf server to support the :rollback-on-error capability.



44
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 44

attribute :error_option

#format ⇒ :xml, ...

Returns The format of the configuration provided as value of C(content). Accepted values are I(xml) and I(text) and the given configuration format should be supported by remote Netconf server.

Returns:

  • (:xml, :text, nil) —

    The format of the configuration provided as value of C(content). Accepted values are I(xml) and I(text) and the given configuration format should be supported by remote Netconf server.



24
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 24

attribute :format

#lock ⇒ :never, ...

Returns Instructs the module to explicitly lock the datastore specified as C(target). By setting the option value I(always) is will explicitly lock the datastore mentioned in C(target) option. It the value is I(never) it will not lock the C(target) datastore. The value I(if-supported) lock the C(target) datastore only if it is supported by the remote Netconf server.

Returns:

  • (:never, :always, :"if-supported", nil) —

    Instructs the module to explicitly lock the datastore specified as C(target). By setting the option value I(always) is will explicitly lock the datastore mentioned in C(target) option. It the value is I(never) it will not lock the C(target) datastore. The value I(if-supported) lock the C(target) datastore only if it is supported by the remote Netconf server.



28
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 28

attribute :lock

#save ⇒ Boolean?

Returns The C(save) argument instructs the module to save the configuration in C(target) datastore to the startup-config if changed and if :startup capability is supported by Netconf server.

Returns:

  • (Boolean, nil) —

    The C(save) argument instructs the module to save the configuration in C(target) datastore to the startup-config if changed and if :startup capability is supported by Netconf server.



48
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 48

attribute :save

#source_datastore ⇒ Object?

Returns Name of the configuration datastore to use as the source to copy the configuration to the datastore mentioned by C(target) option. The values can be either I(running), I(candidate), I(startup) or a remote URL.

Returns:

  • (Object, nil) —

    Name of the configuration datastore to use as the source to copy the configuration to the datastore mentioned by C(target) option. The values can be either I(running), I(candidate), I(startup) or a remote URL



21
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 21

attribute :source_datastore

#src ⇒ Object?

Returns Specifies the source path to the xml 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(xml).

Returns:

  • (Object, nil) —

    Specifies the source path to the xml 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(xml).



68
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 68

attribute :src

#target ⇒ String?

Returns Name of the configuration datastore to be edited. - auto, uses candidate and fallback to running - candidate, edit <candidate/> datastore and then commit - running, edit <running/> datastore directly.

Returns:

  • (String, nil) —

    Name of the configuration datastore to be edited. - auto, uses candidate and fallback to running - candidate, edit <candidate/> datastore and then commit - running, edit <running/> datastore directly



17
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 17

attribute :target

#validate ⇒ Symbol?

Returns This boolean flag if set validates the content of datastore given in C(target) option. For this option to work remote Netconf server shoule support :validate capability.

Returns:

  • (Symbol, nil) —

    This boolean flag if set validates the content of datastore given in C(target) option. For this option to work remote Netconf server shoule support :validate capability.



64
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_config.rb', line 64

attribute :validate