From 69fb310878dfe3ed26078765bd134ac502f67c7f Mon Sep 17 00:00:00 2001 From: Peter Sprygada Date: Mon, 28 Nov 2016 07:13:47 -0500 Subject: [PATCH] updates the network shared docs to include the timeout parameter (#18635) The network shared doc fragment was missing the timeout parameter from the docstring. This commit adds the timeout parameter back to the doc fragment --- lib/ansible/utils/module_docs_fragments/asa.py | 5 +++-- lib/ansible/utils/module_docs_fragments/dellos9.py | 0 lib/ansible/utils/module_docs_fragments/eos.py | 7 +++++++ lib/ansible/utils/module_docs_fragments/ios.py | 7 +++++++ lib/ansible/utils/module_docs_fragments/iosxr.py | 7 +++++++ lib/ansible/utils/module_docs_fragments/junos.py | 7 +++++++ lib/ansible/utils/module_docs_fragments/nxos.py | 9 ++++++++- lib/ansible/utils/module_docs_fragments/openswitch.py | 7 +++++++ lib/ansible/utils/module_docs_fragments/sros.py | 7 +++++++ lib/ansible/utils/module_docs_fragments/vyos.py | 7 +++++++ 10 files changed, 60 insertions(+), 3 deletions(-) mode change 100755 => 100644 lib/ansible/utils/module_docs_fragments/dellos9.py diff --git a/lib/ansible/utils/module_docs_fragments/asa.py b/lib/ansible/utils/module_docs_fragments/asa.py index c2c0cd34df..904aa4c5d1 100644 --- a/lib/ansible/utils/module_docs_fragments/asa.py +++ b/lib/ansible/utils/module_docs_fragments/asa.py @@ -78,8 +78,9 @@ options: default: none timeout: description: - - Specifies idle timeout for the connection, in seconds. Useful if the console - freezes before continuing. For example when saving configurations. + - Specifies idle timeout in seconds for the connection, in seconds. Useful + if the console freezes before continuing. For example when saving + configurations. required: false default: 10 provider: diff --git a/lib/ansible/utils/module_docs_fragments/dellos9.py b/lib/ansible/utils/module_docs_fragments/dellos9.py old mode 100755 new mode 100644 diff --git a/lib/ansible/utils/module_docs_fragments/eos.py b/lib/ansible/utils/module_docs_fragments/eos.py index 0b1a9d3f30..6ae1d5edbd 100644 --- a/lib/ansible/utils/module_docs_fragments/eos.py +++ b/lib/ansible/utils/module_docs_fragments/eos.py @@ -52,6 +52,13 @@ options: value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH keyfile to use to authenticate the connection to diff --git a/lib/ansible/utils/module_docs_fragments/ios.py b/lib/ansible/utils/module_docs_fragments/ios.py index 9c187577a6..2449965b90 100644 --- a/lib/ansible/utils/module_docs_fragments/ios.py +++ b/lib/ansible/utils/module_docs_fragments/ios.py @@ -49,6 +49,13 @@ options: value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to diff --git a/lib/ansible/utils/module_docs_fragments/iosxr.py b/lib/ansible/utils/module_docs_fragments/iosxr.py index ca9ec68904..ac646e07fe 100644 --- a/lib/ansible/utils/module_docs_fragments/iosxr.py +++ b/lib/ansible/utils/module_docs_fragments/iosxr.py @@ -49,6 +49,13 @@ options: value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to diff --git a/lib/ansible/utils/module_docs_fragments/junos.py b/lib/ansible/utils/module_docs_fragments/junos.py index a39b896292..c1177e43d6 100644 --- a/lib/ansible/utils/module_docs_fragments/junos.py +++ b/lib/ansible/utils/module_docs_fragments/junos.py @@ -51,6 +51,13 @@ options: value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to diff --git a/lib/ansible/utils/module_docs_fragments/nxos.py b/lib/ansible/utils/module_docs_fragments/nxos.py index 00ee85cc61..6f1dfe6d4a 100644 --- a/lib/ansible/utils/module_docs_fragments/nxos.py +++ b/lib/ansible/utils/module_docs_fragments/nxos.py @@ -52,6 +52,13 @@ options: value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to @@ -75,7 +82,7 @@ options: choices: ['yes', 'no'] timeout: description: - - Specifies idle timeout in seconds. NX-API can be slow to + - Specifies idle timeout in seconds. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). required: false default: 10 diff --git a/lib/ansible/utils/module_docs_fragments/openswitch.py b/lib/ansible/utils/module_docs_fragments/openswitch.py index 412711ce96..33aaeae638 100644 --- a/lib/ansible/utils/module_docs_fragments/openswitch.py +++ b/lib/ansible/utils/module_docs_fragments/openswitch.py @@ -56,6 +56,13 @@ options: environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to diff --git a/lib/ansible/utils/module_docs_fragments/sros.py b/lib/ansible/utils/module_docs_fragments/sros.py index 4f796d18d8..6e8becdf0e 100644 --- a/lib/ansible/utils/module_docs_fragments/sros.py +++ b/lib/ansible/utils/module_docs_fragments/sros.py @@ -49,6 +49,13 @@ options: value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to diff --git a/lib/ansible/utils/module_docs_fragments/vyos.py b/lib/ansible/utils/module_docs_fragments/vyos.py index 33064b4ae0..5e475a9b28 100644 --- a/lib/ansible/utils/module_docs_fragments/vyos.py +++ b/lib/ansible/utils/module_docs_fragments/vyos.py @@ -49,6 +49,13 @@ options: value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. required: false default: null + timeout: + description: + - Specifies the timeout in seconds for communicating with the network device + for either connecting or sending commands. If the timeout is + exceeded before the operation is completed, the module will error + require: false + default: 10 ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to