You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _sources/modules/panos_active_in_ha_module.rst.txt
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,12 +22,12 @@ paloaltonetworks.panos.panos_active_in_ha module -- Checks if node is an active
22
22
.. Collection note
23
23
24
24
.. note::
25
-
This module is part of the `paloaltonetworks.panos collection <https://galaxy.ansible.com/ui/repo/published/paloaltonetworks/panos/>`_ (version 3.1.1).
25
+
This module is part of the `paloaltonetworks.panos collection <https://galaxy.ansible.com/ui/repo/published/paloaltonetworks/panos/>`_ (version 3.2.0).
26
26
27
27
It is not included in ``ansible-core``.
28
28
To check whether it is installed, run :code:`ansible-galaxy collection list`.
29
29
30
-
To install it, use: :code:`ansible-galaxy collection install paloaltonetworks.panos`.
30
+
To install it, use: :code:`ansible\-galaxy collection install paloaltonetworks.panos`.
31
31
You need further requirements to be able to use this module,
32
32
see :ref:`Requirements <ansible_collections.paloaltonetworks.panos.panos_active_in_ha_module_requirements>` for details.
33
33
@@ -51,7 +51,7 @@ Synopsis
51
51
52
52
.. Description
53
53
54
-
- A wrapper around the PAN-OS Upgrade Assurance package.
54
+
- A wrapper around the PAN\-OS Upgrade Assurance package.
55
55
- A simple boolean check, verifies if a node is an active (\ :strong:`true`\ ) or passive (\ :strong:`false`\ ) node in an HA pair.
56
56
- If node does not belong to an HA pair or the pair is no configured correctly the module will fail.
57
57
@@ -67,9 +67,9 @@ Requirements
67
67
------------
68
68
The below requirements are needed on the host that executes this module.
69
69
70
-
- pan-python can be obtained from PyPI \ `https://pypi.python.org/pypi/pan-python <https://pypi.python.org/pypi/pan-python>`__
70
+
- pan\-python can be obtained from PyPI \ `https://pypi.python.org/pypi/pan\-python <https://pypi.python.org/pypi/pan-python>`__
71
71
- pandevice can be obtained from PyPI \ `https://pypi.python.org/pypi/pandevice <https://pypi.python.org/pypi/pandevice>`__
72
-
- panos-upgrade-assurance can be obtained from PyPI \ `https://pypi.org/project/panos-upgrade-assurance <https://pypi.org/project/panos-upgrade-assurance>`__
72
+
- panos\-upgrade\-assurance can be obtained from PyPI \ `https://pypi.org/project/panos\-upgrade\-assurance <https://pypi.org/project/panos-upgrade-assurance>`__
73
73
74
74
75
75
@@ -121,7 +121,7 @@ Parameters
121
121
122
122
:strong:`Deprecated`
123
123
124
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
124
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
125
125
126
126
.. raw:: html
127
127
@@ -203,7 +203,7 @@ Parameters
203
203
204
204
<div class="ansible-option-cell">
205
205
206
-
Use with caution, when set to \`True\` will ignore if device state is \`non-functional\` on one of the nodes. Helpful when verifying a state of a partially upgraded HA pair with vmseries plugin version mismatch.
206
+
Use with caution, when set to \`True\` will ignore if device state is \`non\-functional\` on one of the nodes. Helpful when verifying a state of a partially upgraded HA pair with vmseries plugin version mismatch.
207
207
208
208
209
209
.. rst-class:: ansible-option-line
@@ -247,13 +247,13 @@ Parameters
247
247
248
248
:strong:`Deprecated`
249
249
250
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
250
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
251
251
252
252
.. raw:: html
253
253
254
254
<hr>
255
255
256
-
The IP address or hostname of the PAN-OS device being configured.
256
+
The IP address or hostname of the PAN\-OS device being configured.
257
257
258
258
259
259
.. raw:: html
@@ -289,7 +289,7 @@ Parameters
289
289
290
290
:strong:`Deprecated`
291
291
292
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
292
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
293
293
294
294
.. raw:: html
295
295
@@ -331,13 +331,13 @@ Parameters
331
331
332
332
:strong:`Deprecated`
333
333
334
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
334
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
335
335
336
336
.. raw:: html
337
337
338
338
<hr>
339
339
340
-
The port number to connect to the PAN-OS device on.
340
+
The port number to connect to the PAN\-OS device on.
The serial number of a firewall to use for targeted commands. If :emphasis:`ip\_address` is not a Panorama PAN-OS device, then this param is ignored.
595
+
The serial number of a firewall to use for targeted commands. If :emphasis:`ip\_address` is not a Panorama PAN\-OS device, then this param is ignored.
596
596
597
597
598
598
.. raw:: html
@@ -717,7 +717,7 @@ Parameters
717
717
718
718
:strong:`Deprecated`
719
719
720
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
720
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
721
721
722
722
.. raw:: html
723
723
@@ -784,7 +784,7 @@ Notes
784
784
.. note::
785
785
- Panorama is not supported.
786
786
- Check mode is not supported.
787
-
- PAN-OS connectivity should be specified using :emphasis:`provider` or the classic PAN-OS connectivity params (\ :emphasis:`ip\_address`\ , :emphasis:`username`\ , :emphasis:`password`\ , :emphasis:`api\_key`\ , and :emphasis:`port`\ ). If both are present, then the classic params are ignored.
787
+
- PAN\-OS connectivity should be specified using :emphasis:`provider` or the classic PAN\-OS connectivity params (\ :emphasis:`ip\_address`\ , :emphasis:`username`\ , :emphasis:`password`\ , :emphasis:`api\_key`\ , and :emphasis:`port`\ ). If both are present, then the classic params are ignored.
This module is part of the `paloaltonetworks.panos collection <https://galaxy.ansible.com/ui/repo/published/paloaltonetworks/panos/>`_ (version 3.1.1).
25
+
This module is part of the `paloaltonetworks.panos collection <https://galaxy.ansible.com/ui/repo/published/paloaltonetworks/panos/>`_ (version 3.2.0).
26
26
27
27
It is not included in ``ansible-core``.
28
28
To check whether it is installed, run :code:`ansible-galaxy collection list`.
29
29
30
-
To install it, use: :code:`ansible-galaxy collection install paloaltonetworks.panos`.
30
+
To install it, use: :code:`ansible\-galaxy collection install paloaltonetworks.panos`.
31
31
You need further requirements to be able to use this module,
32
32
see :ref:`Requirements <ansible_collections.paloaltonetworks.panos.panos_address_group_module_requirements>` for details.
33
33
@@ -51,7 +51,7 @@ Synopsis
51
51
52
52
.. Description
53
53
54
-
- Manage address group objects on PAN-OS devices.
54
+
- Manage address group objects on PAN\-OS devices.
55
55
56
56
57
57
.. Aliases
@@ -66,7 +66,7 @@ Requirements
66
66
------------
67
67
The below requirements are needed on the host that executes this module.
68
68
69
-
- pan-python can be obtained from PyPI \ `https://pypi.python.org/pypi/pan-python <https://pypi.python.org/pypi/pan-python>`__
69
+
- pan\-python can be obtained from PyPI \ `https://pypi.python.org/pypi/pan\-python <https://pypi.python.org/pypi/pan-python>`__
70
70
- pandevice can be obtained from PyPI \ `https://pypi.python.org/pypi/pandevice <https://pypi.python.org/pypi/pandevice>`__
71
71
72
72
@@ -119,7 +119,7 @@ Parameters
119
119
120
120
:strong:`Deprecated`
121
121
122
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
122
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
123
123
124
124
.. raw:: html
125
125
@@ -167,7 +167,7 @@ Parameters
167
167
168
168
<hr>
169
169
170
-
Commit changes after creating object. If :emphasis:`ip\_address` is a Panorama device, and :emphasis:`device\_group` or :emphasis:`template` are also set, perform a commit to Panorama and a commit-all to the device group/template.
170
+
Commit changes after creating object. If :emphasis:`ip\_address` is a Panorama device, and :emphasis:`device\_group` or :emphasis:`template` are also set, perform a commit to Panorama and a commit\-all to the device group/template.
171
171
172
172
173
173
.. rst-class:: ansible-option-line
@@ -317,7 +317,7 @@ Parameters
317
317
318
318
When :emphasis:`state=gathered`.
319
319
320
-
An advanced filtering option to filter results returned from PAN-OS.
320
+
An advanced filtering option to filter results returned from PAN\-OS.
321
321
322
322
Refer to the guide discussing :emphasis:`gathered\_filter` for more information.
323
323
@@ -355,13 +355,13 @@ Parameters
355
355
356
356
:strong:`Deprecated`
357
357
358
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
358
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
359
359
360
360
.. raw:: html
361
361
362
362
<hr>
363
363
364
-
The IP address or hostname of the PAN-OS device being configured.
364
+
The IP address or hostname of the PAN\-OS device being configured.
365
365
366
366
367
367
.. raw:: html
@@ -431,7 +431,7 @@ Parameters
431
431
432
432
:strong:`Deprecated`
433
433
434
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
434
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
435
435
436
436
.. raw:: html
437
437
@@ -473,13 +473,13 @@ Parameters
473
473
474
474
:strong:`Deprecated`
475
475
476
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
476
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
477
477
478
478
.. raw:: html
479
479
480
480
<hr>
481
481
482
-
The port number to connect to the PAN-OS device on.
482
+
The port number to connect to the PAN\-OS device on.
The serial number of a firewall to use for targeted commands. If :emphasis:`ip\_address` is not a Panorama PAN-OS device, then this param is ignored.
737
+
The serial number of a firewall to use for targeted commands. If :emphasis:`ip\_address` is not a Panorama PAN\-OS device, then this param is ignored.
738
738
739
739
740
740
.. raw:: html
@@ -931,7 +931,7 @@ Parameters
931
931
932
932
:strong:`Deprecated`
933
933
934
-
Use :emphasis:`provider` to specify PAN-OS connectivity instead.
934
+
Use :emphasis:`provider` to specify PAN\-OS connectivity instead.
935
935
936
936
.. raw:: html
937
937
@@ -998,7 +998,7 @@ Notes
998
998
.. note::
999
999
- Panorama is supported.
1000
1000
- Check mode is supported.
1001
-
- PAN-OS connectivity should be specified using :emphasis:`provider` or the classic PAN-OS connectivity params (\ :emphasis:`ip\_address`\ , :emphasis:`username`\ , :emphasis:`password`\ , :emphasis:`api\_key`\ , and :emphasis:`port`\ ). If both are present, then the classic params are ignored.
1001
+
- PAN\-OS connectivity should be specified using :emphasis:`provider` or the classic PAN\-OS connectivity params (\ :emphasis:`ip\_address`\ , :emphasis:`username`\ , :emphasis:`password`\ , :emphasis:`api\_key`\ , and :emphasis:`port`\ ). If both are present, then the classic params are ignored.
0 commit comments