diff --git a/docs/plugins/aggregate_module.rst b/docs/plugins/aggregate_module.rst old mode 100755 new mode 100644 index 65089736..a55196ce --- a/docs/plugins/aggregate_module.rst +++ b/docs/plugins/aggregate_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.aggregate -- Creates or removes aggregates from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.aggregate module -- Creates or removes aggregates from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,209 +88,426 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- date_added - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Date added, format: YYYY-MM-DD
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the aggregate
-
-
- prefix - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The aggregate prefix
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rir - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The RIR the aggregate will be assigned to
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
The state of the aggregate
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the aggregate may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-date_added: + + .. rst-class:: ansible-option-title + + **date_added** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Date added, format: YYYY-MM-DD + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the aggregate + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-prefix: + + .. rst-class:: ansible-option-title + + **prefix** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The aggregate prefix + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-rir: + + .. rst-class:: ansible-option-title + + **rir** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The RIR the aggregate will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The state of the aggregate + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`absent` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the aggregate may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -290,7 +519,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -348,46 +577,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- aggregate - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__return-aggregate: + + .. rst-class:: ansible-option-title + + **aggregate** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.aggregate_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/cable_module.rst b/docs/plugins/cable_module.rst old mode 100755 new mode 100644 index 783ed5d2..1ce9ff0a --- a/docs/plugins/cable_module.rst +++ b/docs/plugins/cable_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.cable -- Create, update or delete cables within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.cable module -- Create, update or delete cables within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,332 +88,638 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- color - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The color of the cable
-
-
- label - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The label of the cable
-
-
- length - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The length of the cable
-
-
- length_unit - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • m
    • -
  • cm
    • -
  • ft
    • -
  • in
    • -
- 		-
The unit in which the length of the cable is measured
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the cable
-
Required if state=present and does not exist yet
-
-
- termination_a - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The termination a
-
-
- termination_a_type - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • circuits.circuittermination
    • -
  • dcim.consoleport
    • -
  • dcim.consoleserverport
    • -
  • dcim.frontport
    • -
  • dcim.interface
    • -
  • dcim.powerfeed
    • -
  • dcim.poweroutlet
    • -
  • dcim.powerport
    • -
  • dcim.rearport
    • -
- 		-
The type of the termination a
-
-
- termination_b - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The termination b
-
-
- termination_b_type - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • circuits.circuittermination
    • -
  • dcim.consoleport
    • -
  • dcim.consoleserverport
    • -
  • dcim.frontport
    • -
  • dcim.interface
    • -
  • dcim.powerfeed
    • -
  • dcim.poweroutlet
    • -
  • dcim.powerport
    • -
  • dcim.rearport
    • -
- 		-
The type of the termination b
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • cat3
    • -
  • cat5
    • -
  • cat5e
    • -
  • cat6
    • -
  • cat6a
    • -
  • cat7
    • -
  • dac-active
    • -
  • dac-passive
    • -
  • mrj21-trunk
    • -
  • coaxial
    • -
  • mmf
    • -
  • mmf-om1
    • -
  • mmf-om2
    • -
  • mmf-om3
    • -
  • mmf-om4
    • -
  • smf
    • -
  • smf-os1
    • -
  • smf-os2
    • -
  • aoc
    • -
  • power
    • -
- 		-
The type of the cable
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-color: + + .. rst-class:: ansible-option-title + + **color** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The color of the cable + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-label: + + .. rst-class:: ansible-option-title + + **label** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The label of the cable + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-length: + + .. rst-class:: ansible-option-title + + **length** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The length of the cable + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-length_unit: + + .. rst-class:: ansible-option-title + + **length_unit** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The unit in which the length of the cable is measured + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`m` + - :ansible-option-choices-entry:`cm` + - :ansible-option-choices-entry:`ft` + - :ansible-option-choices-entry:`in` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the cable + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-termination_a: + + .. rst-class:: ansible-option-title + + **termination_a** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The termination a + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-termination_a_type: + + .. rst-class:: ansible-option-title + + **termination_a_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the termination a + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`circuits.circuittermination` + - :ansible-option-choices-entry:`dcim.consoleport` + - :ansible-option-choices-entry:`dcim.consoleserverport` + - :ansible-option-choices-entry:`dcim.frontport` + - :ansible-option-choices-entry:`dcim.interface` + - :ansible-option-choices-entry:`dcim.powerfeed` + - :ansible-option-choices-entry:`dcim.poweroutlet` + - :ansible-option-choices-entry:`dcim.powerport` + - :ansible-option-choices-entry:`dcim.rearport` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-termination_b: + + .. rst-class:: ansible-option-title + + **termination_b** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The termination b + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-termination_b_type: + + .. rst-class:: ansible-option-title + + **termination_b_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the termination b + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`circuits.circuittermination` + - :ansible-option-choices-entry:`dcim.consoleport` + - :ansible-option-choices-entry:`dcim.consoleserverport` + - :ansible-option-choices-entry:`dcim.frontport` + - :ansible-option-choices-entry:`dcim.interface` + - :ansible-option-choices-entry:`dcim.powerfeed` + - :ansible-option-choices-entry:`dcim.poweroutlet` + - :ansible-option-choices-entry:`dcim.powerport` + - :ansible-option-choices-entry:`dcim.rearport` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the cable + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`cat3` + - :ansible-option-choices-entry:`cat5` + - :ansible-option-choices-entry:`cat5e` + - :ansible-option-choices-entry:`cat6` + - :ansible-option-choices-entry:`cat6a` + - :ansible-option-choices-entry:`cat7` + - :ansible-option-choices-entry:`dac-active` + - :ansible-option-choices-entry:`dac-passive` + - :ansible-option-choices-entry:`mrj21-trunk` + - :ansible-option-choices-entry:`coaxial` + - :ansible-option-choices-entry:`mmf` + - :ansible-option-choices-entry:`mmf-om1` + - :ansible-option-choices-entry:`mmf-om2` + - :ansible-option-choices-entry:`mmf-om3` + - :ansible-option-choices-entry:`mmf-om4` + - :ansible-option-choices-entry:`smf` + - :ansible-option-choices-entry:`smf-os1` + - :ansible-option-choices-entry:`smf-os2` + - :ansible-option-choices-entry:`aoc` + - :ansible-option-choices-entry:`power` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -413,7 +731,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -493,46 +811,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- cable - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__return-cable: + + .. rst-class:: ansible-option-title + + **cable** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cable_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/circuit_module.rst b/docs/plugins/circuit_module.rst old mode 100755 new mode 100644 index 77aa1a2a..8dd19f09 --- a/docs/plugins/circuit_module.rst +++ b/docs/plugins/circuit_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.circuit -- Create, update or delete circuits within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.circuit module -- Create, update or delete circuits within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,300 +88,613 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cid - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The circuit id of the circuit
-
-
- circuit_type - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The circuit type of the circuit
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments related to circuit
-
-
- commit_rate - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Commit rate of the circuit (Kbps)
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the circuit
-
-
- install_date - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The date the circuit was installed. e.g. YYYY-MM-DD
-
-
- provider - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The provider of the circuit
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the circuit
-
Required if state=present and does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the device may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant assigned to the circuit
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-cid: + + .. rst-class:: ansible-option-title + + **cid** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The circuit id of the circuit + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-circuit_type: + + .. rst-class:: ansible-option-title + + **circuit_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The circuit type of the circuit + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments related to circuit + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-commit_rate: + + .. rst-class:: ansible-option-title + + **commit_rate** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Commit rate of the circuit (Kbps) + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the circuit + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-install_date: + + .. rst-class:: ansible-option-title + + **install_date** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The date the circuit was installed. e.g. YYYY-MM-DD + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-provider: + + .. rst-class:: ansible-option-title + + **provider** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The provider of the circuit + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the circuit + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the device may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant assigned to the circuit + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -381,7 +706,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -445,46 +770,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- circuit - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__return-circuit: + + .. rst-class:: ansible-option-title + + **circuit** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/circuit_termination_module.rst b/docs/plugins/circuit_termination_module.rst old mode 100755 new mode 100644 index d8222a26..e6fa1dfd --- a/docs/plugins/circuit_termination_module.rst +++ b/docs/plugins/circuit_termination_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.circuit_termination -- Create, update or delete circuit terminations within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.circuit_termination module -- Create, update or delete circuit terminations within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,249 +88,507 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- circuit - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The circuit to assign to circuit termination
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the circuit termination
-
-
- port_speed - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The speed of the port (Kbps)
-
-
- pp_info - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Patch panel information
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The site the circuit termination will be assigned to
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- term_side - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • A
    • -
  • Z
    • -
- 		-
The side of the circuit termination
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- upstream_speed - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The upstream speed of the circuit termination
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- xconnect_id - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The cross connect ID of the circuit termination
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-circuit: + + .. rst-class:: ansible-option-title + + **circuit** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The circuit to assign to circuit termination + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the circuit termination + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-port_speed: + + .. rst-class:: ansible-option-title + + **port_speed** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The speed of the port (Kbps) + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-pp_info: + + .. rst-class:: ansible-option-title + + **pp_info** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Patch panel information + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The site the circuit termination will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-term_side: + + .. rst-class:: ansible-option-title + + **term_side** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The side of the circuit termination + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`A` + - :ansible-option-choices-entry:`Z` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-upstream_speed: + + .. rst-class:: ansible-option-title + + **upstream_speed** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The upstream speed of the circuit termination + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__parameter-xconnect_id: + + .. rst-class:: ansible-option-title + + **xconnect_id** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The cross connect ID of the circuit termination + + + .. raw:: html + +
+ .. Attributes @@ -330,7 +600,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -391,46 +661,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- circuit_termination - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__return-circuit_termination: + + .. rst-class:: ansible-option-title + + **circuit_termination** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_termination_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/circuit_type_module.rst b/docs/plugins/circuit_type_module.rst old mode 100755 new mode 100644 index d25c9fbf..8508ce1a --- a/docs/plugins/circuit_type_module.rst +++ b/docs/plugins/circuit_type_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.circuit_type -- Create, update or delete circuit types within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.circuit_type module -- Create, update or delete circuit types within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,138 +88,280 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the circuit type
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the circuit type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -219,7 +373,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -264,46 +418,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- circuit_type - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__return-circuit_type: + + .. rst-class:: ansible-option-title + + **circuit_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.circuit_type_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/cluster_group_module.rst b/docs/plugins/cluster_group_module.rst old mode 100755 new mode 100644 index a7491f05..8e45b59a --- a/docs/plugins/cluster_group_module.rst +++ b/docs/plugins/cluster_group_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.cluster_group -- Create, update or delete cluster groups within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.cluster_group module -- Create, update or delete cluster groups within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,138 +88,280 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the cluster group
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the cluster group + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -219,7 +373,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -264,46 +418,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- cluster_group - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__return-cluster_group: + + .. rst-class:: ansible-option-title + + **cluster_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_group_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/cluster_module.rst b/docs/plugins/cluster_module.rst old mode 100755 new mode 100644 index 9b469add..df8365c0 --- a/docs/plugins/cluster_module.rst +++ b/docs/plugins/cluster_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.cluster -- Create, update or delete clusters within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.cluster module -- Create, update or delete clusters within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,245 +88,500 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster_group - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
group of the cluster
-
-
- cluster_type - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
type of the cluster
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments that may include additional information in regards to the cluster
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the cluster
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state=present and the cluster does not exist yet
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the cluster may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Tenant the cluster will be assigned to.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-cluster_group: + + .. rst-class:: ansible-option-title + + **cluster_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + group of the cluster + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-cluster_type: + + .. rst-class:: ansible-option-title + + **cluster_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + type of the cluster + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments that may include additional information in regards to the cluster + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the cluster + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if \ :emphasis:`state=present`\ and the cluster does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the cluster may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Tenant the cluster will be assigned to. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -326,7 +593,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -392,46 +659,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- cluster - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__return-cluster: + + .. rst-class:: ansible-option-title + + **cluster** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/cluster_type_module.rst b/docs/plugins/cluster_type_module.rst old mode 100755 new mode 100644 index b5d477f7..6affd0a0 --- a/docs/plugins/cluster_type_module.rst +++ b/docs/plugins/cluster_type_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.cluster_type -- Create, update or delete cluster types within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.cluster_type module -- Create, update or delete cluster types within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,138 +88,280 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the cluster type
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the cluster type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -219,7 +373,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -264,46 +418,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- cluster_type - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__return-cluster_type: + + .. rst-class:: ansible-option-title + + **cluster_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.cluster_type_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/console_port_module.rst b/docs/plugins/console_port_module.rst old mode 100755 new mode 100644 index 15cc7151..258c21ae --- a/docs/plugins/console_port_module.rst +++ b/docs/plugins/console_port_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.console_port -- Create, update or delete console ports within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.console_port module -- Create, update or delete console ports within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,206 +88,407 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the console port
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device the console port is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the console port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the console port may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • de-9
    • -
  • db-25
    • -
  • rj-11
    • -
  • rj-12
    • -
  • rj-45
    • -
  • usb-a
    • -
  • usb-b
    • -
  • usb-c
    • -
  • usb-mini-a
    • -
  • usb-mini-b
    • -
  • usb-micro-a
    • -
  • usb-micro-b
    • -
  • other
    • -
- 		-
The type of the console port
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the console port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the console port is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the console port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the console port may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the console port + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`de-9` + - :ansible-option-choices-entry:`db-25` + - :ansible-option-choices-entry:`rj-11` + - :ansible-option-choices-entry:`rj-12` + - :ansible-option-choices-entry:`rj-45` + - :ansible-option-choices-entry:`usb-a` + - :ansible-option-choices-entry:`usb-b` + - :ansible-option-choices-entry:`usb-c` + - :ansible-option-choices-entry:`usb-mini-a` + - :ansible-option-choices-entry:`usb-mini-b` + - :ansible-option-choices-entry:`usb-micro-a` + - :ansible-option-choices-entry:`usb-micro-b` + - :ansible-option-choices-entry:`other` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -287,7 +500,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -344,46 +557,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- console_port - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__return-console_port: + + .. rst-class:: ansible-option-title + + **console_port** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/console_port_template_module.rst b/docs/plugins/console_port_template_module.rst old mode 100755 new mode 100644 index 075f8761..ecf5f8a6 --- a/docs/plugins/console_port_template_module.rst +++ b/docs/plugins/console_port_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.console_port_template -- Create, update or delete console port templates within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.console_port_template module -- Create, update or delete console port templates within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,170 +88,333 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device type the console port template is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the console port template
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • de-9
    • -
  • db-25
    • -
  • rj-11
    • -
  • rj-12
    • -
  • rj-45
    • -
  • usb-a
    • -
  • usb-b
    • -
  • usb-c
    • -
  • usb-mini-a
    • -
  • usb-mini-b
    • -
  • usb-micro-a
    • -
  • usb-micro-b
    • -
  • other
    • -
- 		-
The type of the console port template
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device type the console port template is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the console port template + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the console port template + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`de-9` + - :ansible-option-choices-entry:`db-25` + - :ansible-option-choices-entry:`rj-11` + - :ansible-option-choices-entry:`rj-12` + - :ansible-option-choices-entry:`rj-45` + - :ansible-option-choices-entry:`usb-a` + - :ansible-option-choices-entry:`usb-b` + - :ansible-option-choices-entry:`usb-c` + - :ansible-option-choices-entry:`usb-mini-a` + - :ansible-option-choices-entry:`usb-mini-b` + - :ansible-option-choices-entry:`usb-micro-a` + - :ansible-option-choices-entry:`usb-micro-b` + - :ansible-option-choices-entry:`other` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -251,7 +426,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -307,46 +482,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- console_port_template - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__return-console_port_template: + + .. rst-class:: ansible-option-title + + **console_port_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_port_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/console_server_port_module.rst b/docs/plugins/console_server_port_module.rst old mode 100755 new mode 100644 index a14cc248..432ad2df --- a/docs/plugins/console_server_port_module.rst +++ b/docs/plugins/console_server_port_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.console_server_port -- Create, update or delete console server ports within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.console_server_port module -- Create, update or delete console server ports within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,206 +88,407 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the console server port
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device the console server port is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the console server port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the console server port may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • de-9
    • -
  • db-25
    • -
  • rj-11
    • -
  • rj-12
    • -
  • rj-45
    • -
  • usb-a
    • -
  • usb-b
    • -
  • usb-c
    • -
  • usb-mini-a
    • -
  • usb-mini-b
    • -
  • usb-micro-a
    • -
  • usb-micro-b
    • -
  • other
    • -
- 		-
The type of the console server port
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the console server port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the console server port is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the console server port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the console server port may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the console server port + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`de-9` + - :ansible-option-choices-entry:`db-25` + - :ansible-option-choices-entry:`rj-11` + - :ansible-option-choices-entry:`rj-12` + - :ansible-option-choices-entry:`rj-45` + - :ansible-option-choices-entry:`usb-a` + - :ansible-option-choices-entry:`usb-b` + - :ansible-option-choices-entry:`usb-c` + - :ansible-option-choices-entry:`usb-mini-a` + - :ansible-option-choices-entry:`usb-mini-b` + - :ansible-option-choices-entry:`usb-micro-a` + - :ansible-option-choices-entry:`usb-micro-b` + - :ansible-option-choices-entry:`other` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -287,7 +500,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -344,46 +557,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- console_server_port - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__return-console_server_port: + + .. rst-class:: ansible-option-title + + **console_server_port** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/console_server_port_template_module.rst b/docs/plugins/console_server_port_template_module.rst old mode 100755 new mode 100644 index 882a37db..5ded3e83 --- a/docs/plugins/console_server_port_template_module.rst +++ b/docs/plugins/console_server_port_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.console_server_port_template -- Create, update or delete console server port templates within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.console_server_port_template module -- Create, update or delete console server port templates within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,170 +88,333 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device type the console server port template is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the console server port template
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • de-9
    • -
  • db-25
    • -
  • rj-11
    • -
  • rj-12
    • -
  • rj-45
    • -
  • usb-a
    • -
  • usb-b
    • -
  • usb-c
    • -
  • usb-mini-a
    • -
  • usb-mini-b
    • -
  • usb-micro-a
    • -
  • usb-micro-b
    • -
  • other
    • -
- 		-
The type of the console server port template
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device type the console server port template is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the console server port template + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the console server port template + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`de-9` + - :ansible-option-choices-entry:`db-25` + - :ansible-option-choices-entry:`rj-11` + - :ansible-option-choices-entry:`rj-12` + - :ansible-option-choices-entry:`rj-45` + - :ansible-option-choices-entry:`usb-a` + - :ansible-option-choices-entry:`usb-b` + - :ansible-option-choices-entry:`usb-c` + - :ansible-option-choices-entry:`usb-mini-a` + - :ansible-option-choices-entry:`usb-mini-b` + - :ansible-option-choices-entry:`usb-micro-a` + - :ansible-option-choices-entry:`usb-micro-b` + - :ansible-option-choices-entry:`other` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -251,7 +426,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -307,46 +482,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- console_server_port_template - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__return-console_server_port_template: + + .. rst-class:: ansible-option-title + + **console_server_port_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.console_server_port_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/device_bay_module.rst b/docs/plugins/device_bay_module.rst old mode 100755 new mode 100644 index 5372d5e3..44db679e --- a/docs/plugins/device_bay_module.rst +++ b/docs/plugins/device_bay_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.device_bay -- Create, update or delete device bays within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.device_bay module -- Create, update or delete device bays within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,191 +88,389 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the device bay. This is supported on v2.6+ of Nautobot
-
-
- device - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device the device bay will be associated to. The device type must be "parent".
-
-
- installed_device - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The ddevice that will be installed into the bay. The device type must be "child".
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the device bay
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the device bay may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the device bay. This is supported on v2.6+ of Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the device bay will be associated to. The device type must be "parent". + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-installed_device: + + .. rst-class:: ansible-option-title + + **installed_device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The ddevice that will be installed into the bay. The device type must be "child". + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the device bay + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the device bay may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -272,7 +482,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -328,46 +538,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- device_bay - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__return-device_bay: + + .. rst-class:: ansible-option-title + + **device_bay** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/device_bay_template_module.rst b/docs/plugins/device_bay_template_module.rst old mode 100755 new mode 100644 index 368044f6..533ac4e1 --- a/docs/plugins/device_bay_template_module.rst +++ b/docs/plugins/device_bay_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.device_bay_template -- Create, update or delete device bay templates within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.device_bay_template module -- Create, update or delete device bay templates within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,137 +88,278 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device type the device bay template will be associated to. The device type must be "parent".
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the device bay template
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device type the device bay template will be associated to. The device type must be "parent". + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the device bay template + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -218,7 +371,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -265,46 +418,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- device_bay_template - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__return-device_bay_template: + + .. rst-class:: ansible-option-title + + **device_bay_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_bay_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/device_interface_module.rst b/docs/plugins/device_interface_module.rst old mode 100755 new mode 100644 index 597dad4e..acdbc34a --- a/docs/plugins/device_interface_module.rst +++ b/docs/plugins/device_interface_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.device_interface -- Creates or removes interfaces on devices from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.device_interface module -- Creates or removes interfaces on devices from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,405 +88,824 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Allows modification of any custom tags on the interface. The custom field must already exist in the model
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the interface
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the device the interface will be associated with (case-sensitive)
-
-
- enabled - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether interface shows enabled or disabled
-
-
- label - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Physical label of the interface
-
-
- lag - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Parent LAG interface will be a member of
-
-
- mac_address - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The MAC address of the interface
-
-
- mgmt_only - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
This interface is used only for out-of-band management
-
-
- mode - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The mode of the interface
-
-
- mtu - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The MTU of the interface
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the interface to be created
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tagged_vlans - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
A list of tagged VLANS to be assigned to interface. Mode must be set to either Tagged or Tagged All
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the interface may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Form factor of the interface: - ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) - This has to be specified exactly as what is found within UI
-
-
- untagged_vlan - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The untagged VLAN to be assigned to interface
-
-
- update_vc_child - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use when master device is specified for device and the specified interface exists on a child device - and needs updated
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Allows modification of any custom tags on the interface. The custom field must already exist in the model + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the device the interface will be associated with (case-sensitive) + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-enabled: + + .. rst-class:: ansible-option-title + + **enabled** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Sets whether interface shows enabled or disabled + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-label: + + .. rst-class:: ansible-option-title + + **label** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Physical label of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-lag: + + .. rst-class:: ansible-option-title + + **lag** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Parent LAG interface will be a member of + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-mac_address: + + .. rst-class:: ansible-option-title + + **mac_address** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The MAC address of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-mgmt_only: + + .. rst-class:: ansible-option-title + + **mgmt_only** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This interface is used only for out-of-band management + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-mode: + + .. rst-class:: ansible-option-title + + **mode** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The mode of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-mtu: + + .. rst-class:: ansible-option-title + + **mtu** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The MTU of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the interface to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-tagged_vlans: + + .. rst-class:: ansible-option-title + + **tagged_vlans** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + A list of tagged VLANS to be assigned to interface. Mode must be set to either \ :literal:`Tagged`\ or \ :literal:`Tagged All`\ + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the interface may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Form factor of the interface: + ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) + This has to be specified exactly as what is found within UI + + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-untagged_vlan: + + .. rst-class:: ansible-option-title + + **untagged_vlan** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The untagged VLAN to be assigned to interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-update_vc_child: + + .. rst-class:: ansible-option-title + + **update_vc_child** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use when master device is specified for \ :literal:`device`\ and the specified interface exists on a child device + and needs updated + + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -486,7 +917,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -595,46 +1026,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- interface - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__return-interface: + + .. rst-class:: ansible-option-title + + **interface** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/device_interface_template_module.rst b/docs/plugins/device_interface_template_module.rst old mode 100755 new mode 100644 index 124c14b9..917fa23d --- a/docs/plugins/device_interface_template_module.rst +++ b/docs/plugins/device_interface_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.device_interface_template -- Creates or removes interfaces on devices from Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.device_interface_template module -- Creates or removes interfaces on devices from Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,180 +88,364 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the device the interface template will be associated with (case-sensitive)
-
-
- mgmt_only - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
This interface template is used only for out-of-band management
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the interface template to be created
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Form factor of the interface: - ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) - This has to be specified exactly as what is found within UI
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the device the interface template will be associated with (case-sensitive) + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-mgmt_only: + + .. rst-class:: ansible-option-title + + **mgmt_only** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This interface template is used only for out-of-band management + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the interface template to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Form factor of the interface: + ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) + This has to be specified exactly as what is found within UI + + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -261,7 +457,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -308,46 +504,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- interface_template - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__return-interface_template: + + .. rst-class:: ansible-option-title + + **interface_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_interface_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/device_module.rst b/docs/plugins/device_module.rst old mode 100755 new mode 100644 index ca5937b2..d5f7ef4b --- a/docs/plugins/device_module.rst +++ b/docs/plugins/device_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.device -- Create, update or delete devices within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.device module -- Create, update or delete devices within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,504 +88,1029 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- asset_tag - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Asset tag that is associated to the device
-
-
- cluster - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Cluster that the device will be assigned to
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments that may include additional information in regards to the device
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- device_role - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state=present and the device does not exist yet
-
-
- device_type - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state=present and the device does not exist yet
-
-
- face - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • Front
    • -
  • front
    • -
  • Rear
    • -
  • rear
    • -
- 		-
Required if rack is defined
-
-
- local_context_data - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Arbitrary JSON data to define the devices configuration variables.
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the device
-
-
- platform - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The platform of the device
-
-
- position - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The position of the device in the rack defined above
-
-
- primary_ip4 - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Primary IPv4 address assigned to the device
-
-
- primary_ip6 - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Primary IPv6 address assigned to the device
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rack - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the rack to assign the device to
-
-
- serial - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Serial number of the device
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state=present and the device does not exist yet
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the device
-
Required if state=present and the device does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the device may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the device will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- vc_position - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Position in the assigned virtual chassis
-
-
- vc_priority - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Priority in the assigned virtual chassis
-
-
- virtual_chassis - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Virtual chassis the device will be assigned to
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-asset_tag: + + .. rst-class:: ansible-option-title + + **asset_tag** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Asset tag that is associated to the device + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-cluster: + + .. rst-class:: ansible-option-title + + **cluster** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Cluster that the device will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments that may include additional information in regards to the device + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-device_role: + + .. rst-class:: ansible-option-title + + **device_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if \ :emphasis:`state=present`\ and the device does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if \ :emphasis:`state=present`\ and the device does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-face: + + .. rst-class:: ansible-option-title + + **face** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if \ :emphasis:`rack`\ is defined + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`Front` + - :ansible-option-choices-entry:`front` + - :ansible-option-choices-entry:`Rear` + - :ansible-option-choices-entry:`rear` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-local_context_data: + + .. rst-class:: ansible-option-title + + **local_context_data** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Arbitrary JSON data to define the devices configuration variables. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the device + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-platform: + + .. rst-class:: ansible-option-title + + **platform** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The platform of the device + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-position: + + .. rst-class:: ansible-option-title + + **position** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The position of the device in the rack defined above + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-primary_ip4: + + .. rst-class:: ansible-option-title + + **primary_ip4** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Primary IPv4 address assigned to the device + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-primary_ip6: + + .. rst-class:: ansible-option-title + + **primary_ip6** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Primary IPv6 address assigned to the device + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-rack: + + .. rst-class:: ansible-option-title + + **rack** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the rack to assign the device to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-serial: + + .. rst-class:: ansible-option-title + + **serial** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serial number of the device + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if \ :emphasis:`state=present`\ and the device does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the device + + Required if \ :emphasis:`state=present`\ and the device does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the device may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the device will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-vc_position: + + .. rst-class:: ansible-option-title + + **vc_position** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Position in the assigned virtual chassis + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-vc_priority: + + .. rst-class:: ansible-option-title + + **vc_priority** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Priority in the assigned virtual chassis + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__parameter-virtual_chassis: + + .. rst-class:: ansible-option-title + + **virtual_chassis** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Virtual chassis the device will be assigned to + + + .. raw:: html + +
+ .. Attributes @@ -585,7 +1122,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -670,46 +1207,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- device - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__return-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/device_role_module.rst b/docs/plugins/device_role_module.rst old mode 100755 new mode 100644 index e729db23..df7bfcc8 --- a/docs/plugins/device_role_module.rst +++ b/docs/plugins/device_role_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.device_role -- Create, update or delete devices roles within Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.device_role module -- Create, update or delete devices roles within Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,196 +88,398 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- color - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Hexidecimal code for a color, ex. FFFFFF
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the device role
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the device role
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- vm_role - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Whether the role is a VM role
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-color: + + .. rst-class:: ansible-option-title + + **color** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Hexidecimal code for a color, ex. FFFFFF + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the device role + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the device role + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__parameter-vm_role: + + .. rst-class:: ansible-option-title + + **vm_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether the role is a VM role + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ .. Attributes @@ -277,7 +491,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -323,46 +537,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- device_role - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__return-device_role: + + .. rst-class:: ansible-option-title + + **device_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_role_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/device_type_module.rst b/docs/plugins/device_type_module.rst old mode 100755 new mode 100644 index a63f51a5..1365677c --- a/docs/plugins/device_type_module.rst +++ b/docs/plugins/device_type_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.device_type -- Create, update or delete device types within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.device_type module -- Create, update or delete device types within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,293 +88,594 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments that may include additional information in regards to the device_type
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- is_full_depth - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Whether or not the device consumes both front and rear rack faces
-
-
- manufacturer - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The manufacturer of the device type
-
-
- model - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The model of the device type
-
-
- part_number - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The part number of the device type
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slug of the device type. Must follow slug formatting (URL friendly)
-
If not specified, it will slugify the model
-
ex. test-device-type
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- subdevice_role - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • Parent
    • -
  • parent
    • -
  • Child
    • -
  • child
    • -
