junipernetworks.junos.junos_rpc – Runs an arbitrary RPC over NetConf on an Juniper JUNOS device

Note

This plugin is part of the junipernetworks.junos collection (version 1.3.0).

To install it use: ansible-galaxy collection install junipernetworks.junos.

To use it in a playbook, specify: junipernetworks.junos.junos_rpc.

New in version 1.0.0: of junipernetworks.junos

Synopsis

  • 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 xml key. If an alternate output format is requested, the reply is transformed to the requested output.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ncclient (>=v0.5.2)

Parameters

Parameter Choices/Defaults Comments
args
dictionary
The 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.
attrs
dictionary
The attrs arguments defines a list of attributes and their values to set for the RPC call. This accepts a dictionary of key-values.
output
string
    Choices:
  • xml ←
  • json
  • text
The output argument specifies the desired output of the return data. This argument accepts one of xml, text, or json. For json, the JUNOS device must be running a version of software that supports native JSON output.
provider
dictionary
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli or connection: netconf.
For more information please see the Junos OS Platform Options guide.
A dict object containing connection details.
host
string
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
string
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
integer
Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for transport=cli) or port 830 (for transport=netconf) device.
ssh_keyfile
path
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout
integer
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
transport
string
    Choices:
  • cli
  • netconf ←
Configures the transport connection to use when connecting to the remote device.
username
string
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
rpc
string / required
The 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.

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.

  • Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.

  • Recommended connection is netconf. See the Junos OS Platform Options.

  • This module also works with local connections for legacy playbooks.

  • For information on using CLI and netconf see the Junos OS Platform Options guide

  • For more information on using Ansible to manage network devices see the Ansible Network Guide

  • For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper.

Examples

- name: collect interface information using rpc
  junipernetworks.junos.junos_rpc:
    rpc: get-interface-information
    args:
      interface-name: em0
      media: true

- name: get system information
  junipernetworks.junos.junos_rpc:
    rpc: get-system-information

- name: load configuration
  junipernetworks.junos.junos_rpc:
    rpc: load-configuration
    attrs:
      action: override
      url: /tmp/config.conf

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
output
string
always
The rpc rely converted to the output format.
output_lines
list / elements=string
always
The text output split into lines for readability.
xml
string
always
The xml return string from the rpc request.


Authors

  • Peter Sprygada (@privateip)