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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Netconf_config

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

• #backup ⇒ :yes, ...

  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.

• #commit ⇒ Boolean^?

  This boolean flag controls if the configuration changes should be committed or not after editing the candidate datastore.

• #confirm ⇒ Integer^?

  This argument will configure a timeout value for the commit to be confirmed before it is automatically rolled back.

• #confirm_commit ⇒ :yes, ...

  This argument will execute commit operation on remote device.

• #content ⇒ String^?

  The configuration data as defined by the device’s data models, the value can be either in xml string format or text format.

• #default_operation ⇒ :merge, ...

  The default operation for <edit-config> rpc, valid values are I(merge), I(replace) and I(none).

• #delete ⇒ :yes, ...

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

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

  This option control the netconf server action after a error is occured while editing the configuration.

• #format ⇒ :xml, ...

  The format of the configuration provided as value of C(content).

• #lock ⇒ :never, ...

  Instructs the module to explicitly lock the datastore specified as C(target).

• #save ⇒ Boolean^?

  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.

• #source_datastore ⇒ Object^?

  Name of the configuration datastore to use as the source to copy the configuration to the datastore mentioned by C(target) option.

• #src ⇒ Object^?

  Specifies the source path to the xml file that contains the configuration or configuration template to load.

• #target ⇒ String^?

  Name of the configuration datastore to be edited.

• #validate ⇒ Symbol^?

  This boolean flag if set validates the content of datastore given in C(target) option.

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

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

attribute :backup

#commit ⇒ Boolean^?

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

attribute :commit

#confirm ⇒ Integer^?

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

attribute :confirm

#confirm_commit ⇒ :yes, ...

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

attribute :confirm_commit

#content ⇒ String^?

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

attribute :content

#default_operation ⇒ :merge, ...

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

attribute :default_operation

#delete ⇒ :yes, ...

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

attribute :delete

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

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

attribute :error_option

#format ⇒ :xml, ...

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

attribute :format

#lock ⇒ :never, ...

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

attribute :lock

#save ⇒ Boolean^?

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

attribute :save

#source_datastore ⇒ Object^?

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

attribute :source_datastore

#src ⇒ Object^?

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

attribute :src

#target ⇒ String^?

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

attribute :target

#validate ⇒ Symbol^?

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

attribute :validate