mirror of https://github.com/ansible/ansible.git
icx: new module icx_ping (#59975)
* new module * new module * new terminal * new terminal * new cliconf * new cliconf * cliconf * cliconf * icx cliconf * icx cliconf * icx_cliconf * icx test units module * icx test units module * icx units module * icx units module * icx banner unit test * icx banner unit test * PR changes resolved * changes resolved * Changes Resolved * check_running_config changes resolved * added notes * added notes * removed icx rst * new changes * new changes * deleted icx rst * icx .rst * icx .rst * modified platform_index.rst * modified platform_index.rst * modified platform_index.rst * modified platform_index.rst * changes resolved * changes resolved * PR comments resolved * PR comments resolved * Update platform_index.rst PR comment resolved * Update platform_index.rst PR comment resolved * new module icx_ping * new changes * Fixed bot errorpull/60398/head
parent
f4502a8f1c
commit
622a493ae0
@ -0,0 +1,270 @@
|
||||
#!/usr/bin/python
|
||||
# Copyright: Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: icx_ping
|
||||
version_added: "2.9"
|
||||
author: "Ruckus Wireless (@Commscope)"
|
||||
short_description: Tests reachability using ping from Ruckus ICX 7000 series switches
|
||||
description:
|
||||
- Tests reachability using ping from switch to a remote destination.
|
||||
notes:
|
||||
- Tested against ICX 10.1
|
||||
options:
|
||||
count:
|
||||
description:
|
||||
- Number of packets to send. Default is 1.
|
||||
type: int
|
||||
dest:
|
||||
description:
|
||||
- ip-addr | host-name | vrf vrf-name | ipv6 [ ipv6-addr | host-name | vrf vrf-name] (resolvable by switch) of the remote node.
|
||||
required: true
|
||||
type: str
|
||||
timeout:
|
||||
description:
|
||||
- Specifies the time, in milliseconds for which the device waits for a reply from the pinged device.
|
||||
The value can range from 1 to 4294967296. The default is 5000 (5 seconds).
|
||||
type: int
|
||||
ttl:
|
||||
description:
|
||||
- Specifies the time to live as a maximum number of hops. The value can range from 1 to 255. The default is 64.
|
||||
type: int
|
||||
size:
|
||||
description:
|
||||
- Specifies the size of the ICMP data portion of the packet, in bytes. This is the payload and does not include the header.
|
||||
The value can range from 0 to 10000. The default is 16..
|
||||
type: int
|
||||
source:
|
||||
description:
|
||||
- IP address to be used as the origin of the ping packets.
|
||||
type: str
|
||||
vrf:
|
||||
description:
|
||||
- Specifies the Virtual Routing and Forwarding (VRF) instance of the device to be pinged.
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- Determines if the expected result is success or fail.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Test reachability to 10.10.10.10
|
||||
icx_ping:
|
||||
dest: 10.10.10.10
|
||||
|
||||
- name: Test reachability to ipv6 address from source with timeout
|
||||
icx_ping:
|
||||
dest: ipv6 2001:cdba:0000:0000:0000:0000:3257:9652
|
||||
source: 10.1.1.1
|
||||
timeout: 100000
|
||||
|
||||
- name: Test reachability to 10.1.1.1 through vrf using 5 packets
|
||||
icx_ping:
|
||||
dest: 10.1.1.1
|
||||
vrf: x.x.x.x
|
||||
count: 5
|
||||
|
||||
- name: Test unreachability to 10.30.30.30
|
||||
icx_ping:
|
||||
dest: 10.40.40.40
|
||||
state: absent
|
||||
|
||||
- name: Test reachability to ipv4 with ttl and packet size
|
||||
icx_ping:
|
||||
dest: 10.10.10.10
|
||||
ttl: 20
|
||||
size: 500
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
commands:
|
||||
description: Show the command sent.
|
||||
returned: always
|
||||
type: list
|
||||
sample: ["ping 10.40.40.40 count 20 source loopback0", "ping 10.40.40.40"]
|
||||
packet_loss:
|
||||
description: Percentage of packets lost.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "0%"
|
||||
packets_rx:
|
||||
description: Packets successfully received.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 20
|
||||
packets_tx:
|
||||
description: Packets successfully transmitted.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 20
|
||||
rtt:
|
||||
description: Show RTT stats.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {"avg": 2, "max": 8, "min": 1}
|
||||
'''
|
||||
|
||||
from ansible.module_utils._text import to_text
|
||||
from ansible.module_utils.network.icx.icx import run_commands
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.connection import Connection, ConnectionError
|
||||
import re
|
||||
|
||||
|
||||
def build_ping(dest, count=None, source=None, timeout=None, ttl=None, size=None, vrf=None):
|
||||
"""
|
||||
Function to build the command to send to the terminal for the switch
|
||||
to execute. All args come from the module's unique params.
|
||||
"""
|
||||
|
||||
if vrf is not None:
|
||||
cmd = "ping vrf {0} {1}".format(vrf, dest)
|
||||
else:
|
||||
cmd = "ping {0}".format(dest)
|
||||
|
||||
if count is not None:
|
||||
cmd += " count {0}".format(str(count))
|
||||
|
||||
if timeout is not None:
|
||||
cmd += " timeout {0}".format(str(timeout))
|
||||
|
||||
if ttl is not None:
|
||||
cmd += " ttl {0}".format(str(ttl))
|
||||
|
||||
if size is not None:
|
||||
cmd += " size {0}".format(str(size))
|
||||
|
||||
if source is not None:
|
||||
cmd += " source {0}".format(source)
|
||||
|
||||
return cmd
|
||||
|
||||
|
||||
def parse_ping(ping_stats):
|
||||
"""
|
||||
Function used to parse the statistical information from the ping response.
|
||||
Example: "Success rate is 100 percent (5/5), round-trip min/avg/max=40/51/55 ms."
|
||||
Returns the percent of packet loss, recieved packets, transmitted packets, and RTT dict.
|
||||
"""
|
||||
if ping_stats.startswith('Success'):
|
||||
rate_re = re.compile(r"^\w+\s+\w+\s+\w+\s+(?P<pct>\d+)\s+\w+\s+\((?P<rx>\d+)/(?P<tx>\d+)\)")
|
||||
rtt_re = re.compile(r".*,\s+\S+\s+\S+=(?P<min>\d+)/(?P<avg>\d+)/(?P<max>\d+)\s+\w+\.+\s*$|.*\s*$")
|
||||
|
||||
rate = rate_re.match(ping_stats)
|
||||
rtt = rtt_re.match(ping_stats)
|
||||
return rate.group("pct"), rate.group("rx"), rate.group("tx"), rtt.groupdict()
|
||||
else:
|
||||
rate_re = re.compile(r"^Sending+\s+(?P<tx>\d+),")
|
||||
rate = rate_re.match(ping_stats)
|
||||
rtt = {'avg': 0, 'max': 0, 'min': 0}
|
||||
return 0, 0, rate.group('tx'), rtt
|
||||
|
||||
|
||||
def validate_results(module, loss, results):
|
||||
"""
|
||||
This function is used to validate whether the ping results were unexpected per "state" param.
|
||||
"""
|
||||
state = module.params["state"]
|
||||
if state == "present" and loss == 100:
|
||||
module.fail_json(msg="Ping failed unexpectedly", **results)
|
||||
elif state == "absent" and loss < 100:
|
||||
module.fail_json(msg="Ping succeeded unexpectedly", **results)
|
||||
|
||||
|
||||
def validate_fail(module, responses):
|
||||
if ("Success" in responses or "No reply" in responses) is False:
|
||||
module.fail_json(msg=responses)
|
||||
|
||||
|
||||
def validate_parameters(module, timeout, count):
|
||||
if timeout and not 1 <= int(timeout) <= 4294967294:
|
||||
module.fail_json(msg="bad value for timeout - valid range (1-4294967294)")
|
||||
if count and not 1 <= int(count) <= 4294967294:
|
||||
module.fail_json(msg="bad value for count - valid range (1-4294967294)")
|
||||
|
||||
|
||||
def main():
|
||||
""" main entry point for module execution
|
||||
"""
|
||||
argument_spec = dict(
|
||||
count=dict(type="int"),
|
||||
dest=dict(type="str", required=True),
|
||||
timeout=dict(type="int"),
|
||||
ttl=dict(type="int"),
|
||||
size=dict(type="int"),
|
||||
source=dict(type="str"),
|
||||
state=dict(type="str", choices=["absent", "present"], default="present"),
|
||||
vrf=dict(type="str")
|
||||
)
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec)
|
||||
|
||||
count = module.params["count"]
|
||||
dest = module.params["dest"]
|
||||
source = module.params["source"]
|
||||
timeout = module.params["timeout"]
|
||||
ttl = module.params["ttl"]
|
||||
size = module.params["size"]
|
||||
vrf = module.params["vrf"]
|
||||
results = {}
|
||||
warnings = list()
|
||||
|
||||
if warnings:
|
||||
results["warnings"] = warnings
|
||||
|
||||
response = ''
|
||||
try:
|
||||
validate_parameters(module, timeout, count)
|
||||
results["commands"] = [build_ping(dest, count, source, timeout, ttl, size, vrf)]
|
||||
ping_results = run_commands(module, commands=results["commands"])
|
||||
ping_results_list = ping_results[0].split("\n")
|
||||
|
||||
except ConnectionError as exc:
|
||||
module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
||||
|
||||
validate_fail(module, ping_results[0])
|
||||
|
||||
stats = ""
|
||||
statserror = ''
|
||||
for line in ping_results_list:
|
||||
if line.startswith('Sending'):
|
||||
statserror = line
|
||||
if line.startswith('Success'):
|
||||
stats = line
|
||||
elif line.startswith('No reply'):
|
||||
stats = statserror
|
||||
|
||||
success, rx, tx, rtt = parse_ping(stats)
|
||||
loss = abs(100 - int(success))
|
||||
results["packet_loss"] = str(loss) + "%"
|
||||
results["packets_rx"] = int(rx)
|
||||
results["packets_tx"] = int(tx)
|
||||
|
||||
# Convert rtt values to int
|
||||
for k, v in rtt.items():
|
||||
if rtt[k] is not None:
|
||||
rtt[k] = int(v)
|
||||
|
||||
results["rtt"] = rtt
|
||||
|
||||
validate_results(module, loss, results)
|
||||
|
||||
module.exit_json(**results)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
@ -0,0 +1,4 @@
|
||||
Sending 1, 16-byte ICMP Echo to 10.255.255.250, timeout 100 msec, TTL 64
|
||||
Type Control-c to abort
|
||||
Request timed out.
|
||||
No reply from remote host.
|
@ -0,0 +1,4 @@
|
||||
Sending 1, 16-byte ICMP Echo to 10.255.255.250, timeout 100 msec, TTL 64
|
||||
Type Control-c to abort
|
||||
Request timed out.
|
||||
No reply from remote host.
|
@ -0,0 +1,5 @@
|
||||
Sending 2, 16-byte ICMP Echo to 8.8.8.8, timeout 5000 msec, TTL 64
|
||||
Type Control-c to abort
|
||||
Reply from 8.8.8.8 : bytes=16 time=49ms TTL=45
|
||||
Reply from 8.8.8.8 : bytes=16 time=41ms TTL=45
|
||||
Success rate is 100 percent (2/2), round-trip min/avg/max=41/45/49 ms.
|
@ -0,0 +1,8 @@
|
||||
Sending 5, 16-byte ICMP Echo to 8.8.8.8, timeout 5000 msec, TTL 70
|
||||
Type Control-c to abort
|
||||
Reply from 8.8.8.8 : bytes=16 time=40ms TTL=45
|
||||
Reply from 8.8.8.8 : bytes=16 time=40ms TTL=45
|
||||
Reply from 8.8.8.8 : bytes=16 time=40ms TTL=45
|
||||
Reply from 8.8.8.8 : bytes=16 time=40ms TTL=45
|
||||
Reply from 8.8.8.8 : bytes=16 time=40ms TTL=45
|
||||
Success rate is 100 percent (5/5), round-trip min/avg/max=40/40/40 ms.
|
@ -0,0 +1 @@
|
||||
Invalid size - valid range (0-10000)
|
@ -0,0 +1 @@
|
||||
Bad value for TTL, valid range is from 1 to 255.
|
@ -0,0 +1,87 @@
|
||||
# Copyright: (c) 2019, Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
from units.compat.mock import patch
|
||||
from ansible.modules.network.icx import icx_ping
|
||||
from units.modules.utils import set_module_args
|
||||
from .icx_module import TestICXModule, load_fixture
|
||||
import traceback
|
||||
|
||||
|
||||
class TestICXPingModule(TestICXModule):
|
||||
''' Class used for Unit Tests agains icx_ping module '''
|
||||
module = icx_ping
|
||||
|
||||
def setUp(self):
|
||||
super(TestICXPingModule, self).setUp()
|
||||
self.mock_run_commands = patch('ansible.modules.network.icx.icx_ping.run_commands')
|
||||
self.run_commands = self.mock_run_commands.start()
|
||||
|
||||
def tearDown(self):
|
||||
super(TestICXPingModule, self).tearDown()
|
||||
self.mock_run_commands.stop()
|
||||
|
||||
def load_fixtures(self, commands=None):
|
||||
def load_from_file(*args, **kwargs):
|
||||
module = args
|
||||
commands = kwargs['commands']
|
||||
output = list()
|
||||
|
||||
for command in commands:
|
||||
filename = str(command).split(' | ')[0].replace(' ', '_')
|
||||
output.append(load_fixture('icx_ping_%s' % filename))
|
||||
return output
|
||||
|
||||
self.run_commands.side_effect = load_from_file
|
||||
|
||||
def test_icx_ping_expected_success(self):
|
||||
''' Test for successful pings when destination should be reachable '''
|
||||
set_module_args(dict(count=2, dest="8.8.8.8"))
|
||||
commands = ['ping 8.8.8.8 count 2']
|
||||
fields = {'packets_tx': 2}
|
||||
self.execute_module(commands=commands, fields=fields)
|
||||
|
||||
def test_icx_ping_expected_failure(self):
|
||||
''' Test for unsuccessful pings when destination should not be reachable '''
|
||||
set_module_args(dict(count=2, dest="10.255.255.250", state="absent"))
|
||||
self.execute_module()
|
||||
|
||||
def test_icx_ping_unexpected_success(self):
|
||||
''' Test for successful pings when destination should not be reachable - FAIL. '''
|
||||
set_module_args(dict(count=2, dest="8.8.8.8", state="absent"))
|
||||
self.execute_module(failed=True)
|
||||
|
||||
def test_icx_ping_unexpected_failure(self):
|
||||
''' Test for unsuccessful pings when destination should be reachable - FAIL. '''
|
||||
set_module_args(dict(count=2, dest="10.255.255.250", timeout=45))
|
||||
fields = {'packets_tx': 1, 'packets_rx': 0, 'packet_loss': '100%', 'rtt': {'max': 0, 'avg': 0, 'min': 0}}
|
||||
self.execute_module(failed=True, fields=fields)
|
||||
|
||||
def test_icx_ping_expected_success_cmd(self):
|
||||
''' Test for successful pings when destination should be reachable '''
|
||||
set_module_args(dict(count=5, dest="8.8.8.8", ttl=70))
|
||||
commands = ['ping 8.8.8.8 count 5 ttl 70']
|
||||
self.execute_module(commands=commands)
|
||||
|
||||
def test_icx_ping_invalid_ttl(self):
|
||||
''' Test for invalid range of ttl for reachable '''
|
||||
set_module_args(dict(dest="8.8.8.8", ttl=300))
|
||||
commands = ['ping 8.8.8.8 ttl 300']
|
||||
self.execute_module(failed=True, sort=False)
|
||||
|
||||
def test_icx_ping_invalid_timeout(self):
|
||||
''' Test for invalid range of timeout for reachable '''
|
||||
set_module_args(dict(dest="8.8.8.8", timeout=4294967296))
|
||||
self.execute_module(failed=True, sort=False)
|
||||
|
||||
def test_icx_ping_invalid_count(self):
|
||||
''' Test for invalid range of count for reachable '''
|
||||
set_module_args(dict(dest="8.8.8.8", count=4294967296))
|
||||
self.execute_module(failed=True, sort=False)
|
||||
|
||||
def test_icx_ping_invalid_size(self):
|
||||
'''Test for invalid range of size for reachable '''
|
||||
set_module_args(dict(dest="8.8.8.8", size=10001))
|
||||
self.execute_module(failed=True, sort=False)
|
Loading…
Reference in New Issue