Class: Ansible::Ruby::Modules::Netconf_rpc

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/netconf/netconf_rpc.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 execute NETCONF RPC requests as defined by IETF RFC standards as well as proprietary requests.

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

#content ⇒ Hash, ...

Returns This argument specifies the optional request content (all RPC attributes). The I(content) value can either be provided as XML formatted string or as dictionary.

Returns:

  • (Hash, String, nil) —

    This argument specifies the optional request content (all RPC attributes). The I(content) value can either be provided as XML formatted string or as dictionary.



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

attribute :content

#display ⇒ :json, ...

Returns Encoding scheme to use when serializing output from the device. The option I(json) will serialize the output as JSON data. If the option value is I(json) it requires jxmlease to be installed on control node. The option I(pretty) is similar to received XML response but is using human readable format (spaces, new lines). The option value I(xml) is similar to received XML response but removes all XML namespaces.

Returns:

  • (:json, :pretty, :xml, nil) —

    Encoding scheme to use when serializing output from the device. The option I(json) will serialize the output as JSON data. If the option value is I(json) it requires jxmlease to be installed on control node. The option I(pretty) is similar to received XML response but is using human readable format (spaces, new lines). The option value I(xml) is similar to received XML response but removes all XML namespaces.



25
 
# File 'lib/ansible/ruby/modules/generated/network/netconf/netconf_rpc.rb', line 25

attribute :display

#rpc ⇒ String?

Returns This argument specifies the request (name of the operation) to be executed on the remote NETCONF enabled device.

Returns:

  • (String, nil) —

    This argument specifies the request (name of the operation) to be executed on the remote NETCONF enabled device.



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

attribute :rpc

#xmlns ⇒ String?

Returns NETCONF operations not defined in rfc6241 typically require the appropriate XML namespace to be set. In the case the I(request) option is not already provided in XML format, the namespace can be defined by the I(xmlns) option.

Returns:

  • (String, nil) —

    NETCONF operations not defined in rfc6241 typically require the appropriate XML namespace to be set. In the case the I(request) option is not already provided in XML format, the namespace can be defined by the I(xmlns) option.



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

attribute :xmlns