junipernetworks.junos.junos_ping module – Tests reachability using ping from devices running Juniper JUNOS
Note
This module is part of the junipernetworks.junos collection (version 5.3.1).
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
.
To use it in a playbook, specify: junipernetworks.junos.junos_ping
.
New in junipernetworks.junos 1.0.0
Synopsis
Tests reachability using ping from devices running Juniper JUNOS to a remote destination.
Tested against Junos (17.3R1.10)
For a general purpose network module, see the ansible.netcommon.net_ping module.
For Windows targets, use the ansible.windows.win_ping module instead.
For targets running Python, use the ansible.builtin.ping module instead.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Number of packets to send to check reachability. Default: |
|
The IP Address or hostname (resolvable by the device) of the remote node. |
|
Determines whether to set the DF bit. Choices:
|
|
The source interface to use while sending the ping packet(s). |
|
Determines the interval (in seconds) between consecutive pings. |
|
Determines whether to send the packets rapidly. Choices:
|
|
Determines the size (in bytes) of the ping packet(s). |
|
The IP Address to use while sending the ping packet(s). |
|
Determines if the expected result is success or fail. Choices:
|
|
The time-to-live value for the ICMP packet(s). |
Notes
Note
For a general purpose network module, see the ansible.netcommon.net_ping module.
For Windows targets, use the ansible.windows.win_ping module instead.
For targets running Python, use the ansible.builtin.ping module instead.
This module works only with connection
network_cli
.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: Test reachability to 10.10.10.10
junipernetworks.junos.junos_ping:
dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using source and size set
junipernetworks.junos.junos_ping:
dest: 10.20.20.20
size: 1024
ttl: 128
- name: Test unreachability to 10.30.30.30 using interval
junipernetworks.junos.junos_ping:
dest: 10.30.30.30
interval: 3
state: absent
- name: Test reachability to 10.40.40.40 setting count and interface
junipernetworks.junos.junos_ping:
dest: 10.40.40.40
interface: fxp0
count: 20
size: 512
- name: Test reachability to 10.50.50.50 using do-not-fragment and rapid
junipernetworks.junos.junos_ping:
dest: 10.50.50.50
df_bit: true
rapid: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of commands sent. Returned: always Sample: |
|
Percentage of packets lost. Returned: always Sample: |
|
Packets successfully received. Returned: always Sample: |
|
Packets successfully transmitted. Returned: always Sample: |
|
The round trip time (RTT) stats. Returned: when ping succeeds Sample: |