- 		-
Whether the device type is parent, child, or neither
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the device type may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- u_height - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The height of the device type in rack units
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments that may include additional information in regards to the device_type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-is_full_depth: + + .. rst-class:: ansible-option-title + + **is_full_depth** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether or not the device consumes both front and rear rack faces + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-manufacturer: + + .. rst-class:: ansible-option-title + + **manufacturer** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The manufacturer of the device type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-model: + + .. rst-class:: ansible-option-title + + **model** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The model of the device type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-part_number: + + .. rst-class:: ansible-option-title + + **part_number** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The part number of the device type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slug of the device type. Must follow slug formatting (URL friendly) + + If not specified, it will slugify the model + + ex. test-device-type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-subdevice_role: + + .. rst-class:: ansible-option-title + + **subdevice_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether the device type is parent, child, or neither + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`Parent` + - :ansible-option-choices-entry:`parent` + - :ansible-option-choices-entry:`Child` + - :ansible-option-choices-entry:`child` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the device type may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-u_height: + + .. rst-class:: ansible-option-title + + **u_height** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The height of the device type in rack units + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -374,7 +687,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -434,46 +747,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- device_type - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__return-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.device_type_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/front_port_module.rst b/docs/plugins/front_port_module.rst old mode 100755 new mode 100644 index 698e3d13..cfa61f44 --- a/docs/plugins/front_port_module.rst +++ b/docs/plugins/front_port_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.front_port -- Create, update or delete front ports within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.front_port module -- Create, update or delete front ports within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,243 +88,482 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the front port
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device the front port is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the front port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rear_port - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The rear_port the front port is attached to
-
-
- rear_port_position - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The position of the rear port this front port is connected to
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the front port may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • 8p8c
    • -
  • 110-punch
    • -
  • bnc
    • -
  • mrj21
    • -
  • fc
    • -
  • lc
    • -
  • lc-apc
    • -
  • lsh
    • -
  • lsh-apc
    • -
  • mpo
    • -
  • mtrj
    • -
  • sc
    • -
  • sc-apc
    • -
  • st
    • -
- 		-
The type of the front port
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the front port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the front port is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the front port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-rear_port: + + .. rst-class:: ansible-option-title + + **rear_port** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The rear_port the front port is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-rear_port_position: + + .. rst-class:: ansible-option-title + + **rear_port_position** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The position of the rear port this front port is connected to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the front port may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the front port + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`8p8c` + - :ansible-option-choices-entry:`110-punch` + - :ansible-option-choices-entry:`bnc` + - :ansible-option-choices-entry:`mrj21` + - :ansible-option-choices-entry:`fc` + - :ansible-option-choices-entry:`lc` + - :ansible-option-choices-entry:`lc-apc` + - :ansible-option-choices-entry:`lsh` + - :ansible-option-choices-entry:`lsh-apc` + - :ansible-option-choices-entry:`mpo` + - :ansible-option-choices-entry:`mtrj` + - :ansible-option-choices-entry:`sc` + - :ansible-option-choices-entry:`sc-apc` + - :ansible-option-choices-entry:`st` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -324,7 +575,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -387,46 +638,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- front_port - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__return-front_port: + + .. rst-class:: ansible-option-title + + **front_port** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/front_port_template_module.rst b/docs/plugins/front_port_template_module.rst old mode 100755 new mode 100644 index d68038e9..27ed1b3c --- a/docs/plugins/front_port_template_module.rst +++ b/docs/plugins/front_port_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.front_port_template -- Create, update or delete front port templates within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.front_port_template module -- Create, update or delete front port templates within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,217 +88,418 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device type the front port template is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the front port template
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rear_port_template - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The rear_port_template the front port template is attached to
-
-
- rear_port_template_position - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The position of the rear port template this front port template is connected to
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • 8p8c
    • -
  • 8p6c
    • -
  • 8p4c
    • -
  • 8p2c
    • -
  • gg45
    • -
  • tera-4p
    • -
  • tera-2p
    • -
  • tera-1p
    • -
  • 110-punch
    • -
  • bnc
    • -
  • mrj21
    • -
  • st
    • -
  • sc
    • -
  • sc-apc
    • -
  • fc
    • -
  • lc
    • -
  • lc-apc
    • -
  • mtrj
    • -
  • mpo
    • -
  • lsh
    • -
  • lsh-apc
    • -
  • splice
    • -
  • cs
    • -
  • sn
    • -
- 		-
The type of the front port template
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device type the front port template is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the front port template + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-rear_port_template: + + .. rst-class:: ansible-option-title + + **rear_port_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The rear_port_template the front port template is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-rear_port_template_position: + + .. rst-class:: ansible-option-title + + **rear_port_template_position** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The position of the rear port template this front port template is connected to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the front port template + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`8p8c` + - :ansible-option-choices-entry:`8p6c` + - :ansible-option-choices-entry:`8p4c` + - :ansible-option-choices-entry:`8p2c` + - :ansible-option-choices-entry:`gg45` + - :ansible-option-choices-entry:`tera-4p` + - :ansible-option-choices-entry:`tera-2p` + - :ansible-option-choices-entry:`tera-1p` + - :ansible-option-choices-entry:`110-punch` + - :ansible-option-choices-entry:`bnc` + - :ansible-option-choices-entry:`mrj21` + - :ansible-option-choices-entry:`st` + - :ansible-option-choices-entry:`sc` + - :ansible-option-choices-entry:`sc-apc` + - :ansible-option-choices-entry:`fc` + - :ansible-option-choices-entry:`lc` + - :ansible-option-choices-entry:`lc-apc` + - :ansible-option-choices-entry:`mtrj` + - :ansible-option-choices-entry:`mpo` + - :ansible-option-choices-entry:`lsh` + - :ansible-option-choices-entry:`lsh-apc` + - :ansible-option-choices-entry:`splice` + - :ansible-option-choices-entry:`cs` + - :ansible-option-choices-entry:`sn` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -298,7 +511,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -361,46 +574,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- front_port_template - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__return-front_port_template: + + .. rst-class:: ansible-option-title + + **front_port_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.front_port_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/gql_inventory_inventory.rst b/docs/plugins/gql_inventory_inventory.rst old mode 100755 new mode 100644 index ed6c2b6d..d8f03aeb --- a/docs/plugins/gql_inventory_inventory.rst +++ b/docs/plugins/gql_inventory_inventory.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.gql_inventory -- Nautobot inventory source using GraphQL capability -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.gql_inventory inventory -- Nautobot inventory source using GraphQL capability +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This inventory plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -75,229 +87,453 @@ The below requirements are needed on the local controller node that executes thi Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- additional_variables - -
- list - / elements=string
- - 		- Default:
[]
- 		- -
Variable types and values to use while making the call
-
-
- api_endpoint - -
- string - / required
- - 		- -
- env:NAUTOBOT_URL - -
- 		-
Endpoint of the Nautobot API
-
-
- filters - -
- dictionary -
- - 		- Default:
{}
- 		- -
Granular device search query
-
-
- follow_redirects - -
- string -
- - 		-
    Choices: -
  • urllib2 ←
    • -
  • all
    • -
  • yes
    • -
  • safe
    • -
  • none
    • -
- 		- -
Determine how redirects are followed.
-
By default, follow_redirects is set to uses urllib2 default behavior.
-
-
- group_by - -
- list - / elements=string
- - 		- Default:
[]
- 		- -
List of dot-sparated paths to index graphql query results (e.g. `platform.slug`)
-
The final value returned by each path is used to derive group names and then group the devices into these groups.
-
Valid group names must be string, so indexing the dotted path should return a string (i.e. `platform.slug` instead of `platform`)
-
If value returned by the defined path is a dictionary, an attempt will first be made to access the `name` field, and then the `slug` field. (i.e. `platform` would attempt to lookup `platform.name`, and if that data was not returned, it would then try `platform.slug`)
-
-
- plugin - -
- string - / required
- - 		-
    Choices: -
  • networktocode.nautobot.gql_inventory
    • -
- 		- -
Setting that ensures this is a source file for the 'networktocode.nautobot' plugin.
-
-
- query - -
- dictionary -
- - 		- Default:
{}
- 		- -
GraphQL query to send to Nautobot to obtain desired data
-
-
- timeout - -
- integer -
- - 		- Default:
60
- 		- -
Timeout for Nautobot requests in seconds
-
-
- token - -
- string - / required
- - 		- -
- env:NAUTOBOT_TOKEN - -
- 		-
Nautobot API token to be able to read against Nautobot.
-
This may not be required depending on the Nautobot setup.
-
-
- validate_certs - -
- boolean -
- - 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		- -
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-additional_variables: + + .. rst-class:: ansible-option-title + + **additional_variables** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Variable types and values to use while making the call + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`[]` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-api_endpoint: + + .. rst-class:: ansible-option-title + + **api_endpoint** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Endpoint of the Nautobot API + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_URL + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-filters: + + .. rst-class:: ansible-option-title + + **filters** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Granular device search query + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`{}` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-follow_redirects: + + .. rst-class:: ansible-option-title + + **follow_redirects** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Determine how redirects are followed. + + By default, \ :emphasis:`follow\_redirects`\ is set to uses urllib2 default behavior. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`urllib2` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`all` + - :ansible-option-choices-entry:`yes` + - :ansible-option-choices-entry:`safe` + - :ansible-option-choices-entry:`none` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-group_by: + + .. rst-class:: ansible-option-title + + **group_by** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + List of dot-sparated paths to index graphql query results (e.g. `platform.slug`) + + The final value returned by each path is used to derive group names and then group the devices into these groups. + + Valid group names must be string, so indexing the dotted path should return a string (i.e. `platform.slug` instead of `platform`) + + If value returned by the defined path is a dictionary, an attempt will first be made to access the `name` field, and then the `slug` field. (i.e. `platform` would attempt to lookup `platform.name`, and if that data was not returned, it would then try `platform.slug`) + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`[]` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-plugin: + + .. rst-class:: ansible-option-title + + **plugin** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Setting that ensures this is a source file for the 'networktocode.nautobot' plugin. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`networktocode.nautobot.gql\_inventory` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-query: + + .. rst-class:: ansible-option-title + + **query** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + GraphQL query to send to Nautobot to obtain desired data + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`{}` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-timeout: + + .. rst-class:: ansible-option-title + + **timeout** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Timeout for Nautobot requests in seconds + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`60` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nautobot API token to be able to read against Nautobot. + + This may not be required depending on the Nautobot setup. + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_TOKEN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Allows connection when SSL certificates are not valid. Set to \ :literal:`false`\ when certificates are not trusted. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ .. Attributes diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst old mode 100755 new mode 100644 index 8bdac237..1d8031da --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,4 +1,5 @@ + .. _plugins_in_networktocode.nautobot: Networktocode.Nautobot @@ -13,80 +14,82 @@ Collection version 3.3.0 Plugin Index ------------ -These are the plugins in the networktocode.nautobot collection +These are the plugins in the networktocode.nautobot collection: + + +Modules +~~~~~~~ + +* :ref:`aggregate module ` -- Creates or removes aggregates from Nautobot +* :ref:`cable module ` -- Create, update or delete cables within Nautobot +* :ref:`circuit module ` -- Create, update or delete circuits within Nautobot +* :ref:`circuit_termination module ` -- Create, update or delete circuit terminations within Nautobot +* :ref:`circuit_type module ` -- Create, update or delete circuit types within Nautobot +* :ref:`cluster module ` -- Create, update or delete clusters within Nautobot +* :ref:`cluster_group module ` -- Create, update or delete cluster groups within Nautobot +* :ref:`cluster_type module ` -- Create, update or delete cluster types within Nautobot +* :ref:`console_port module ` -- Create, update or delete console ports within Nautobot +* :ref:`console_port_template module ` -- Create, update or delete console port templates within Nautobot +* :ref:`console_server_port module ` -- Create, update or delete console server ports within Nautobot +* :ref:`console_server_port_template module ` -- Create, update or delete console server port templates within Nautobot +* :ref:`device module ` -- Create, update or delete devices within Nautobot +* :ref:`device_bay module ` -- Create, update or delete device bays within Nautobot +* :ref:`device_bay_template module ` -- Create, update or delete device bay templates within Nautobot +* :ref:`device_interface module ` -- Creates or removes interfaces on devices from Nautobot +* :ref:`device_interface_template module ` -- Creates or removes interfaces on devices from Nautobot +* :ref:`device_role module ` -- Create, update or delete devices roles within Nautobot +* :ref:`device_type module ` -- Create, update or delete device types within Nautobot +* :ref:`front_port module ` -- Create, update or delete front ports within Nautobot +* :ref:`front_port_template module ` -- Create, update or delete front port templates within Nautobot +* :ref:`inventory_item module ` -- Creates or removes inventory items from Nautobot +* :ref:`ip_address module ` -- Creates or removes IP addresses from Nautobot +* :ref:`ipam_role module ` -- Creates or removes ipam roles from Nautobot +* :ref:`manufacturer module ` -- Create or delete manufacturers within Nautobot +* :ref:`nautobot_server module ` -- Manages Nautobot Server application. +* :ref:`platform module ` -- Create or delete platforms within Nautobot +* :ref:`power_feed module ` -- Create, update or delete power feeds within Nautobot +* :ref:`power_outlet module ` -- Create, update or delete power outlets within Nautobot +* :ref:`power_outlet_template module ` -- Create, update or delete power outlet templates within Nautobot +* :ref:`power_panel module ` -- Create, update or delete power panels within Nautobot +* :ref:`power_port module ` -- Create, update or delete power ports within Nautobot +* :ref:`power_port_template module ` -- Create, update or delete power port templates within Nautobot +* :ref:`prefix module ` -- Creates or removes prefixes from Nautobot +* :ref:`provider module ` -- Create, update or delete providers within Nautobot +* :ref:`query_graphql module ` -- Queries and returns elements from Nautobot GraphQL endpoint +* :ref:`rack module ` -- Create, update or delete racks within Nautobot +* :ref:`rack_group module ` -- Create, update or delete racks groups within Nautobot +* :ref:`rack_role module ` -- Create, update or delete racks roles within Nautobot +* :ref:`rear_port module ` -- Create, update or delete rear ports within Nautobot +* :ref:`rear_port_template module ` -- Create, update or delete rear port templates within Nautobot +* :ref:`region module ` -- Creates or removes regions from Nautobot +* :ref:`rir module ` -- Create, update or delete RIRs within Nautobot +* :ref:`route_target module ` -- Creates or removes route targets from Nautobot +* :ref:`service module ` -- Creates or removes service from Nautobot +* :ref:`site module ` -- Creates or removes sites from Nautobot +* :ref:`status module ` -- Creates or removes status from Nautobot +* :ref:`tag module ` -- Creates or removes tags from Nautobot +* :ref:`tenant module ` -- Creates or removes tenants from Nautobot +* :ref:`tenant_group module ` -- Creates or removes tenant groups from Nautobot +* :ref:`virtual_chassis module ` -- Create, update or delete virtual chassis within Nautobot +* :ref:`virtual_machine module ` -- Create, update or delete virtual_machines within Nautobot +* :ref:`vlan module ` -- Create, update or delete vlans within Nautobot +* :ref:`vlan_group module ` -- Create, update or delete vlans groups within Nautobot +* :ref:`vm_interface module ` -- Creates or removes interfaces from virtual machines in Nautobot +* :ref:`vrf module ` -- Create, update or delete vrfs within Nautobot Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`gql_inventory ` -- Nautobot inventory source using GraphQL capability -* :ref:`inventory ` -- Nautobot inventory source +* :ref:`gql_inventory inventory ` -- Nautobot inventory source using GraphQL capability +* :ref:`inventory inventory ` -- Nautobot inventory source + Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`lookup ` -- Queries and returns elements from Nautobot -* :ref:`lookup_graphql ` -- Queries and returns elements from Nautobot GraphQL endpoint - -Modules -~~~~~~~ - -* :ref:`aggregate ` -- Creates or removes aggregates from Nautobot -* :ref:`cable ` -- Create, update or delete cables within Nautobot -* :ref:`circuit ` -- Create, update or delete circuits within Nautobot -* :ref:`circuit_termination ` -- Create, update or delete circuit terminations within Nautobot -* :ref:`circuit_type ` -- Create, update or delete circuit types within Nautobot -* :ref:`cluster ` -- Create, update or delete clusters within Nautobot -* :ref:`cluster_group ` -- Create, update or delete cluster groups within Nautobot -* :ref:`cluster_type ` -- Create, update or delete cluster types within Nautobot -* :ref:`console_port ` -- Create, update or delete console ports within Nautobot -* :ref:`console_port_template ` -- Create, update or delete console port templates within Nautobot -* :ref:`console_server_port ` -- Create, update or delete console server ports within Nautobot -* :ref:`console_server_port_template ` -- Create, update or delete console server port templates within Nautobot -* :ref:`device ` -- Create, update or delete devices within Nautobot -* :ref:`device_bay ` -- Create, update or delete device bays within Nautobot -* :ref:`device_bay_template ` -- Create, update or delete device bay templates within Nautobot -* :ref:`device_interface ` -- Creates or removes interfaces on devices from Nautobot -* :ref:`device_interface_template ` -- Creates or removes interfaces on devices from Nautobot -* :ref:`device_role ` -- Create, update or delete devices roles within Nautobot -* :ref:`device_type ` -- Create, update or delete device types within Nautobot -* :ref:`front_port ` -- Create, update or delete front ports within Nautobot -* :ref:`front_port_template ` -- Create, update or delete front port templates within Nautobot -* :ref:`inventory_item ` -- Creates or removes inventory items from Nautobot -* :ref:`ip_address ` -- Creates or removes IP addresses from Nautobot -* :ref:`ipam_role ` -- Creates or removes ipam roles from Nautobot -* :ref:`manufacturer ` -- Create or delete manufacturers within Nautobot -* :ref:`nautobot_server ` -- Manages Nautobot Server application. -* :ref:`platform ` -- Create or delete platforms within Nautobot -* :ref:`power_feed ` -- Create, update or delete power feeds within Nautobot -* :ref:`power_outlet ` -- Create, update or delete power outlets within Nautobot -* :ref:`power_outlet_template ` -- Create, update or delete power outlet templates within Nautobot -* :ref:`power_panel ` -- Create, update or delete power panels within Nautobot -* :ref:`power_port ` -- Create, update or delete power ports within Nautobot -* :ref:`power_port_template ` -- Create, update or delete power port templates within Nautobot -* :ref:`prefix ` -- Creates or removes prefixes from Nautobot -* :ref:`provider ` -- Create, update or delete providers within Nautobot -* :ref:`query_graphql ` -- Queries and returns elements from Nautobot GraphQL endpoint -* :ref:`rack ` -- Create, update or delete racks within Nautobot -* :ref:`rack_group ` -- Create, update or delete racks groups within Nautobot -* :ref:`rack_role ` -- Create, update or delete racks roles within Nautobot -* :ref:`rear_port ` -- Create, update or delete rear ports within Nautobot -* :ref:`rear_port_template ` -- Create, update or delete rear port templates within Nautobot -* :ref:`region ` -- Creates or removes regions from Nautobot -* :ref:`rir ` -- Create, update or delete RIRs within Nautobot -* :ref:`route_target ` -- Creates or removes route targets from Nautobot -* :ref:`service ` -- Creates or removes service from Nautobot -* :ref:`site ` -- Creates or removes sites from Nautobot -* :ref:`status ` -- Creates or removes status from Nautobot -* :ref:`tag ` -- Creates or removes tags from Nautobot -* :ref:`tenant ` -- Creates or removes tenants from Nautobot -* :ref:`tenant_group ` -- Creates or removes tenant groups from Nautobot -* :ref:`virtual_chassis ` -- Create, update or delete virtual chassis within Nautobot -* :ref:`virtual_machine ` -- Create, update or delete virtual_machines within Nautobot -* :ref:`vlan ` -- Create, update or delete vlans within Nautobot -* :ref:`vlan_group ` -- Create, update or delete vlans groups within Nautobot -* :ref:`vm_interface ` -- Creates or removes interfaces from virtual machines in Nautobot -* :ref:`vrf ` -- Create, update or delete vrfs within Nautobot +* :ref:`lookup lookup ` -- Queries and returns elements from Nautobot +* :ref:`lookup_graphql lookup ` -- Queries and returns elements from Nautobot GraphQL endpoint diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst old mode 100755 new mode 100644 index 4cf26abf..8a1ea67a --- a/docs/plugins/inventory_inventory.rst +++ b/docs/plugins/inventory_inventory.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.inventory -- Nautobot inventory source -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.inventory inventory -- Nautobot inventory source ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This inventory plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -69,837 +81,1586 @@ Synopsis Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- ansible_host_dns_name - -
- boolean -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
If True, sets DNS Name (fetched from primary_ip) to be used in ansible_host variable, instead of IP Address.
-
-
- api_endpoint - -
- string - / required
- - 		- -
- env:NAUTOBOT_URL - -
- 		-
Endpoint of the Nautobot API
-
-
- cache - -
- boolean -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
ini entries: -

- [inventory]
cache = no - -

-
-
- env:ANSIBLE_INVENTORY_CACHE - -
- 		-
Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work.
-
-
- cache_connection - -
- string -
- - 		- -
ini entries: -

- [defaults]
fact_caching_connection = None - -

-

- [inventory]
cache_connection = None - -

-
-
- env:ANSIBLE_CACHE_PLUGIN_CONNECTION - -
-
- env:ANSIBLE_INVENTORY_CACHE_CONNECTION - -
- 		-
Cache connection data or path, read cache plugin documentation for specifics.
-
-
- cache_plugin - -
- string -
- - 		- Default:
"memory"
- 		-
ini entries: -

- [defaults]
fact_caching = memory - -

-

- [inventory]
cache_plugin = memory - -

-
-
- env:ANSIBLE_CACHE_PLUGIN - -
-
- env:ANSIBLE_INVENTORY_CACHE_PLUGIN - -
- 		-
Cache plugin to use for the inventory's source data.
-
-
- cache_prefix - -
- string -
- - 		- Default:
"ansible_inventory_"
- 		-
ini entries: -

- [default]
fact_caching_prefix = ansible_inventory_ - -

-

- [inventory]
cache_prefix = ansible_inventory_ - -

-
-
- env:ANSIBLE_CACHE_PLUGIN_PREFIX - -
-
- env:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX - -
- 		-
Prefix to use for cache plugin files/tables
-
-
- cache_timeout - -
- integer -
- - 		- Default:
3600
- 		-
ini entries: -

- [defaults]
fact_caching_timeout = 3600 - -

-

- [inventory]
cache_timeout = 3600 - -

-
-
- env:ANSIBLE_CACHE_PLUGIN_TIMEOUT - -
-
- env:ANSIBLE_INVENTORY_CACHE_TIMEOUT - -
- 		-
Cache duration in seconds
-
-
- compose - -
- dictionary -
- - 		- Default:
{}
- 		- -
List of custom ansible host vars to create from the device object fetched from Nautobot
-
-
- config_context - -
- boolean -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
If True, it adds config_context in host vars.
-
Config-context enables the association of arbitrary data to devices and virtual machines grouped by region, site, role, platform, and/or tenant. Please check official nautobot docs for more info.
-
-
- device_query_filters - -
- list - / elements=string
- - 		- Default:
[]
- 		- -
List of parameters passed to the query string for devices (Multiple values may be separated by commas)
-
-
- dns_name - -
- boolean -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
Force IP Addresses to be fetched so that the dns_name for the primary_ip of each device or VM is set as a host_var.
-
Setting interfaces will also fetch IP addresses and the dns_name host_var will be set.
-
-
- fetch_all - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		- -
By default, fetching interfaces and services will get all of the contents of Nautobot regardless of query_filters applied to devices and VMs.
-
When set to False, separate requests will be made fetching interfaces, services, and IP addresses for each device_id and virtual_machine_id.
-
If you are using the various query_filters options to reduce the number of devices, querying Nautobot may be faster with fetch_all False.
-
For efficiency, when False, these requests will be batched, for example /api/dcim/interfaces?limit=0&device_id=1&device_id=2&device_id=3
-
These GET request URIs can become quite large for a large number of devices.
-
If you run into HTTP 414 errors, you can adjust the max_uri_length option to suit your web server.
-
-
- flatten_config_context - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
If config_context is enabled, by default it's added as a host var named config_context.
-
If flatten_config_context is set to True, the config context variables will be added directly to the host instead.
-
-
- flatten_custom_fields - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
By default, host custom fields are added as a dictionary host var named custom_fields.
-
If flatten_custom_fields is set to True, the fields will be added directly to the host instead.
-
-
- flatten_local_context_data - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
If local_context_data is enabled, by default it's added as a host var named local_context_data.
-
If flatten_local_context_data is set to True, the config context variables will be added directly to the host instead.
-
-
- follow_redirects - -
- string -
- - 		-
    Choices: -
  • urllib2 ←
    • -
  • all
    • -
  • yes
    • -
  • safe
    • -
  • none
    • -
- 		- -
Determine how redirects are followed.
-
By default, follow_redirects is set to uses urllib2 default behavior.
-
-
- group_by - -
- list - / elements=string
- - 		-
    Choices: -
  • sites
    • -
  • site
    • -
  • tenants
    • -
  • tenant
    • -
  • tenant_group
    • -
  • racks
    • -
  • rack
    • -
  • rack_group
    • -
  • rack_role
    • -
  • tags
    • -
  • tag
    • -
  • device_roles
    • -
  • role
    • -
  • device_types
    • -
  • device_type
    • -
  • manufacturers
    • -
  • manufacturer
    • -
  • platforms
    • -
  • platform
    • -
  • region
    • -
  • cluster
    • -
  • cluster_type
    • -
  • cluster_group
    • -
  • is_virtual
    • -
  • services
    • -
  • status
    • -
