mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Adding more details on DOCSTRING about how to use the module (#5121)
This commit is contained in:
parent
9707ae6490
commit
b4565b6667
1 changed files with 11 additions and 1 deletions
|
@ -27,7 +27,10 @@ notes:
|
||||||
- The module will fail due to timeout issues, but the install will go on
|
- The module will fail due to timeout issues, but the install will go on
|
||||||
anyway. Ansible's block and rescue can be leveraged to handle this kind
|
anyway. Ansible's block and rescue can be leveraged to handle this kind
|
||||||
of failure and check actual module results. See EXAMPLE for more about
|
of failure and check actual module results. See EXAMPLE for more about
|
||||||
this.
|
this. The first task on the rescue block is needed to make sure the
|
||||||
|
device has completed all checks and it started to reboot. The second
|
||||||
|
task is needed to wait the device to come back up. Last two tasks are
|
||||||
|
used to verify the installation process's been successful.
|
||||||
- Do not include full file paths, just the name of the file(s) stored on
|
- Do not include full file paths, just the name of the file(s) stored on
|
||||||
the top level flash directory.
|
the top level flash directory.
|
||||||
- You must know if your platform supports taking a kickstart image as a
|
- You must know if your platform supports taking a kickstart image as a
|
||||||
|
@ -62,6 +65,13 @@ EXAMPLES = '''
|
||||||
password: "{{ pwd }}"
|
password: "{{ pwd }}"
|
||||||
transport: nxapi
|
transport: nxapi
|
||||||
rescue:
|
rescue:
|
||||||
|
- name: Wait for device to perform checks
|
||||||
|
wait_for:
|
||||||
|
port: 22
|
||||||
|
state: stopped
|
||||||
|
timeout: 300
|
||||||
|
delay: 60
|
||||||
|
host: "{{ inventory_hostname }}"
|
||||||
- name: Wait for device to come back up
|
- name: Wait for device to come back up
|
||||||
wait_for:
|
wait_for:
|
||||||
port: 22
|
port: 22
|
||||||
|
|
Loading…
Reference in a new issue