Class: Ansible::Ruby::Modules::Junos_rpc

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/network/junos/junos_rpc.rb

Overview

Sends a request to the remote device running JUNOS to execute the specified RPC using the NetConf transport. The reply is then returned to the playbook in the C(xml) key. If an alternate output format is requested, the reply is transformed to the requested output.

Instance Method Summary

• #args ⇒ Hash^?

  The C(args) argument provides a set of arguments for the RPC call and are encoded in the request message.

• #attrs ⇒ Hash^?

  The C(attrs) arguments defines a list of attributes and their values to set for the RPC call.

• #output ⇒ String^?

  The C(output) argument specifies the desired output of the return data.

• #rpc ⇒ String

  The C(rpc) argument specifies the RPC call to send to the remote devices to be executed.

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

#args ⇒ Hash^?

Returns The C(args) argument provides a set of arguments for the RPC call and are encoded in the request message. This argument accepts a set of key=value arguments.

Returns:

• (Hash, nil) —

  The C(args) argument provides a set of arguments for the RPC call and are encoded in the request message. This argument accepts a set of key=value arguments.

# File 'lib/ansible/ruby/modules/generated/network/junos/junos_rpc.rb', line 16

attribute :args

#attrs ⇒ Hash^?

Returns The C(attrs) arguments defines a list of attributes and their values to set for the RPC call. This accepts a dictionary of key-values.

Returns:

• (Hash, nil) —

  The C(attrs) arguments defines a list of attributes and their values to set for the RPC call. This accepts a dictionary of key-values.

# File 'lib/ansible/ruby/modules/generated/network/junos/junos_rpc.rb', line 20

attribute :attrs

#output ⇒ String^?

Returns The C(output) argument specifies the desired output of the return data. This argument accepts one of C(xml), C(text), or C(json). For C(json), the JUNOS device must be running a version of software that supports native JSON output.

Returns:

• (String, nil) —

  The C(output) argument specifies the desired output of the return data. This argument accepts one of C(xml), C(text), or C(json). For C(json), the JUNOS device must be running a version of software that supports native JSON output.

# File 'lib/ansible/ruby/modules/generated/network/junos/junos_rpc.rb', line 24

attribute :output

#rpc ⇒ String

Returns The C(rpc) argument specifies the RPC call to send to the remote devices to be executed. The RPC Reply message is parsed and the contents are returned to the playbook.

Returns:

• (String) —

  The C(rpc) argument specifies the RPC call to send to the remote devices to be executed. The RPC Reply message is parsed and the contents are returned to the playbook.

# File 'lib/ansible/ruby/modules/generated/network/junos/junos_rpc.rb', line 12

attribute :rpc