- Default:
[]
- 		- -
Keys used to create groups. The plurals option controls which of these are valid.
-
-
- group_names_raw - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
Will not add the group_by choice name to the group names
-
-
- groups - -
- dictionary -
- - 		- Default:
{}
- 		- -
Add hosts to group based on Jinja2 conditionals.
-
-
- interfaces - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
If True, it adds the device or virtual machine interface information in host vars.
-
-
- keyed_groups - -
- list - / elements=string
- - 		- Default:
[]
- 		- -
Add hosts to group based on the values of a variable.
-
-
- max_uri_length - -
- integer -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		- Default:
4000
- 		- -
When fetch_all is False, GET requests to Nautobot may become quite long and return a HTTP 414 (URI Too Long).
-
You can adjust this option to be smaller to avoid 414 errors, or larger for a reduced number of requests.
-
-
- plugin - -
- string - / required
- - 		-
    Choices: -
  • networktocode.nautobot.inventory
    • -
- 		- -
token that ensures this is a source file for the 'nautobot' plugin.
-
-
- plurals - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		- -
If True, all host vars are contained inside single-element arrays for legacy compatibility with old versions of this plugin.
-
Group names will be plural (ie. "sites_mysite" instead of "site_mysite")
-
The choices of group_by will be changed by this option.
-
-
- query_filters - -
- list - / elements=string
- - 		- Default:
[]
- 		- -
List of parameters passed to the query string for both devices and VMs (Multiple values may be separated by commas)
-
-
- services - -
- boolean -
-
- added in 1.0.0 of networktocode.nautobot -
- - 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		- -
If True, it adds the device or virtual machine services information in host vars.
-
-
- strict - -
- boolean -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
If yes make invalid entries a fatal error, otherwise skip and continue.
-
Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.
-
-
- timeout - -
- integer -
- - 		- Default:
60
- 		- -
Timeout for Nautobot requests in seconds
-
-
- token - -
- string -
- - 		- -
- env:NAUTOBOT_TOKEN - -
- 		-
Nautobot API token to be able to read against Nautobot.
-
This may not be required depending on the Nautobot setup.
-
-
- validate_certs - -
- boolean -
- - 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		- -
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-
-
- virtual_chassis_name - -
- boolean -
- - 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		- -
When a device is part of a virtual chassis, use the virtual chassis name as the Ansible inventory hostname.
-
The host var values will be from the virtual chassis master.
-
-
- vm_query_filters - -
- list - / elements=string
- - 		- Default:
[]
- 		- -
List of parameters passed to the query string for VMs (Multiple values may be separated by commas)
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-ansible_host_dns_name: + + .. rst-class:: ansible-option-title + + **ansible_host_dns_name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If True, sets DNS Name (fetched from primary_ip) to be used in ansible_host variable, instead of IP Address. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-api_endpoint: + + .. rst-class:: ansible-option-title + + **api_endpoint** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Endpoint of the Nautobot API + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_URL + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-cache: + + .. rst-class:: ansible-option-title + + **cache** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entry: + + .. code-block:: + + [inventory] + cache = no + + + - Environment variable: ANSIBLE\_INVENTORY\_CACHE + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-cache_connection: + + .. rst-class:: ansible-option-title + + **cache_connection** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Cache connection data or path, read cache plugin documentation for specifics. + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entries: + + .. code-block:: + + [defaults] + fact_caching_connection = None + + + + .. code-block:: + + [inventory] + cache_connection = None + + + - Environment variable: ANSIBLE\_CACHE\_PLUGIN\_CONNECTION + + - Environment variable: ANSIBLE\_INVENTORY\_CACHE\_CONNECTION + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-cache_plugin: + + .. rst-class:: ansible-option-title + + **cache_plugin** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Cache plugin to use for the inventory's source data. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"memory"` + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entries: + + .. code-block:: + + [defaults] + fact_caching = memory + + + + .. code-block:: + + [inventory] + cache_plugin = memory + + + - Environment variable: ANSIBLE\_CACHE\_PLUGIN + + - Environment variable: ANSIBLE\_INVENTORY\_CACHE\_PLUGIN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-cache_prefix: + + .. rst-class:: ansible-option-title + + **cache_prefix** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Prefix to use for cache plugin files/tables + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"ansible\_inventory\_"` + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entries: + + .. code-block:: + + [default] + fact_caching_prefix = ansible_inventory_ + + + + .. code-block:: + + [inventory] + cache_prefix = ansible_inventory_ + + + - Environment variable: ANSIBLE\_CACHE\_PLUGIN\_PREFIX + + - Environment variable: ANSIBLE\_INVENTORY\_CACHE\_PLUGIN\_PREFIX + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-cache_timeout: + + .. rst-class:: ansible-option-title + + **cache_timeout** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Cache duration in seconds + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`3600` + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entries: + + .. code-block:: + + [defaults] + fact_caching_timeout = 3600 + + + + .. code-block:: + + [inventory] + cache_timeout = 3600 + + + - Environment variable: ANSIBLE\_CACHE\_PLUGIN\_TIMEOUT + + - Environment variable: ANSIBLE\_INVENTORY\_CACHE\_TIMEOUT + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-compose: + + .. rst-class:: ansible-option-title + + **compose** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + List of custom ansible host vars to create from the device object fetched from Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`{}` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-config_context: + + .. rst-class:: ansible-option-title + + **config_context** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If True, it adds config_context in host vars. + + Config-context enables the association of arbitrary data to devices and virtual machines grouped by region, site, role, platform, and/or tenant. Please check official nautobot docs for more info. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-device_query_filters: + + .. rst-class:: ansible-option-title + + **device_query_filters** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + List of parameters passed to the query string for devices (Multiple values may be separated by commas) + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`[]` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-dns_name: + + .. rst-class:: ansible-option-title + + **dns_name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Force IP Addresses to be fetched so that the dns_name for the primary_ip of each device or VM is set as a host_var. + + Setting interfaces will also fetch IP addresses and the dns_name host_var will be set. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-fetch_all: + + .. rst-class:: ansible-option-title + + **fetch_all** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + By default, fetching interfaces and services will get all of the contents of Nautobot regardless of query_filters applied to devices and VMs. + + When set to False, separate requests will be made fetching interfaces, services, and IP addresses for each device_id and virtual_machine_id. + + If you are using the various query_filters options to reduce the number of devices, querying Nautobot may be faster with fetch_all False. + + For efficiency, when False, these requests will be batched, for example /api/dcim/interfaces?limit=0&device_id=1&device_id=2&device_id=3 + + These GET request URIs can become quite large for a large number of devices. + + If you run into HTTP 414 errors, you can adjust the max_uri_length option to suit your web server. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-flatten_config_context: + + .. rst-class:: ansible-option-title + + **flatten_config_context** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :emphasis:`config\_context`\ is enabled, by default it's added as a host var named config_context. + + If flatten_config_context is set to True, the config context variables will be added directly to the host instead. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-flatten_custom_fields: + + .. rst-class:: ansible-option-title + + **flatten_custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + By default, host custom fields are added as a dictionary host var named custom_fields. + + If flatten_custom_fields is set to True, the fields will be added directly to the host instead. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-flatten_local_context_data: + + .. rst-class:: ansible-option-title + + **flatten_local_context_data** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :emphasis:`local\_context\_data`\ is enabled, by default it's added as a host var named local_context_data. + + If flatten_local_context_data is set to True, the config context variables will be added directly to the host instead. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-follow_redirects: + + .. rst-class:: ansible-option-title + + **follow_redirects** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Determine how redirects are followed. + + By default, \ :emphasis:`follow\_redirects`\ is set to uses urllib2 default behavior. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`urllib2` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`all` + - :ansible-option-choices-entry:`yes` + - :ansible-option-choices-entry:`safe` + - :ansible-option-choices-entry:`none` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-group_by: + + .. rst-class:: ansible-option-title + + **group_by** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Keys used to create groups. The \ :emphasis:`plurals`\ option controls which of these are valid. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`sites` + - :ansible-option-choices-entry:`site` + - :ansible-option-choices-entry:`tenants` + - :ansible-option-choices-entry:`tenant` + - :ansible-option-choices-entry:`tenant\_group` + - :ansible-option-choices-entry:`racks` + - :ansible-option-choices-entry:`rack` + - :ansible-option-choices-entry:`rack\_group` + - :ansible-option-choices-entry:`rack\_role` + - :ansible-option-choices-entry:`tags` + - :ansible-option-choices-entry:`tag` + - :ansible-option-choices-entry:`device\_roles` + - :ansible-option-choices-entry:`role` + - :ansible-option-choices-entry:`device\_types` + - :ansible-option-choices-entry:`device\_type` + - :ansible-option-choices-entry:`manufacturers` + - :ansible-option-choices-entry:`manufacturer` + - :ansible-option-choices-entry:`platforms` + - :ansible-option-choices-entry:`platform` + - :ansible-option-choices-entry:`region` + - :ansible-option-choices-entry:`cluster` + - :ansible-option-choices-entry:`cluster\_type` + - :ansible-option-choices-entry:`cluster\_group` + - :ansible-option-choices-entry:`is\_virtual` + - :ansible-option-choices-entry:`services` + - :ansible-option-choices-entry:`status` + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`[]` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-group_names_raw: + + .. rst-class:: ansible-option-title + + **group_names_raw** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Will not add the group_by choice name to the group names + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-groups: + + .. rst-class:: ansible-option-title + + **groups** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Add hosts to group based on Jinja2 conditionals. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`{}` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-interfaces: + + .. rst-class:: ansible-option-title + + **interfaces** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If True, it adds the device or virtual machine interface information in host vars. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-keyed_groups: + + .. rst-class:: ansible-option-title + + **keyed_groups** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Add hosts to group based on the values of a variable. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`[]` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-max_uri_length: + + .. rst-class:: ansible-option-title + + **max_uri_length** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + When fetch_all is False, GET requests to Nautobot may become quite long and return a HTTP 414 (URI Too Long). + + You can adjust this option to be smaller to avoid 414 errors, or larger for a reduced number of requests. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`4000` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-plugin: + + .. rst-class:: ansible-option-title + + **plugin** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + token that ensures this is a source file for the 'nautobot' plugin. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`networktocode.nautobot.inventory` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-plurals: + + .. rst-class:: ansible-option-title + + **plurals** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If True, all host vars are contained inside single-element arrays for legacy compatibility with old versions of this plugin. + + Group names will be plural (ie. "sites_mysite" instead of "site_mysite") + + The choices of \ :emphasis:`group\_by`\ will be changed by this option. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-query_filters: + + .. rst-class:: ansible-option-title + + **query_filters** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + List of parameters passed to the query string for both devices and VMs (Multiple values may be separated by commas) + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`[]` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-services: + + .. rst-class:: ansible-option-title + + **services** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 1.0.0 of networktocode.nautobot` + + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If True, it adds the device or virtual machine services information in host vars. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-strict: + + .. rst-class:: ansible-option-title + + **strict** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`yes`\ make invalid entries a fatal error, otherwise skip and continue. + + Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-timeout: + + .. rst-class:: ansible-option-title + + **timeout** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Timeout for Nautobot requests in seconds + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`60` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nautobot API token to be able to read against Nautobot. + + This may not be required depending on the Nautobot setup. + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_TOKEN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Allows connection when SSL certificates are not valid. Set to \ :literal:`false`\ when certificates are not trusted. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-virtual_chassis_name: + + .. rst-class:: ansible-option-title + + **virtual_chassis_name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + When a device is part of a virtual chassis, use the virtual chassis name as the Ansible inventory hostname. + + The host var values will be from the virtual chassis master. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_inventory__parameter-vm_query_filters: + + .. rst-class:: ansible-option-title + + **vm_query_filters** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + List of parameters passed to the query string for VMs (Multiple values may be separated by commas) + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`[]` + + .. raw:: html + +
+ .. Attributes diff --git a/docs/plugins/inventory_item_module.rst b/docs/plugins/inventory_item_module.rst old mode 100755 new mode 100644 index e951c90c..cad06721 --- a/docs/plugins/inventory_item_module.rst +++ b/docs/plugins/inventory_item_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.inventory_item -- Creates or removes inventory items from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.inventory_item module -- Creates or removes inventory items from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,268 +88,546 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- asset_tag - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The asset tag of the inventory item
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the inventory item
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the device the inventory item belongs to
-
-
- discovered - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Set the discovery flag for the inventory item
-
-
- manufacturer - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The manufacturer of the inventory item
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the inventory item to be created
-
-
- part_id - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The part ID of the inventory item
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- serial - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The serial number of the inventory item
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the device may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-asset_tag: + + .. rst-class:: ansible-option-title + + **asset_tag** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The asset tag of the inventory item + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the inventory item + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the device the inventory item belongs to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-discovered: + + .. rst-class:: ansible-option-title + + **discovered** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Set the discovery flag for the inventory item + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-manufacturer: + + .. rst-class:: ansible-option-title + + **manufacturer** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The manufacturer of the inventory item + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the inventory item to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-part_id: + + .. rst-class:: ansible-option-title + + **part_id** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The part ID of the inventory item + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-serial: + + .. rst-class:: ansible-option-title + + **serial** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The serial number of the inventory item + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the device may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -349,7 +639,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -408,46 +698,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- inventory_item - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__return-inventory_item: + + .. rst-class:: ansible-option-title + + **inventory_item** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.inventory_item_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/ip_address_module.rst b/docs/plugins/ip_address_module.rst old mode 100755 new mode 100644 index 479470da..a803ecc8 --- a/docs/plugins/ip_address_module.rst +++ b/docs/plugins/ip_address_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.ip_address -- Creates or removes IP addresses from Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.ip_address module -- Creates or removes IP addresses from Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,389 +88,780 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- address - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state is present
-
-
- assigned_object - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Definition of the assigned object.
-
-
- device - -
- string -
- 		- -
The device the interface is attached to.
-
-
- name - -
- string -
- 		- -
The name of the interface
-
-
- virtual_machine - -
- string -
- 		- -
The virtual machine the interface is attached to.
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the interface
-
-
- dns_name - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Hostname or FQDN
-
-
- nat_inside - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The inside IP address this IP is assigned to
-
-
- prefix - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
With state present, if an interface is given, it will ensure - that an IP inside this prefix (and vrf, if given) is attached - to this interface. Otherwise, it will get the next available IP - of this prefix and attach it. - With state new, it will force to get the next available IP in - this prefix. If an interface is given, it will also force to attach - it. - Required if state is present or new when no address is given. - Unused if an address is specified.
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- role - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • Loopback
    • -
  • Secondary
    • -
  • Anycast
    • -
  • VIP
    • -
  • VRRP
    • -
  • HSRP
    • -
  • GLBP
    • -
  • CARP
    • -
- 		-
The role of the IP address
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • new
    • -
  • present ←
    • -
