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

Note

This module is part of the junipernetworks.junos collection (version 9.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install junipernetworks.junos. You need further requirements to be able to use this module, see Requirements for details.

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

New in junipernetworks.junos 1.0.0

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.

Aliases: rpc

Requirements

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

  • ncclient (>=v0.5.2)

Parameters

Parameter

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

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.

Choices:

  • "xml" ← (default)

  • "json"

  • "text"

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 :ref:`Junos OS Platform Options guide <junos_platform_options>`

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <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

Description

output

string

The rpc rely converted to the output format.

Returned: always

output_lines

list / elements=string

The text output split into lines for readability.

Returned: always

xml

string

The xml return string from the rpc request.

Returned: always

Authors

  • Peter Sprygada (@privateip)