From 5cdb646ab72195e0649fadda80215ad227bfaf50 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Fri, 8 May 2020 00:01:40 +0530 Subject: [PATCH] Updated listen_ports_facts documentation (#301) Updated listen_ports_facts module documentation to reflect - Linux only support - Required netstat command Fixes: ansible/ansible#68077 Signed-off-by: Abhijeet Kasurde --- changelogs/fragments/listen_ports_facts_doc.yml | 2 ++ plugins/modules/system/listen_ports_facts.py | 9 ++++----- 2 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 changelogs/fragments/listen_ports_facts_doc.yml diff --git a/changelogs/fragments/listen_ports_facts_doc.yml b/changelogs/fragments/listen_ports_facts_doc.yml new file mode 100644 index 0000000000..b56988c3a2 --- /dev/null +++ b/changelogs/fragments/listen_ports_facts_doc.yml @@ -0,0 +1,2 @@ +minor_changes: +- Updated documentation about netstat command requirement for listen_ports_facts module (https://github.com/ansible/ansible/issues/68077). diff --git a/plugins/modules/system/listen_ports_facts.py b/plugins/modules/system/listen_ports_facts.py index f25396ae64..b6d2207744 100644 --- a/plugins/modules/system/listen_ports_facts.py +++ b/plugins/modules/system/listen_ports_facts.py @@ -14,14 +14,13 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = r''' --- module: listen_ports_facts - author: - Nathan Davison (@ndavison) - - description: - - Gather facts on processes listening on TCP and UDP ports. - + - Gather facts on processes listening on TCP and UDP ports using netstat command. + - This module currently supports Linux only. +requirements: + - netstat short_description: Gather facts on processes listening on TCP and UDP ports. '''