- 		-
Use present, new or absent for adding, force adding or removing. - present will check if the IP is already created, and return it if - true. new will force to create it anyway (useful for anycasts, for - example).
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the IP address
-
Required if state=present and does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the IP address may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the device will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- vrf - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
VRF that IP address is associated with
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-address: + + .. rst-class:: ansible-option-title + + **address** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if state is \ :literal:`present`\ + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-assigned_object: + + .. rst-class:: ansible-option-title + + **assigned_object** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Definition of the assigned object. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-assigned_object/device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the interface is attached to. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-assigned_object/name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-assigned_object/virtual_machine: + + .. rst-class:: ansible-option-title + + **virtual_machine** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The virtual machine the interface is attached to. + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-dns_name: + + .. rst-class:: ansible-option-title + + **dns_name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Hostname or FQDN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-nat_inside: + + .. rst-class:: ansible-option-title + + **nat_inside** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The inside IP address this IP is assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-prefix: + + .. rst-class:: ansible-option-title + + **prefix** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + With state \ :literal:`present`\ , if an interface is given, it will ensure + that an IP inside this prefix (and vrf, if given) is attached + to this interface. Otherwise, it will get the next available IP + of this prefix and attach it. + With state \ :literal:`new`\ , it will force to get the next available IP in + this prefix. If an interface is given, it will also force to attach + it. + Required if state is \ :literal:`present`\ or \ :literal:`new`\ when no address is given. + Unused if an address is specified. + + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-role: + + .. rst-class:: ansible-option-title + + **role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The role of the IP address + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`Loopback` + - :ansible-option-choices-entry:`Secondary` + - :ansible-option-choices-entry:`Anycast` + - :ansible-option-choices-entry:`VIP` + - :ansible-option-choices-entry:`VRRP` + - :ansible-option-choices-entry:`HSRP` + - :ansible-option-choices-entry:`GLBP` + - :ansible-option-choices-entry:`CARP` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ , \ :literal:`new`\ or \ :literal:`absent`\ for adding, force adding or removing. + \ :literal:`present`\ will check if the IP is already created, and return it if + true. \ :literal:`new`\ will force to create it anyway (useful for anycasts, for + example). + + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-choices-entry:`new` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the IP address + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the IP address may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the device will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__parameter-vrf: + + .. rst-class:: ansible-option-title + + **vrf** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + VRF that IP address is associated with + + + .. raw:: html + +
+ .. Attributes @@ -470,7 +873,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -574,46 +977,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- ip_address - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__return-ip_address: + + .. rst-class:: ansible-option-title + + **ip_address** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ip_address_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/ipam_role_module.rst b/docs/plugins/ipam_role_module.rst old mode 100755 new mode 100644 index 04a0203b..f890844e --- a/docs/plugins/ipam_role_module.rst +++ b/docs/plugins/ipam_role_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.ipam_role -- Creates or removes ipam roles from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.ipam_role module -- Creates or removes ipam roles from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,157 +88,319 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the ipam role to be created
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
- weight - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The weight of the ipam role to be created
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the ipam role to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__parameter-weight: + + .. rst-class:: ansible-option-title + + **weight** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The weight of the ipam role to be created + + + .. raw:: html + +
+ .. Attributes @@ -238,7 +412,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -282,46 +456,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- role - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.ipam_role_module__return-role: + + .. rst-class:: ansible-option-title + + **role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/lookup_graphql_lookup.rst b/docs/plugins/lookup_graphql_lookup.rst old mode 100755 new mode 100644 index 1e585a28..67708b9d --- a/docs/plugins/lookup_graphql_lookup.rst +++ b/docs/plugins/lookup_graphql_lookup.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.lookup_graphql -- Queries and returns elements from Nautobot GraphQL endpoint -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.lookup_graphql lookup -- Queries and returns elements from Nautobot GraphQL endpoint ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This lookup plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,117 +88,221 @@ The below requirements are needed on the local controller node that executes thi Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- graph_variables - -
- string -
- - 		- - -
Dictionary of keys/values to pass into the GraphQL query
-
See [pynautobot GraphQL documentation](https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html) for more details
-
-
- query - -
- string - / required
- - 		- - -
The GraphQL formatted query string, see [pynautobot GraphQL documentation](https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html).
-
-
- token - -
- string -
- - 		- -
- env:NAUTOBOT_TOKEN - -
- 		-
The API token created through Nautobot
-
-
- url - -
- string - / required
- - 		- -
- env:NAUTOBOT_URL - -
- 		-
The URL to the Nautobot instance to query (http://nautobot.example.com:8000)
-
-
- validate_certs - -
- string -
- - 		- Default:
"yes"
- 		- -
Whether or not to validate SSL of the Nautobot instance
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_graphql_lookup__parameter-graph_variables: + + .. rst-class:: ansible-option-title + + **graph_variables** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of keys/values to pass into the GraphQL query + + See [pynautobot GraphQL documentation](https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html) for more details + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_graphql_lookup__parameter-query: + + .. rst-class:: ansible-option-title + + **query** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The GraphQL formatted query string, see [pynautobot GraphQL documentation](https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html). + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_graphql_lookup__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The API token created through Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_TOKEN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_graphql_lookup__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The URL to the Nautobot instance to query (http://nautobot.example.com:8000) + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_URL + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_graphql_lookup__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether or not to validate SSL of the Nautobot instance + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -258,31 +374,56 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this lookup: -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- data - -
- dictionary -
- 		success -
Data result from the GraphQL endpoint
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_graphql_lookup__return-data: + + .. rst-class:: ansible-option-title + + **data** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Data result from the GraphQL endpoint + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst old mode 100755 new mode 100644 index bf3b5450..796dd5d3 --- a/docs/plugins/lookup_lookup.rst +++ b/docs/plugins/lookup_lookup.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.lookup -- Queries and returns elements from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.lookup lookup -- Queries and returns elements from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This lookup plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,153 +88,295 @@ The below requirements are needed on the local controller node that executes thi Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsConfigurationComments
-
- _terms - -
- string - / required
- - 		- - -
The Nautobot object type to query
-
-
- api_endpoint - -
- string - / required
- - 		- -
- env:NAUTOBOT_URL - -
- 		-
The URL to the Nautobot instance to query
-
-
- api_filter - -
- string -
- - 		- - -
The api_filter to use.
-
-
- plugin - -
- string -
- - 		- - -
The Nautobot plugin to query
-
-
- raw_data - -
- string -
- - 		- - -
Whether to return raw API data with the lookup/query or whether to return a key/value dict
-
-
- token - -
- string -
- - 		- -
- env:NAUTOBOT_TOKEN - -
- 		-
The API token created through Nautobot
-
This may not be required depending on the Nautobot setup.
-
-
- validate_certs - -
- string -
- - 		- Default:
"yes"
- 		- -
Whether or not to validate SSL of the Nautobot instance
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__parameter-_terms: + + .. rst-class:: ansible-option-title + + **_terms** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The Nautobot object type to query + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__parameter-api_endpoint: + + .. rst-class:: ansible-option-title + + **api_endpoint** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The URL to the Nautobot instance to query + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_URL + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__parameter-api_filter: + + .. rst-class:: ansible-option-title + + **api_filter** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The api_filter to use. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__parameter-plugin: + + .. rst-class:: ansible-option-title + + **plugin** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The Nautobot plugin to query + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__parameter-raw_data: + + .. rst-class:: ansible-option-title + + **raw_data** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether to return raw API data with the lookup/query or whether to return a key/value dict + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The API token created through Nautobot + + This may not be required depending on the Nautobot setup. + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - Environment variable: NAUTOBOT\_TOKEN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether or not to validate SSL of the Nautobot instance + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -287,31 +441,56 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this lookup: -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- _list - -
- list - / elements=string
- 		success -
list of composed dictionaries with key and value
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.lookup_lookup__return-_list: + + .. rst-class:: ansible-option-title + + **_list** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + list of composed dictionaries with key and value + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/manufacturer_module.rst b/docs/plugins/manufacturer_module.rst old mode 100755 new mode 100644 index d570aba0..5a548cdd --- a/docs/plugins/manufacturer_module.rst +++ b/docs/plugins/manufacturer_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.manufacturer -- Create or delete manufacturers within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.manufacturer module -- Create or delete manufacturers within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,138 +88,280 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the manufacturer
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the manufacturer + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -219,7 +373,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -264,46 +418,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- manufacturer - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__return-manufacturer: + + .. rst-class:: ansible-option-title + + **manufacturer** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.manufacturer_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/nautobot_server_module.rst b/docs/plugins/nautobot_server_module.rst old mode 100755 new mode 100644 index 9332a74a..69bb78cd --- a/docs/plugins/nautobot_server_module.rst +++ b/docs/plugins/nautobot_server_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.nautobot_server -- Manages Nautobot Server application. -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.nautobot_server module -- Manages Nautobot Server application. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -56,8 +68,8 @@ Synopsis .. Description -- Manages Nautobot Server using the ``nautobot-server`` application frontend to ``django-admin``. With the ``virtualenv`` parameter -- all management commands will be executed by the given ``virtualenv`` installation. +- Manages Nautobot Server using the \ :literal:`nautobot-server`\ application frontend to \ :literal:`django-admin`\ . With the \ :literal:`virtualenv`\ parameter +- all management commands will be executed by the given \ :literal:`virtualenv`\ installation. .. Aliases @@ -77,175 +89,388 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- args - -
- dictionary -
- 		- -
A dictionary of the optional arguments and their values used together with the command. - This translates {"name_arg": "value_arg"} to "--name_arg value_arg".
-
-
- command - -
- string - / required
- 		- -
The name of the Nautobot management command to run. Some command fully implemented are: createsuperuser, - migrate, makemigrations, post_upgrade and collectstatic. - Other commands can be entered, but will fail if they're unknown to Nautobot or use positional arguments. - The module will perform some basic parameter validation, when applicable, to the commands.
-
-
- db_password - -
- string -
- 		- -
Database password used in Nautobot.
-
-
- db_username - -
- string -
- 		- -
Database username used in Nautobot.
-
-
- flags - -
- list - / elements=string
- 		- -
A list of flags to append to the command that is passed to nautobot-server, so that ["flag1", "flag2"] is translated to "--flag1 --flag2".
-
-
- positional_args - -
- list - / elements=string
- 		- -
A list of additional arguments to append to the end of the command that is passed to nautobot-server.
-
These are appended to the end of the command, so that ["arg1", "arg2"] is translated to "arg1 arg2".
-
-
- project_path - -
- path -
- 		- Default:
"/opt/nautobot"
- 		-
The path to the root of the Nautobot application where nautobot-server lives.
-

aliases: app_path, chdir
-
-
- pythonpath - -
- path -
- 		- -
A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory.
-

aliases: python_path
-
-
- settings - -
- path -
- 		- -
The Python path to the application's settings module, such as 'myapp.settings'.
-
-
- virtualenv - -
- path -
- 		- -
An optional path to a virtualenv installation to use while running the nautobot-server application.
-

aliases: virtual_env
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-args: + + .. rst-class:: ansible-option-title + + **args** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + A dictionary of the optional arguments and their values used together with the command. + This translates {"name_arg": "value_arg"} to "--name_arg value_arg". + + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-command: + + .. rst-class:: ansible-option-title + + **command** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the Nautobot management command to run. Some command fully implemented are: \ :literal:`createsuperuser`\ , + \ :literal:`migrate`\ , \ :literal:`makemigrations`\ , \ :literal:`post\_upgrade`\ and \ :literal:`collectstatic`\ . + Other commands can be entered, but will fail if they're unknown to Nautobot or use positional arguments. + The module will perform some basic parameter validation, when applicable, to the commands. + + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-db_password: + + .. rst-class:: ansible-option-title + + **db_password** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Database password used in Nautobot. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-db_username: + + .. rst-class:: ansible-option-title + + **db_username** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Database username used in Nautobot. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-flags: + + .. rst-class:: ansible-option-title + + **flags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + A list of flags to append to the command that is passed to \ :literal:`nautobot-server`\ , so that ["flag1", "flag2"] is translated to "--flag1 --flag2". + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-positional_args: + + .. rst-class:: ansible-option-title + + **positional_args** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + A list of additional arguments to append to the end of the command that is passed to \ :literal:`nautobot-server`\ . + + These are appended to the end of the command, so that ["arg1", "arg2"] is translated to "arg1 arg2". + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-project_path: + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-app_path: + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-chdir: + + .. rst-class:: ansible-option-title + + **project_path** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-aliases:`aliases: app_path, chdir` + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`path` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The path to the root of the Nautobot application where \ :strong:`nautobot-server`\ lives. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"/opt/nautobot"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-pythonpath: + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-python_path: + + .. rst-class:: ansible-option-title + + **pythonpath** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-aliases:`aliases: python_path` + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`path` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-settings: + + .. rst-class:: ansible-option-title + + **settings** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`path` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The Python path to the application's settings module, such as 'myapp.settings'. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-virtualenv: + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__parameter-virtual_env: + + .. rst-class:: ansible-option-title + + **virtualenv** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-aliases:`aliases: virtual_env` + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`path` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + An optional path to a \ :emphasis:`virtualenv`\ installation to use while running the nautobot-server application. + + + .. raw:: html + +
+ .. Attributes @@ -256,9 +481,9 @@ Notes ----- .. note:: - - Inspired from Django_manage (https://github.com/ansible-collections/community.general/blob/main/plugins/modules/web_infrastructure/django_manage.py). - - To be able to use the ``collectstatic`` command, you must have enabled staticfiles in your nautbot_config.py. - - Your ``nautobot-server`` application must be executable (rwxr-xr-x), and must have a valid shebang. + - Inspired from Django_manage (\ https://github.com/ansible-collections/community.general/blob/main/plugins/modules/web_infrastructure/django_manage.py\ ). + - To be able to use the \ :literal:`collectstatic`\ command, you must have enabled staticfiles in your nautbot_config.py. + - Your \ :literal:`nautobot-server`\ application must be executable (rwxr-xr-x), and must have a valid shebang. .. Seealso @@ -312,84 +537,196 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
Boolean that is true if the command changed the state.
-
-
Sample:
-
True
-
-
- cmd - -
- string -
- 		always -
Full command executed in the Server.
-
-
Sample:
-
nautobot-server createsuperuser --noinput --email=admin33@example.com --username=superadmin
-
-
- out - -
- string -
- 		always -
Raw output from the command execution.
-
-
Sample:
-
superadmin user already exists.
-
-
- project_path - -
- string -
- 		always -
The path to the root of the Nautobot application where nautobot-server lives.
-
-
Sample:
-
/opt/nautobot
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__return-changed: + + .. rst-class:: ansible-option-title + + **changed** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Boolean that is true if the command changed the state. + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + .. rst-class:: ansible-option-line + .. rst-class:: ansible-option-sample + + :ansible-option-sample-bold:`Sample:` true + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__return-cmd: + + .. rst-class:: ansible-option-title + + **cmd** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Full command executed in the Server. + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + .. rst-class:: ansible-option-line + .. rst-class:: ansible-option-sample + + :ansible-option-sample-bold:`Sample:` "nautobot-server createsuperuser --noinput --email=admin33@example.com --username=superadmin" + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__return-out: + + .. rst-class:: ansible-option-title + + **out** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Raw output from the command execution. + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + .. rst-class:: ansible-option-line + .. rst-class:: ansible-option-sample + + :ansible-option-sample-bold:`Sample:` "superadmin user already exists." + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.nautobot_server_module__return-project_path: + + .. rst-class:: ansible-option-title + + **project_path** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The path to the root of the Nautobot application where \ :strong:`nautobot-server`\ lives. + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + .. rst-class:: ansible-option-line + .. rst-class:: ansible-option-sample + + :ansible-option-sample-bold:`Sample:` "/opt/nautobot" + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/platform_module.rst b/docs/plugins/platform_module.rst old mode 100755 new mode 100644 index fd15f24e..4afb1184 --- a/docs/plugins/platform_module.rst +++ b/docs/plugins/platform_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.platform -- Create or delete platforms within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.platform module -- Create or delete platforms within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,210 +88,428 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the platform
-
-
- manufacturer - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The manufacturer the platform will be tied to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the platform
-
-
- napalm_args - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The optional arguments used for NAPALM connections
-
-
- napalm_driver - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the NAPALM driver to be used when using the NAPALM plugin
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the platform + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-manufacturer: + + .. rst-class:: ansible-option-title + + **manufacturer** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The manufacturer the platform will be tied to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the platform + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-napalm_args: + + .. rst-class:: ansible-option-title + + **napalm_args** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The optional arguments used for NAPALM connections + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-napalm_driver: + + .. rst-class:: ansible-option-title + + **napalm_driver** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the NAPALM driver to be used when using the NAPALM plugin + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -291,7 +521,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -347,46 +577,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- platform - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.platform_module__return-platform: + + .. rst-class:: ansible-option-title + + **platform** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/power_feed_module.rst b/docs/plugins/power_feed_module.rst old mode 100755 new mode 100644 index 7e8c853d..e709bff1 --- a/docs/plugins/power_feed_module.rst +++ b/docs/plugins/power_feed_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.power_feed -- Create, update or delete power feeds within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.power_feed module -- Create, update or delete power feeds within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,348 +88,708 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- amperage - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The amperage of the power feed
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments related to the power feed
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- max_utilization - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The maximum permissible draw of the power feed in percent
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the power feed
-
-
- phase - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • single-phase
    • -
  • three-phase
    • -
- 		-
The phase type of the power feed
-
-
- power_panel - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The power panel the power feed is terminated on
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rack - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The rack the power feed is assigned to
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the power feed
-
Required if state=present and does not exist yet
-
-
- supply - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • ac
    • -
  • dc
    • -
- 		-
The supply type of the power feed
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the power feed may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • primary
    • -
  • redundant
    • -
- 		-
The type of the power feed
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- voltage - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The voltage of the power feed
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-amperage: + + .. rst-class:: ansible-option-title + + **amperage** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The amperage of the power feed + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments related to the power feed + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-max_utilization: + + .. rst-class:: ansible-option-title + + **max_utilization** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The maximum permissible draw of the power feed in percent + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the power feed + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-phase: + + .. rst-class:: ansible-option-title + + **phase** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The phase type of the power feed + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`single-phase` + - :ansible-option-choices-entry:`three-phase` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-power_panel: + + .. rst-class:: ansible-option-title + + **power_panel** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The power panel the power feed is terminated on + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-rack: + + .. rst-class:: ansible-option-title + + **rack** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The rack the power feed is assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the power feed + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-supply: + + .. rst-class:: ansible-option-title + + **supply** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The supply type of the power feed + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`ac` + - :ansible-option-choices-entry:`dc` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the power feed may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the power feed + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`primary` + - :ansible-option-choices-entry:`redundant` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__parameter-voltage: + + .. rst-class:: ansible-option-title + + **voltage** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The voltage of the power feed + + + .. raw:: html + +
+ .. Attributes @@ -429,7 +801,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -493,46 +865,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- power_feed - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_feed_module__return-power_feed: + + .. rst-class:: ansible-option-title + + **power_feed** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/power_outlet_module.rst b/docs/plugins/power_outlet_module.rst old mode 100755 new mode 100644 index 57980af2..4745ecd1 --- a/docs/plugins/power_outlet_module.rst +++ b/docs/plugins/power_outlet_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.power_outlet -- Create, update or delete power outlets within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.power_outlet module -- Create, update or delete power outlets within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,288 +88,530 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the power outlet
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device the power outlet is attached to
-
-
- feed_leg - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • A
    • -
  • B
    • -
  • C
    • -
- 		-
The phase, in case of three-phase feed
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the power outlet
-
-
- power_port - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The attached power port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the power outlet may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • iec-60320-c5
    • -
  • iec-60320-c7
    • -
  • iec-60320-c13
    • -
  • iec-60320-c15
    • -
  • iec-60320-c19
    • -
  • iec-60309-p-n-e-4h
    • -
  • iec-60309-p-n-e-6h
    • -
  • iec-60309-p-n-e-9h
    • -
  • iec-60309-2p-e-4h
    • -
  • iec-60309-2p-e-6h
    • -
  • iec-60309-2p-e-9h
    • -
  • iec-60309-3p-e-4h
    • -
  • iec-60309-3p-e-6h
    • -
  • iec-60309-3p-e-9h
    • -
  • iec-60309-3p-n-e-4h
    • -
  • iec-60309-3p-n-e-6h
    • -
  • iec-60309-3p-n-e-9h
    • -
  • nema-5-15r
    • -
  • nema-5-20r
    • -
  • nema-5-30r
    • -
  • nema-5-50r
    • -
  • nema-6-15r
    • -
  • nema-6-20r
    • -
  • nema-6-30r
    • -
  • nema-6-50r
    • -
  • nema-l5-15r
    • -
  • nema-l5-20r
    • -
  • nema-l5-30r
    • -
  • nema-l5-50r
    • -
  • nema-l6-20r
    • -
  • nema-l6-30r
    • -
  • nema-l6-50r
    • -
  • nema-l14-20r
    • -
  • nema-l14-30r
    • -
  • nema-l21-20r
    • -
  • nema-l21-30r
    • -
  • CS6360C
    • -
  • CS6364C
    • -
  • CS8164C
    • -
  • CS8264C
    • -
  • CS8364C
    • -
  • CS8464C
    • -
  • ita-e
    • -
  • ita-f
    • -
  • ita-g
    • -
  • ita-h
    • -
  • ita-i
    • -
  • ita-j
    • -
  • ita-k
    • -
  • ita-l
    • -
  • ita-m
    • -
  • ita-n
    • -
  • ita-o
    • -
  • hdot-cx
    • -
- 		-
The type of the power outlet
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the power outlet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the power outlet is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-feed_leg: + + .. rst-class:: ansible-option-title + + **feed_leg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The phase, in case of three-phase feed + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`A` + - :ansible-option-choices-entry:`B` + - :ansible-option-choices-entry:`C` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the power outlet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-power_port: + + .. rst-class:: ansible-option-title + + **power_port** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The attached power port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the power outlet may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the power outlet + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`iec-60320-c5` + - :ansible-option-choices-entry:`iec-60320-c7` + - :ansible-option-choices-entry:`iec-60320-c13` + - :ansible-option-choices-entry:`iec-60320-c15` + - :ansible-option-choices-entry:`iec-60320-c19` + - :ansible-option-choices-entry:`iec-60309-p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-9h` + - :ansible-option-choices-entry:`iec-60309-2p-e-4h` + - :ansible-option-choices-entry:`iec-60309-2p-e-6h` + - :ansible-option-choices-entry:`iec-60309-2p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-9h` + - :ansible-option-choices-entry:`nema-5-15r` + - :ansible-option-choices-entry:`nema-5-20r` + - :ansible-option-choices-entry:`nema-5-30r` + - :ansible-option-choices-entry:`nema-5-50r` + - :ansible-option-choices-entry:`nema-6-15r` + - :ansible-option-choices-entry:`nema-6-20r` + - :ansible-option-choices-entry:`nema-6-30r` + - :ansible-option-choices-entry:`nema-6-50r` + - :ansible-option-choices-entry:`nema-l5-15r` + - :ansible-option-choices-entry:`nema-l5-20r` + - :ansible-option-choices-entry:`nema-l5-30r` + - :ansible-option-choices-entry:`nema-l5-50r` + - :ansible-option-choices-entry:`nema-l6-20r` + - :ansible-option-choices-entry:`nema-l6-30r` + - :ansible-option-choices-entry:`nema-l6-50r` + - :ansible-option-choices-entry:`nema-l14-20r` + - :ansible-option-choices-entry:`nema-l14-30r` + - :ansible-option-choices-entry:`nema-l21-20r` + - :ansible-option-choices-entry:`nema-l21-30r` + - :ansible-option-choices-entry:`CS6360C` + - :ansible-option-choices-entry:`CS6364C` + - :ansible-option-choices-entry:`CS8164C` + - :ansible-option-choices-entry:`CS8264C` + - :ansible-option-choices-entry:`CS8364C` + - :ansible-option-choices-entry:`CS8464C` + - :ansible-option-choices-entry:`ita-e` + - :ansible-option-choices-entry:`ita-f` + - :ansible-option-choices-entry:`ita-g` + - :ansible-option-choices-entry:`ita-h` + - :ansible-option-choices-entry:`ita-i` + - :ansible-option-choices-entry:`ita-j` + - :ansible-option-choices-entry:`ita-k` + - :ansible-option-choices-entry:`ita-l` + - :ansible-option-choices-entry:`ita-m` + - :ansible-option-choices-entry:`ita-n` + - :ansible-option-choices-entry:`ita-o` + - :ansible-option-choices-entry:`hdot-cx` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -369,7 +623,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -428,46 +682,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- power_outlet - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_module__return-power_outlet: + + .. rst-class:: ansible-option-title + + **power_outlet** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/power_outlet_template_module.rst b/docs/plugins/power_outlet_template_module.rst old mode 100755 new mode 100644 index 0070ee94..2203dba9 --- a/docs/plugins/power_outlet_template_module.rst +++ b/docs/plugins/power_outlet_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.power_outlet_template -- Create, update or delete power outlet templates within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.power_outlet_template module -- Create, update or delete power outlet templates within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,252 +88,456 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device type the power outlet is attached to
-
-
- feed_leg - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • A
    • -
  • B
    • -
  • C
    • -
- 		-
The phase, in case of three-phase feed
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the power outlet
-
-
- power_port_template - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The attached power port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • iec-60320-c5
    • -
  • iec-60320-c7
    • -
  • iec-60320-c13
    • -
  • iec-60320-c15
    • -
  • iec-60320-c19
    • -
  • iec-60309-p-n-e-4h
    • -
  • iec-60309-p-n-e-6h
    • -
  • iec-60309-p-n-e-9h
    • -
  • iec-60309-2p-e-4h
    • -
  • iec-60309-2p-e-6h
    • -
  • iec-60309-2p-e-9h
    • -
  • iec-60309-3p-e-4h
    • -
  • iec-60309-3p-e-6h
    • -
  • iec-60309-3p-e-9h
    • -
  • iec-60309-3p-n-e-4h
    • -
  • iec-60309-3p-n-e-6h
    • -
  • iec-60309-3p-n-e-9h
    • -
  • nema-5-15r
    • -
  • nema-5-20r
    • -
  • nema-5-30r
    • -
  • nema-5-50r
    • -
  • nema-6-15r
    • -
  • nema-6-20r
    • -
  • nema-6-30r
    • -
  • nema-6-50r
    • -
  • nema-l5-15r
    • -
  • nema-l5-20r
    • -
  • nema-l5-30r
    • -
  • nema-l5-50r
    • -
  • nema-l6-20r
    • -
  • nema-l6-30r
    • -
  • nema-l6-50r
    • -
  • nema-l14-20r
    • -
  • nema-l14-30r
    • -
  • nema-l21-20r
    • -
  • nema-l21-30r
    • -
  • CS6360C
    • -
  • CS6364C
    • -
  • CS8164C
    • -
  • CS8264C
    • -
  • CS8364C
    • -
  • CS8464C
    • -
  • ita-e
    • -
  • ita-f
    • -
  • ita-g
    • -
  • ita-h
    • -
  • ita-i
    • -
  • ita-j
    • -
  • ita-k
    • -
  • ita-l
    • -
  • ita-m
    • -
  • ita-n
    • -
  • ita-o
    • -
  • hdot-cx
    • -
- 		-
The type of the power outlet
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device type the power outlet is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-feed_leg: + + .. rst-class:: ansible-option-title + + **feed_leg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The phase, in case of three-phase feed + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`A` + - :ansible-option-choices-entry:`B` + - :ansible-option-choices-entry:`C` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the power outlet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-power_port_template: + + .. rst-class:: ansible-option-title + + **power_port_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The attached power port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the power outlet + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`iec-60320-c5` + - :ansible-option-choices-entry:`iec-60320-c7` + - :ansible-option-choices-entry:`iec-60320-c13` + - :ansible-option-choices-entry:`iec-60320-c15` + - :ansible-option-choices-entry:`iec-60320-c19` + - :ansible-option-choices-entry:`iec-60309-p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-9h` + - :ansible-option-choices-entry:`iec-60309-2p-e-4h` + - :ansible-option-choices-entry:`iec-60309-2p-e-6h` + - :ansible-option-choices-entry:`iec-60309-2p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-9h` + - :ansible-option-choices-entry:`nema-5-15r` + - :ansible-option-choices-entry:`nema-5-20r` + - :ansible-option-choices-entry:`nema-5-30r` + - :ansible-option-choices-entry:`nema-5-50r` + - :ansible-option-choices-entry:`nema-6-15r` + - :ansible-option-choices-entry:`nema-6-20r` + - :ansible-option-choices-entry:`nema-6-30r` + - :ansible-option-choices-entry:`nema-6-50r` + - :ansible-option-choices-entry:`nema-l5-15r` + - :ansible-option-choices-entry:`nema-l5-20r` + - :ansible-option-choices-entry:`nema-l5-30r` + - :ansible-option-choices-entry:`nema-l5-50r` + - :ansible-option-choices-entry:`nema-l6-20r` + - :ansible-option-choices-entry:`nema-l6-30r` + - :ansible-option-choices-entry:`nema-l6-50r` + - :ansible-option-choices-entry:`nema-l14-20r` + - :ansible-option-choices-entry:`nema-l14-30r` + - :ansible-option-choices-entry:`nema-l21-20r` + - :ansible-option-choices-entry:`nema-l21-30r` + - :ansible-option-choices-entry:`CS6360C` + - :ansible-option-choices-entry:`CS6364C` + - :ansible-option-choices-entry:`CS8164C` + - :ansible-option-choices-entry:`CS8264C` + - :ansible-option-choices-entry:`CS8364C` + - :ansible-option-choices-entry:`CS8464C` + - :ansible-option-choices-entry:`ita-e` + - :ansible-option-choices-entry:`ita-f` + - :ansible-option-choices-entry:`ita-g` + - :ansible-option-choices-entry:`ita-h` + - :ansible-option-choices-entry:`ita-i` + - :ansible-option-choices-entry:`ita-j` + - :ansible-option-choices-entry:`ita-k` + - :ansible-option-choices-entry:`ita-l` + - :ansible-option-choices-entry:`ita-m` + - :ansible-option-choices-entry:`ita-n` + - :ansible-option-choices-entry:`ita-o` + - :ansible-option-choices-entry:`hdot-cx` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -333,7 +549,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -391,46 +607,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- power_outlet_template - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_outlet_template_module__return-power_outlet_template: + + .. rst-class:: ansible-option-title + + **power_outlet_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/power_panel_module.rst b/docs/plugins/power_panel_module.rst old mode 100755 new mode 100644 index bd54b046..45f3b3a8 --- a/docs/plugins/power_panel_module.rst +++ b/docs/plugins/power_panel_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.power_panel -- Create, update or delete power panels within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.power_panel module -- Create, update or delete power panels within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,155 +88,315 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the power panel
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rack_group - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The rack group the power panel is assigned to
-
-
- site - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The site the power panel is located in
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the power panel + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-rack_group: + + .. rst-class:: ansible-option-title + + **rack_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The rack group the power panel is assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The site the power panel is located in + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -236,7 +408,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -292,46 +464,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- power_panel - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_panel_module__return-power_panel: + + .. rst-class:: ansible-option-title + + **power_panel** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/power_port_module.rst b/docs/plugins/power_port_module.rst old mode 100755 new mode 100644 index d6341350..d76fc0fa --- a/docs/plugins/power_port_module.rst +++ b/docs/plugins/power_port_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.power_port -- Create, update or delete power ports within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.power_port module -- Create, update or delete power ports within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,283 +88,522 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allocated_draw - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The allocated draw of the power port in watt
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the power port
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device the power port is attached to
-
-
- maximum_draw - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The maximum permissible draw of the power port in watt
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the power port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the power port may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • iec-60320-c6
    • -
  • iec-60320-c8
    • -
  • iec-60320-c14
    • -
  • iec-60320-c16
    • -
  • iec-60320-c20
    • -
  • iec-60309-p-n-e-4h
    • -
  • iec-60309-p-n-e-6h
    • -
  • iec-60309-p-n-e-9h
    • -
  • iec-60309-2p-e-4h
    • -
  • iec-60309-2p-e-6h
    • -
  • iec-60309-2p-e-9h
    • -
  • iec-60309-3p-e-4h
    • -
  • iec-60309-3p-e-6h
    • -
  • iec-60309-3p-e-9h
    • -
  • iec-60309-3p-n-e-4h
    • -
  • iec-60309-3p-n-e-6h
    • -
  • iec-60309-3p-n-e-9h
    • -
  • nema-5-15p
    • -
  • nema-5-20p
    • -
  • nema-5-30p
    • -
  • nema-5-50p
    • -
  • nema-6-15p
    • -
  • nema-6-20p
    • -
  • nema-6-30p
    • -
  • nema-6-50p
    • -
  • nema-l5-15p
    • -
  • nema-l5-20p
    • -
  • nema-l5-30p
    • -
  • nema-l5-50p
    • -
  • nema-l6-20p
    • -
  • nema-l6-30p
    • -
  • nema-l6-50p
    • -
  • nema-l14-20p
    • -
  • nema-l14-30p
    • -
  • nema-l21-20p
    • -
  • nema-l21-30p
    • -
  • cs6361c
    • -
  • cs6365c
    • -
  • cs8165c
    • -
  • cs8265c
    • -
  • cs8365c
    • -
  • cs8465c
    • -
  • ita-e
    • -
  • ita-f
    • -
  • ita-ef
    • -
  • ita-g
    • -
  • ita-h
    • -
  • ita-i
    • -
  • ita-j
    • -
  • ita-k
    • -
  • ita-l
    • -
  • ita-m
    • -
  • ita-n
    • -
  • ita-o
    • -
- 		-
The type of the power port
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-allocated_draw: + + .. rst-class:: ansible-option-title + + **allocated_draw** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The allocated draw of the power port in watt + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the power port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the power port is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-maximum_draw: + + .. rst-class:: ansible-option-title + + **maximum_draw** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The maximum permissible draw of the power port in watt + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the power port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the power port may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the power port + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`iec-60320-c6` + - :ansible-option-choices-entry:`iec-60320-c8` + - :ansible-option-choices-entry:`iec-60320-c14` + - :ansible-option-choices-entry:`iec-60320-c16` + - :ansible-option-choices-entry:`iec-60320-c20` + - :ansible-option-choices-entry:`iec-60309-p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-9h` + - :ansible-option-choices-entry:`iec-60309-2p-e-4h` + - :ansible-option-choices-entry:`iec-60309-2p-e-6h` + - :ansible-option-choices-entry:`iec-60309-2p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-9h` + - :ansible-option-choices-entry:`nema-5-15p` + - :ansible-option-choices-entry:`nema-5-20p` + - :ansible-option-choices-entry:`nema-5-30p` + - :ansible-option-choices-entry:`nema-5-50p` + - :ansible-option-choices-entry:`nema-6-15p` + - :ansible-option-choices-entry:`nema-6-20p` + - :ansible-option-choices-entry:`nema-6-30p` + - :ansible-option-choices-entry:`nema-6-50p` + - :ansible-option-choices-entry:`nema-l5-15p` + - :ansible-option-choices-entry:`nema-l5-20p` + - :ansible-option-choices-entry:`nema-l5-30p` + - :ansible-option-choices-entry:`nema-l5-50p` + - :ansible-option-choices-entry:`nema-l6-20p` + - :ansible-option-choices-entry:`nema-l6-30p` + - :ansible-option-choices-entry:`nema-l6-50p` + - :ansible-option-choices-entry:`nema-l14-20p` + - :ansible-option-choices-entry:`nema-l14-30p` + - :ansible-option-choices-entry:`nema-l21-20p` + - :ansible-option-choices-entry:`nema-l21-30p` + - :ansible-option-choices-entry:`cs6361c` + - :ansible-option-choices-entry:`cs6365c` + - :ansible-option-choices-entry:`cs8165c` + - :ansible-option-choices-entry:`cs8265c` + - :ansible-option-choices-entry:`cs8365c` + - :ansible-option-choices-entry:`cs8465c` + - :ansible-option-choices-entry:`ita-e` + - :ansible-option-choices-entry:`ita-f` + - :ansible-option-choices-entry:`ita-ef` + - :ansible-option-choices-entry:`ita-g` + - :ansible-option-choices-entry:`ita-h` + - :ansible-option-choices-entry:`ita-i` + - :ansible-option-choices-entry:`ita-j` + - :ansible-option-choices-entry:`ita-k` + - :ansible-option-choices-entry:`ita-l` + - :ansible-option-choices-entry:`ita-m` + - :ansible-option-choices-entry:`ita-n` + - :ansible-option-choices-entry:`ita-o` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -364,7 +615,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -423,46 +674,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- power_port - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_module__return-power_port: + + .. rst-class:: ansible-option-title + + **power_port** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/power_port_template_module.rst b/docs/plugins/power_port_template_module.rst old mode 100755 new mode 100644 index 5863ca6f..fd659335 --- a/docs/plugins/power_port_template_module.rst +++ b/docs/plugins/power_port_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.power_port_template -- Create, update or delete power port templates within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.power_port_template module -- Create, update or delete power port templates within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,247 +88,448 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- allocated_draw - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The allocated draw of the power port in watt
-
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device type the power port is attached to
-
-
- maximum_draw - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The maximum permissible draw of the power port in watt
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the power port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • iec-60320-c6
    • -
  • iec-60320-c8
    • -
  • iec-60320-c14
    • -
  • iec-60320-c16
    • -
  • iec-60320-c20
    • -
  • iec-60309-p-n-e-4h
    • -
  • iec-60309-p-n-e-6h
    • -
  • iec-60309-p-n-e-9h
    • -
  • iec-60309-2p-e-4h
    • -
  • iec-60309-2p-e-6h
    • -
  • iec-60309-2p-e-9h
    • -
  • iec-60309-3p-e-4h
    • -
  • iec-60309-3p-e-6h
    • -
  • iec-60309-3p-e-9h
    • -
  • iec-60309-3p-n-e-4h
    • -
  • iec-60309-3p-n-e-6h
    • -
  • iec-60309-3p-n-e-9h
    • -
  • nema-5-15p
    • -
  • nema-5-20p
    • -
  • nema-5-30p
    • -
  • nema-5-50p
    • -
  • nema-6-15p
    • -
  • nema-6-20p
    • -
  • nema-6-30p
    • -
  • nema-6-50p
    • -
  • nema-l5-15p
    • -
  • nema-l5-20p
    • -
  • nema-l5-30p
    • -
  • nema-l5-50p
    • -
  • nema-l6-20p
    • -
  • nema-l6-30p
    • -
  • nema-l6-50p
    • -
  • nema-l14-20p
    • -
  • nema-l14-30p
    • -
  • nema-l21-20p
    • -
  • nema-l21-30p
    • -
  • cs6361c
    • -
  • cs6365c
    • -
  • cs8165c
    • -
  • cs8265c
    • -
  • cs8365c
    • -
  • cs8465c
    • -
  • ita-e
    • -
  • ita-f
    • -
  • ita-ef
    • -
  • ita-g
    • -
  • ita-h
    • -
  • ita-i
    • -
  • ita-j
    • -
  • ita-k
    • -
  • ita-l
    • -
  • ita-m
    • -
  • ita-n
    • -
  • ita-o
    • -
- 		-
The type of the power port
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-allocated_draw: + + .. rst-class:: ansible-option-title + + **allocated_draw** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The allocated draw of the power port in watt + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device type the power port is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-maximum_draw: + + .. rst-class:: ansible-option-title + + **maximum_draw** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The maximum permissible draw of the power port in watt + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the power port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the power port + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`iec-60320-c6` + - :ansible-option-choices-entry:`iec-60320-c8` + - :ansible-option-choices-entry:`iec-60320-c14` + - :ansible-option-choices-entry:`iec-60320-c16` + - :ansible-option-choices-entry:`iec-60320-c20` + - :ansible-option-choices-entry:`iec-60309-p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-p-n-e-9h` + - :ansible-option-choices-entry:`iec-60309-2p-e-4h` + - :ansible-option-choices-entry:`iec-60309-2p-e-6h` + - :ansible-option-choices-entry:`iec-60309-2p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-e-9h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-4h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-6h` + - :ansible-option-choices-entry:`iec-60309-3p-n-e-9h` + - :ansible-option-choices-entry:`nema-5-15p` + - :ansible-option-choices-entry:`nema-5-20p` + - :ansible-option-choices-entry:`nema-5-30p` + - :ansible-option-choices-entry:`nema-5-50p` + - :ansible-option-choices-entry:`nema-6-15p` + - :ansible-option-choices-entry:`nema-6-20p` + - :ansible-option-choices-entry:`nema-6-30p` + - :ansible-option-choices-entry:`nema-6-50p` + - :ansible-option-choices-entry:`nema-l5-15p` + - :ansible-option-choices-entry:`nema-l5-20p` + - :ansible-option-choices-entry:`nema-l5-30p` + - :ansible-option-choices-entry:`nema-l5-50p` + - :ansible-option-choices-entry:`nema-l6-20p` + - :ansible-option-choices-entry:`nema-l6-30p` + - :ansible-option-choices-entry:`nema-l6-50p` + - :ansible-option-choices-entry:`nema-l14-20p` + - :ansible-option-choices-entry:`nema-l14-30p` + - :ansible-option-choices-entry:`nema-l21-20p` + - :ansible-option-choices-entry:`nema-l21-30p` + - :ansible-option-choices-entry:`cs6361c` + - :ansible-option-choices-entry:`cs6365c` + - :ansible-option-choices-entry:`cs8165c` + - :ansible-option-choices-entry:`cs8265c` + - :ansible-option-choices-entry:`cs8365c` + - :ansible-option-choices-entry:`cs8465c` + - :ansible-option-choices-entry:`ita-e` + - :ansible-option-choices-entry:`ita-f` + - :ansible-option-choices-entry:`ita-ef` + - :ansible-option-choices-entry:`ita-g` + - :ansible-option-choices-entry:`ita-h` + - :ansible-option-choices-entry:`ita-i` + - :ansible-option-choices-entry:`ita-j` + - :ansible-option-choices-entry:`ita-k` + - :ansible-option-choices-entry:`ita-l` + - :ansible-option-choices-entry:`ita-m` + - :ansible-option-choices-entry:`ita-n` + - :ansible-option-choices-entry:`ita-o` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -328,7 +541,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -386,46 +599,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- power_port_template - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.power_port_template_module__return-power_port_template: + + .. rst-class:: ansible-option-title + + **power_port_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/prefix_module.rst b/docs/plugins/prefix_module.rst old mode 100755 new mode 100644 index f2fa5cc3..0a1414b1 --- a/docs/plugins/prefix_module.rst +++ b/docs/plugins/prefix_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.prefix -- Creates or removes prefixes from Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.prefix module -- Creates or removes prefixes from Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,381 +88,777 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Must exist in Nautobot and in key/value format
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the prefix
-
-
- family - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Specifies which address family the prefix prefix belongs to
-
-
- first_available - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
If yes and state present, if an parent is given, it will get the first available prefix of the given prefix_length inside the given parent (and vrf, if given). Unused with state absent.
-
-
- is_pool - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
All IP Addresses within this prefix are considered usable
-
-
- parent - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state is present and first_available is yes. Will get a new available prefix in this parent prefix.
-
-
- prefix - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state is present and first_available is False. Will allocate or free this prefix.
-
-
- prefix_length - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required ONLY if state is present and first_available is yes. - Will get a new available prefix of the given prefix_length in this parent prefix.
-
-
- prefix_role - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The role of the prefix
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Site that prefix is associated with
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the prefix
-
Required if state=present and does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the prefix may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the prefix will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- vlan - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The VLAN the prefix will be assigned to
-
-
- vrf - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
VRF that prefix is associated with
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Must exist in Nautobot and in key/value format + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the prefix + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-family: + + .. rst-class:: ansible-option-title + + **family** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specifies which address family the prefix prefix belongs to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-first_available: + + .. rst-class:: ansible-option-title + + **first_available** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`yes`\ and state \ :literal:`present`\ , if an parent is given, it will get the first available prefix of the given prefix_length inside the given parent (and vrf, if given). Unused with state \ :literal:`absent`\ . + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-is_pool: + + .. rst-class:: ansible-option-title + + **is_pool** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + All IP Addresses within this prefix are considered usable + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-parent: + + .. rst-class:: ansible-option-title + + **parent** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if state is \ :literal:`present`\ and first_available is \ :literal:`yes`\ . Will get a new available prefix in this parent prefix. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-prefix: + + .. rst-class:: ansible-option-title + + **prefix** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if state is \ :literal:`present`\ and first_available is False. Will allocate or free this prefix. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-prefix_length: + + .. rst-class:: ansible-option-title + + **prefix_length** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required ONLY if state is \ :literal:`present`\ and first_available is \ :literal:`yes`\ . + Will get a new available prefix of the given prefix_length in this parent prefix. + + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-prefix_role: + + .. rst-class:: ansible-option-title + + **prefix_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The role of the prefix + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Site that prefix is associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the prefix + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the prefix may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the prefix will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-vlan: + + .. rst-class:: ansible-option-title + + **vlan** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The VLAN the prefix will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__parameter-vrf: + + .. rst-class:: ansible-option-title + + **vrf** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + VRF that prefix is associated with + + + .. raw:: html + +
+ .. Attributes @@ -462,7 +870,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -566,46 +974,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- prefix - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.prefix_module__return-prefix: + + .. rst-class:: ansible-option-title + + **prefix** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/provider_module.rst b/docs/plugins/provider_module.rst old mode 100755 new mode 100644 index 6a356098..12722756 --- a/docs/plugins/provider_module.rst +++ b/docs/plugins/provider_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.provider -- Create, update or delete providers within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.provider module -- Create, update or delete providers within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,263 +88,537 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- account - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The account number of the provider
-
-
- admin_contact - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The admin contact of the provider
-
-
- asn - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The provider ASN
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments related to the provider
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the provider
-
-
- noc_contact - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The NOC contact of the provider
-
-
- portal_url - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The URL of the provider
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the device may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-account: + + .. rst-class:: ansible-option-title + + **account** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The account number of the provider + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-admin_contact: + + .. rst-class:: ansible-option-title + + **admin_contact** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The admin contact of the provider + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-asn: + + .. rst-class:: ansible-option-title + + **asn** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The provider ASN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments related to the provider + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the provider + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-noc_contact: + + .. rst-class:: ansible-option-title + + **noc_contact** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The NOC contact of the provider + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-portal_url: + + .. rst-class:: ansible-option-title + + **portal_url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The URL of the provider + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the device may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -344,7 +630,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -402,46 +688,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- provider - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.provider_module__return-provider: + + .. rst-class:: ansible-option-title + + **provider** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst old mode 100755 new mode 100644 index dd746d19..4af88fc5 --- a/docs/plugins/query_graphql_module.rst +++ b/docs/plugins/query_graphql_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.query_graphql -- Queries and returns elements from Nautobot GraphQL endpoint -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.query_graphql module -- Queries and returns elements from Nautobot GraphQL endpoint +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -78,114 +90,234 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- graph_variables - -
- dictionary -
- 		- -
Dictionary of keys/values to pass into the GraphQL query, see (https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html) for more info
-
-
- query - -
- string - / required
- 		- -
The GraphQL formatted query string, see (https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html) for more details.
-
-
- token - -
- string -
- 		- -
The API token created through Nautobot, optional env=NAUTOBOT_TOKEN
-
-
- update_hostvars - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Whether or not to populate data in the in the root (e.g. hostvars[inventory_hostname]) or within the 'data' key (e.g. hostvars[inventory_hostname]['data']). Beware, that the root keys provided by the query will overwrite any root keys already present, leverage the GraphQL alias feature to avoid issues.
-
-
- url - -
- string -
- 		- -
The URL to the Nautobot instance to query (http://nautobot.example.com:8000), optional env=NAUTOBOT_URL
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Whether or not to validate SSL of the Nautobot instance
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__parameter-graph_variables: + + .. rst-class:: ansible-option-title + + **graph_variables** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of keys/values to pass into the GraphQL query, see (\ https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html\ ) for more info + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__parameter-query: + + .. rst-class:: ansible-option-title + + **query** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The GraphQL formatted query string, see (\ https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html\ ) for more details. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The API token created through Nautobot, optional env=NAUTOBOT_TOKEN + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__parameter-update_hostvars: + + .. rst-class:: ansible-option-title + + **update_hostvars** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether or not to populate data in the in the root (e.g. hostvars[inventory_hostname]) or within the 'data' key (e.g. hostvars[inventory_hostname]['data']). Beware, that the root keys provided by the query will overwrite any root keys already present, leverage the GraphQL alias feature to avoid issues. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The URL to the Nautobot instance to query (http://nautobot.example.com:8000), optional env=NAUTOBOT_URL + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether or not to validate SSL of the Nautobot instance + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ .. Attributes @@ -263,76 +395,176 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- data - -
- dictionary -
- 		success -
Data result from the GraphQL endpoint
-
-
-
- graph_variables - -
- dictionary -
- 		success -
Variables passed in
-
-
-
- query - -
- string -
- 		success -
Query string that was sent to Nautobot
-
-
-
- url - -
- string -
- 		success -
Nautobot URL that was supplied for troubleshooting
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__return-data: + + .. rst-class:: ansible-option-title + + **data** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Data result from the GraphQL endpoint + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__return-graph_variables: + + .. rst-class:: ansible-option-title + + **graph_variables** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Variables passed in + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__return-query: + + .. rst-class:: ansible-option-title + + **query** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Query string that was sent to Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.query_graphql_module__return-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nautobot URL that was supplied for troubleshooting + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/rack_group_module.rst b/docs/plugins/rack_group_module.rst old mode 100755 new mode 100644 index fa3a30a3..979eeb9b --- a/docs/plugins/rack_group_module.rst +++ b/docs/plugins/rack_group_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.rack_group -- Create, update or delete racks groups within Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.rack_group module -- Create, update or delete racks groups within Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,210 +88,428 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the rack group
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the rack group
-
-
- parent_rack_group - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The parent rack-group the rack group will be assigned to
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- region - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The region the rack group will be assigned to
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state=present and the rack does not exist yet
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the rack group + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the rack group + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-parent_rack_group: + + .. rst-class:: ansible-option-title + + **parent_rack_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The parent rack-group the rack group will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-region: + + .. rst-class:: ansible-option-title + + **region** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The region the rack group will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if \ :emphasis:`state=present`\ and the rack does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -291,7 +521,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -338,46 +568,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- rack_group - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_group_module__return-rack_group: + + .. rst-class:: ansible-option-title + + **rack_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/rack_module.rst b/docs/plugins/rack_module.rst old mode 100755 new mode 100644 index 448afbc1..bb86ec64 --- a/docs/plugins/rack_module.rst +++ b/docs/plugins/rack_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.rack -- Create, update or delete racks within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.rack module -- Create, update or delete racks within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -56,7 +68,7 @@ Synopsis .. Description -- Creates, updates or removes racks from Nautobot +- Creates, updates or removes racks from Nautobot. .. Aliases @@ -76,465 +88,942 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- asset_tag - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Asset tag that is associated to the rack
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments that may include additional information in regards to the rack
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- desc_units - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Rack units will be numbered top-to-bottom
-
-
- facility_id - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The unique rack ID assigned by the facility
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the rack
-
-
- outer_depth - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The outer depth of the rack
-
-
- outer_unit - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • Millimeters
    • -
  • Inches
    • -
- 		-
Whether the rack unit is in Millimeters or Inches and is required if outer_width/outer_depth is specified
-
-
- outer_width - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The outer width of the rack
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rack_group - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The rack group the rack will be associated to
-
-
- rack_role - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The rack role the rack will be associated to
-
-
- serial - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Serial number of the rack
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Required if state=present and the rack does not exist yet
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the rack
-
Required if state=present and does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the rack may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the device will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • 2-post frame
    • -
  • 4-post frame
    • -
  • 4-post cabinet
    • -
  • Wall-mounted frame
    • -
  • Wall-mounted cabinet
    • -
- 		-
The type of rack
-
-
- u_height - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The height of the rack in rack units
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- width - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • 10
    • -
  • 19
    • -
  • 21
    • -
  • 23
    • -
- 		-
The rail-to-rail width
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-asset_tag: + + .. rst-class:: ansible-option-title + + **asset_tag** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Asset tag that is associated to the rack. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments that may include additional information in regards to the rack. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Must exist in Nautobot. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-desc_units: + + .. rst-class:: ansible-option-title + + **desc_units** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Rack units will be numbered top-to-bottom. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-facility_id: + + .. rst-class:: ansible-option-title + + **facility_id** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The unique rack ID assigned by the facility. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the rack. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-outer_depth: + + .. rst-class:: ansible-option-title + + **outer_depth** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The outer depth of the rack. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-outer_unit: + + .. rst-class:: ansible-option-title + + **outer_unit** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Whether the rack unit is in Millimeters or Inches and is \ :emphasis:`required`\ if outer_width/outer_depth is specified. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`Millimeters` + - :ansible-option-choices-entry:`Inches` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-outer_width: + + .. rst-class:: ansible-option-title + + **outer_width** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The outer width of the rack. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-rack_group: + + .. rst-class:: ansible-option-title + + **rack_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The rack group the rack will be associated to. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-rack_role: + + .. rst-class:: ansible-option-title + + **rack_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The rack role the rack will be associated to. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-serial: + + .. rst-class:: ansible-option-title + + **serial** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serial number of the rack. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Required if \ :emphasis:`state=present`\ and the rack does not exist yet. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the rack + + Required if \ :emphasis:`state=present`\ and does not exist yet. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the rack may need to be associated with. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the device will be assigned to. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of rack. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`2-post frame` + - :ansible-option-choices-entry:`4-post frame` + - :ansible-option-choices-entry:`4-post cabinet` + - :ansible-option-choices-entry:`Wall-mounted frame` + - :ansible-option-choices-entry:`Wall-mounted cabinet` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-u_height: + + .. rst-class:: ansible-option-title + + **u_height** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The height of the rack in rack units. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__parameter-width: + + .. rst-class:: ansible-option-title + + **width** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The rail-to-rail width. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`10` + - :ansible-option-choices-entry:`19` + - :ansible-option-choices-entry:`21` + - :ansible-option-choices-entry:`23` + + .. raw:: html + +
+ .. Attributes @@ -545,8 +1034,9 @@ Notes ----- .. note:: - - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - Tags should be defined as a YAML list. + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ . + - The module supports \ :literal:`check\_mode`\ . .. Seealso @@ -593,46 +1083,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- rack - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved. + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_module__return-rack: + + .. rst-class:: ansible-option-title + + **rack** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot. + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/rack_role_module.rst b/docs/plugins/rack_role_module.rst old mode 100755 new mode 100644 index 530ad1d4..27286757 --- a/docs/plugins/rack_role_module.rst +++ b/docs/plugins/rack_role_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.rack_role -- Create, update or delete racks roles within Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.rack_role module -- Create, update or delete racks roles within Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,156 +88,317 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- color - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Hexidecimal code for a color, ex. FFFFFF
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the rack role
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-color: + + .. rst-class:: ansible-option-title + + **color** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Hexidecimal code for a color, ex. FFFFFF + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the rack role + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -237,7 +410,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -283,46 +456,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- rack_role - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rack_role_module__return-rack_role: + + .. rst-class:: ansible-option-title + + **rack_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/rear_port_module.rst b/docs/plugins/rear_port_module.rst old mode 100755 new mode 100644 index cc933e65..2418c775 --- a/docs/plugins/rear_port_module.rst +++ b/docs/plugins/rear_port_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.rear_port -- Create, update or delete rear ports within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.rear_port module -- Create, update or delete rear ports within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,228 +88,448 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Description of the rear port
-
-
- device - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device the rear port is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the rear port
-
-
- positions - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The number of front ports which may be mapped to each rear port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the rear port may need to be associated with
-
-
- token - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • 8p8c
    • -
  • 110-punch
    • -
  • bnc
    • -
  • mrj21
    • -
  • fc
    • -
  • lc
    • -
  • lc-apc
    • -
  • lsh
    • -
  • lsh-apc
    • -
  • mpo
    • -
  • mtrj
    • -
  • sc
    • -
  • sc-apc
    • -
  • st
    • -
- 		-
The type of the rear port
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Description of the rear port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device the rear port is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the rear port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-positions: + + .. rst-class:: ansible-option-title + + **positions** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The number of front ports which may be mapped to each rear port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the rear port may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the rear port + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`8p8c` + - :ansible-option-choices-entry:`110-punch` + - :ansible-option-choices-entry:`bnc` + - :ansible-option-choices-entry:`mrj21` + - :ansible-option-choices-entry:`fc` + - :ansible-option-choices-entry:`lc` + - :ansible-option-choices-entry:`lc-apc` + - :ansible-option-choices-entry:`lsh` + - :ansible-option-choices-entry:`lsh-apc` + - :ansible-option-choices-entry:`mpo` + - :ansible-option-choices-entry:`mtrj` + - :ansible-option-choices-entry:`sc` + - :ansible-option-choices-entry:`sc-apc` + - :ansible-option-choices-entry:`st` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -309,7 +541,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -369,46 +601,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- rear_port - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_module__return-rear_port: + + .. rst-class:: ansible-option-title + + **rear_port** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/rear_port_template_module.rst b/docs/plugins/rear_port_template_module.rst old mode 100755 new mode 100644 index 2748e5f0..9a6f4081 --- a/docs/plugins/rear_port_template_module.rst +++ b/docs/plugins/rear_port_template_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.rear_port_template -- Create, update or delete rear port templates within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.rear_port_template module -- Create, update or delete rear port templates within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,199 +88,381 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- device_type - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The device type the rear port template is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the rear port template
-
-
- positions - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The number of front ports which may be mapped to each rear port
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- type - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • 8p8c
    • -
  • 8p6c
    • -
  • 8p4c
    • -
  • 8p2c
    • -
  • gg45
    • -
  • tera-4p
    • -
  • tera-2p
    • -
  • tera-1p
    • -
  • 110-punch
    • -
  • bnc
    • -
  • mrj21
    • -
  • st
    • -
  • sc
    • -
  • sc-apc
    • -
  • fc
    • -
  • lc
    • -
  • lc-apc
    • -
  • mtrj
    • -
  • mpo
    • -
  • lsh
    • -
  • lsh-apc
    • -
  • splice
    • -
  • cs
    • -
  • sn
    • -
- 		-
The type of the rear port
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-device_type: + + .. rst-class:: ansible-option-title + + **device_type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The device type the rear port template is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the rear port template + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-positions: + + .. rst-class:: ansible-option-title + + **positions** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The number of front ports which may be mapped to each rear port + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The type of the rear port + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`8p8c` + - :ansible-option-choices-entry:`8p6c` + - :ansible-option-choices-entry:`8p4c` + - :ansible-option-choices-entry:`8p2c` + - :ansible-option-choices-entry:`gg45` + - :ansible-option-choices-entry:`tera-4p` + - :ansible-option-choices-entry:`tera-2p` + - :ansible-option-choices-entry:`tera-1p` + - :ansible-option-choices-entry:`110-punch` + - :ansible-option-choices-entry:`bnc` + - :ansible-option-choices-entry:`mrj21` + - :ansible-option-choices-entry:`st` + - :ansible-option-choices-entry:`sc` + - :ansible-option-choices-entry:`sc-apc` + - :ansible-option-choices-entry:`fc` + - :ansible-option-choices-entry:`lc` + - :ansible-option-choices-entry:`lc-apc` + - :ansible-option-choices-entry:`mtrj` + - :ansible-option-choices-entry:`mpo` + - :ansible-option-choices-entry:`lsh` + - :ansible-option-choices-entry:`lsh-apc` + - :ansible-option-choices-entry:`splice` + - :ansible-option-choices-entry:`cs` + - :ansible-option-choices-entry:`sn` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -280,7 +474,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -339,46 +533,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- rear_port_template - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rear_port_template_module__return-rear_port_template: + + .. rst-class:: ansible-option-title + + **rear_port_template** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/region_module.rst b/docs/plugins/region_module.rst old mode 100755 new mode 100644 index ce7b04db..dc11614d --- a/docs/plugins/region_module.rst +++ b/docs/plugins/region_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.region -- Creates or removes regions from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.region module -- Creates or removes regions from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,157 +88,319 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the region to be created
-
-
- parent_region - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The parent region this region should be tied to
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the region to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-parent_region: + + .. rst-class:: ansible-option-title + + **parent_region** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The parent region this region should be tied to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -238,7 +412,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -282,46 +456,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- region - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.region_module__return-region: + + .. rst-class:: ansible-option-title + + **region** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/rir_module.rst b/docs/plugins/rir_module.rst old mode 100755 new mode 100644 index cca8e87e..71ba7ed3 --- a/docs/plugins/rir_module.rst +++ b/docs/plugins/rir_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.rir -- Create, update or delete RIRs within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.rir module -- Create, update or delete RIRs within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,160 +88,324 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- is_private - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
IP space managed by this RIR is considered private
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the RIR
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-is_private: + + .. rst-class:: ansible-option-title + + **is_private** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + IP space managed by this RIR is considered private + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the RIR + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -241,7 +417,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -294,46 +470,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- rir - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.rir_module__return-rir: + + .. rst-class:: ansible-option-title + + **rir** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/route_target_module.rst b/docs/plugins/route_target_module.rst old mode 100755 new mode 100644 index 527b44c7..e3510be6 --- a/docs/plugins/route_target_module.rst +++ b/docs/plugins/route_target_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.route_target -- Creates or removes route targets from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.route_target module -- Creates or removes route targets from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,189 +88,388 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Tag description
-
-
- name - -
- string - / required
- 		- -
Route target name
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the device may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the route target will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Tag description + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Route target name + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the device may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the route target will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -270,7 +481,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -335,46 +546,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- route_target - -
- dictionary -
- 		always -
Serialized object as created/existent/updated/deleted within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.route_target_module__return-route_target: + + .. rst-class:: ansible-option-title + + **route_target** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created/existent/updated/deleted within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/service_module.rst b/docs/plugins/service_module.rst old mode 100755 new mode 100644 index 449d7c57..42e082bb --- a/docs/plugins/service_module.rst +++ b/docs/plugins/service_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.service -- Creates or removes service from Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.service module -- Creates or removes service from Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -56,7 +68,7 @@ Synopsis .. Description -- Creates or removes service from Nautobot +- Creates or removes service from Nautobot. .. Aliases @@ -76,263 +88,537 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Must exist in Nautobot and in key/value format
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Service description
-
-
- device - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Specifies on which device the service is running
-
-
- ipaddresses - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Specifies which IPaddresses to associate with service.
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the region to be created
-
-
- ports - -
- list - / elements=integer
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Specifies which ports used by service (Nautobot 2.10 and newer)
-
-
- protocol - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Specifies which protocol used by service
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
What tags to add/update
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- virtual_machine - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Specifies on which virtual machine the service is running
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Must exist in Nautobot and in key/value format. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Service description. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-device: + + .. rst-class:: ansible-option-title + + **device** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specifies on which device the service is running. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-ipaddresses: + + .. rst-class:: ansible-option-title + + **ipaddresses** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specifies which IPaddresses to associate with service. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the region to be created. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-ports: + + .. rst-class:: ansible-option-title + + **ports** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specifies which ports used by service (Nautobot 2.10 and newer). + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-protocol: + + .. rst-class:: ansible-option-title + + **protocol** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specifies which protocol used by service. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + What tags to add/update. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.service_module__parameter-virtual_machine: + + .. rst-class:: ansible-option-title + + **virtual_machine** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Specifies on which virtual machine the service is running. + + + .. raw:: html + +
+ .. Attributes @@ -343,7 +629,8 @@ Notes ----- .. note:: - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ . + - The module supports \ :literal:`check\_mode`\ . .. Seealso diff --git a/docs/plugins/site_module.rst b/docs/plugins/site_module.rst old mode 100755 new mode 100644 index e706be8f..084df1df --- a/docs/plugins/site_module.rst +++ b/docs/plugins/site_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.site -- Creates or removes sites from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.site module -- Creates or removes sites from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,442 +88,908 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- asn - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The ASN associated with the site
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments for the site. This can be markdown syntax
-
-
- contact_email - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Contact email for site
-
-
- contact_name - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of contact for site
-
-
- contact_phone - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Contact phone number for site
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the prefix
-
-
- facility - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Data center provider or facility, ex. Equinix NY7
-
-
- latitude - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Latitude in decimal format
-
-
- longitude - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Longitude in decimal format
-
-
- name - -
- string - / required
- 		- -
Name of the site to be created
-
-
- physical_address - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Physical address of site
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- region - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The region that the site should be associated with
-
-
- shipping_address - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Shipping address of site
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
URL-friendly unique shorthand
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Status of the site
-
Required if state=present and does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the prefix may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant the site will be assigned to
-
-
- time_zone - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Timezone associated with the site, ex. America/Denver
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-asn: + + .. rst-class:: ansible-option-title + + **asn** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The ASN associated with the site + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments for the site. This can be markdown syntax + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-contact_email: + + .. rst-class:: ansible-option-title + + **contact_email** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Contact email for site + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-contact_name: + + .. rst-class:: ansible-option-title + + **contact_name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of contact for site + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-contact_phone: + + .. rst-class:: ansible-option-title + + **contact_phone** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Contact phone number for site + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the prefix + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-facility: + + .. rst-class:: ansible-option-title + + **facility** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Data center provider or facility, ex. Equinix NY7 + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-latitude: + + .. rst-class:: ansible-option-title + + **latitude** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Latitude in decimal format + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-longitude: + + .. rst-class:: ansible-option-title + + **longitude** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Longitude in decimal format + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the site to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-physical_address: + + .. rst-class:: ansible-option-title + + **physical_address** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Physical address of site + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-region: + + .. rst-class:: ansible-option-title + + **region** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The region that the site should be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-shipping_address: + + .. rst-class:: ansible-option-title + + **shipping_address** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Shipping address of site + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL-friendly unique shorthand + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Status of the site + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the prefix may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant the site will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-time_zone: + + .. rst-class:: ansible-option-title + + **time_zone** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Timezone associated with the site, ex. America/Denver + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -523,7 +1001,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -591,46 +1069,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- site - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.site_module__return-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/status_module.rst b/docs/plugins/status_module.rst old mode 100755 new mode 100644 index 37c29aa5..cf150513 --- a/docs/plugins/status_module.rst +++ b/docs/plugins/status_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.status -- Creates or removes status from Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.status module -- Creates or removes status from Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,194 +88,395 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- color - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Status color
-
-
- content_types - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Status content type(s). These match app.endpoint and the endpoint is singular.
-
e.g. dcim.device, ipam.ipaddress (more can be found in the examples)
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description for the status
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Status name
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-color: + + .. rst-class:: ansible-option-title + + **color** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Status color + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-content_types: + + .. rst-class:: ansible-option-title + + **content_types** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Status content type(s). These match app.endpoint and the endpoint is singular. + + e.g. dcim.device, ipam.ipaddress (more can be found in the examples) + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description for the status + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Status name + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -330,46 +543,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- statuses - -
- dictionary -
- 		always -
Serialized object as created/existent/updated/deleted within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.status_module__return-statuses: + + .. rst-class:: ansible-option-title + + **statuses** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created/existent/updated/deleted within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/tag_module.rst b/docs/plugins/tag_module.rst old mode 100755 new mode 100644 index 6c482299..2b1d7e07 --- a/docs/plugins/tag_module.rst +++ b/docs/plugins/tag_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.tag -- Creates or removes tags from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.tag module -- Creates or removes tags from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,175 +88,356 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- color - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Tag color
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Tag description
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Tag name
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-color: + + .. rst-class:: ansible-option-title + + **color** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Tag color + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Tag description + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Tag name + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -256,7 +449,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -306,46 +499,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- tags - -
- dictionary -
- 		always -
Serialized object as created/existent/updated/deleted within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tag_module__return-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created/existent/updated/deleted within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/tenant_group_module.rst b/docs/plugins/tenant_group_module.rst old mode 100755 new mode 100644 index 1c3a2cc7..466f1fed --- a/docs/plugins/tenant_group_module.rst +++ b/docs/plugins/tenant_group_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.tenant_group -- Creates or removes tenant groups from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.tenant_group module -- Creates or removes tenant groups from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,174 +88,354 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the tenant
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the tenant group to be created
-
-
- parent_tenant_group - -
- raw -
-
- added in 3.1.0 of networktocode.nautobot -
- 		- -
Name of the parent tenant group
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
URL-friendly unique shorthand
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the tenant + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the tenant group to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-parent_tenant_group: + + .. rst-class:: ansible-option-title + + **parent_tenant_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.1.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the parent tenant group + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL-friendly unique shorthand + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -255,7 +447,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -310,46 +502,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- tenant_group - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_group_module__return-tenant_group: + + .. rst-class:: ansible-option-title + + **tenant_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/tenant_module.rst b/docs/plugins/tenant_module.rst old mode 100755 new mode 100644 index 0d399f4b..c024cdb7 --- a/docs/plugins/tenant_module.rst +++ b/docs/plugins/tenant_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.tenant -- Creates or removes tenants from Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.tenant module -- Creates or removes tenants from Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,228 +88,465 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments for the tenant. This can be markdown syntax
-
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the tenant
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the tenant to be created
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
URL-friendly unique shorthand
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the tenant may need to be associated with
-
-
- tenant_group - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Tenant group this tenant should be in
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments for the tenant. This can be markdown syntax + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the tenant + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the tenant to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL-friendly unique shorthand + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the tenant may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-tenant_group: + + .. rst-class:: ansible-option-title + + **tenant_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Tenant group this tenant should be in + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -309,7 +558,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -368,46 +617,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- tenant - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.tenant_module__return-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/virtual_chassis_module.rst b/docs/plugins/virtual_chassis_module.rst old mode 100755 new mode 100644 index a3585136..20bbc539 --- a/docs/plugins/virtual_chassis_module.rst +++ b/docs/plugins/virtual_chassis_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.virtual_chassis -- Create, update or delete virtual chassis within Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.virtual_chassis module -- Create, update or delete virtual chassis within Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,173 +88,352 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- domain - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
domain of the virtual chassis
-
-
- master - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The master device the virtual chassis is attached to
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the virtual chassis may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-domain: + + .. rst-class:: ansible-option-title + + **domain** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + domain of the virtual chassis + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-master: + + .. rst-class:: ansible-option-title + + **master** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The master device the virtual chassis is attached to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the virtual chassis may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -254,7 +445,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -308,46 +499,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- virtual_chassis - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_chassis_module__return-virtual_chassis: + + .. rst-class:: ansible-option-title + + **virtual_chassis** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/virtual_machine_module.rst b/docs/plugins/virtual_machine_module.rst old mode 100755 new mode 100644 index f814162d..7d234ee4 --- a/docs/plugins/virtual_machine_module.rst +++ b/docs/plugins/virtual_machine_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.virtual_machine -- Create, update or delete virtual_machines within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.virtual_machine module -- Create, update or delete virtual_machines within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,387 +88,795 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- cluster - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the cluster attach to the virtual machine
-
-
- comments - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Comments of the virtual machine
-
-
- custom_fields - -
- dictionary -
- 		- -
Must exist in Nautobot
-
-
- disk - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Disk of the virtual machine (GB)
-
-
- local_context_data - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
configuration context of the virtual machine
-
-
- memory - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Memory of the virtual machine (MB)
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the virtual machine
-
-
- platform - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The platform of the virtual machine
-
-
- primary_ip4 - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Primary IPv4 address assigned to the virtual machine
-
-
- primary_ip6 - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Primary IPv6 address assigned to the virtual machine
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the site attach to the virtual machine
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the virtual machine
-
Required if state=present and does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the virtual machine may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the virtual machine will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- vcpus - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Number of vcpus of the virtual machine
-
-
- virtual_machine_role - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The role of the virtual machine
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-cluster: + + .. rst-class:: ansible-option-title + + **cluster** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the cluster attach to the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Comments of the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-disk: + + .. rst-class:: ansible-option-title + + **disk** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Disk of the virtual machine (GB) + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-local_context_data: + + .. rst-class:: ansible-option-title + + **local_context_data** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + configuration context of the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-memory: + + .. rst-class:: ansible-option-title + + **memory** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Memory of the virtual machine (MB) + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-platform: + + .. rst-class:: ansible-option-title + + **platform** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The platform of the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-primary_ip4: + + .. rst-class:: ansible-option-title + + **primary_ip4** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Primary IPv4 address assigned to the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-primary_ip6: + + .. rst-class:: ansible-option-title + + **primary_ip6** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Primary IPv6 address assigned to the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the site attach to the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the virtual machine + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the virtual machine may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the virtual machine will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-vcpus: + + .. rst-class:: ansible-option-title + + **vcpus** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Number of vcpus of the virtual machine + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__parameter-virtual_machine_role: + + .. rst-class:: ansible-option-title + + **virtual_machine_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The role of the virtual machine + + + .. raw:: html + +
+ .. Attributes @@ -468,7 +888,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -537,46 +957,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- virtual machine - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.virtual_machine_module__return-virtual machine: + + .. rst-class:: ansible-option-title + + **virtual machine** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/vlan_group_module.rst b/docs/plugins/vlan_group_module.rst old mode 100755 new mode 100644 index c26b83a2..acf4b221 --- a/docs/plugins/vlan_group_module.rst +++ b/docs/plugins/vlan_group_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.vlan_group -- Create, update or delete vlans groups within Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.vlan_group module -- Create, update or delete vlans groups within Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,174 +88,354 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the vlan group
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the vlan group
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The site the vlan will be assigned to
-
-
- slug - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The slugified version of the name or custom slug.
-
This is auto-generated following Nautobot rules if not provided
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the vlan group + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the vlan group + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The site the vlan will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-slug: + + .. rst-class:: ansible-option-title + + **slug** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The slugified version of the name or custom slug. + + This is auto-generated following Nautobot rules if not provided + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -255,7 +447,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -301,46 +493,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- vlan_group - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_group_module__return-vlan_group: + + .. rst-class:: ansible-option-title + + **vlan_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/vlan_module.rst b/docs/plugins/vlan_module.rst old mode 100755 new mode 100644 index 5612e31e..40bbdd68 --- a/docs/plugins/vlan_module.rst +++ b/docs/plugins/vlan_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.vlan -- Create, update or delete vlans within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.vlan module -- Create, update or delete vlans within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,282 +88,576 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the vlan
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the vlan
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- site - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The site the VLAN will be associated to
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- status - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The status of the vlan
-
Required if state=present and does not exist yet
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the vlan may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the vlan will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
- vid - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The VLAN ID
-
-
- vlan_group - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The VLAN group the VLAN will be associated to
-
-
- vlan_role - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The role of the VLAN.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the vlan + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the vlan + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-site: + + .. rst-class:: ansible-option-title + + **site** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The site the VLAN will be associated to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-status: + + .. rst-class:: ansible-option-title + + **status** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The status of the vlan + + Required if \ :emphasis:`state=present`\ and does not exist yet + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the vlan may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the vlan will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-vid: + + .. rst-class:: ansible-option-title + + **vid** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The VLAN ID + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-vlan_group: + + .. rst-class:: ansible-option-title + + **vlan_group** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The VLAN group the VLAN will be associated to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__parameter-vlan_role: + + .. rst-class:: ansible-option-title + + **vlan_role** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The role of the VLAN. + + + .. raw:: html + +
+ .. Attributes @@ -363,7 +669,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -428,46 +734,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- vlan - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vlan_module__return-vlan: + + .. rst-class:: ansible-option-title + + **vlan** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/vm_interface_module.rst b/docs/plugins/vm_interface_module.rst old mode 100755 new mode 100644 index 1c920a6a..49052aa7 --- a/docs/plugins/vm_interface_module.rst +++ b/docs/plugins/vm_interface_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.vm_interface -- Creates or removes interfaces from virtual machines in Nautobot -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.vm_interface module -- Creates or removes interfaces from virtual machines in Nautobot ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,286 +88,583 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the interface
-
-
- enabled - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Sets whether interface shows enabled or disabled
-
-
- mac_address - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The MAC address of the interface
-
-
- mode - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The mode of the interface
-
-
- mtu - -
- integer -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The MTU of the interface
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the interface to be created
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tagged_vlans - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
A list of tagged VLANS to be assigned to interface. Mode must be set to either Tagged or Tagged All
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the prefix may need to be associated with
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- untagged_vlan - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The untagged VLAN to be assigned to interface
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. - This should only be used on personally controlled sites using self-signed certificates.
-
-
- virtual_machine - -
- raw - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Name of the virtual machine the interface will be associated with (case-sensitive)
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-enabled: + + .. rst-class:: ansible-option-title + + **enabled** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Sets whether interface shows enabled or disabled + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-mac_address: + + .. rst-class:: ansible-option-title + + **mac_address** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The MAC address of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-mode: + + .. rst-class:: ansible-option-title + + **mode** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The mode of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-mtu: + + .. rst-class:: ansible-option-title + + **mtu** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The MTU of the interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the interface to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-tagged_vlans: + + .. rst-class:: ansible-option-title + + **tagged_vlans** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + A list of tagged VLANS to be assigned to interface. Mode must be set to either \ :literal:`Tagged`\ or \ :literal:`Tagged All`\ + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the prefix may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-untagged_vlan: + + .. rst-class:: ansible-option-title + + **untagged_vlan** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The untagged VLAN to be assigned to interface + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + This should only be used on personally controlled sites using self-signed certificates. + + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__parameter-virtual_machine: + + .. rst-class:: ansible-option-title + + **virtual_machine** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Name of the virtual machine the interface will be associated with (case-sensitive) + + + .. raw:: html + +
+ .. Attributes @@ -367,7 +676,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -432,46 +741,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- interface - -
- dictionary -
- 		on creation -
Serialized object as created or already existent within Nautobot
-
-
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__return-interface: + + .. rst-class:: ansible-option-title + + **interface** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vm_interface_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/docs/plugins/vrf_module.rst b/docs/plugins/vrf_module.rst old mode 100755 new mode 100644 index 4d5d9631..f51b2126 --- a/docs/plugins/vrf_module.rst +++ b/docs/plugins/vrf_module.rst @@ -11,6 +11,18 @@ .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na +.. role:: ansible-option-type +.. role:: ansible-option-elements +.. role:: ansible-option-required +.. role:: ansible-option-versionadded +.. role:: ansible-option-aliases +.. role:: ansible-option-choices +.. role:: ansible-option-choices-entry +.. role:: ansible-option-default +.. role:: ansible-option-default-bold +.. role:: ansible-option-configuration +.. role:: ansible-option-returned-bold +.. role:: ansible-option-sample-bold .. Anchors @@ -24,13 +36,13 @@ .. Title -networktocode.nautobot.vrf -- Create, update or delete vrfs within Nautobot -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +networktocode.nautobot.vrf module -- Create, update or delete vrfs within Nautobot +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + This module is part of the `networktocode.nautobot collection `_ (version 3.3.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. @@ -76,267 +88,544 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- custom_fields - -
- dictionary -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
must exist in Nautobot
-
-
- description - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The description of the vrf
-
-
- enforce_unique - -
- boolean -
-
- added in 3.0.0 of networktocode.nautobot -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Prevent duplicate prefixes/IP addresses within this VRF
-
-
- export_targets - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Export targets tied to VRF
-
-
- import_targets - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Import targets tied to VRF
-
-
- name - -
- string - / required
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The name of the vrf
-
-
- query_params - -
- list - / elements=string
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
-
in plugins/module_utils/utils.py and provides control to users on what may make
-
an object unique in their environment.
-
-
- rd - -
- string -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The RD of the VRF. Must be quoted to pass as a string.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Use present or absent for adding or removing.
-
-
- tags - -
- list - / elements=raw
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
Any tags that the vrf may need to be associated with
-
-
- tenant - -
- raw -
-
- added in 3.0.0 of networktocode.nautobot -
- 		- -
The tenant that the vrf will be assigned to
-
-
- token - -
- string - / required
- 		- -
The token created within Nautobot to authorize API access
-
-
- url - -
- string - / required
- 		- -
URL of the Nautobot instance resolvable by Ansible control host
-
-
- validate_certs - -
- raw -
- 		- Default:
"yes"
- 		-
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
-
-
+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + must exist in Nautobot + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The description of the vrf + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-enforce_unique: + + .. rst-class:: ansible-option-title + + **enforce_unique** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Prevent duplicate prefixes/IP addresses within this VRF + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`no` + - :ansible-option-choices-entry:`yes` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-export_targets: + + .. rst-class:: ansible-option-title + + **export_targets** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Export targets tied to VRF + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-import_targets: + + .. rst-class:: ansible-option-title + + **import_targets** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Import targets tied to VRF + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The name of the vrf + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined + + in plugins/module_utils/utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-rd: + + .. rst-class:: ansible-option-title + + **rd** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The RD of the VRF. Must be quoted to pass as a string. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Use \ :literal:`present`\ or \ :literal:`absent`\ for adding or removing. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`absent` + - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`list` / :ansible-option-elements:`elements=raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Any tags that the vrf may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-tenant: + + .. rst-class:: ansible-option-title + + **tenant** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + :ansible-option-versionadded:`added in 3.0.0 of networktocode.nautobot` + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The tenant that the vrf will be assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-token: + + .. rst-class:: ansible-option-title + + **token** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The token created within Nautobot to authorize API access + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-url: + + .. rst-class:: ansible-option-title + + **url** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + URL of the Nautobot instance resolvable by Ansible control host + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`raw` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"` + + .. raw:: html + +
+ .. Attributes @@ -348,7 +637,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection ``local`` and hosts ``localhost`` + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ .. Seealso @@ -410,46 +699,96 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- msg - -
- string -
- 		always -
Message indicating failure or info about what has been achieved
-
-
-
- vrf - -
- dictionary -
- 		success (when state=present) -
Serialized object as created or already existent within Nautobot
-
-
-

+.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.networktocode.nautobot.vrf_module__return-vrf: + + .. rst-class:: ansible-option-title + + **vrf** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within Nautobot + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + + + .. raw:: html + +
+ + .. Status (Presently only deprecated) diff --git a/poetry.lock b/poetry.lock index 7f594ab5..0c9980ee 100644 --- a/poetry.lock +++ b/poetry.lock @@ -8,7 +8,7 @@ python-versions = "*" [[package]] name = "ansible-base" -version = "2.10.15" +version = "2.10.17" description = "Radically simple IT automation" category = "main" optional = false @@ -22,11 +22,11 @@ PyYAML = "*" [[package]] name = "astroid" -version = "2.8.5" +version = "2.9.3" description = "An abstract syntax tree for Python with inference support." category = "dev" optional = false -python-versions = "~=3.6" +python-versions = ">=3.6.2" [package.dependencies] lazy-object-proxy = ">=1.4.0" @@ -44,17 +44,17 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "attrs" -version = "21.2.0" +version = "21.4.0" description = "Classes Without Boilerplate" category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [package.extras] -dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit"] +dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit", "cloudpickle"] docs = ["furo", "sphinx", "zope.interface", "sphinx-notfound-page"] -tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface"] -tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins"] +tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "cloudpickle"] +tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "cloudpickle"] [[package]] name = "babel" @@ -83,7 +83,7 @@ stevedore = ">=1.20.0" [[package]] name = "black" -version = "21.11b0" +version = "21.12b0" description = "The uncompromising code formatter." category = "dev" optional = false @@ -95,7 +95,6 @@ dataclasses = {version = ">=0.6", markers = "python_version < \"3.7\""} mypy-extensions = ">=0.4.3" pathspec = ">=0.9.0,<1" platformdirs = ">=2" -regex = ">=2020.1.8" tomli = ">=0.2.6,<2.0.0" typed-ast = {version = ">=1.4.2", markers = "python_version < \"3.8\" and implementation_name == \"cpython\""} typing-extensions = [ @@ -131,7 +130,7 @@ pycparser = "*" [[package]] name = "charset-normalizer" -version = "2.0.7" +version = "2.0.12" description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." category = "dev" optional = false @@ -142,7 +141,7 @@ unicode_backport = ["unicodedata2"] [[package]] name = "click" -version = "8.0.3" +version = "8.0.4" description = "Composable command line interface toolkit" category = "dev" optional = false @@ -182,7 +181,7 @@ python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4" [[package]] name = "cryptography" -version = "35.0.0" +version = "36.0.1" description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers." category = "main" optional = false @@ -193,7 +192,7 @@ cffi = ">=1.12" [package.extras] docs = ["sphinx (>=1.6.5,!=1.8.0,!=3.1.0,!=3.1.1)", "sphinx-rtd-theme"] -docstest = ["doc8", "pyenchant (>=1.6.11)", "twine (>=1.12.0)", "sphinxcontrib-spelling (>=4.0.1)"] +docstest = ["pyenchant (>=1.6.11)", "twine (>=1.12.0)", "sphinxcontrib-spelling (>=4.0.1)"] pep8test = ["black", "flake8", "flake8-import-order", "pep8-naming"] sdist = ["setuptools_rust (>=0.11.4)"] ssh = ["bcrypt (>=3.1.5)"] @@ -209,7 +208,7 @@ python-versions = ">=3.6, <3.7" [[package]] name = "docutils" -version = "0.18" +version = "0.17.1" description = "Docutils -- Python Documentation Utilities" category = "dev" optional = false @@ -251,7 +250,7 @@ typing-extensions = {version = ">=3.7.4.3", markers = "python_version < \"3.10\" [[package]] name = "hypothesis" -version = "6.24.5" +version = "6.31.6" description = "A library for property-based testing" category = "dev" optional = false @@ -262,11 +261,11 @@ attrs = ">=19.2.0" sortedcontainers = ">=2.1.0,<3.0.0" [package.extras] -all = ["black (>=19.10b0)", "click (>=7.0)", "django (>=2.2)", "dpcontracts (>=0.4)", "lark-parser (>=0.6.5)", "libcst (>=0.3.16)", "numpy (>=1.9.0)", "pandas (>=0.25)", "pytest (>=4.6)", "python-dateutil (>=1.4)", "pytz (>=2014.1)", "redis (>=3.0.0)", "rich (>=9.0.0)", "importlib-resources (>=3.3.0)", "importlib-metadata (>=3.6)", "backports.zoneinfo (>=0.2.1)", "tzdata (>=2020.4)"] +all = ["black (>=19.10b0)", "click (>=7.0)", "django (>=2.2)", "dpcontracts (>=0.4)", "lark-parser (>=0.6.5)", "libcst (>=0.3.16)", "numpy (>=1.9.0)", "pandas (>=0.25)", "pytest (>=4.6)", "python-dateutil (>=1.4)", "pytz (>=2014.1)", "redis (>=3.0.0)", "rich (>=9.0.0)", "importlib-resources (>=3.3.0)", "importlib-metadata (>=3.6)", "backports.zoneinfo (>=0.2.1)", "tzdata (>=2021.5)"] cli = ["click (>=7.0)", "black (>=19.10b0)", "rich (>=9.0.0)"] codemods = ["libcst (>=0.3.16)"] dateutil = ["python-dateutil (>=1.4)"] -django = ["pytz (>=2014.1)", "django (>=2.2)"] +django = ["django (>=2.2)"] dpcontracts = ["dpcontracts (>=0.4)"] ghostwriter = ["black (>=19.10b0)"] lark = ["lark-parser (>=0.6.5)"] @@ -275,7 +274,7 @@ pandas = ["pandas (>=0.25)"] pytest = ["pytest (>=4.6)"] pytz = ["pytz (>=2014.1)"] redis = ["redis (>=3.0.0)"] -zoneinfo = ["importlib-resources (>=3.3.0)", "backports.zoneinfo (>=0.2.1)", "tzdata (>=2020.4)"] +zoneinfo = ["importlib-resources (>=3.3.0)", "backports.zoneinfo (>=0.2.1)", "tzdata (>=2021.5)"] [[package]] name = "idna" @@ -362,7 +361,7 @@ python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" [[package]] name = "jsondiff" -version = "1.3.0" +version = "1.3.1" description = "Diff JSON and JSON-like structures in Python" category = "dev" optional = false @@ -370,11 +369,11 @@ python-versions = "*" [[package]] name = "lazy-object-proxy" -version = "1.6.0" +version = "1.7.1" description = "A fast and thorough lazy object proxy." category = "dev" optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*" +python-versions = ">=3.6" [[package]] name = "markupsafe" @@ -415,22 +414,22 @@ python-versions = "*" [[package]] name = "netutils" -version = "0.2.4" +version = "0.2.5" description = "Common helper functions useful in network automation." category = "main" optional = false -python-versions = ">=3.6.2,<4.0.0" +python-versions = ">=3.6,<4.0" [[package]] name = "packaging" -version = "21.2" +version = "21.3" description = "Core utilities for Python packages" category = "main" optional = false python-versions = ">=3.6" [package.dependencies] -pyparsing = ">=2.0.2,<3" +pyparsing = ">=2.0.2,<3.0.5 || >3.0.5" [[package]] name = "parameterized" @@ -453,7 +452,7 @@ python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7" [[package]] name = "pbr" -version = "5.7.0" +version = "5.8.1" description = "Python Build Reasonableness" category = "dev" optional = false @@ -504,7 +503,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "pygments" -version = "2.10.0" +version = "2.11.2" description = "Pygments is a syntax highlighting package written in Python." category = "dev" optional = false @@ -512,24 +511,24 @@ python-versions = ">=3.5" [[package]] name = "pylint" -version = "2.11.1" +version = "2.12.2" description = "python code static checker" category = "dev" optional = false -python-versions = "~=3.6" +python-versions = ">=3.6.2" [package.dependencies] -astroid = ">=2.8.0,<2.9" +astroid = ">=2.9.0,<2.10" colorama = {version = "*", markers = "sys_platform == \"win32\""} isort = ">=4.2.5,<6" mccabe = ">=0.6,<0.7" platformdirs = ">=2.2.0" -toml = ">=0.7.1" +toml = ">=0.9.2" typing-extensions = {version = ">=3.10.0", markers = "python_version < \"3.10\""} [[package]] name = "pynautobot" -version = "1.0.3" +version = "1.0.4" description = "Nautobot API client library" category = "dev" optional = false @@ -543,11 +542,14 @@ docs = ["Sphinx (>=3.5.1,<4.0.0)"] [[package]] name = "pyparsing" -version = "2.4.7" +version = "3.0.7" description = "Python parsing module" category = "main" optional = false -python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" +python-versions = ">=3.6" + +[package.extras] +diagrams = ["jinja2", "railroad-diagrams"] [[package]] name = "pytest" @@ -573,11 +575,11 @@ testing = ["argcomplete", "hypothesis (>=3.56)", "mock", "nose", "requests", "xm [[package]] name = "pytest-forked" -version = "1.3.0" +version = "1.4.0" description = "run tests in isolated forked subprocesses" category = "dev" optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +python-versions = ">=3.6" [package.dependencies] py = "*" @@ -599,18 +601,18 @@ dev = ["pre-commit", "tox", "pytest-asyncio"] [[package]] name = "pytest-pythonpath" -version = "0.7.3" +version = "0.7.4" description = "pytest plugin for adding to the PYTHONPATH from command line or configs." category = "dev" optional = false -python-versions = "*" +python-versions = ">=2.6, <4" [package.dependencies] -pytest = ">=2.5.2" +pytest = ">=2.5.2,<7" [[package]] name = "pytest-xdist" -version = "2.4.0" +version = "2.5.0" description = "pytest xdist plugin for distributed testing and loop-on-failing modes" category = "dev" optional = false @@ -618,7 +620,7 @@ python-versions = ">=3.6" [package.dependencies] execnet = ">=1.1" -pytest = ">=6.0.0" +pytest = ">=6.2.0" pytest-forked = "*" [package.extras] @@ -642,17 +644,9 @@ category = "main" optional = false python-versions = ">=3.6" -[[package]] -name = "regex" -version = "2021.11.10" -description = "Alternative regular expression module, to replace re." -category = "dev" -optional = false -python-versions = "*" - [[package]] name = "requests" -version = "2.26.0" +version = "2.27.1" description = "Python HTTP for Humans." category = "dev" optional = false @@ -694,17 +688,17 @@ python-versions = "*" [[package]] name = "sphinx" -version = "3.5.3" +version = "4.3.2" description = "Python documentation generator" category = "dev" optional = false -python-versions = ">=3.5" +python-versions = ">=3.6" [package.dependencies] alabaster = ">=0.7,<0.8" babel = ">=1.3" colorama = {version = ">=0.3.5", markers = "sys_platform == \"win32\""} -docutils = ">=0.12" +docutils = ">=0.14,<0.18" imagesize = "*" Jinja2 = ">=2.3" packaging = "*" @@ -713,26 +707,27 @@ requests = ">=2.5.0" snowballstemmer = ">=1.1" sphinxcontrib-applehelp = "*" sphinxcontrib-devhelp = "*" -sphinxcontrib-htmlhelp = "*" +sphinxcontrib-htmlhelp = ">=2.0.0" sphinxcontrib-jsmath = "*" sphinxcontrib-qthelp = "*" -sphinxcontrib-serializinghtml = "*" +sphinxcontrib-serializinghtml = ">=1.1.5" [package.extras] docs = ["sphinxcontrib-websupport"] -lint = ["flake8 (>=3.5.0)", "isort", "mypy (>=0.800)", "docutils-stubs"] +lint = ["flake8 (>=3.5.0)", "isort", "mypy (>=0.920)", "docutils-stubs", "types-typed-ast", "types-pkg-resources", "types-requests"] test = ["pytest", "pytest-cov", "html5lib", "cython", "typed-ast"] [[package]] name = "sphinx-rtd-theme" -version = "0.5.1" +version = "1.0.0" description = "Read the Docs theme for Sphinx" category = "dev" optional = false -python-versions = "*" +python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*" [package.dependencies] -sphinx = "*" +docutils = "<0.18" +sphinx = ">=1.6" [package.extras] dev = ["transifex-client", "sphinxcontrib-httpdomain", "bump2version"] @@ -830,7 +825,7 @@ python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" [[package]] name = "tomli" -version = "1.2.2" +version = "1.2.3" description = "A lil' TOML parser" category = "dev" optional = false @@ -838,7 +833,7 @@ python-versions = ">=3.6" [[package]] name = "typed-ast" -version = "1.5.0" +version = "1.5.2" description = "a fork of Python 2 and 3 ast modules with type comment support" category = "dev" optional = false @@ -846,7 +841,7 @@ python-versions = ">=3.6" [[package]] name = "typing-extensions" -version = "4.0.0" +version = "4.1.1" description = "Backported and Experimental Type Hints for Python 3.6+" category = "dev" optional = false @@ -854,7 +849,7 @@ python-versions = ">=3.6" [[package]] name = "urllib3" -version = "1.26.7" +version = "1.26.8" description = "HTTP library with thread-safe connection pooling, file post, and more." category = "dev" optional = false @@ -896,19 +891,19 @@ alabaster = [ {file = "alabaster-0.7.12.tar.gz", hash = "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"}, ] ansible-base = [ - {file = "ansible-base-2.10.15.tar.gz", hash = "sha256:4478818ba821dba143e123568ec5d317dc8fa4ac6e1513f7a501734e52976bff"}, + {file = "ansible-base-2.10.17.tar.gz", hash = "sha256:ef925882ca8d4c3c2ccd091cde199e0c869024ccad0d07a337dcf207bff32f34"}, ] astroid = [ - {file = "astroid-2.8.5-py3-none-any.whl", hash = "sha256:abc423a1e85bc1553954a14f2053473d2b7f8baf32eae62a328be24f436b5107"}, - {file = "astroid-2.8.5.tar.gz", hash = "sha256:11f7356737b624c42e21e71fe85eea6875cb94c03c82ac76bd535a0ff10b0f25"}, + {file = "astroid-2.9.3-py3-none-any.whl", hash = "sha256:506daabe5edffb7e696ad82483ad0228245a9742ed7d2d8c9cdb31537decf9f6"}, + {file = "astroid-2.9.3.tar.gz", hash = "sha256:1efdf4e867d4d8ba4a9f6cf9ce07cd182c4c41de77f23814feb27ca93ca9d877"}, ] atomicwrites = [ {file = "atomicwrites-1.4.0-py2.py3-none-any.whl", hash = "sha256:6d1784dea7c0c8d4a5172b6c620f40b6e4cbfdf96d783691f2e1302a7b88e197"}, {file = "atomicwrites-1.4.0.tar.gz", hash = "sha256:ae70396ad1a434f9c7046fd2dd196fc04b12f9e91ffb859164193be8b6168a7a"}, ] attrs = [ - {file = "attrs-21.2.0-py2.py3-none-any.whl", hash = "sha256:149e90d6d8ac20db7a955ad60cf0e6881a3f20d37096140088356da6c716b0b1"}, - {file = "attrs-21.2.0.tar.gz", hash = "sha256:ef6aaac3ca6cd92904cdd0d83f629a15f18053ec84e6432106f7a4d04ae4f5fb"}, + {file = "attrs-21.4.0-py2.py3-none-any.whl", hash = "sha256:2d27e3784d7a565d36ab851fe94887c5eccd6a463168875832a1be79c82828b4"}, + {file = "attrs-21.4.0.tar.gz", hash = "sha256:626ba8234211db98e869df76230a137c4c40a12d72445c45d5f5b716f076e2fd"}, ] babel = [ {file = "Babel-2.9.1-py2.py3-none-any.whl", hash = "sha256:ab49e12b91d937cd11f0b67cb259a57ab4ad2b59ac7a3b41d6c06c0ac5b0def9"}, @@ -919,8 +914,8 @@ bandit = [ {file = "bandit-1.7.1.tar.gz", hash = "sha256:a81b00b5436e6880fa8ad6799bc830e02032047713cbb143a12939ac67eb756c"}, ] black = [ - {file = "black-21.11b0-py3-none-any.whl", hash = "sha256:0b1f66cbfadcd332ceeaeecf6373d9991d451868d2e2219ad0ac1213fb701117"}, - {file = "black-21.11b0.tar.gz", hash = "sha256:83f3852301c8dcb229e9c444dd79f573c8d31c7c2dad9bbaaa94c808630e32aa"}, + {file = "black-21.12b0-py3-none-any.whl", hash = "sha256:a615e69ae185e08fdd73e4715e260e2479c861b5740057fde6e8b4e3b7dd589f"}, + {file = "black-21.12b0.tar.gz", hash = "sha256:77b80f693a569e2e527958459634f18df9b0ba2625ba4e0c2d5da5be42e6f2b3"}, ] certifi = [ {file = "certifi-2021.10.8-py2.py3-none-any.whl", hash = "sha256:d62a0163eb4c2344ac042ab2bdf75399a71a2d8c7d47eac2e2ee91b9d6339569"}, @@ -979,12 +974,12 @@ cffi = [ {file = "cffi-1.15.0.tar.gz", hash = "sha256:920f0d66a896c2d99f0adbb391f990a84091179542c205fa53ce5787aff87954"}, ] charset-normalizer = [ - {file = "charset-normalizer-2.0.7.tar.gz", hash = "sha256:e019de665e2bcf9c2b64e2e5aa025fa991da8720daa3c1138cadd2fd1856aed0"}, - {file = "charset_normalizer-2.0.7-py3-none-any.whl", hash = "sha256:f7af805c321bfa1ce6714c51f254e0d5bb5e5834039bc17db7ebe3a4cec9492b"}, + {file = "charset-normalizer-2.0.12.tar.gz", hash = "sha256:2857e29ff0d34db842cd7ca3230549d1a697f96ee6d3fb071cfa6c7393832597"}, + {file = "charset_normalizer-2.0.12-py3-none-any.whl", hash = "sha256:6881edbebdb17b39b4eaaa821b438bf6eddffb4468cf344f09f89def34a8b1df"}, ] click = [ - {file = "click-8.0.3-py3-none-any.whl", hash = "sha256:353f466495adaeb40b6b5f592f9f91cb22372351c84caeb068132442a4518ef3"}, - {file = "click-8.0.3.tar.gz", hash = "sha256:410e932b050f5eed773c4cda94de75971c89cdb3155a72a0831139a79e5ecb5b"}, + {file = "click-8.0.4-py3-none-any.whl", hash = "sha256:6a7a62563bbfabfda3a38f3023a1db4a35978c0abd76f6c9605ecd6554d6d9b1"}, + {file = "click-8.0.4.tar.gz", hash = "sha256:8458d7b1287c5fb128c90e23381cf99dcde74beaf6c7ff6384ce84d6fe090adb"}, ] codecov = [ {file = "codecov-2.1.12-py2.py3-none-any.whl", hash = "sha256:585dc217dc3d8185198ceb402f85d5cb5dbfa0c5f350a5abcdf9e347776a5b47"}, @@ -1030,34 +1025,34 @@ coverage = [ {file = "coverage-4.5.4.tar.gz", hash = "sha256:e07d9f1a23e9e93ab5c62902833bf3e4b1f65502927379148b6622686223125c"}, ] cryptography = [ - {file = "cryptography-35.0.0-cp36-abi3-macosx_10_10_x86_64.whl", hash = "sha256:d57e0cdc1b44b6cdf8af1d01807db06886f10177469312fbde8f44ccbb284bc9"}, - {file = "cryptography-35.0.0-cp36-abi3-macosx_11_0_arm64.whl", hash = "sha256:ced40344e811d6abba00295ced98c01aecf0c2de39481792d87af4fa58b7b4d6"}, - {file = "cryptography-35.0.0-cp36-abi3-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:54b2605e5475944e2213258e0ab8696f4f357a31371e538ef21e8d61c843c28d"}, - {file = "cryptography-35.0.0-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_24_aarch64.whl", hash = "sha256:7b7ceeff114c31f285528ba8b390d3e9cfa2da17b56f11d366769a807f17cbaa"}, - {file = "cryptography-35.0.0-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2d69645f535f4b2c722cfb07a8eab916265545b3475fdb34e0be2f4ee8b0b15e"}, - {file = "cryptography-35.0.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4a2d0e0acc20ede0f06ef7aa58546eee96d2592c00f450c9acb89c5879b61992"}, - {file = "cryptography-35.0.0-cp36-abi3-manylinux_2_24_x86_64.whl", hash = "sha256:07bb7fbfb5de0980590ddfc7f13081520def06dc9ed214000ad4372fb4e3c7f6"}, - {file = "cryptography-35.0.0-cp36-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:7eba2cebca600a7806b893cb1d541a6e910afa87e97acf2021a22b32da1df52d"}, - {file = "cryptography-35.0.0-cp36-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:18d90f4711bf63e2fb21e8c8e51ed8189438e6b35a6d996201ebd98a26abbbe6"}, - {file = "cryptography-35.0.0-cp36-abi3-win32.whl", hash = "sha256:c10c797ac89c746e488d2ee92bd4abd593615694ee17b2500578b63cad6b93a8"}, - {file = "cryptography-35.0.0-cp36-abi3-win_amd64.whl", hash = "sha256:7075b304cd567694dc692ffc9747f3e9cb393cc4aa4fb7b9f3abd6f5c4e43588"}, - {file = "cryptography-35.0.0-pp36-pypy36_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:a688ebcd08250eab5bb5bca318cc05a8c66de5e4171a65ca51db6bd753ff8953"}, - {file = "cryptography-35.0.0-pp36-pypy36_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d99915d6ab265c22873f1b4d6ea5ef462ef797b4140be4c9d8b179915e0985c6"}, - {file = "cryptography-35.0.0-pp36-pypy36_pp73-manylinux_2_24_x86_64.whl", hash = "sha256:928185a6d1ccdb816e883f56ebe92e975a262d31cc536429041921f8cb5a62fd"}, - {file = "cryptography-35.0.0-pp37-pypy37_pp73-macosx_10_10_x86_64.whl", hash = "sha256:ebeddd119f526bcf323a89f853afb12e225902a24d29b55fe18dd6fcb2838a76"}, - {file = "cryptography-35.0.0-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:22a38e96118a4ce3b97509443feace1d1011d0571fae81fc3ad35f25ba3ea999"}, - {file = "cryptography-35.0.0-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eb80e8a1f91e4b7ef8b33041591e6d89b2b8e122d787e87eeb2b08da71bb16ad"}, - {file = "cryptography-35.0.0-pp37-pypy37_pp73-manylinux_2_24_x86_64.whl", hash = "sha256:abb5a361d2585bb95012a19ed9b2c8f412c5d723a9836418fab7aaa0243e67d2"}, - {file = "cryptography-35.0.0-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:1ed82abf16df40a60942a8c211251ae72858b25b7421ce2497c2eb7a1cee817c"}, - {file = "cryptography-35.0.0.tar.gz", hash = "sha256:9933f28f70d0517686bd7de36166dda42094eac49415459d9bdf5e7df3e0086d"}, + {file = "cryptography-36.0.1-cp36-abi3-macosx_10_10_universal2.whl", hash = "sha256:73bc2d3f2444bcfeac67dd130ff2ea598ea5f20b40e36d19821b4df8c9c5037b"}, + {file = "cryptography-36.0.1-cp36-abi3-macosx_10_10_x86_64.whl", hash = "sha256:2d87cdcb378d3cfed944dac30596da1968f88fb96d7fc34fdae30a99054b2e31"}, + {file = "cryptography-36.0.1-cp36-abi3-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:74d6c7e80609c0f4c2434b97b80c7f8fdfaa072ca4baab7e239a15d6d70ed73a"}, + {file = "cryptography-36.0.1-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_24_aarch64.whl", hash = "sha256:6c0c021f35b421ebf5976abf2daacc47e235f8b6082d3396a2fe3ccd537ab173"}, + {file = "cryptography-36.0.1-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5d59a9d55027a8b88fd9fd2826c4392bd487d74bf628bb9d39beecc62a644c12"}, + {file = "cryptography-36.0.1-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0a817b961b46894c5ca8a66b599c745b9a3d9f822725221f0e0fe49dc043a3a3"}, + {file = "cryptography-36.0.1-cp36-abi3-manylinux_2_24_x86_64.whl", hash = "sha256:94ae132f0e40fe48f310bba63f477f14a43116f05ddb69d6fa31e93f05848ae2"}, + {file = "cryptography-36.0.1-cp36-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:7be0eec337359c155df191d6ae00a5e8bbb63933883f4f5dffc439dac5348c3f"}, + {file = "cryptography-36.0.1-cp36-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:e0344c14c9cb89e76eb6a060e67980c9e35b3f36691e15e1b7a9e58a0a6c6dc3"}, + {file = "cryptography-36.0.1-cp36-abi3-win32.whl", hash = "sha256:4caa4b893d8fad33cf1964d3e51842cd78ba87401ab1d2e44556826df849a8ca"}, + {file = "cryptography-36.0.1-cp36-abi3-win_amd64.whl", hash = "sha256:391432971a66cfaf94b21c24ab465a4cc3e8bf4a939c1ca5c3e3a6e0abebdbcf"}, + {file = "cryptography-36.0.1-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:bb5829d027ff82aa872d76158919045a7c1e91fbf241aec32cb07956e9ebd3c9"}, + {file = "cryptography-36.0.1-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ebc15b1c22e55c4d5566e3ca4db8689470a0ca2babef8e3a9ee057a8b82ce4b1"}, + {file = "cryptography-36.0.1-pp37-pypy37_pp73-manylinux_2_24_x86_64.whl", hash = "sha256:596f3cd67e1b950bc372c33f1a28a0692080625592ea6392987dba7f09f17a94"}, + {file = "cryptography-36.0.1-pp38-pypy38_pp73-macosx_10_10_x86_64.whl", hash = "sha256:30ee1eb3ebe1644d1c3f183d115a8c04e4e603ed6ce8e394ed39eea4a98469ac"}, + {file = "cryptography-36.0.1-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ec63da4e7e4a5f924b90af42eddf20b698a70e58d86a72d943857c4c6045b3ee"}, + {file = "cryptography-36.0.1-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ca238ceb7ba0bdf6ce88c1b74a87bffcee5afbfa1e41e173b1ceb095b39add46"}, + {file = "cryptography-36.0.1-pp38-pypy38_pp73-manylinux_2_24_x86_64.whl", hash = "sha256:ca28641954f767f9822c24e927ad894d45d5a1e501767599647259cbf030b903"}, + {file = "cryptography-36.0.1-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:39bdf8e70eee6b1c7b289ec6e5d84d49a6bfa11f8b8646b5b3dfe41219153316"}, + {file = "cryptography-36.0.1.tar.gz", hash = "sha256:53e5c1dc3d7a953de055d77bef2ff607ceef7a2aac0353b5d630ab67f7423638"}, ] dataclasses = [ {file = "dataclasses-0.8-py3-none-any.whl", hash = "sha256:0201d89fa866f68c8ebd9d08ee6ff50c0b255f8ec63a71c16fda7af82bb887bf"}, {file = "dataclasses-0.8.tar.gz", hash = "sha256:8479067f342acf957dc82ec415d355ab5edb7e7646b90dc6e2fd1d96ad084c97"}, ] docutils = [ - {file = "docutils-0.18-py2.py3-none-any.whl", hash = "sha256:a31688b2ea858517fa54293e5d5df06fbb875fb1f7e4c64529271b77781ca8fc"}, - {file = "docutils-0.18.tar.gz", hash = "sha256:c1d5dab2b11d16397406a282e53953fe495a46d69ae329f55aa98a5c4e3c5fbb"}, + {file = "docutils-0.17.1-py2.py3-none-any.whl", hash = "sha256:cf316c8370a737a022b72b56874f6602acf974a37a9fba42ec2876387549fc61"}, + {file = "docutils-0.17.1.tar.gz", hash = "sha256:686577d2e4c32380bb50cbb22f575ed742d58168cee37e99117a854bcd88f125"}, ] execnet = [ {file = "execnet-1.9.0-py2.py3-none-any.whl", hash = "sha256:a295f7cc774947aac58dde7fdc85f4aa00c42adf5d8f5468fc630c1acf30a142"}, @@ -1072,8 +1067,8 @@ gitpython = [ {file = "GitPython-3.1.20.tar.gz", hash = "sha256:df0e072a200703a65387b0cfdf0466e3bab729c0458cf6b7349d0e9877636519"}, ] hypothesis = [ - {file = "hypothesis-6.24.5-py3-none-any.whl", hash = "sha256:8f7318839b64bae1410704933fe01f3db5f80f20f2ba8d4ea3520443ae3a001d"}, - {file = "hypothesis-6.24.5.tar.gz", hash = "sha256:f1627022f75306c653115fbd169ba6a4322804f60533a7b46625fd0eecba43d5"}, + {file = "hypothesis-6.31.6-py3-none-any.whl", hash = "sha256:fbd31da5174f3da8d062017302071967b239a1b397d0e3181a44d43346bc6def"}, + {file = "hypothesis-6.31.6.tar.gz", hash = "sha256:d54be6a80b160ad5ea4209b01a0d72e31d910510ed7142fa9907861911800771"}, ] idna = [ {file = "idna-3.3-py3-none-any.whl", hash = "sha256:84d9dd047ffa80596e0f246e2eab0b391788b0503584e8945f2368256d2735ff"}, @@ -1109,31 +1104,46 @@ jmespath = [ {file = "jmespath-0.10.0.tar.gz", hash = "sha256:b85d0567b8666149a93172712e68920734333c0ce7e89b78b3e987f71e5ed4f9"}, ] jsondiff = [ - {file = "jsondiff-1.3.0.tar.gz", hash = "sha256:5122bf4708a031b02db029366184a87c5d0ddd5a327a5884ee6cf0193e599d71"}, + {file = "jsondiff-1.3.1.tar.gz", hash = "sha256:04cfaebd4a5e5738948ab615710dc3ee98efbdf851255fd3977c4c2ee59e7312"}, ] lazy-object-proxy = [ - {file = "lazy-object-proxy-1.6.0.tar.gz", hash = "sha256:489000d368377571c6f982fba6497f2aa13c6d1facc40660963da62f5c379726"}, - {file = "lazy_object_proxy-1.6.0-cp27-cp27m-macosx_10_14_x86_64.whl", hash = "sha256:c6938967f8528b3668622a9ed3b31d145fab161a32f5891ea7b84f6b790be05b"}, - {file = "lazy_object_proxy-1.6.0-cp27-cp27m-win32.whl", hash = "sha256:ebfd274dcd5133e0afae738e6d9da4323c3eb021b3e13052d8cbd0e457b1256e"}, - {file = "lazy_object_proxy-1.6.0-cp27-cp27m-win_amd64.whl", hash = "sha256:ed361bb83436f117f9917d282a456f9e5009ea12fd6de8742d1a4752c3017e93"}, - {file = "lazy_object_proxy-1.6.0-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:d900d949b707778696fdf01036f58c9876a0d8bfe116e8d220cfd4b15f14e741"}, - {file = "lazy_object_proxy-1.6.0-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:5743a5ab42ae40caa8421b320ebf3a998f89c85cdc8376d6b2e00bd12bd1b587"}, - {file = "lazy_object_proxy-1.6.0-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:bf34e368e8dd976423396555078def5cfc3039ebc6fc06d1ae2c5a65eebbcde4"}, - {file = "lazy_object_proxy-1.6.0-cp36-cp36m-win32.whl", hash = "sha256:b579f8acbf2bdd9ea200b1d5dea36abd93cabf56cf626ab9c744a432e15c815f"}, - {file = "lazy_object_proxy-1.6.0-cp36-cp36m-win_amd64.whl", hash = "sha256:4f60460e9f1eb632584c9685bccea152f4ac2130e299784dbaf9fae9f49891b3"}, - {file = "lazy_object_proxy-1.6.0-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:d7124f52f3bd259f510651450e18e0fd081ed82f3c08541dffc7b94b883aa981"}, - {file = "lazy_object_proxy-1.6.0-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:22ddd618cefe54305df49e4c069fa65715be4ad0e78e8d252a33debf00f6ede2"}, - {file = "lazy_object_proxy-1.6.0-cp37-cp37m-win32.whl", hash = "sha256:9d397bf41caad3f489e10774667310d73cb9c4258e9aed94b9ec734b34b495fd"}, - {file = "lazy_object_proxy-1.6.0-cp37-cp37m-win_amd64.whl", hash = "sha256:24a5045889cc2729033b3e604d496c2b6f588c754f7a62027ad4437a7ecc4837"}, - {file = "lazy_object_proxy-1.6.0-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:17e0967ba374fc24141738c69736da90e94419338fd4c7c7bef01ee26b339653"}, - {file = "lazy_object_proxy-1.6.0-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:410283732af311b51b837894fa2f24f2c0039aa7f220135192b38fcc42bd43d3"}, - {file = "lazy_object_proxy-1.6.0-cp38-cp38-win32.whl", hash = "sha256:85fb7608121fd5621cc4377a8961d0b32ccf84a7285b4f1d21988b2eae2868e8"}, - {file = "lazy_object_proxy-1.6.0-cp38-cp38-win_amd64.whl", hash = "sha256:d1c2676e3d840852a2de7c7d5d76407c772927addff8d742b9808fe0afccebdf"}, - {file = "lazy_object_proxy-1.6.0-cp39-cp39-macosx_10_14_x86_64.whl", hash = "sha256:b865b01a2e7f96db0c5d12cfea590f98d8c5ba64ad222300d93ce6ff9138bcad"}, - {file = "lazy_object_proxy-1.6.0-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:4732c765372bd78a2d6b2150a6e99d00a78ec963375f236979c0626b97ed8e43"}, - {file = "lazy_object_proxy-1.6.0-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:9698110e36e2df951c7c36b6729e96429c9c32b3331989ef19976592c5f3c77a"}, - {file = "lazy_object_proxy-1.6.0-cp39-cp39-win32.whl", hash = "sha256:1fee665d2638491f4d6e55bd483e15ef21f6c8c2095f235fef72601021e64f61"}, - {file = "lazy_object_proxy-1.6.0-cp39-cp39-win_amd64.whl", hash = "sha256:f5144c75445ae3ca2057faac03fda5a902eff196702b0a24daf1d6ce0650514b"}, + {file = "lazy-object-proxy-1.7.1.tar.gz", hash = "sha256:d609c75b986def706743cdebe5e47553f4a5a1da9c5ff66d76013ef396b5a8a4"}, + {file = "lazy_object_proxy-1.7.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:bb8c5fd1684d60a9902c60ebe276da1f2281a318ca16c1d0a96db28f62e9166b"}, + {file = "lazy_object_proxy-1.7.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a57d51ed2997e97f3b8e3500c984db50a554bb5db56c50b5dab1b41339b37e36"}, + {file = "lazy_object_proxy-1.7.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fd45683c3caddf83abbb1249b653a266e7069a09f486daa8863fb0e7496a9fdb"}, + {file = "lazy_object_proxy-1.7.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:8561da8b3dd22d696244d6d0d5330618c993a215070f473b699e00cf1f3f6443"}, + {file = "lazy_object_proxy-1.7.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fccdf7c2c5821a8cbd0a9440a456f5050492f2270bd54e94360cac663398739b"}, + {file = "lazy_object_proxy-1.7.1-cp310-cp310-win32.whl", hash = "sha256:898322f8d078f2654d275124a8dd19b079080ae977033b713f677afcfc88e2b9"}, + {file = "lazy_object_proxy-1.7.1-cp310-cp310-win_amd64.whl", hash = "sha256:85b232e791f2229a4f55840ed54706110c80c0a210d076eee093f2b2e33e1bfd"}, + {file = "lazy_object_proxy-1.7.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:46ff647e76f106bb444b4533bb4153c7370cdf52efc62ccfc1a28bdb3cc95442"}, + {file = "lazy_object_proxy-1.7.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:12f3bb77efe1367b2515f8cb4790a11cffae889148ad33adad07b9b55e0ab22c"}, + {file = "lazy_object_proxy-1.7.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c19814163728941bb871240d45c4c30d33b8a2e85972c44d4e63dd7107faba44"}, + {file = "lazy_object_proxy-1.7.1-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:e40f2013d96d30217a51eeb1db28c9ac41e9d0ee915ef9d00da639c5b63f01a1"}, + {file = "lazy_object_proxy-1.7.1-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:2052837718516a94940867e16b1bb10edb069ab475c3ad84fd1e1a6dd2c0fcfc"}, + {file = "lazy_object_proxy-1.7.1-cp36-cp36m-win32.whl", hash = "sha256:6a24357267aa976abab660b1d47a34aaf07259a0c3859a34e536f1ee6e76b5bb"}, + {file = "lazy_object_proxy-1.7.1-cp36-cp36m-win_amd64.whl", hash = "sha256:6aff3fe5de0831867092e017cf67e2750c6a1c7d88d84d2481bd84a2e019ec35"}, + {file = "lazy_object_proxy-1.7.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:6a6e94c7b02641d1311228a102607ecd576f70734dc3d5e22610111aeacba8a0"}, + {file = "lazy_object_proxy-1.7.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c4ce15276a1a14549d7e81c243b887293904ad2d94ad767f42df91e75fd7b5b6"}, + {file = "lazy_object_proxy-1.7.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e368b7f7eac182a59ff1f81d5f3802161932a41dc1b1cc45c1f757dc876b5d2c"}, + {file = "lazy_object_proxy-1.7.1-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:6ecbb350991d6434e1388bee761ece3260e5228952b1f0c46ffc800eb313ff42"}, + {file = "lazy_object_proxy-1.7.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:553b0f0d8dbf21890dd66edd771f9b1b5f51bd912fa5f26de4449bfc5af5e029"}, + {file = "lazy_object_proxy-1.7.1-cp37-cp37m-win32.whl", hash = "sha256:c7a683c37a8a24f6428c28c561c80d5f4fd316ddcf0c7cab999b15ab3f5c5c69"}, + {file = "lazy_object_proxy-1.7.1-cp37-cp37m-win_amd64.whl", hash = "sha256:df2631f9d67259dc9620d831384ed7732a198eb434eadf69aea95ad18c587a28"}, + {file = "lazy_object_proxy-1.7.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:07fa44286cda977bd4803b656ffc1c9b7e3bc7dff7d34263446aec8f8c96f88a"}, + {file = "lazy_object_proxy-1.7.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4dca6244e4121c74cc20542c2ca39e5c4a5027c81d112bfb893cf0790f96f57e"}, + {file = "lazy_object_proxy-1.7.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:91ba172fc5b03978764d1df5144b4ba4ab13290d7bab7a50f12d8117f8630c38"}, + {file = "lazy_object_proxy-1.7.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:043651b6cb706eee4f91854da4a089816a6606c1428fd391573ef8cb642ae4f7"}, + {file = "lazy_object_proxy-1.7.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:b9e89b87c707dd769c4ea91f7a31538888aad05c116a59820f28d59b3ebfe25a"}, + {file = "lazy_object_proxy-1.7.1-cp38-cp38-win32.whl", hash = "sha256:9d166602b525bf54ac994cf833c385bfcc341b364e3ee71e3bf5a1336e677b55"}, + {file = "lazy_object_proxy-1.7.1-cp38-cp38-win_amd64.whl", hash = "sha256:8f3953eb575b45480db6568306893f0bd9d8dfeeebd46812aa09ca9579595148"}, + {file = "lazy_object_proxy-1.7.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:dd7ed7429dbb6c494aa9bc4e09d94b778a3579be699f9d67da7e6804c422d3de"}, + {file = "lazy_object_proxy-1.7.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:70ed0c2b380eb6248abdef3cd425fc52f0abd92d2b07ce26359fcbc399f636ad"}, + {file = "lazy_object_proxy-1.7.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7096a5e0c1115ec82641afbdd70451a144558ea5cf564a896294e346eb611be1"}, + {file = "lazy_object_proxy-1.7.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:f769457a639403073968d118bc70110e7dce294688009f5c24ab78800ae56dc8"}, + {file = "lazy_object_proxy-1.7.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:39b0e26725c5023757fc1ab2a89ef9d7ab23b84f9251e28f9cc114d5b59c1b09"}, + {file = "lazy_object_proxy-1.7.1-cp39-cp39-win32.whl", hash = "sha256:2130db8ed69a48a3440103d4a520b89d8a9405f1b06e2cc81640509e8bf6548f"}, + {file = "lazy_object_proxy-1.7.1-cp39-cp39-win_amd64.whl", hash = "sha256:677ea950bef409b47e51e733283544ac3d660b709cfce7b187f5ace137960d61"}, + {file = "lazy_object_proxy-1.7.1-pp37.pp38-none-any.whl", hash = "sha256:d66906d5785da8e0be7360912e99c9188b70f52c422f9fc18223347235691a84"}, ] markupsafe = [ {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d8446c54dc28c01e5a2dbac5a25f071f6653e6e40f3a8818e8b45d790fe6ef53"}, @@ -1219,12 +1229,12 @@ mypy-extensions = [ {file = "mypy_extensions-0.4.3.tar.gz", hash = "sha256:2d82818f5bb3e369420cb3c4060a7970edba416647068eb4c5343488a6c604a8"}, ] netutils = [ - {file = "netutils-0.2.4-py3-none-any.whl", hash = "sha256:a6cd90fc446f00778ddc8e3538221f0e46e12b3c9d4b434d5cefa18807995d05"}, - {file = "netutils-0.2.4.tar.gz", hash = "sha256:362850aa5933a9df66f497f9074828f8651aed103d1c390dcb2868bcffc58679"}, + {file = "netutils-0.2.5-py3-none-any.whl", hash = "sha256:6715b0e1175051f5db7685bf057ede68c7dafc56cf705a1ca3896e24980b22ce"}, + {file = "netutils-0.2.5.tar.gz", hash = "sha256:bdfd8e454c4aeacf59c1537bfd434e1d944ce69032fed533f0171c2532c91751"}, ] packaging = [ - {file = "packaging-21.2-py3-none-any.whl", hash = "sha256:14317396d1e8cdb122989b916fa2c7e9ca8e2be9e8060a6eff75b6b7b4d8a7e0"}, - {file = "packaging-21.2.tar.gz", hash = "sha256:096d689d78ca690e4cd8a89568ba06d07ca097e3306a4381635073ca91479966"}, + {file = "packaging-21.3-py3-none-any.whl", hash = "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"}, + {file = "packaging-21.3.tar.gz", hash = "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb"}, ] parameterized = [ {file = "parameterized-0.8.1-py2.py3-none-any.whl", hash = "sha256:9cbb0b69a03e8695d68b3399a8a5825200976536fe1cb79db60ed6a4c8c9efe9"}, @@ -1235,8 +1245,8 @@ pathspec = [ {file = "pathspec-0.9.0.tar.gz", hash = "sha256:e564499435a2673d586f6b2130bb5b95f04a3ba06f81b8f895b651a3c76aabb1"}, ] pbr = [ - {file = "pbr-5.7.0-py2.py3-none-any.whl", hash = "sha256:60002958e459b195e8dbe61bf22bcf344eedf1b4e03a321a5414feb15566100c"}, - {file = "pbr-5.7.0.tar.gz", hash = "sha256:4651ca1445e80f2781827305de3d76b3ce53195f2227762684eb08f17bc473b7"}, + {file = "pbr-5.8.1-py2.py3-none-any.whl", hash = "sha256:27108648368782d07bbf1cb468ad2e2eeef29086affd14087a6d04b7de8af4ec"}, + {file = "pbr-5.8.1.tar.gz", hash = "sha256:66bc5a34912f408bb3925bf21231cb6f59206267b7f63f3503ef865c1a292e25"}, ] platformdirs = [ {file = "platformdirs-2.4.0-py3-none-any.whl", hash = "sha256:8868bbe3c3c80d42f20156f22e7131d2fb321f5bc86a2a345375c6481a67021d"}, @@ -1255,39 +1265,40 @@ pycparser = [ {file = "pycparser-2.21.tar.gz", hash = "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206"}, ] pygments = [ - {file = "Pygments-2.10.0-py3-none-any.whl", hash = "sha256:b8e67fe6af78f492b3c4b3e2970c0624cbf08beb1e493b2c99b9fa1b67a20380"}, - {file = "Pygments-2.10.0.tar.gz", hash = "sha256:f398865f7eb6874156579fdf36bc840a03cab64d1cde9e93d68f46a425ec52c6"}, + {file = "Pygments-2.11.2-py3-none-any.whl", hash = "sha256:44238f1b60a76d78fc8ca0528ee429702aae011c265fe6a8dd8b63049ae41c65"}, + {file = "Pygments-2.11.2.tar.gz", hash = "sha256:4e426f72023d88d03b2fa258de560726ce890ff3b630f88c21cbb8b2503b8c6a"}, ] pylint = [ - {file = "pylint-2.11.1-py3-none-any.whl", hash = "sha256:0f358e221c45cbd4dad2a1e4b883e75d28acdcccd29d40c76eb72b307269b126"}, - {file = "pylint-2.11.1.tar.gz", hash = "sha256:2c9843fff1a88ca0ad98a256806c82c5a8f86086e7ccbdb93297d86c3f90c436"}, + {file = "pylint-2.12.2-py3-none-any.whl", hash = "sha256:daabda3f7ed9d1c60f52d563b1b854632fd90035bcf01443e234d3dc794e3b74"}, + {file = "pylint-2.12.2.tar.gz", hash = "sha256:9d945a73640e1fec07ee34b42f5669b770c759acd536ec7b16d7e4b87a9c9ff9"}, ] pynautobot = [ - {file = "pynautobot-1.0.3-py3-none-any.whl", hash = "sha256:8ef66962ad8143ff2c9b01b1f66165f18d52302e97d18c32b47a9b67e0b7fe7c"}, - {file = "pynautobot-1.0.3.tar.gz", hash = "sha256:01fc6cf32e6ad520c7847d304dde356890960a4d95de48af6a1ce1f43fac6a65"}, + {file = "pynautobot-1.0.4-py3-none-any.whl", hash = "sha256:e30b667cd0e5df91c93453234dc5920b7633ed1c9dcce1bb9d507072c4ae23ed"}, + {file = "pynautobot-1.0.4.tar.gz", hash = "sha256:193b5989f42254eff71655623fa2255a8c97920f28faab14360566816e29d78a"}, ] pyparsing = [ - {file = "pyparsing-2.4.7-py2.py3-none-any.whl", hash = "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"}, - {file = "pyparsing-2.4.7.tar.gz", hash = "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1"}, + {file = "pyparsing-3.0.7-py3-none-any.whl", hash = "sha256:a6c06a88f252e6c322f65faf8f418b16213b51bdfaece0524c1c1bc30c63c484"}, + {file = "pyparsing-3.0.7.tar.gz", hash = "sha256:18ee9022775d270c55187733956460083db60b37d0d0fb357445f3094eed3eea"}, ] pytest = [ {file = "pytest-6.2.5-py3-none-any.whl", hash = "sha256:7310f8d27bc79ced999e760ca304d69f6ba6c6649c0b60fb0e04a4a77cacc134"}, {file = "pytest-6.2.5.tar.gz", hash = "sha256:131b36680866a76e6781d13f101efb86cf674ebb9762eb70d3082b6f29889e89"}, ] pytest-forked = [ - {file = "pytest-forked-1.3.0.tar.gz", hash = "sha256:6aa9ac7e00ad1a539c41bec6d21011332de671e938c7637378ec9710204e37ca"}, - {file = "pytest_forked-1.3.0-py2.py3-none-any.whl", hash = "sha256:dc4147784048e70ef5d437951728825a131b81714b398d5d52f17c7c144d8815"}, + {file = "pytest-forked-1.4.0.tar.gz", hash = "sha256:8b67587c8f98cbbadfdd804539ed5455b6ed03802203485dd2f53c1422d7440e"}, + {file = "pytest_forked-1.4.0-py3-none-any.whl", hash = "sha256:bbbb6717efc886b9d64537b41fb1497cfaf3c9601276be8da2cccfea5a3c8ad8"}, ] pytest-mock = [ {file = "pytest-mock-3.6.1.tar.gz", hash = "sha256:40217a058c52a63f1042f0784f62009e976ba824c418cced42e88d5f40ab0e62"}, {file = "pytest_mock-3.6.1-py3-none-any.whl", hash = "sha256:30c2f2cc9759e76eee674b81ea28c9f0b94f8f0445a1b87762cadf774f0df7e3"}, ] pytest-pythonpath = [ - {file = "pytest-pythonpath-0.7.3.tar.gz", hash = "sha256:63fc546ace7d2c845c1ee289e8f7a6362c2b6bae497d10c716e58e253e801d62"}, + {file = "pytest-pythonpath-0.7.4.tar.gz", hash = "sha256:64e195b23a8f8c0c631fb16882d9ad6fa4137ed1f2961ddd15d52065cd435db6"}, + {file = "pytest_pythonpath-0.7.4-py3-none-any.whl", hash = "sha256:e73e11dab2f0b83e73229e261242b251f0a369d7f527dbfec068822fd26a6ce5"}, ] pytest-xdist = [ - {file = "pytest-xdist-2.4.0.tar.gz", hash = "sha256:89b330316f7fc475f999c81b577c2b926c9569f3d397ae432c0c2e2496d61ff9"}, - {file = "pytest_xdist-2.4.0-py3-none-any.whl", hash = "sha256:7b61ebb46997a0820a263553179d6d1e25a8c50d8a8620cd1aa1e20e3be99168"}, + {file = "pytest-xdist-2.5.0.tar.gz", hash = "sha256:4580deca3ff04ddb2ac53eba39d76cb5dd5edeac050cb6fbc768b0dd712b4edf"}, + {file = "pytest_xdist-2.5.0-py3-none-any.whl", hash = "sha256:6fe5c74fec98906deb8f2d2b616b5c782022744978e7bd4695d39c8f42d0ce65"}, ] pytz = [ {file = "pytz-2021.3-py2.py3-none-any.whl", hash = "sha256:3672058bc3453457b622aab7a1c3bfd5ab0bdae451512f6cf25f64ed37f5b87c"}, @@ -1328,60 +1339,9 @@ pyyaml = [ {file = "PyYAML-6.0-cp39-cp39-win_amd64.whl", hash = "sha256:b3d267842bf12586ba6c734f89d1f5b871df0273157918b0ccefa29deb05c21c"}, {file = "PyYAML-6.0.tar.gz", hash = "sha256:68fb519c14306fec9720a2a5b45bc9f0c8d1b9c72adf45c37baedfcd949c35a2"}, ] -regex = [ - {file = "regex-2021.11.10-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:9345b6f7ee578bad8e475129ed40123d265464c4cfead6c261fd60fc9de00bcf"}, - {file = "regex-2021.11.10-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:416c5f1a188c91e3eb41e9c8787288e707f7d2ebe66e0a6563af280d9b68478f"}, - {file = "regex-2021.11.10-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e0538c43565ee6e703d3a7c3bdfe4037a5209250e8502c98f20fea6f5fdf2965"}, - {file = "regex-2021.11.10-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:7ee1227cf08b6716c85504aebc49ac827eb88fcc6e51564f010f11a406c0a667"}, - {file = "regex-2021.11.10-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6650f16365f1924d6014d2ea770bde8555b4a39dc9576abb95e3cd1ff0263b36"}, - {file = "regex-2021.11.10-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:30ab804ea73972049b7a2a5c62d97687d69b5a60a67adca07eb73a0ddbc9e29f"}, - {file = "regex-2021.11.10-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:68a067c11463de2a37157930d8b153005085e42bcb7ad9ca562d77ba7d1404e0"}, - {file = "regex-2021.11.10-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:162abfd74e88001d20cb73ceaffbfe601469923e875caf9118333b1a4aaafdc4"}, - {file = "regex-2021.11.10-cp310-cp310-win32.whl", hash = "sha256:98ba568e8ae26beb726aeea2273053c717641933836568c2a0278a84987b2a1a"}, - {file = "regex-2021.11.10-cp310-cp310-win_amd64.whl", hash = "sha256:780b48456a0f0ba4d390e8b5f7c661fdd218934388cde1a974010a965e200e12"}, - {file = "regex-2021.11.10-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:dba70f30fd81f8ce6d32ddeef37d91c8948e5d5a4c63242d16a2b2df8143aafc"}, - {file = "regex-2021.11.10-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e1f54b9b4b6c53369f40028d2dd07a8c374583417ee6ec0ea304e710a20f80a0"}, - {file = "regex-2021.11.10-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fbb9dc00e39f3e6c0ef48edee202f9520dafb233e8b51b06b8428cfcb92abd30"}, - {file = "regex-2021.11.10-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:666abff54e474d28ff42756d94544cdfd42e2ee97065857413b72e8a2d6a6345"}, - {file = "regex-2021.11.10-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5537f71b6d646f7f5f340562ec4c77b6e1c915f8baae822ea0b7e46c1f09b733"}, - {file = "regex-2021.11.10-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ed2e07c6a26ed4bea91b897ee2b0835c21716d9a469a96c3e878dc5f8c55bb23"}, - {file = "regex-2021.11.10-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ca5f18a75e1256ce07494e245cdb146f5a9267d3c702ebf9b65c7f8bd843431e"}, - {file = "regex-2021.11.10-cp36-cp36m-win32.whl", hash = "sha256:93a5051fcf5fad72de73b96f07d30bc29665697fb8ecdfbc474f3452c78adcf4"}, - {file = "regex-2021.11.10-cp36-cp36m-win_amd64.whl", hash = "sha256:b483c9d00a565633c87abd0aaf27eb5016de23fed952e054ecc19ce32f6a9e7e"}, - {file = "regex-2021.11.10-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:fff55f3ce50a3ff63ec8e2a8d3dd924f1941b250b0aac3d3d42b687eeff07a8e"}, - {file = "regex-2021.11.10-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e32d2a2b02ccbef10145df9135751abea1f9f076e67a4e261b05f24b94219e36"}, - {file = "regex-2021.11.10-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:53db2c6be8a2710b359bfd3d3aa17ba38f8aa72a82309a12ae99d3c0c3dcd74d"}, - {file = "regex-2021.11.10-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2207ae4f64ad3af399e2d30dde66f0b36ae5c3129b52885f1bffc2f05ec505c8"}, - {file = "regex-2021.11.10-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d5ca078bb666c4a9d1287a379fe617a6dccd18c3e8a7e6c7e1eb8974330c626a"}, - {file = "regex-2021.11.10-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dd33eb9bdcfbabab3459c9ee651d94c842bc8a05fabc95edf4ee0c15a072495e"}, - {file = "regex-2021.11.10-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:05b7d6d7e64efe309972adab77fc2af8907bb93217ec60aa9fe12a0dad35874f"}, - {file = "regex-2021.11.10-cp37-cp37m-win32.whl", hash = "sha256:e71255ba42567d34a13c03968736c5d39bb4a97ce98188fafb27ce981115beec"}, - {file = "regex-2021.11.10-cp37-cp37m-win_amd64.whl", hash = "sha256:07856afef5ffcc052e7eccf3213317fbb94e4a5cd8177a2caa69c980657b3cb4"}, - {file = "regex-2021.11.10-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:ba05430e819e58544e840a68b03b28b6d328aff2e41579037e8bab7653b37d83"}, - {file = "regex-2021.11.10-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:7f301b11b9d214f83ddaf689181051e7f48905568b0c7017c04c06dfd065e244"}, - {file = "regex-2021.11.10-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4aaa4e0705ef2b73dd8e36eeb4c868f80f8393f5f4d855e94025ce7ad8525f50"}, - {file = "regex-2021.11.10-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:788aef3549f1924d5c38263104dae7395bf020a42776d5ec5ea2b0d3d85d6646"}, - {file = "regex-2021.11.10-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f8af619e3be812a2059b212064ea7a640aff0568d972cd1b9e920837469eb3cb"}, - {file = "regex-2021.11.10-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:85bfa6a5413be0ee6c5c4a663668a2cad2cbecdee367630d097d7823041bdeec"}, - {file = "regex-2021.11.10-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f23222527b307970e383433daec128d769ff778d9b29343fb3496472dc20dabe"}, - {file = "regex-2021.11.10-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:da1a90c1ddb7531b1d5ff1e171b4ee61f6345119be7351104b67ff413843fe94"}, - {file = "regex-2021.11.10-cp38-cp38-win32.whl", hash = "sha256:0617383e2fe465732af4509e61648b77cbe3aee68b6ac8c0b6fe934db90be5cc"}, - {file = "regex-2021.11.10-cp38-cp38-win_amd64.whl", hash = "sha256:a3feefd5e95871872673b08636f96b61ebef62971eab044f5124fb4dea39919d"}, - {file = "regex-2021.11.10-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:f7f325be2804246a75a4f45c72d4ce80d2443ab815063cdf70ee8fb2ca59ee1b"}, - {file = "regex-2021.11.10-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:537ca6a3586931b16a85ac38c08cc48f10fc870a5b25e51794c74df843e9966d"}, - {file = "regex-2021.11.10-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:eef2afb0fd1747f33f1ee3e209bce1ed582d1896b240ccc5e2697e3275f037c7"}, - {file = "regex-2021.11.10-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:432bd15d40ed835a51617521d60d0125867f7b88acf653e4ed994a1f8e4995dc"}, - {file = "regex-2021.11.10-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b43c2b8a330a490daaef5a47ab114935002b13b3f9dc5da56d5322ff218eeadb"}, - {file = "regex-2021.11.10-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:962b9a917dd7ceacbe5cd424556914cb0d636001e393b43dc886ba31d2a1e449"}, - {file = "regex-2021.11.10-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fa8c626d6441e2d04b6ee703ef2d1e17608ad44c7cb75258c09dd42bacdfc64b"}, - {file = "regex-2021.11.10-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:3c5fb32cc6077abad3bbf0323067636d93307c9fa93e072771cf9a64d1c0f3ef"}, - {file = "regex-2021.11.10-cp39-cp39-win32.whl", hash = "sha256:3b5df18db1fccd66de15aa59c41e4f853b5df7550723d26aa6cb7f40e5d9da5a"}, - {file = "regex-2021.11.10-cp39-cp39-win_amd64.whl", hash = "sha256:83ee89483672b11f8952b158640d0c0ff02dc43d9cb1b70c1564b49abe92ce29"}, - {file = "regex-2021.11.10.tar.gz", hash = "sha256:f341ee2df0999bfdf7a95e448075effe0db212a59387de1a70690e4acb03d4c6"}, -] requests = [ - {file = "requests-2.26.0-py2.py3-none-any.whl", hash = "sha256:6c1246513ecd5ecd4528a0906f910e8f0f9c6b8ec72030dc9fd154dc1a6efd24"}, - {file = "requests-2.26.0.tar.gz", hash = "sha256:b8aa58f8cf793ffd8782d3d8cb19e66ef36f7aba4353eec859e74678b01b07a7"}, + {file = "requests-2.27.1-py2.py3-none-any.whl", hash = "sha256:f22fa1e554c9ddfd16e6e41ac79759e17be9e492b3587efa038054674760e72d"}, + {file = "requests-2.27.1.tar.gz", hash = "sha256:68d7c56fd5a8999887728ef304a6d12edc7be74f1cfa47714fc8b414525c9a61"}, ] smmap = [ {file = "smmap-5.0.0-py3-none-any.whl", hash = "sha256:2aba19d6a040e78d8b09de5c57e96207b09ed71d8e55ce0959eeee6c8e190d94"}, @@ -1396,12 +1356,12 @@ sortedcontainers = [ {file = "sortedcontainers-2.4.0.tar.gz", hash = "sha256:25caa5a06cc30b6b83d11423433f65d1f9d76c4c6a0c90e3379eaa43b9bfdb88"}, ] sphinx = [ - {file = "Sphinx-3.5.3-py3-none-any.whl", hash = "sha256:3f01732296465648da43dec8fb40dc451ba79eb3e2cc5c6d79005fd98197107d"}, - {file = "Sphinx-3.5.3.tar.gz", hash = "sha256:ce9c228456131bab09a3d7d10ae58474de562a6f79abb3dc811ae401cf8c1abc"}, + {file = "Sphinx-4.3.2-py3-none-any.whl", hash = "sha256:6a11ea5dd0bdb197f9c2abc2e0ce73e01340464feaece525e64036546d24c851"}, + {file = "Sphinx-4.3.2.tar.gz", hash = "sha256:0a8836751a68306b3fe97ecbe44db786f8479c3bf4b80e3a7f5c838657b4698c"}, ] sphinx-rtd-theme = [ - {file = "sphinx_rtd_theme-0.5.1-py2.py3-none-any.whl", hash = "sha256:fa6bebd5ab9a73da8e102509a86f3fcc36dec04a0b52ea80e5a033b2aba00113"}, - {file = "sphinx_rtd_theme-0.5.1.tar.gz", hash = "sha256:eda689eda0c7301a80cf122dad28b1861e5605cbf455558f3775e1e8200e83a5"}, + {file = "sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl", hash = "sha256:4d35a56f4508cfee4c4fb604373ede6feae2a306731d533f409ef5c3496fdbd8"}, + {file = "sphinx_rtd_theme-1.0.0.tar.gz", hash = "sha256:eec6d497e4c2195fa0e8b2016b337532b8a699a68bcb22a512870e16925c6a5c"}, ] sphinxcontrib-applehelp = [ {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"}, @@ -1436,37 +1396,42 @@ toml = [ {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"}, ] tomli = [ - {file = "tomli-1.2.2-py3-none-any.whl", hash = "sha256:f04066f68f5554911363063a30b108d2b5a5b1a010aa8b6132af78489fe3aade"}, - {file = "tomli-1.2.2.tar.gz", hash = "sha256:c6ce0015eb38820eaf32b5db832dbc26deb3dd427bd5f6556cf0acac2c214fee"}, + {file = "tomli-1.2.3-py3-none-any.whl", hash = "sha256:e3069e4be3ead9668e21cb9b074cd948f7b3113fd9c8bba083f48247aab8b11c"}, + {file = "tomli-1.2.3.tar.gz", hash = "sha256:05b6166bff487dc068d322585c7ea4ef78deed501cc124060e0f238e89a9231f"}, ] typed-ast = [ - {file = "typed_ast-1.5.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7b310a207ee9fde3f46ba327989e6cba4195bc0c8c70a158456e7b10233e6bed"}, - {file = "typed_ast-1.5.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:52ca2b2b524d770bed7a393371a38e91943f9160a190141e0df911586066ecda"}, - {file = "typed_ast-1.5.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:14fed8820114a389a2b7e91624db5f85f3f6682fda09fe0268a59aabd28fe5f5"}, - {file = "typed_ast-1.5.0-cp310-cp310-win_amd64.whl", hash = "sha256:65c81abbabda7d760df7304d843cc9dbe7ef5d485504ca59a46ae2d1731d2428"}, - {file = "typed_ast-1.5.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:37ba2ab65a0028b1a4f2b61a8fe77f12d242731977d274a03d68ebb751271508"}, - {file = "typed_ast-1.5.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:49af5b8f6f03ed1eb89ee06c1d7c2e7c8e743d720c3746a5857609a1abc94c94"}, - {file = "typed_ast-1.5.0-cp36-cp36m-win_amd64.whl", hash = "sha256:e4374a76e61399a173137e7984a1d7e356038cf844f24fd8aea46c8029a2f712"}, - {file = "typed_ast-1.5.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:ea517c2bb11c5e4ba7a83a91482a2837041181d57d3ed0749a6c382a2b6b7086"}, - {file = "typed_ast-1.5.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:51040bf45aacefa44fa67fb9ebcd1f2bec73182b99a532c2394eea7dabd18e24"}, - {file = "typed_ast-1.5.0-cp37-cp37m-win_amd64.whl", hash = "sha256:806e0c7346b9b4af8c62d9a29053f484599921a4448c37fbbcbbf15c25138570"}, - {file = "typed_ast-1.5.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:a67fd5914603e2165e075f1b12f5a8356bfb9557e8bfb74511108cfbab0f51ed"}, - {file = "typed_ast-1.5.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:224afecb8b39739f5c9562794a7c98325cb9d972712e1a98b6989a4720219541"}, - {file = "typed_ast-1.5.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:155b74b078be842d2eb630dd30a280025eca0a5383c7d45853c27afee65f278f"}, - {file = "typed_ast-1.5.0-cp38-cp38-win_amd64.whl", hash = "sha256:361b9e5d27bd8e3ccb6ea6ad6c4f3c0be322a1a0f8177db6d56264fa0ae40410"}, - {file = "typed_ast-1.5.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:618912cbc7e17b4aeba86ffe071698c6e2d292acbd6d1d5ec1ee724b8c4ae450"}, - {file = "typed_ast-1.5.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7e6731044f748340ef68dcadb5172a4b1f40847a2983fe3983b2a66445fbc8e6"}, - {file = "typed_ast-1.5.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:e8a9b9c87801cecaad3b4c2b8876387115d1a14caa602c1618cedbb0cb2a14e6"}, - {file = "typed_ast-1.5.0-cp39-cp39-win_amd64.whl", hash = "sha256:ec184dfb5d3d11e82841dbb973e7092b75f306b625fad7b2e665b64c5d60ab3f"}, - {file = "typed_ast-1.5.0.tar.gz", hash = "sha256:ff4ad88271aa7a55f19b6a161ed44e088c393846d954729549e3cde8257747bb"}, + {file = "typed_ast-1.5.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:183b183b7771a508395d2cbffd6db67d6ad52958a5fdc99f450d954003900266"}, + {file = "typed_ast-1.5.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:676d051b1da67a852c0447621fdd11c4e104827417bf216092ec3e286f7da596"}, + {file = "typed_ast-1.5.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bc2542e83ac8399752bc16e0b35e038bdb659ba237f4222616b4e83fb9654985"}, + {file = "typed_ast-1.5.2-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:74cac86cc586db8dfda0ce65d8bcd2bf17b58668dfcc3652762f3ef0e6677e76"}, + {file = "typed_ast-1.5.2-cp310-cp310-win_amd64.whl", hash = "sha256:18fe320f354d6f9ad3147859b6e16649a0781425268c4dde596093177660e71a"}, + {file = "typed_ast-1.5.2-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:31d8c6b2df19a777bc8826770b872a45a1f30cfefcfd729491baa5237faae837"}, + {file = "typed_ast-1.5.2-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:963a0ccc9a4188524e6e6d39b12c9ca24cc2d45a71cfdd04a26d883c922b4b78"}, + {file = "typed_ast-1.5.2-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:0eb77764ea470f14fcbb89d51bc6bbf5e7623446ac4ed06cbd9ca9495b62e36e"}, + {file = "typed_ast-1.5.2-cp36-cp36m-win_amd64.whl", hash = "sha256:294a6903a4d087db805a7656989f613371915fc45c8cc0ddc5c5a0a8ad9bea4d"}, + {file = "typed_ast-1.5.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:26a432dc219c6b6f38be20a958cbe1abffcc5492821d7e27f08606ef99e0dffd"}, + {file = "typed_ast-1.5.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c7407cfcad702f0b6c0e0f3e7ab876cd1d2c13b14ce770e412c0c4b9728a0f88"}, + {file = "typed_ast-1.5.2-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:f30ddd110634c2d7534b2d4e0e22967e88366b0d356b24de87419cc4410c41b7"}, + {file = "typed_ast-1.5.2-cp37-cp37m-win_amd64.whl", hash = "sha256:8c08d6625bb258179b6e512f55ad20f9dfef019bbfbe3095247401e053a3ea30"}, + {file = "typed_ast-1.5.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:90904d889ab8e81a956f2c0935a523cc4e077c7847a836abee832f868d5c26a4"}, + {file = "typed_ast-1.5.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:bbebc31bf11762b63bf61aaae232becb41c5bf6b3461b80a4df7e791fabb3aca"}, + {file = "typed_ast-1.5.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c29dd9a3a9d259c9fa19d19738d021632d673f6ed9b35a739f48e5f807f264fb"}, + {file = "typed_ast-1.5.2-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:58ae097a325e9bb7a684572d20eb3e1809802c5c9ec7108e85da1eb6c1a3331b"}, + {file = "typed_ast-1.5.2-cp38-cp38-win_amd64.whl", hash = "sha256:da0a98d458010bf4fe535f2d1e367a2e2060e105978873c04c04212fb20543f7"}, + {file = "typed_ast-1.5.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:33b4a19ddc9fc551ebabca9765d54d04600c4a50eda13893dadf67ed81d9a098"}, + {file = "typed_ast-1.5.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:1098df9a0592dd4c8c0ccfc2e98931278a6c6c53cb3a3e2cf7e9ee3b06153344"}, + {file = "typed_ast-1.5.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42c47c3b43fe3a39ddf8de1d40dbbfca60ac8530a36c9b198ea5b9efac75c09e"}, + {file = "typed_ast-1.5.2-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:f290617f74a610849bd8f5514e34ae3d09eafd521dceaa6cf68b3f4414266d4e"}, + {file = "typed_ast-1.5.2-cp39-cp39-win_amd64.whl", hash = "sha256:df05aa5b241e2e8045f5f4367a9f6187b09c4cdf8578bb219861c4e27c443db5"}, + {file = "typed_ast-1.5.2.tar.gz", hash = "sha256:525a2d4088e70a9f75b08b3f87a51acc9cde640e19cc523c7e41aa355564ae27"}, ] typing-extensions = [ - {file = "typing_extensions-4.0.0-py3-none-any.whl", hash = "sha256:829704698b22e13ec9eaf959122315eabb370b0884400e9818334d8b677023d9"}, - {file = "typing_extensions-4.0.0.tar.gz", hash = "sha256:2cdf80e4e04866a9b3689a51869016d36db0814d84b8d8a568d22781d45d27ed"}, + {file = "typing_extensions-4.1.1-py3-none-any.whl", hash = "sha256:21c85e0fe4b9a155d0799430b0ad741cdce7e359660ccbd8b530613e8df88ce2"}, + {file = "typing_extensions-4.1.1.tar.gz", hash = "sha256:1a9462dcc3347a79b1f1c0271fbe79e844580bb598bafa1ed208b94da3cdcd42"}, ] urllib3 = [ - {file = "urllib3-1.26.7-py2.py3-none-any.whl", hash = "sha256:c4fdf4019605b6e5423637e01bc9fe4daef873709a7973e195ceba0a62bbc844"}, - {file = "urllib3-1.26.7.tar.gz", hash = "sha256:4987c65554f7a2dbf30c18fd48778ef124af6fab771a377103da0585e2336ece"}, + {file = "urllib3-1.26.8-py2.py3-none-any.whl", hash = "sha256:000ca7f471a233c2251c6c7023ee85305721bfdf18621ebff4fd17a8653427ed"}, + {file = "urllib3-1.26.8.tar.gz", hash = "sha256:0e7c33d9a63e7ddfcb86780aac87befc2fbddf46c58dbb487e0855f7ceec283c"}, ] wrapt = [ {file = "wrapt-1.13.3-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:e05e60ff3b2b0342153be4d1b597bbcfd8330890056b9619f4ad6b8d5c96a81a"},