junipernetworks.junos.junos_command (8.0.0) — module

Install collection

Install with ansible-galaxy collection install junipernetworks.junos:==8.0.0

Add to requirements.yml

  collections:
    - name: junipernetworks.junos
      version: 8.0.0

Description

Sends an arbitrary set of commands to an JUNOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Requirements

• jxmlease
• ncclient (>=v0.5.2)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run show version on remote devices
  junipernetworks.junos.junos_command:
    commands: show version

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run show version and check to see if output contains Juniper
  junipernetworks.junos.junos_command:
    commands: show version
    wait_for: result[0] contains Juniper

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run multiple commands on remote nodes
  junipernetworks.junos.junos_command:
    commands:
      - show version
      - show interfaces

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run multiple commands and evaluate the output
  junipernetworks.junos.junos_command:
    commands:
      - show version
      - show interfaces
    wait_for:
      - result[0] contains Juniper
      - result[1] contains Loopback0

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run commands and specify the output format
  junipernetworks.junos.junos_command:
    commands: show version
    display: json

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run rpc on the remote device
  junipernetworks.junos.junos_command:
    commands: show configuration
    display: set

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: run rpc on the remote device
  junipernetworks.junos.junos_command:
    rpcs: get-software-information

Inputs

    
rpcs:
    description:
    - The C(rpcs) argument accepts a list of RPCs to be executed over a netconf session
      and the results from the RPC execution is return to the playbook via the modules
      results dictionary.
    elements: str
    type: list

match:
    choices:
    - any
    - all
    default: all
    description:
    - The I(match) argument is used in conjunction with the I(wait_for) argument to specify
      the match policy.  Valid values are C(all) or C(any).  If the value is set to C(all)
      then all conditionals in the I(wait_for) must be satisfied.  If the value is set
      to C(any) then only one of the values must be satisfied.
    type: str

display:
    aliases:
    - format
    - output
    choices:
    - text
    - json
    - xml
    - set
    description:
    - Encoding scheme to use when serializing output from the device. This handles how
      to properly understand the output and apply the conditionals path to the result
      set. For I(rpcs) argument default display is C(xml) and for I(commands) argument
      default display is C(text). Value C(set) is applicable only for fetching configuration
      from device.
    type: str

retries:
    default: 10
    description:
    - Specifies the number of retries a command should be tried before it is considered
      failed.  The command is run on the target device every retry and evaluated against
      the I(wait_for) conditionals.
    type: int

commands:
    description:
    - The commands to send to the remote junos device.  The resulting output from the
      command is returned.  If the I(wait_for) argument is provided, the module is not
      returned until the condition is satisfied or the number of I(retries) has been exceeded.
    elements: str
    type: list

interval:
    default: 1
    description:
    - Configures the interval in seconds to wait between retries of the command.  If the
      command does not pass the specified conditional, the interval indicates how to long
      to wait before trying the command again.
    type: int

wait_for:
    aliases:
    - waitfor
    description:
    - Specifies what to evaluate from the output of the command and what conditionals
      to apply.  This argument will cause the task to wait for a particular conditional
      to be true before moving forward.   If the conditional is not true by the configured
      retries, the task fails.  See examples.
    elements: str
    type: list

Outputs

failed_conditions:
  description: The list of conditionals that have failed
  returned: failed
  sample:
  - '...'
  - '...'
  type: list
output:
  description: The set of transformed xml to json format from the commands responses
  returned: If the I(display) is in C(xml) format.
  sample:
  - '...'
  - '...'
  type: list
stdout:
  description: The set of responses from the commands
  returned: always apart from low level errors (such as action plugin)
  sample:
  - '...'
  - '...'
  type: list
stdout_lines:
  description: The value of stdout split into a list
  returned: always apart from low level errors (such as action plugin)
  sample:
  - - '...'
    - '...'
  - - '...'
  - - '...'
  type: list