diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fccb40655..03a827362 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -76,12 +76,12 @@ jobs: fail-fast: false matrix: include: - - VERSION: "v3.4" - NETBOX_DOCKER_VERSION: 2.5.3 - VERSION: "v3.5" NETBOX_DOCKER_VERSION: 2.6.1 - VERSION: "v3.6" NETBOX_DOCKER_VERSION: 2.7.0 + - VERSION: "v3.7" + NETBOX_DOCKER_VERSION: 2.7.0 # If we want to integration test wiht all supported Python: #python-version: ["3.9", "3.10", "3.11"] diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 81628bf23..f215a59a2 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,28 @@ NetBox.NetBox Release Notes .. contents:: Topics +v3.17.0 +======= + +Minor Changes +------------- + +- CI - CI adjustments [#1154](https://github.com/netbox-community/ansible_modules/pull/1154) [#1155](https://github.com/netbox-community/ansible_modules/pull/1155) [#1157](https://github.com/netbox-community/ansible_modules/pull/1157) +- nb_lookup - Add new VPN endpoints for NetBox 3.7 support [#1162](https://github.com/netbox-community/ansible_modules/pull/1162) +- netbox_rack_role - Add description option [#1143](https://github.com/netbox-community/ansible_modules/pull/1143) +- netbox_virtual_disk - New module [#1153](https://github.com/netbox-community/ansible_modules/pull/1153) +- netbox_virtual_machine and netbox_device - Add option config_template [#1171](https://github.com/netbox-community/ansible_modules/pull/1171) + +Bugfixes +-------- + +- netbox_vlan - Fix documentation of vlan_group [#1138](https://github.com/netbox-community/ansible_modules/pull/1138) + +New Modules +----------- + +- netbox.netbox.netbox_virtual_disk - Create, updates, or removes a disk from a Virtual Machine + v3.16.0 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 37b46d8b1..f113070a6 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -843,3 +843,18 @@ releases: - nb_inventory - Enable ansible-vault strings in config-context data [#1114](https://github.com/netbox-community/ansible_modules/pull/1114) - netbox_platform - Add config_template option to netbox_platform [#1119](https://github.com/netbox-community/ansible_modules/pull/1119) release_date: '2023-12-10' + 3.17.0: + changes: + bugfixes: + - netbox_vlan - Fix documentation of vlan_group [#1138](https://github.com/netbox-community/ansible_modules/pull/1138) + minor_changes: + - nb_lookup - Add new VPN endpoints for NetBox 3.7 support [#1162](https://github.com/netbox-community/ansible_modules/pull/1162) + - netbox_rack_role - Add description option [#1143](https://github.com/netbox-community/ansible_modules/pull/1143) + - netbox_virtual_disk - New module [#1153](https://github.com/netbox-community/ansible_modules/pull/1153) + - CI - CI adjustments [#1154](https://github.com/netbox-community/ansible_modules/pull/1154) [#1155](https://github.com/netbox-community/ansible_modules/pull/1155) [#1157](https://github.com/netbox-community/ansible_modules/pull/1157) + - netbox_virtual_machine and netbox_device - Add option config_template [#1171](https://github.com/netbox-community/ansible_modules/pull/1171) + modules: + - description: Create, updates, or removes a disk from a Virtual Machine + name: netbox_virtual_disk + namespace: '' + release_date: '2024-02-14' diff --git a/docs/conf.py b/docs/conf.py index 936198818..cc5034ae0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,7 @@ author = "Mikhail Yohman <@FragmentedPacket>" # The full version, including alpha/beta/rc tags -release = "3.16.0" +release = "3.17.0" # -- General configuration --------------------------------------------------- diff --git a/docs/plugins/environment_variables.rst b/docs/plugins/environment_variables.rst index b1213b91f..da663dd63 100644 --- a/docs/plugins/environment_variables.rst +++ b/docs/plugins/environment_variables.rst @@ -1,6 +1,9 @@ :orphan: +.. meta:: + :antsibull-docs: 2.7.0 + .. _list_of_collection_env_vars: Index of all Collection Environment Variables @@ -14,14 +17,14 @@ Environment variables used by the ansible-core configuration are documented in : Merge extra vars into the available variables for composition (highest precedence). *Used by:* - :ref:`netbox.netbox.nb\_inventory inventory plugin ` + :ansplugin:`netbox.netbox.nb\_inventory inventory plugin ` .. envvar:: NETBOX_API See the documentations for the options where this environment variable is used. *Used by:* - :ref:`netbox.netbox.nb\_inventory inventory plugin `, - :ref:`netbox.netbox.nb\_lookup lookup plugin ` + :ansplugin:`netbox.netbox.nb\_inventory inventory plugin `, + :ansplugin:`netbox.netbox.nb\_lookup lookup plugin ` .. envvar:: NETBOX_API_KEY NetBox API token to be able to read against NetBox. @@ -33,7 +36,7 @@ Environment variables used by the ansible-core configuration are documented in : If you do not provide a "type" and "value" parameter, the HTTP authorization header will be set to "Token", which is the NetBox default *Used by:* - :ref:`netbox.netbox.nb\_inventory inventory plugin ` + :ansplugin:`netbox.netbox.nb\_inventory inventory plugin ` .. envvar:: NETBOX_API_TOKEN The API token created through NetBox @@ -41,17 +44,17 @@ Environment variables used by the ansible-core configuration are documented in : This may not be required depending on the NetBox setup. *Used by:* - :ref:`netbox.netbox.nb\_lookup lookup plugin ` + :ansplugin:`netbox.netbox.nb\_lookup lookup plugin ` .. envvar:: NETBOX_TOKEN See the documentations for the options where this environment variable is used. *Used by:* - :ref:`netbox.netbox.nb\_inventory inventory plugin `, - :ref:`netbox.netbox.nb\_lookup lookup plugin ` + :ansplugin:`netbox.netbox.nb\_inventory inventory plugin `, + :ansplugin:`netbox.netbox.nb\_lookup lookup plugin ` .. envvar:: NETBOX_URL The URL to the NetBox instance to query *Used by:* - :ref:`netbox.netbox.nb\_lookup lookup plugin ` + :ansplugin:`netbox.netbox.nb\_lookup lookup plugin ` diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index c1fccd9b6..caf18e175 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,12 +1,15 @@ +.. meta:: + :antsibull-docs: 2.7.0 + .. _plugins_in_netbox.netbox: Netbox.Netbox ============= -Collection version 3.16.0 +Collection version 3.17.0 .. contents:: :local: @@ -26,12 +29,15 @@ This is a collection of NetBox Ansible modules * 2.9.10 or newer -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

@@ -48,83 +54,84 @@ These are the plugins in the netbox.netbox collection: Modules ~~~~~~~ -* :ref:`netbox_aggregate module ` -- Creates or removes aggregates from NetBox -* :ref:`netbox_asn module ` -- Create, update or delete ASNs within NetBox -* :ref:`netbox_cable module ` -- Create, update or delete cables within NetBox -* :ref:`netbox_circuit module ` -- Create, update or delete circuits within NetBox -* :ref:`netbox_circuit_termination module ` -- Create, update or delete circuit terminations within NetBox -* :ref:`netbox_circuit_type module ` -- Create, update or delete circuit types within NetBox -* :ref:`netbox_cluster module ` -- Create, update or delete clusters within NetBox -* :ref:`netbox_cluster_group module ` -- Create, update or delete cluster groups within NetBox -* :ref:`netbox_cluster_type module ` -- Create, update or delete cluster types within NetBox -* :ref:`netbox_config_context module ` -- Creates, updates or deletes configuration contexts within NetBox -* :ref:`netbox_config_template module ` -- Creates or removes config templates from NetBox -* :ref:`netbox_console_port module ` -- Create, update or delete console ports within NetBox -* :ref:`netbox_console_port_template module ` -- Create, update or delete console port templates within NetBox -* :ref:`netbox_console_server_port module ` -- Create, update or delete console server ports within NetBox -* :ref:`netbox_console_server_port_template module ` -- Create, update or delete console server port templates within NetBox -* :ref:`netbox_contact module ` -- Creates or removes contacts from NetBox -* :ref:`netbox_contact_group module ` -- Creates or removes contact groups from NetBox -* :ref:`netbox_contact_role module ` -- Creates or removes contact roles from NetBox -* :ref:`netbox_custom_field module ` -- Creates, updates or deletes custom fields within NetBox -* :ref:`netbox_custom_link module ` -- Creates, updates or deletes custom links within NetBox -* :ref:`netbox_device module ` -- Create, update or delete devices within NetBox -* :ref:`netbox_device_bay module ` -- Create, update or delete device bays within NetBox -* :ref:`netbox_device_bay_template module ` -- Create, update or delete device bay templates within NetBox -* :ref:`netbox_device_interface module ` -- Creates or removes interfaces on devices from NetBox -* :ref:`netbox_device_interface_template module ` -- Creates or removes interfaces on devices from NetBox -* :ref:`netbox_device_role module ` -- Create, update or delete devices roles within NetBox -* :ref:`netbox_device_type module ` -- Create, update or delete device types within NetBox -* :ref:`netbox_export_template module ` -- Creates, updates or deletes export templates within NetBox -* :ref:`netbox_fhrp_group module ` -- Create, update or delete FHRP groups within NetBox -* :ref:`netbox_fhrp_group_assignment module ` -- Create, update or delete FHRP group assignments within NetBox -* :ref:`netbox_front_port module ` -- Create, update or delete front ports within NetBox -* :ref:`netbox_front_port_template module ` -- Create, update or delete front port templates within NetBox -* :ref:`netbox_inventory_item module ` -- Creates or removes inventory items from NetBox -* :ref:`netbox_inventory_item_role module ` -- Create, update or delete devices roles within NetBox -* :ref:`netbox_ip_address module ` -- Creates or removes IP addresses from NetBox -* :ref:`netbox_ipam_role module ` -- Creates or removes ipam roles from NetBox -* :ref:`netbox_journal_entry module ` -- Creates a journal entry -* :ref:`netbox_l2vpn module ` -- Create, update or delete L2VPNs within NetBox -* :ref:`netbox_l2vpn_termination module ` -- Create, update or delete L2VPNs terminations within NetBox -* :ref:`netbox_location module ` -- Create, update or delete locations within NetBox -* :ref:`netbox_manufacturer module ` -- Create or delete manufacturers within NetBox -* :ref:`netbox_module_type module ` -- Create, update or delete module types within NetBox -* :ref:`netbox_platform module ` -- Create or delete platforms within NetBox -* :ref:`netbox_power_feed module ` -- Create, update or delete power feeds within NetBox -* :ref:`netbox_power_outlet module ` -- Create, update or delete power outlets within NetBox -* :ref:`netbox_power_outlet_template module ` -- Create, update or delete power outlet templates within NetBox -* :ref:`netbox_power_panel module ` -- Create, update or delete power panels within NetBox -* :ref:`netbox_power_port module ` -- Create, update or delete power ports within NetBox -* :ref:`netbox_power_port_template module ` -- Create, update or delete power port templates within NetBox -* :ref:`netbox_prefix module ` -- Creates or removes prefixes from NetBox -* :ref:`netbox_provider module ` -- Create, update or delete providers within NetBox -* :ref:`netbox_provider_network module ` -- Create, update or delete provider networks within NetBox -* :ref:`netbox_rack module ` -- Create, update or delete racks within NetBox -* :ref:`netbox_rack_group module ` -- Create, update or delete racks groups within NetBox -* :ref:`netbox_rack_role module ` -- Create, update or delete racks roles within NetBox -* :ref:`netbox_rear_port module ` -- Create, update or delete rear ports within NetBox -* :ref:`netbox_rear_port_template module ` -- Create, update or delete rear port templates within NetBox -* :ref:`netbox_region module ` -- Creates or removes regions from NetBox -* :ref:`netbox_rir module ` -- Create, update or delete RIRs within NetBox -* :ref:`netbox_route_target module ` -- Creates or removes route targets from NetBox -* :ref:`netbox_service module ` -- Creates or removes service from NetBox -* :ref:`netbox_service_template module ` -- Create, update or delete service templates within NetBox -* :ref:`netbox_site module ` -- Creates or removes sites from NetBox -* :ref:`netbox_site_group module ` -- Create, update, or delete site groups within NetBox -* :ref:`netbox_tag module ` -- Creates or removes tags from NetBox -* :ref:`netbox_tenant module ` -- Creates or removes tenants from NetBox -* :ref:`netbox_tenant_group module ` -- Creates or removes tenant groups from NetBox -* :ref:`netbox_virtual_chassis module ` -- Create, update or delete virtual chassis within NetBox -* :ref:`netbox_virtual_machine module ` -- Create, update or delete virtual\_machines within NetBox -* :ref:`netbox_vlan module ` -- Create, update or delete vlans within NetBox -* :ref:`netbox_vlan_group module ` -- Create, update or delete vlans groups within NetBox -* :ref:`netbox_vm_interface module ` -- Creates or removes interfaces from virtual machines in NetBox -* :ref:`netbox_vrf module ` -- Create, update or delete vrfs within NetBox -* :ref:`netbox_webhook module ` -- Creates, updates or deletes webhook configuration within NetBox -* :ref:`netbox_wireless_lan module ` -- Creates or removes Wireless LANs from NetBox -* :ref:`netbox_wireless_lan_group module ` -- Creates or removes Wireless LAN Groups from NetBox -* :ref:`netbox_wireless_link module ` -- Creates or removes Wireless links from NetBox +* :ansplugin:`netbox_aggregate module ` -- Creates or removes aggregates from NetBox +* :ansplugin:`netbox_asn module ` -- Create, update or delete ASNs within NetBox +* :ansplugin:`netbox_cable module ` -- Create, update or delete cables within NetBox +* :ansplugin:`netbox_circuit module ` -- Create, update or delete circuits within NetBox +* :ansplugin:`netbox_circuit_termination module ` -- Create, update or delete circuit terminations within NetBox +* :ansplugin:`netbox_circuit_type module ` -- Create, update or delete circuit types within NetBox +* :ansplugin:`netbox_cluster module ` -- Create, update or delete clusters within NetBox +* :ansplugin:`netbox_cluster_group module ` -- Create, update or delete cluster groups within NetBox +* :ansplugin:`netbox_cluster_type module ` -- Create, update or delete cluster types within NetBox +* :ansplugin:`netbox_config_context module ` -- Creates, updates or deletes configuration contexts within NetBox +* :ansplugin:`netbox_config_template module ` -- Creates or removes config templates from NetBox +* :ansplugin:`netbox_console_port module ` -- Create, update or delete console ports within NetBox +* :ansplugin:`netbox_console_port_template module ` -- Create, update or delete console port templates within NetBox +* :ansplugin:`netbox_console_server_port module ` -- Create, update or delete console server ports within NetBox +* :ansplugin:`netbox_console_server_port_template module ` -- Create, update or delete console server port templates within NetBox +* :ansplugin:`netbox_contact module ` -- Creates or removes contacts from NetBox +* :ansplugin:`netbox_contact_group module ` -- Creates or removes contact groups from NetBox +* :ansplugin:`netbox_contact_role module ` -- Creates or removes contact roles from NetBox +* :ansplugin:`netbox_custom_field module ` -- Creates, updates or deletes custom fields within NetBox +* :ansplugin:`netbox_custom_link module ` -- Creates, updates or deletes custom links within NetBox +* :ansplugin:`netbox_device module ` -- Create, update or delete devices within NetBox +* :ansplugin:`netbox_device_bay module ` -- Create, update or delete device bays within NetBox +* :ansplugin:`netbox_device_bay_template module ` -- Create, update or delete device bay templates within NetBox +* :ansplugin:`netbox_device_interface module ` -- Creates or removes interfaces on devices from NetBox +* :ansplugin:`netbox_device_interface_template module ` -- Creates or removes interfaces on devices from NetBox +* :ansplugin:`netbox_device_role module ` -- Create, update or delete devices roles within NetBox +* :ansplugin:`netbox_device_type module ` -- Create, update or delete device types within NetBox +* :ansplugin:`netbox_export_template module ` -- Creates, updates or deletes export templates within NetBox +* :ansplugin:`netbox_fhrp_group module ` -- Create, update or delete FHRP groups within NetBox +* :ansplugin:`netbox_fhrp_group_assignment module ` -- Create, update or delete FHRP group assignments within NetBox +* :ansplugin:`netbox_front_port module ` -- Create, update or delete front ports within NetBox +* :ansplugin:`netbox_front_port_template module ` -- Create, update or delete front port templates within NetBox +* :ansplugin:`netbox_inventory_item module ` -- Creates or removes inventory items from NetBox +* :ansplugin:`netbox_inventory_item_role module ` -- Create, update or delete devices roles within NetBox +* :ansplugin:`netbox_ip_address module ` -- Creates or removes IP addresses from NetBox +* :ansplugin:`netbox_ipam_role module ` -- Creates or removes ipam roles from NetBox +* :ansplugin:`netbox_journal_entry module ` -- Creates a journal entry +* :ansplugin:`netbox_l2vpn module ` -- Create, update or delete L2VPNs within NetBox +* :ansplugin:`netbox_l2vpn_termination module ` -- Create, update or delete L2VPNs terminations within NetBox +* :ansplugin:`netbox_location module ` -- Create, update or delete locations within NetBox +* :ansplugin:`netbox_manufacturer module ` -- Create or delete manufacturers within NetBox +* :ansplugin:`netbox_module_type module ` -- Create, update or delete module types within NetBox +* :ansplugin:`netbox_platform module ` -- Create or delete platforms within NetBox +* :ansplugin:`netbox_power_feed module ` -- Create, update or delete power feeds within NetBox +* :ansplugin:`netbox_power_outlet module ` -- Create, update or delete power outlets within NetBox +* :ansplugin:`netbox_power_outlet_template module ` -- Create, update or delete power outlet templates within NetBox +* :ansplugin:`netbox_power_panel module ` -- Create, update or delete power panels within NetBox +* :ansplugin:`netbox_power_port module ` -- Create, update or delete power ports within NetBox +* :ansplugin:`netbox_power_port_template module ` -- Create, update or delete power port templates within NetBox +* :ansplugin:`netbox_prefix module ` -- Creates or removes prefixes from NetBox +* :ansplugin:`netbox_provider module ` -- Create, update or delete providers within NetBox +* :ansplugin:`netbox_provider_network module ` -- Create, update or delete provider networks within NetBox +* :ansplugin:`netbox_rack module ` -- Create, update or delete racks within NetBox +* :ansplugin:`netbox_rack_group module ` -- Create, update or delete racks groups within NetBox +* :ansplugin:`netbox_rack_role module ` -- Create, update or delete racks roles within NetBox +* :ansplugin:`netbox_rear_port module ` -- Create, update or delete rear ports within NetBox +* :ansplugin:`netbox_rear_port_template module ` -- Create, update or delete rear port templates within NetBox +* :ansplugin:`netbox_region module ` -- Creates or removes regions from NetBox +* :ansplugin:`netbox_rir module ` -- Create, update or delete RIRs within NetBox +* :ansplugin:`netbox_route_target module ` -- Creates or removes route targets from NetBox +* :ansplugin:`netbox_service module ` -- Creates or removes service from NetBox +* :ansplugin:`netbox_service_template module ` -- Create, update or delete service templates within NetBox +* :ansplugin:`netbox_site module ` -- Creates or removes sites from NetBox +* :ansplugin:`netbox_site_group module ` -- Create, update, or delete site groups within NetBox +* :ansplugin:`netbox_tag module ` -- Creates or removes tags from NetBox +* :ansplugin:`netbox_tenant module ` -- Creates or removes tenants from NetBox +* :ansplugin:`netbox_tenant_group module ` -- Creates or removes tenant groups from NetBox +* :ansplugin:`netbox_virtual_chassis module ` -- Create, update or delete virtual chassis within NetBox +* :ansplugin:`netbox_virtual_disk module ` -- Creates or removes disks from virtual machines in NetBox +* :ansplugin:`netbox_virtual_machine module ` -- Create, update or delete virtual\_machines within NetBox +* :ansplugin:`netbox_vlan module ` -- Create, update or delete vlans within NetBox +* :ansplugin:`netbox_vlan_group module ` -- Create, update or delete vlans groups within NetBox +* :ansplugin:`netbox_vm_interface module ` -- Creates or removes interfaces from virtual machines in NetBox +* :ansplugin:`netbox_vrf module ` -- Create, update or delete vrfs within NetBox +* :ansplugin:`netbox_webhook module ` -- Creates, updates or deletes webhook configuration within NetBox +* :ansplugin:`netbox_wireless_lan module ` -- Creates or removes Wireless LANs from NetBox +* :ansplugin:`netbox_wireless_lan_group module ` -- Creates or removes Wireless LAN Groups from NetBox +* :ansplugin:`netbox_wireless_link module ` -- Creates or removes Wireless links from NetBox .. toctree:: :maxdepth: 1 @@ -198,6 +205,7 @@ Modules netbox_tenant_module netbox_tenant_group_module netbox_virtual_chassis_module + netbox_virtual_disk_module netbox_virtual_machine_module netbox_vlan_module netbox_vlan_group_module @@ -212,7 +220,7 @@ Modules Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`nb_inventory inventory ` -- NetBox inventory source +* :ansplugin:`nb_inventory inventory ` -- NetBox inventory source .. toctree:: :maxdepth: 1 @@ -224,7 +232,7 @@ Inventory Plugins Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`nb_lookup lookup ` -- Queries and returns elements from NetBox +* :ansplugin:`nb_lookup lookup ` -- Queries and returns elements from NetBox .. toctree:: :maxdepth: 1 diff --git a/docs/plugins/nb_inventory_inventory.rst b/docs/plugins/nb_inventory_inventory.rst index caf1b7267..f52447e4e 100644 --- a/docs/plugins/nb_inventory_inventory.rst +++ b/docs/plugins/nb_inventory_inventory.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.nb_inventory inventory -- NetBox inventory source @@ -42,7 +23,10 @@ netbox.netbox.nb_inventory inventory -- NetBox inventory source .. Collection note .. note:: - This inventory plugin is part of the `netbox.netbox collection `_ (version 3.16.0). + This inventory plugin is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. @@ -81,12 +65,13 @@ Synopsis Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -106,9 +91,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -151,9 +136,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -195,9 +180,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -236,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -296,9 +281,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -357,9 +342,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -422,9 +407,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -450,21 +435,6 @@ Parameters - INI entries: - .. code-block:: - - [default] - fact_caching_prefix = ansible_inventory_ - - - Removed in: version 2.16 of ansible.builtin - - - Why: Fixes typing error in INI section name - - Alternative: Use the 'defaults' section instead - - - .. code-block:: [defaults] @@ -502,9 +472,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` @@ -567,9 +537,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -608,9 +578,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -649,9 +619,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -696,9 +666,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` @@ -739,9 +709,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -786,9 +756,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.2.1` @@ -842,9 +812,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.2.1` @@ -892,9 +862,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.2.1` @@ -942,9 +912,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.3.0` @@ -992,9 +962,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -1042,9 +1012,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` @@ -1123,9 +1093,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.2.0` @@ -1171,9 +1141,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -1212,9 +1182,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.1.7` @@ -1260,9 +1230,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -1301,9 +1271,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` + :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` @@ -1332,6 +1302,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-keyed_groups/default_value: .. rst-class:: ansible-option-title @@ -1342,9 +1316,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in ansible-core 2.12` @@ -1356,13 +1330,17 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
The default value when the host variable's value is an empty string. - This option is mutually exclusive with \ :literal:`trailing\_separator`\ . + This option is mutually exclusive with \ :ansopt:`netbox.netbox.nb\_inventory#inventory:keyed\_groups[].trailing\_separator`\ . .. raw:: html @@ -1374,6 +1352,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-keyed_groups/key: .. rst-class:: ansible-option-title @@ -1384,9 +1366,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -1395,6 +1377,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1411,6 +1397,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-keyed_groups/parent_group: .. rst-class:: ansible-option-title @@ -1421,9 +1411,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -1432,6 +1422,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1448,6 +1442,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-keyed_groups/prefix: .. rst-class:: ansible-option-title @@ -1458,9 +1456,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -1469,6 +1467,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1489,6 +1491,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-keyed_groups/separator: .. rst-class:: ansible-option-title @@ -1499,9 +1505,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -1510,6 +1516,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1530,6 +1540,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-keyed_groups/trailing_separator: .. rst-class:: ansible-option-title @@ -1540,9 +1554,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in ansible-core 2.12` @@ -1554,13 +1568,17 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
- Set this option to \ :emphasis:`False`\ to omit the \ :literal:`separator`\ after the host variable when the value is an empty string. + Set this option to \ :ansval:`False`\ to omit the \ :ansopt:`netbox.netbox.nb\_inventory#inventory:keyed\_groups[].separator`\ after the host variable when the value is an empty string. - This option is mutually exclusive with \ :literal:`default\_value`\ . + This option is mutually exclusive with \ :ansopt:`netbox.netbox.nb\_inventory#inventory:keyed\_groups[].default\_value`\ . .. rst-class:: ansible-option-line @@ -1591,9 +1609,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in ansible-core 2.11` @@ -1649,9 +1667,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 0.2.1` @@ -1695,9 +1713,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -1739,9 +1757,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.2.1` @@ -1791,9 +1809,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.5.0` @@ -1841,9 +1859,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` @@ -1884,9 +1902,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -1934,9 +1952,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 0.2.0` @@ -1982,9 +2000,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.5.0` @@ -2030,9 +2048,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -2045,7 +2063,7 @@ Parameters
- If \ :literal:`yes`\ make invalid entries a fatal error, otherwise skip and continue. + If \ :ansval:`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. @@ -2077,9 +2095,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` @@ -2118,9 +2136,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -2170,9 +2188,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in ansible-core 2.11` @@ -2233,9 +2251,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -2278,9 +2296,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -2325,9 +2343,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` @@ -2510,12 +2528,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/nb_lookup_lookup.rst b/docs/plugins/nb_lookup_lookup.rst index 721dc2f49..530466b7c 100644 --- a/docs/plugins/nb_lookup_lookup.rst +++ b/docs/plugins/nb_lookup_lookup.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.nb_lookup lookup -- Queries and returns elements from NetBox @@ -42,7 +23,10 @@ netbox.netbox.nb_lookup lookup -- Queries and returns elements from NetBox .. Collection note .. note:: - This lookup plugin is part of the `netbox.netbox collection `_ (version 3.16.0). + This lookup plugin is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this lookup plugin, @@ -92,12 +76,13 @@ The below requirements are needed on the local controller node that executes thi Terms ----- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -117,9 +102,9 @@ Terms - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -151,12 +136,13 @@ Keyword parameters This describes keyword parameters of the lookup. These are the values ``key1=value1``, ``key2=value2`` and so on in the following examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` and ``query('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -176,9 +162,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -222,9 +208,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -259,9 +245,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -298,9 +284,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -335,9 +321,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -374,9 +360,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -419,9 +405,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -467,9 +453,9 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -553,12 +539,13 @@ Examples Return Value ------------ -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -578,9 +565,9 @@ Return Value - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -623,12 +610,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_aggregate_module.rst b/docs/plugins/netbox_aggregate_module.rst index a885ded63..96cea2629 100644 --- a/docs/plugins/netbox_aggregate_module.rst +++ b/docs/plugins/netbox_aggregate_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_aggregate module -- Creates or removes aggregates from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_aggregate module -- Creates or removes aggregates from NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/date_added: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/prefix: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/rir: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -428,9 +473,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.12.0` @@ -439,6 +484,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -466,9 +515,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -500,9 +549,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -536,9 +585,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -574,9 +623,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -616,9 +665,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -713,12 +762,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -738,9 +788,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -778,9 +828,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -821,12 +871,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_asn_module.rst b/docs/plugins/netbox_asn_module.rst index 69f43829f..39088eaae 100644 --- a/docs/plugins/netbox_asn_module.rst +++ b/docs/plugins/netbox_asn_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_asn module -- Create, update or delete ASNs within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_asn module -- Create, update or delete ASNs within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_asn_module__parameter-data/asn: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` / :ansible-option-required:`required` + :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_asn_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_asn_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_asn_module__parameter-data/rir: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_asn_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_asn_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -392,9 +425,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -426,9 +459,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -462,9 +495,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -500,9 +533,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -542,9 +575,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -628,12 +661,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -653,9 +687,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -693,9 +727,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -736,12 +770,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_cable_module.rst b/docs/plugins/netbox_cable_module.rst index 757391ed5..ff0b43a32 100644 --- a/docs/plugins/netbox_cable_module.rst +++ b/docs/plugins/netbox_cable_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_cable module -- Create, update or delete cables within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_cable module -- Create, update or delete cables within NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/color: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -221,9 +218,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -232,6 +229,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -258,9 +263,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -269,6 +274,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -295,9 +308,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -306,6 +319,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -322,6 +339,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -332,14 +353,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -356,6 +381,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/length: .. rst-class:: ansible-option-title @@ -366,14 +395,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`float` + :ansible-option-type:`float` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -390,6 +423,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/length_unit: .. rst-class:: ansible-option-title @@ -400,14 +437,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -434,6 +475,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -444,14 +489,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -477,6 +526,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -487,14 +540,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -511,6 +568,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -521,9 +582,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.14.0` @@ -532,6 +593,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -548,6 +613,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/termination_a: .. rst-class:: ansible-option-title @@ -558,14 +627,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -582,6 +655,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/termination_a_type: .. rst-class:: ansible-option-title @@ -592,14 +669,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -631,6 +712,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/termination_b: .. rst-class:: ansible-option-title @@ -641,14 +726,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -665,6 +754,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/termination_b_type: .. rst-class:: ansible-option-title @@ -675,14 +768,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -714,6 +811,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -724,14 +825,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -785,9 +890,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -819,9 +924,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -855,9 +960,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -893,9 +998,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -935,9 +1040,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1055,12 +1160,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1080,9 +1186,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1120,9 +1226,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1163,12 +1269,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_circuit_module.rst b/docs/plugins/netbox_circuit_module.rst index 039d566f0..2c0f3595f 100644 --- a/docs/plugins/netbox_circuit_module.rst +++ b/docs/plugins/netbox_circuit_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_circuit module -- Create, update or delete circuits within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_circuit module -- Create, update or delete circuits within .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/cid: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/circuit_type: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/commit_rate: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -381,6 +414,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/install_date: .. rst-class:: ansible-option-title @@ -391,14 +428,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -415,6 +456,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/provider: .. rst-class:: ansible-option-title @@ -425,14 +470,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -449,6 +498,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -459,14 +512,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -483,6 +540,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -493,14 +554,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -517,6 +582,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -527,14 +596,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -562,9 +635,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -596,9 +669,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -632,9 +705,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -670,9 +743,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -712,9 +785,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -813,12 +886,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -838,9 +912,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -878,9 +952,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -921,12 +995,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_circuit_termination_module.rst b/docs/plugins/netbox_circuit_termination_module.rst index 8c08ec897..adb846b95 100644 --- a/docs/plugins/netbox_circuit_termination_module.rst +++ b/docs/plugins/netbox_circuit_termination_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_circuit_termination module -- Create, update or delete circuit terminations within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_circuit_termination module -- Create, update or delete circ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/circuit: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/mark_connected: .. rst-class:: ansible-option-title @@ -255,9 +260,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.5.0` @@ -266,6 +271,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -290,6 +299,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/port_speed: .. rst-class:: ansible-option-title @@ -300,14 +313,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -324,6 +341,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/pp_info: .. rst-class:: ansible-option-title @@ -334,14 +355,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -358,6 +383,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/provider_network: .. rst-class:: ansible-option-title @@ -368,14 +397,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -392,6 +425,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -402,14 +439,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -426,6 +467,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/term_side: .. rst-class:: ansible-option-title @@ -436,14 +481,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -468,6 +517,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/upstream_speed: .. rst-class:: ansible-option-title @@ -478,14 +531,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -502,6 +559,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/xconnect_id: .. rst-class:: ansible-option-title @@ -512,14 +573,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -547,9 +612,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -581,9 +646,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -617,9 +682,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -655,9 +720,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -697,9 +762,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -797,12 +862,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -822,9 +888,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -862,9 +928,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -905,12 +971,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_circuit_type_module.rst b/docs/plugins/netbox_circuit_type_module.rst index 167e7a20f..bd35a9d91 100644 --- a/docs/plugins/netbox_circuit_type_module.rst +++ b/docs/plugins/netbox_circuit_type_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_circuit_type module -- Create, update or delete circuit types within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_circuit_type module -- Create, update or delete circuit typ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -172,11 +157,60 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_circuit_type_module__parameter-data/color: + + .. rst-class:: ansible-option-title + + **color** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in netbox.netbox 3.17.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Color to associate the circuit type with + + + .. raw:: html + +
+ * - .. raw:: html
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_type_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +232,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +252,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_type_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,9 +266,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.14.0` @@ -235,6 +277,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -251,6 +297,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_type_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -261,14 +311,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +339,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_type_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -295,14 +353,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -321,6 +383,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_circuit_type_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -331,9 +397,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -342,6 +408,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -369,9 +439,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -403,9 +473,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -439,9 +509,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -477,9 +547,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -519,9 +589,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -602,12 +672,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -627,9 +698,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -667,9 +738,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -710,12 +781,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_cluster_group_module.rst b/docs/plugins/netbox_cluster_group_module.rst index 4d5c98a31..b0c95357f 100644 --- a/docs/plugins/netbox_cluster_group_module.rst +++ b/docs/plugins/netbox_cluster_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_cluster_group module -- Create, update or delete cluster groups within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_cluster_group module -- Create, update or delete cluster gr .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_group_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_group_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_group_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -284,6 +293,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_group_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -294,9 +307,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -305,6 +318,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -332,9 +349,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -366,9 +383,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -402,9 +419,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -440,9 +457,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -482,9 +499,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -565,12 +582,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -590,9 +608,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -630,9 +648,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -673,12 +691,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_cluster_module.rst b/docs/plugins/netbox_cluster_module.rst index 92b853a42..c17b01a0d 100644 --- a/docs/plugins/netbox_cluster_module.rst +++ b/docs/plugins/netbox_cluster_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_cluster module -- Create, update or delete clusters within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_cluster module -- Create, update or delete clusters within .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/cluster_group: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/cluster_type: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -323,9 +344,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -334,6 +355,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -428,14 +473,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -452,6 +501,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -462,14 +515,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -497,9 +554,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -531,9 +588,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -567,9 +624,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -605,9 +662,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -647,9 +704,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -753,12 +810,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -778,9 +836,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -818,9 +876,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -861,12 +919,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_cluster_type_module.rst b/docs/plugins/netbox_cluster_type_module.rst index 94b1e5997..7841e23cf 100644 --- a/docs/plugins/netbox_cluster_type_module.rst +++ b/docs/plugins/netbox_cluster_type_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_cluster_type module -- Create, update or delete cluster types within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_cluster_type module -- Create, update or delete cluster typ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_type_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_type_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_type_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_type_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -318,6 +335,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_cluster_type_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -328,9 +349,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -339,6 +360,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -366,9 +391,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -400,9 +425,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -436,9 +461,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -474,9 +499,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -516,9 +541,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -599,12 +624,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -624,9 +650,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -664,9 +690,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -707,12 +733,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_config_context_module.rst b/docs/plugins/netbox_config_context_module.rst index a35aa3678..3d87bdac4 100644 --- a/docs/plugins/netbox_config_context_module.rst +++ b/docs/plugins/netbox_config_context_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_config_context module -- Creates, updates or deletes configuration contexts within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_config_context module -- Creates, updates or deletes config .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/cluster_groups: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/cluster_types: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/clusters: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/data: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/device_types: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -381,6 +414,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/is_active: .. rst-class:: ansible-option-title @@ -391,14 +428,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -423,6 +464,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -433,14 +478,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -457,6 +506,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/platforms: .. rst-class:: ansible-option-title @@ -467,14 +520,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -491,6 +548,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/regions: .. rst-class:: ansible-option-title @@ -501,14 +562,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -525,6 +590,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/roles: .. rst-class:: ansible-option-title @@ -535,14 +604,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -559,6 +632,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/site_groups: .. rst-class:: ansible-option-title @@ -569,14 +646,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -593,6 +674,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/sites: .. rst-class:: ansible-option-title @@ -603,14 +688,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -627,6 +716,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -637,14 +730,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -661,6 +758,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/tenant_groups: .. rst-class:: ansible-option-title @@ -671,14 +772,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -695,6 +800,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/tenants: .. rst-class:: ansible-option-title @@ -705,14 +814,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -729,6 +842,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-data/weight: .. rst-class:: ansible-option-title @@ -739,14 +856,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -774,9 +895,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -808,9 +929,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -844,9 +965,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -882,9 +1003,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -924,9 +1045,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1018,12 +1139,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1043,9 +1165,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1083,9 +1205,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1126,12 +1248,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_config_template_module.rst b/docs/plugins/netbox_config_template_module.rst index d369e43a4..65031d5e6 100644 --- a/docs/plugins/netbox_config_template_module.rst +++ b/docs/plugins/netbox_config_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_config_template module -- Creates or removes config templates from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_config_template module -- Creates or removes config templat .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_template_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_template_module__parameter-data/environment_params: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_template_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_config_template_module__parameter-data/template_code: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -358,9 +383,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -392,9 +417,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -428,9 +453,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -466,9 +491,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -508,9 +533,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -594,12 +619,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -619,9 +645,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -659,9 +685,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -702,12 +728,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_console_port_module.rst b/docs/plugins/netbox_console_port_module.rst index a10e13255..52b0685ed 100644 --- a/docs/plugins/netbox_console_port_module.rst +++ b/docs/plugins/netbox_console_port_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_console_port module -- Create, update or delete console ports within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_console_port module -- Create, update or delete console por .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/cable: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -235,6 +232,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -251,6 +252,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -261,14 +266,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -295,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -319,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -329,9 +350,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -340,6 +361,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -356,6 +381,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/mark_connected: .. rst-class:: ansible-option-title @@ -366,9 +395,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -377,6 +406,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -401,6 +434,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/module: .. rst-class:: ansible-option-title @@ -411,9 +448,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -422,6 +459,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -438,6 +479,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -448,14 +493,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -472,6 +521,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/speed: .. rst-class:: ansible-option-title @@ -482,9 +535,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -493,6 +546,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -509,6 +566,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -519,14 +580,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -543,6 +608,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -553,14 +622,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -609,9 +682,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -643,9 +716,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -679,9 +752,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -717,9 +790,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -759,9 +832,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -855,12 +928,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -880,9 +954,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -920,9 +994,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -963,12 +1037,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_console_port_template_module.rst b/docs/plugins/netbox_console_port_template_module.rst index 8589b1d8a..748e3cafa 100644 --- a/docs/plugins/netbox_console_port_template_module.rst +++ b/docs/plugins/netbox_console_port_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_console_port_template module -- Create, update or delete console port templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_console_port_template module -- Create, update or delete co .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_port_template_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -309,9 +318,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -343,9 +352,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -379,9 +388,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -417,9 +426,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -459,9 +468,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -554,12 +563,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -579,9 +589,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -619,9 +629,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -662,12 +672,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_console_server_port_module.rst b/docs/plugins/netbox_console_server_port_module.rst index c28dd8bd2..abeddaff6 100644 --- a/docs/plugins/netbox_console_server_port_module.rst +++ b/docs/plugins/netbox_console_server_port_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_console_server_port module -- Create, update or delete console server ports within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_console_server_port module -- Create, update or delete cons .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/cable: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -235,6 +232,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -251,6 +252,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -261,14 +266,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -295,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -319,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -329,9 +350,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -340,6 +361,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -356,6 +381,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/mark_connected: .. rst-class:: ansible-option-title @@ -366,9 +395,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -377,6 +406,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -401,6 +434,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -411,14 +448,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -435,6 +476,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/speed: .. rst-class:: ansible-option-title @@ -445,9 +490,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -456,6 +501,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -472,6 +521,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -482,14 +535,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -506,6 +563,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -516,14 +577,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -572,9 +637,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -606,9 +671,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -642,9 +707,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -680,9 +745,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -722,9 +787,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -819,12 +884,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -844,9 +910,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -884,9 +950,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -927,12 +993,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_console_server_port_template_module.rst b/docs/plugins/netbox_console_server_port_template_module.rst index cad0d0252..a733f1e00 100644 --- a/docs/plugins/netbox_console_server_port_template_module.rst +++ b/docs/plugins/netbox_console_server_port_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_console_server_port_template module -- Create, update or delete console server port templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_console_server_port_template module -- Create, update or de .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_console_server_port_template_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -309,9 +318,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -343,9 +352,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -379,9 +388,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -417,9 +426,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -459,9 +468,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -554,12 +563,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -579,9 +589,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -619,9 +629,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -662,12 +672,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_contact_group_module.rst b/docs/plugins/netbox_contact_group_module.rst index c40bd18aa..b02ed35d7 100644 --- a/docs/plugins/netbox_contact_group_module.rst +++ b/docs/plugins/netbox_contact_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_contact_group module -- Creates or removes contact groups from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_contact_group module -- Creates or removes contact groups f .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_group_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_group_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_group_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_group_module__parameter-data/parent_contact_group: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_group_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_group_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -392,9 +425,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -426,9 +459,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -462,9 +495,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -500,9 +533,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -542,9 +575,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -626,12 +659,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -651,9 +685,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -691,9 +725,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -734,12 +768,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_contact_module.rst b/docs/plugins/netbox_contact_module.rst index deb414ad6..9997173a4 100644 --- a/docs/plugins/netbox_contact_module.rst +++ b/docs/plugins/netbox_contact_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_contact module -- Creates or removes contacts from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_contact module -- Creates or removes contacts from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/address: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/contact_group: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -323,9 +344,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -334,6 +355,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/email: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/link: .. rst-class:: ansible-option-title @@ -394,9 +431,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -405,6 +442,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -421,6 +462,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -431,14 +476,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -455,6 +504,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/phone: .. rst-class:: ansible-option-title @@ -465,14 +518,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -489,6 +546,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -499,14 +560,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -523,6 +588,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/title: .. rst-class:: ansible-option-title @@ -533,14 +602,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -568,9 +641,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -602,9 +675,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -638,9 +711,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -676,9 +749,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -718,9 +791,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -815,12 +888,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -840,9 +914,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -880,9 +954,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -923,12 +997,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_contact_role_module.rst b/docs/plugins/netbox_contact_role_module.rst index d896e5de8..baf0bcbc1 100644 --- a/docs/plugins/netbox_contact_role_module.rst +++ b/docs/plugins/netbox_contact_role_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_contact_role module -- Creates or removes contact roles from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_contact_role module -- Creates or removes contact roles fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_role_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_role_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_role_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_role_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -315,6 +332,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_contact_role_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -325,14 +346,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -360,9 +385,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -394,9 +419,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -430,9 +455,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -468,9 +493,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -510,9 +535,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -592,12 +617,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -617,9 +643,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -657,9 +683,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -700,12 +726,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_custom_field_module.rst b/docs/plugins/netbox_custom_field_module.rst index f8603426a..24d2e6e43 100644 --- a/docs/plugins/netbox_custom_field_module.rst +++ b/docs/plugins/netbox_custom_field_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_custom_field module -- Creates, updates or deletes custom fields within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_custom_field module -- Creates, updates or deletes custom f .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/choices: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/content_types: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/default: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/filter_logic: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/group_name: .. rst-class:: ansible-option-title @@ -357,9 +386,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -368,6 +397,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -428,14 +473,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -452,6 +501,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/object_type: .. rst-class:: ansible-option-title @@ -462,9 +515,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -473,6 +526,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -489,6 +546,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/required: .. rst-class:: ansible-option-title @@ -499,14 +560,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -531,6 +596,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/search_weight: .. rst-class:: ansible-option-title @@ -541,9 +610,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -552,6 +621,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -568,6 +641,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -578,14 +655,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -621,6 +702,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/ui_visibility: .. rst-class:: ansible-option-title @@ -631,9 +716,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -642,6 +727,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -668,6 +757,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/validation_maximum: .. rst-class:: ansible-option-title @@ -678,14 +771,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -702,6 +799,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/validation_minimum: .. rst-class:: ansible-option-title @@ -712,14 +813,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -736,6 +841,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/validation_regex: .. rst-class:: ansible-option-title @@ -746,14 +855,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -770,6 +883,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/weight: .. rst-class:: ansible-option-title @@ -780,14 +897,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -815,9 +936,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -849,9 +970,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -885,9 +1006,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -923,9 +1044,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -965,9 +1086,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1064,12 +1185,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1089,9 +1211,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1129,9 +1251,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1172,12 +1294,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_custom_link_module.rst b/docs/plugins/netbox_custom_link_module.rst index 35a4b119b..3348ef6fe 100644 --- a/docs/plugins/netbox_custom_link_module.rst +++ b/docs/plugins/netbox_custom_link_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_custom_link module -- Creates, updates or deletes custom links within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_custom_link module -- Creates, updates or deletes custom li .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/button_class: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/content_type: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/content_types: .. rst-class:: ansible-option-title @@ -255,9 +260,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -266,6 +271,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/enabled: .. rst-class:: ansible-option-title @@ -292,9 +305,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -303,6 +316,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -327,6 +344,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/group_name: .. rst-class:: ansible-option-title @@ -337,14 +358,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -361,6 +386,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/link_text: .. rst-class:: ansible-option-title @@ -371,14 +400,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -395,6 +428,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/link_url: .. rst-class:: ansible-option-title @@ -405,14 +442,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -429,6 +470,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -439,14 +484,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -463,6 +512,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/new_window: .. rst-class:: ansible-option-title @@ -473,14 +526,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -505,6 +562,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-data/weight: .. rst-class:: ansible-option-title @@ -515,14 +576,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -550,9 +615,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -584,9 +649,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -620,9 +685,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -658,9 +723,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -700,9 +765,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -786,12 +851,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -811,9 +877,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -851,9 +917,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -894,12 +960,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_device_bay_module.rst b/docs/plugins/netbox_device_bay_module.rst index d4055ac72..56b730e40 100644 --- a/docs/plugins/netbox_device_bay_module.rst +++ b/docs/plugins/netbox_device_bay_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_device_bay module -- Create, update or delete device bays within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_device_bay module -- Create, update or delete device bays w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_module__parameter-data/installed_device: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -289,9 +302,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -300,6 +313,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -395,9 +428,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -429,9 +462,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -465,9 +498,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -503,9 +536,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -545,9 +578,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -641,12 +674,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -666,9 +700,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -706,9 +740,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -749,12 +783,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_device_bay_template_module.rst b/docs/plugins/netbox_device_bay_template_module.rst index 63ccad76a..0c255076f 100644 --- a/docs/plugins/netbox_device_bay_template_module.rst +++ b/docs/plugins/netbox_device_bay_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_device_bay_template module -- Create, update or delete device bay templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_device_bay_template module -- Create, update or delete devi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_bay_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -256,9 +257,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -290,9 +291,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -326,9 +327,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -364,9 +365,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -406,9 +407,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -492,12 +493,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -517,9 +519,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -557,9 +559,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -600,12 +602,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_device_interface_module.rst b/docs/plugins/netbox_device_interface_module.rst index 7e79e74fc..c80d1af13 100644 --- a/docs/plugins/netbox_device_interface_module.rst +++ b/docs/plugins/netbox_device_interface_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_device_interface module -- Creates or removes interfaces on devices from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_device_interface module -- Creates or removes interfaces on .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/bridge: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/duplex: .. rst-class:: ansible-option-title @@ -326,9 +347,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -337,6 +358,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -362,6 +387,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/enabled: .. rst-class:: ansible-option-title @@ -372,14 +401,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -404,6 +437,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/form_factor: .. rst-class:: ansible-option-title @@ -414,14 +451,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -441,6 +482,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -451,14 +496,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -475,6 +524,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/lag: .. rst-class:: ansible-option-title @@ -485,14 +538,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -509,6 +566,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/mac_address: .. rst-class:: ansible-option-title @@ -519,14 +580,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -543,6 +608,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/mark_connected: .. rst-class:: ansible-option-title @@ -553,14 +622,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -585,6 +658,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/mgmt_only: .. rst-class:: ansible-option-title @@ -595,14 +672,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -627,6 +708,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/mode: .. rst-class:: ansible-option-title @@ -637,14 +722,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -661,6 +750,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/mtu: .. rst-class:: ansible-option-title @@ -671,14 +764,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -695,6 +792,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -705,14 +806,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -729,6 +834,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/parent_interface: .. rst-class:: ansible-option-title @@ -739,9 +848,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.2.0` @@ -750,6 +859,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -766,6 +879,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/poe_mode: .. rst-class:: ansible-option-title @@ -776,9 +893,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.8.0` @@ -787,6 +904,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -803,6 +924,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/poe_type: .. rst-class:: ansible-option-title @@ -813,9 +938,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.8.0` @@ -824,6 +949,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -840,6 +969,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/speed: .. rst-class:: ansible-option-title @@ -850,9 +983,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -861,6 +994,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -877,6 +1014,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/tagged_vlans: .. rst-class:: ansible-option-title @@ -887,14 +1028,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -911,6 +1056,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -921,14 +1070,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -945,6 +1098,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/tx_power: .. rst-class:: ansible-option-title @@ -955,9 +1112,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.14.0` @@ -966,6 +1123,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -982,6 +1143,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -992,14 +1157,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1019,6 +1188,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/untagged_vlan: .. rst-class:: ansible-option-title @@ -1029,14 +1202,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1053,6 +1230,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/vrf: .. rst-class:: ansible-option-title @@ -1063,9 +1244,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -1074,6 +1255,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1090,6 +1275,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-data/wwn: .. rst-class:: ansible-option-title @@ -1100,9 +1289,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.14.0` @@ -1111,6 +1300,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1138,9 +1331,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -1172,9 +1365,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -1208,9 +1401,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -1246,9 +1439,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1288,9 +1481,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html @@ -1332,9 +1525,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1487,12 +1680,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1512,9 +1706,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1552,9 +1746,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1595,12 +1789,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_device_interface_template_module.rst b/docs/plugins/netbox_device_interface_template_module.rst index e0af9a9de..56f28d7be 100644 --- a/docs/plugins/netbox_device_interface_template_module.rst +++ b/docs/plugins/netbox_device_interface_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_device_interface_template module -- Creates or removes interfaces on devices from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_device_interface_template module -- Creates or removes inte .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_template_module__parameter-data/mgmt_only: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -253,6 +254,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -263,14 +268,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -287,6 +296,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_template_module__parameter-data/poe_mode: .. rst-class:: ansible-option-title @@ -297,9 +310,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.8.0` @@ -308,6 +321,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -324,6 +341,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_template_module__parameter-data/poe_type: .. rst-class:: ansible-option-title @@ -334,9 +355,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.8.0` @@ -345,6 +366,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -361,6 +386,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_interface_template_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -371,14 +400,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -409,9 +442,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -443,9 +476,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -479,9 +512,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -517,9 +550,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -559,9 +592,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -644,12 +677,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -669,9 +703,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -709,9 +743,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -752,12 +786,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_device_module.rst b/docs/plugins/netbox_device_module.rst index 7abb8a9fa..47d068742 100644 --- a/docs/plugins/netbox_device_module.rst +++ b/docs/plugins/netbox_device_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_device module -- Create, update or delete devices within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_device module -- Create, update or delete devices within Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/airflow: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -227,6 +220,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/asset_tag: .. rst-class:: ansible-option-title @@ -237,14 +234,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -261,6 +262,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/cluster: .. rst-class:: ansible-option-title @@ -271,14 +276,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -295,6 +304,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -305,14 +318,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -320,6 +337,51 @@ Parameters Comments that may include additional information in regards to the device + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/config_template: + + .. rst-class:: ansible-option-title + + **config_template** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + :ansible-option-versionadded:`added in netbox.netbox 3.17.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Configuration template + + .. raw:: html
@@ -329,6 +391,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -339,14 +405,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -363,6 +433,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -373,9 +447,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -384,6 +458,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -400,6 +478,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/device_role: .. rst-class:: ansible-option-title @@ -410,14 +492,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -434,6 +520,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -444,14 +534,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -468,6 +562,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/face: .. rst-class:: ansible-option-title @@ -478,14 +576,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -512,6 +614,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/local_context_data: .. rst-class:: ansible-option-title @@ -522,14 +628,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -546,6 +656,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/location: .. rst-class:: ansible-option-title @@ -556,9 +670,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.3.0` @@ -567,6 +681,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -583,6 +701,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -593,14 +715,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -617,6 +743,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/oob_ip: .. rst-class:: ansible-option-title @@ -627,9 +757,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.15.0` @@ -638,6 +768,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -654,6 +788,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/platform: .. rst-class:: ansible-option-title @@ -664,14 +802,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -688,6 +830,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/position: .. rst-class:: ansible-option-title @@ -698,14 +844,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -722,6 +872,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/primary_ip4: .. rst-class:: ansible-option-title @@ -732,14 +886,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -756,6 +914,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/primary_ip6: .. rst-class:: ansible-option-title @@ -766,14 +928,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -790,6 +956,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/rack: .. rst-class:: ansible-option-title @@ -800,14 +970,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -824,6 +998,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/serial: .. rst-class:: ansible-option-title @@ -834,14 +1012,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -858,6 +1040,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -868,14 +1054,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -892,6 +1082,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -902,14 +1096,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -926,6 +1124,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -936,14 +1138,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -960,6 +1166,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -970,14 +1180,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -994,6 +1208,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/vc_position: .. rst-class:: ansible-option-title @@ -1004,14 +1222,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1028,6 +1250,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/vc_priority: .. rst-class:: ansible-option-title @@ -1038,14 +1264,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1062,6 +1292,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-data/virtual_chassis: .. rst-class:: ansible-option-title @@ -1072,14 +1306,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1107,9 +1345,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -1141,9 +1379,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -1177,9 +1415,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -1215,9 +1453,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1257,9 +1495,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1380,12 +1618,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1405,9 +1644,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1445,9 +1684,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1489,12 +1728,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_device_role_module.rst b/docs/plugins/netbox_device_role_module.rst index 09e65ceef..575aa75e2 100644 --- a/docs/plugins/netbox_device_role_module.rst +++ b/docs/plugins/netbox_device_role_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_device_role module -- Create, update or delete devices roles within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_device_role module -- Create, update or delete devices role .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-data/color: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,9 +218,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -232,6 +229,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -352,6 +377,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -362,9 +391,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -373,6 +402,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -389,6 +422,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-data/vm_role: .. rst-class:: ansible-option-title @@ -399,14 +436,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -442,9 +483,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -476,9 +517,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -512,9 +553,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -550,9 +591,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -592,9 +633,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -676,12 +717,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -701,9 +743,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -741,9 +783,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -784,12 +826,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_device_type_module.rst b/docs/plugins/netbox_device_type_module.rst index e0de8b118..97e4d9c61 100644 --- a/docs/plugins/netbox_device_type_module.rst +++ b/docs/plugins/netbox_device_type_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_device_type module -- Create, update or delete device types within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_device_type module -- Create, update or delete device types .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/airflow: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -227,6 +220,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -237,14 +234,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -261,6 +262,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -271,14 +276,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -295,6 +304,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/default_platform: .. rst-class:: ansible-option-title @@ -305,9 +318,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.15.0` @@ -316,6 +329,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -332,6 +349,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -342,9 +363,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -353,6 +374,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -369,6 +394,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/is_full_depth: .. rst-class:: ansible-option-title @@ -379,14 +408,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -411,6 +444,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/manufacturer: .. rst-class:: ansible-option-title @@ -421,14 +458,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -445,6 +486,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/model: .. rst-class:: ansible-option-title @@ -455,14 +500,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -479,6 +528,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/part_number: .. rst-class:: ansible-option-title @@ -489,14 +542,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -513,6 +570,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -523,14 +584,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -551,6 +616,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/subdevice_role: .. rst-class:: ansible-option-title @@ -561,14 +630,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -595,6 +668,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -605,14 +682,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -629,6 +710,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/u_height: .. rst-class:: ansible-option-title @@ -639,14 +724,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -663,6 +752,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/weight: .. rst-class:: ansible-option-title @@ -673,9 +766,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`float` + :ansible-option-type:`float` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -684,6 +777,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -700,6 +797,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-data/weight_unit: .. rst-class:: ansible-option-title @@ -710,9 +811,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -721,6 +822,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -758,9 +863,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -792,9 +897,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -828,9 +933,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -866,9 +971,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -908,9 +1013,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1007,12 +1112,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1032,9 +1138,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1072,9 +1178,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1115,12 +1221,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_export_template_module.rst b/docs/plugins/netbox_export_template_module.rst index df8e4bee6..695917d5c 100644 --- a/docs/plugins/netbox_export_template_module.rst +++ b/docs/plugins/netbox_export_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_export_template module -- Creates, updates or deletes export templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_export_template module -- Creates, updates or deletes expor .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/as_attachment: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -219,6 +212,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/content_type: .. rst-class:: ansible-option-title @@ -229,14 +226,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -253,6 +254,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/content_types: .. rst-class:: ansible-option-title @@ -263,9 +268,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -274,6 +279,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -290,6 +299,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -300,14 +313,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -324,6 +341,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/file_extension: .. rst-class:: ansible-option-title @@ -334,14 +355,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -358,6 +383,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/mime_type: .. rst-class:: ansible-option-title @@ -368,14 +397,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -392,6 +425,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -402,14 +439,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -426,6 +467,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-data/template_code: .. rst-class:: ansible-option-title @@ -436,14 +481,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -471,9 +520,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -505,9 +554,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -541,9 +590,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -579,9 +628,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -621,9 +670,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -707,12 +756,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -732,9 +782,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -772,9 +822,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -815,12 +865,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_fhrp_group_assignment_module.rst b/docs/plugins/netbox_fhrp_group_assignment_module.rst index 819de943e..493125183 100644 --- a/docs/plugins/netbox_fhrp_group_assignment_module.rst +++ b/docs/plugins/netbox_fhrp_group_assignment_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_fhrp_group_assignment module -- Create, update or delete FHRP group assignments within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_fhrp_group_assignment module -- Create, update or delete FH .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -91,12 +75,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -116,9 +101,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -150,9 +135,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -174,6 +159,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_assignment_module__parameter-data/fhrp_group: .. rst-class:: ansible-option-title @@ -184,14 +173,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` / :ansible-option-required:`required` + :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -208,6 +201,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_assignment_module__parameter-data/interface_id: .. rst-class:: ansible-option-title @@ -218,14 +215,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` / :ansible-option-required:`required` + :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -242,6 +243,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_assignment_module__parameter-data/interface_type: .. rst-class:: ansible-option-title @@ -252,14 +257,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -284,6 +293,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_assignment_module__parameter-data/priority: .. rst-class:: ansible-option-title @@ -294,14 +307,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -329,9 +346,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -363,9 +380,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -399,9 +416,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -437,9 +454,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -479,9 +496,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -573,12 +590,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -598,9 +616,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -638,9 +656,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -681,12 +699,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_fhrp_group_module.rst b/docs/plugins/netbox_fhrp_group_module.rst index 93a9b5ffa..15d4c16d2 100644 --- a/docs/plugins/netbox_fhrp_group_module.rst +++ b/docs/plugins/netbox_fhrp_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_fhrp_group module -- Create, update or delete FHRP groups within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_fhrp_group module -- Create, update or delete FHRP groups w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-data/auth_key: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-data/auth_type: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -253,6 +254,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -263,14 +268,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -287,6 +296,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -297,14 +310,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -321,6 +338,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-data/group_id: .. rst-class:: ansible-option-title @@ -331,14 +352,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` / :ansible-option-required:`required` + :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -355,6 +380,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-data/protocol: .. rst-class:: ansible-option-title @@ -365,14 +394,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -402,6 +435,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -412,14 +449,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -447,9 +488,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -481,9 +522,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -517,9 +558,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -555,9 +596,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -597,9 +638,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -689,12 +730,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -714,9 +756,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -754,9 +796,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -797,12 +839,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_front_port_module.rst b/docs/plugins/netbox_front_port_module.rst index 4650dda7f..b2914909b 100644 --- a/docs/plugins/netbox_front_port_module.rst +++ b/docs/plugins/netbox_front_port_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_front_port module -- Create, update or delete front ports within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_front_port module -- Create, update or delete front ports w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -255,9 +260,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -266,6 +271,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/rear_port: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/rear_port_position: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -428,14 +473,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -483,9 +532,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -517,9 +566,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -553,9 +602,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -591,9 +640,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -633,9 +682,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -735,12 +784,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -760,9 +810,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -800,9 +850,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -843,12 +893,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_front_port_template_module.rst b/docs/plugins/netbox_front_port_template_module.rst index d52da5763..ad173b378 100644 --- a/docs/plugins/netbox_front_port_template_module.rst +++ b/docs/plugins/netbox_front_port_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_front_port_template module -- Create, update or delete front port templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_front_port_template module -- Create, update or delete fron .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -258,9 +263,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -269,6 +274,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -295,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -319,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-data/rear_port_template: .. rst-class:: ansible-option-title @@ -329,14 +350,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -353,6 +378,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-data/rear_port_template_position: .. rst-class:: ansible-option-title @@ -363,14 +392,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -387,6 +420,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -397,14 +434,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -452,9 +493,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -486,9 +527,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -522,9 +563,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -560,9 +601,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -602,9 +643,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -703,12 +744,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -728,9 +770,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -768,9 +810,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -811,12 +853,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_interface_module.rst b/docs/plugins/netbox_interface_module.rst index 04f5a3e0f..53fe418d2 100644 --- a/docs/plugins/netbox_interface_module.rst +++ b/docs/plugins/netbox_interface_module.rst @@ -3,6 +3,9 @@ :orphan: +.. meta:: + :antsibull-docs: 2.7.0 + .. Anchors .. _ansible_collections.netbox.netbox.netbox_interface_module: @@ -15,7 +18,7 @@ netbox.netbox.netbox_interface .. Collection note .. note:: - This plugin was part of the `netbox.netbox collection `_ (version 3.16.0). + This plugin was part of the `netbox.netbox collection `_ (version 3.17.0). This module has been removed in version 0.1.0 of netbox.netbox. diff --git a/docs/plugins/netbox_inventory_item_module.rst b/docs/plugins/netbox_inventory_item_module.rst index f153cb626..86a7ad6e5 100644 --- a/docs/plugins/netbox_inventory_item_module.rst +++ b/docs/plugins/netbox_inventory_item_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_inventory_item module -- Creates or removes inventory items from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_inventory_item module -- Creates or removes inventory items .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/asset_tag: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/component: .. rst-class:: ansible-option-title @@ -221,9 +218,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.15.0` @@ -232,6 +229,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/component/device: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/component/name: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -317,6 +334,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/component_type: .. rst-class:: ansible-option-title @@ -327,9 +348,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.15.0` @@ -338,6 +359,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -367,6 +392,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -377,9 +406,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.4.0` @@ -388,6 +417,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -404,6 +437,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -414,14 +451,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -438,6 +479,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -448,14 +493,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -472,6 +521,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/discovered: .. rst-class:: ansible-option-title @@ -482,14 +535,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -514,6 +571,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/inventory_item_role: .. rst-class:: ansible-option-title @@ -524,9 +585,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.14.0` @@ -535,6 +596,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -551,6 +616,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -561,9 +630,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.4.0` @@ -572,6 +641,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -588,6 +661,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/manufacturer: .. rst-class:: ansible-option-title @@ -598,14 +675,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -622,6 +703,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -632,14 +717,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -656,6 +745,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/parent_inventory_item: .. rst-class:: ansible-option-title @@ -666,9 +759,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.5.0` @@ -677,6 +770,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -693,6 +790,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/part_id: .. rst-class:: ansible-option-title @@ -703,14 +804,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -727,6 +832,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/serial: .. rst-class:: ansible-option-title @@ -737,14 +846,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -761,6 +874,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -771,14 +888,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -806,9 +927,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -840,9 +961,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -876,9 +997,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -914,9 +1035,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -956,9 +1077,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1080,12 +1201,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1105,9 +1227,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1145,9 +1267,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1188,12 +1310,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_inventory_item_role_module.rst b/docs/plugins/netbox_inventory_item_role_module.rst index 204c9ebb0..bf115eb58 100644 --- a/docs/plugins/netbox_inventory_item_role_module.rst +++ b/docs/plugins/netbox_inventory_item_role_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_inventory_item_role module -- Create, update or delete devices roles within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_inventory_item_role module -- Create, update or delete devi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_role_module__parameter-data/color: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_role_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_role_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_role_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_role_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -349,6 +374,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_inventory_item_role_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -359,14 +388,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -394,9 +427,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -428,9 +461,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -464,9 +497,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -502,9 +535,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -544,9 +577,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -628,12 +661,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -653,9 +687,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -693,9 +727,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -736,12 +770,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_ip_address_module.rst b/docs/plugins/netbox_ip_address_module.rst index a6a217b25..77500a2be 100644 --- a/docs/plugins/netbox_ip_address_module.rst +++ b/docs/plugins/netbox_ip_address_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_ip_address module -- Creates or removes IP addresses from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_ip_address module -- Creates or removes IP addresses from N .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/address: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/assigned_object: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/assigned_object/device: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/assigned_object/name: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/assigned_object/virtual_machine: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -348,6 +373,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -358,9 +387,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -369,6 +398,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -385,6 +418,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -395,14 +432,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -419,6 +460,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -429,14 +474,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -453,6 +502,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/dns_name: .. rst-class:: ansible-option-title @@ -463,14 +516,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -487,6 +544,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/family: .. rst-class:: ansible-option-title @@ -497,14 +558,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -531,6 +596,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/interface: .. rst-class:: ansible-option-title @@ -541,14 +610,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -567,6 +640,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/nat_inside: .. rst-class:: ansible-option-title @@ -577,14 +654,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -601,6 +682,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/prefix: .. rst-class:: ansible-option-title @@ -611,14 +696,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -644,6 +733,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/role: .. rst-class:: ansible-option-title @@ -654,14 +747,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -692,6 +789,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -702,14 +803,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -726,6 +831,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -736,14 +845,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -760,6 +873,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -770,14 +887,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -794,6 +915,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-data/vrf: .. rst-class:: ansible-option-title @@ -804,14 +929,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -839,9 +968,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -873,9 +1002,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -909,9 +1038,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -947,9 +1076,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -994,9 +1123,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1158,12 +1287,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1183,9 +1313,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1223,9 +1353,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1267,12 +1397,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_ipam_role_module.rst b/docs/plugins/netbox_ipam_role_module.rst index 381e01c6e..10819760e 100644 --- a/docs/plugins/netbox_ipam_role_module.rst +++ b/docs/plugins/netbox_ipam_role_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_ipam_role module -- Creates or removes ipam roles from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_ipam_role module -- Creates or removes ipam roles from NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ipam_role_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ipam_role_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ipam_role_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ipam_role_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -318,6 +335,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ipam_role_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -328,9 +349,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -339,6 +360,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -355,6 +380,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_ipam_role_module__parameter-data/weight: .. rst-class:: ansible-option-title @@ -365,14 +394,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -400,9 +433,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -434,9 +467,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -470,9 +503,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -508,9 +541,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -550,9 +583,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -632,12 +665,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -657,9 +691,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -697,9 +731,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -740,12 +774,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_journal_entry_module.rst b/docs/plugins/netbox_journal_entry_module.rst index 276ca11d8..8811c918c 100644 --- a/docs/plugins/netbox_journal_entry_module.rst +++ b/docs/plugins/netbox_journal_entry_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_journal_entry module -- Creates a journal entry @@ -42,7 +23,10 @@ netbox.netbox.netbox_journal_entry module -- Creates a journal entry .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-data/assigned_object_id: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` / :ansible-option-required:`required` + :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-data/assigned_object_type: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-data/created_by: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-data/kind: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -381,6 +414,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -391,14 +428,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -426,9 +467,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -460,9 +501,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -496,9 +537,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -534,9 +575,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -576,9 +617,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -662,12 +703,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -687,9 +729,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -727,9 +769,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -770,12 +812,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_l2vpn_module.rst b/docs/plugins/netbox_l2vpn_module.rst index bfe4afea9..1cb005521 100644 --- a/docs/plugins/netbox_l2vpn_module.rst +++ b/docs/plugins/netbox_l2vpn_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_l2vpn module -- Create, update or delete L2VPNs within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_l2vpn module -- Create, update or delete L2VPNs within NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/export_targets: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/identifier: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/import_targets: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -428,14 +473,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -452,6 +501,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -462,14 +515,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -486,6 +543,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -496,14 +557,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -531,9 +596,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -565,9 +630,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -601,9 +666,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -639,9 +704,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -681,9 +746,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -784,12 +849,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -809,9 +875,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -849,9 +915,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -892,12 +958,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_l2vpn_termination_module.rst b/docs/plugins/netbox_l2vpn_termination_module.rst index 116dbf85e..7a718c357 100644 --- a/docs/plugins/netbox_l2vpn_termination_module.rst +++ b/docs/plugins/netbox_l2vpn_termination_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_l2vpn_termination module -- Create, update or delete L2VPNs terminations within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_l2vpn_termination module -- Create, update or delete L2VPNs .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_termination_module__parameter-data/assigned_object_id: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` / :ansible-option-required:`required` + :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_termination_module__parameter-data/assigned_object_type: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -254,6 +255,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_termination_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -264,14 +269,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -288,6 +297,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_termination_module__parameter-data/l2vpn: .. rst-class:: ansible-option-title @@ -298,14 +311,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` / :ansible-option-required:`required` + :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -322,6 +339,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_l2vpn_termination_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -332,14 +353,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -367,9 +392,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -401,9 +426,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -437,9 +462,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -475,9 +500,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -517,9 +542,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -609,12 +634,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -634,9 +660,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -674,9 +700,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -717,12 +743,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_location_module.rst b/docs/plugins/netbox_location_module.rst index acffe2006..366ff9452 100644 --- a/docs/plugins/netbox_location_module.rst +++ b/docs/plugins/netbox_location_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_location module -- Create, update or delete locations within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_location module -- Create, update or delete locations withi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/parent_location: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -386,6 +419,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -396,9 +433,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -407,6 +444,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -423,6 +464,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -433,9 +478,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.8.0` @@ -444,6 +489,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -471,9 +520,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -505,9 +554,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -541,9 +590,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -579,9 +628,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -621,9 +670,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -715,12 +764,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -740,9 +790,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -780,9 +830,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -823,12 +873,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_manufacturer_module.rst b/docs/plugins/netbox_manufacturer_module.rst index 57b4d0599..b162c04f5 100644 --- a/docs/plugins/netbox_manufacturer_module.rst +++ b/docs/plugins/netbox_manufacturer_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_manufacturer module -- Create or delete manufacturers within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_manufacturer module -- Create or delete manufacturers withi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_manufacturer_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_manufacturer_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_manufacturer_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_manufacturer_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -318,6 +335,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_manufacturer_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -328,9 +349,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -339,6 +360,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -366,9 +391,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -400,9 +425,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -436,9 +461,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -474,9 +499,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -516,9 +541,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -599,12 +624,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -624,9 +650,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -664,9 +690,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -707,12 +733,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_module_type_module.rst b/docs/plugins/netbox_module_type_module.rst index 316f29773..c1b65065f 100644 --- a/docs/plugins/netbox_module_type_module.rst +++ b/docs/plugins/netbox_module_type_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_module_type module -- Create, update or delete module types within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_module_type module -- Create, update or delete module types .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/manufacturer: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/model: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/part_number: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -381,6 +414,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/weight: .. rst-class:: ansible-option-title @@ -391,14 +428,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`float` + :ansible-option-type:`float` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -415,6 +456,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-data/weight_unit: .. rst-class:: ansible-option-title @@ -425,9 +470,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -436,6 +481,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -473,9 +522,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -507,9 +556,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -543,9 +592,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -581,9 +630,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -623,9 +672,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -717,12 +766,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -742,9 +792,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -782,9 +832,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -825,12 +875,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_platform_module.rst b/docs/plugins/netbox_platform_module.rst index a57364964..a7fd21759 100644 --- a/docs/plugins/netbox_platform_module.rst +++ b/docs/plugins/netbox_platform_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_platform module -- Create or delete platforms within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_platform module -- Create or delete platforms within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/config_template: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.16.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -235,6 +232,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -251,6 +252,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -261,14 +266,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/manufacturer: .. rst-class:: ansible-option-title @@ -295,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -319,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -329,14 +350,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -353,6 +378,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/napalm_args: .. rst-class:: ansible-option-title @@ -363,14 +392,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -387,6 +420,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/napalm_driver: .. rst-class:: ansible-option-title @@ -397,14 +434,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -421,6 +462,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -431,14 +476,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -457,6 +506,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -467,9 +520,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -478,6 +531,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -505,9 +562,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -539,9 +596,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -575,9 +632,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -613,9 +670,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -655,9 +712,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -759,12 +816,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -784,9 +842,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -824,9 +882,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -867,12 +925,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_power_feed_module.rst b/docs/plugins/netbox_power_feed_module.rst index 517d58de1..25e68e30c 100644 --- a/docs/plugins/netbox_power_feed_module.rst +++ b/docs/plugins/netbox_power_feed_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_power_feed module -- Create, update or delete power feeds within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_power_feed module -- Create, update or delete power feeds w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/amperage: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -289,9 +302,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -300,6 +313,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/max_utilization: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/phase: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -426,6 +467,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/power_panel: .. rst-class:: ansible-option-title @@ -436,14 +481,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -460,6 +509,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/rack: .. rst-class:: ansible-option-title @@ -470,14 +523,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -494,6 +551,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -504,14 +565,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -538,6 +603,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/supply: .. rst-class:: ansible-option-title @@ -548,14 +617,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -580,6 +653,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -590,14 +667,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -614,6 +695,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -624,14 +709,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -656,6 +745,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-data/voltage: .. rst-class:: ansible-option-title @@ -666,14 +759,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -701,9 +798,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -735,9 +832,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -771,9 +868,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -809,9 +906,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -851,9 +948,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -953,12 +1050,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -978,9 +1076,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1018,9 +1116,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1061,12 +1159,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_power_outlet_module.rst b/docs/plugins/netbox_power_outlet_module.rst index c3f79517d..cc2155a48 100644 --- a/docs/plugins/netbox_power_outlet_module.rst +++ b/docs/plugins/netbox_power_outlet_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_power_outlet module -- Create, update or delete power outlets within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_power_outlet module -- Create, update or delete power outle .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-data/feed_leg: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -288,6 +297,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -298,14 +311,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -322,6 +339,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-data/power_port: .. rst-class:: ansible-option-title @@ -332,14 +353,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -356,6 +381,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -366,14 +395,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -390,6 +423,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -400,14 +437,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -495,9 +536,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -529,9 +570,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -565,9 +606,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -603,9 +644,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -645,9 +686,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -743,12 +784,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -768,9 +810,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -808,9 +850,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -851,12 +893,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_power_outlet_template_module.rst b/docs/plugins/netbox_power_outlet_template_module.rst index 3886924f5..3e17dded5 100644 --- a/docs/plugins/netbox_power_outlet_template_module.rst +++ b/docs/plugins/netbox_power_outlet_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_power_outlet_template module -- Create, update or delete power outlet templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_power_outlet_template module -- Create, update or delete po .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_template_module__parameter-data/feed_leg: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -254,6 +255,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -264,14 +269,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -288,6 +297,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_template_module__parameter-data/power_port_template: .. rst-class:: ansible-option-title @@ -298,14 +311,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -322,6 +339,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_outlet_template_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -332,14 +353,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -427,9 +452,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -461,9 +486,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -497,9 +522,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -535,9 +560,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -577,9 +602,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -674,12 +699,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -699,9 +725,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -739,9 +765,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -782,12 +808,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_power_panel_module.rst b/docs/plugins/netbox_power_panel_module.rst index 2f72024da..4ce4ead6e 100644 --- a/docs/plugins/netbox_power_panel_module.rst +++ b/docs/plugins/netbox_power_panel_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_power_panel module -- Create, update or delete power panels within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_power_panel module -- Create, update or delete power panels .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -235,6 +232,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -251,6 +252,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -261,9 +266,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -272,6 +277,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -288,6 +297,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/location: .. rst-class:: ansible-option-title @@ -298,9 +311,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.1.0` @@ -309,6 +322,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -325,6 +342,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -335,14 +356,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -359,6 +384,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/rack_group: .. rst-class:: ansible-option-title @@ -369,14 +398,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -395,6 +428,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -405,14 +442,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -429,6 +470,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -439,9 +484,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -450,6 +495,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -477,9 +526,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -511,9 +560,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -547,9 +596,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -585,9 +634,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -627,9 +676,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -732,12 +781,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -757,9 +807,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -797,9 +847,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -840,12 +890,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_power_port_module.rst b/docs/plugins/netbox_power_port_module.rst index 1d123f132..9172b6cd6 100644 --- a/docs/plugins/netbox_power_port_module.rst +++ b/docs/plugins/netbox_power_port_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_power_port module -- Create, update or delete power ports within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_power_port module -- Create, update or delete power ports w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/allocated_draw: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/maximum_draw: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -381,6 +414,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -391,14 +428,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -532,9 +573,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -566,9 +607,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -602,9 +643,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -640,9 +681,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -682,9 +723,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -780,12 +821,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -805,9 +847,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -845,9 +887,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -888,12 +930,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_power_port_template_module.rst b/docs/plugins/netbox_power_port_template_module.rst index 51c2d2c94..566ad28d6 100644 --- a/docs/plugins/netbox_power_port_template_module.rst +++ b/docs/plugins/netbox_power_port_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_power_port_template module -- Create, update or delete power port templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_power_port_template module -- Create, update or delete powe .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_template_module__parameter-data/allocated_draw: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -247,6 +248,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_template_module__parameter-data/maximum_draw: .. rst-class:: ansible-option-title @@ -257,14 +262,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -281,6 +290,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_template_module__parameter-data/module_type: .. rst-class:: ansible-option-title @@ -291,9 +304,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.16.0` @@ -302,6 +315,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -320,6 +337,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -330,14 +351,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -354,6 +379,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_power_port_template_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -364,14 +393,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -505,9 +538,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -539,9 +572,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -575,9 +608,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -613,9 +646,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -655,9 +688,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -763,12 +796,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -788,9 +822,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -828,9 +862,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -871,12 +905,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_prefix_module.rst b/docs/plugins/netbox_prefix_module.rst index bf70ace9d..b2dff30a0 100644 --- a/docs/plugins/netbox_prefix_module.rst +++ b/docs/plugins/netbox_prefix_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_prefix module -- Creates or removes prefixes from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_prefix module -- Creates or removes prefixes from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/family: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/is_pool: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -358,6 +383,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/mark_utilized: .. rst-class:: ansible-option-title @@ -368,9 +397,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in netbox.netbox 3.8.0` @@ -379,6 +408,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -403,6 +436,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/parent: .. rst-class:: ansible-option-title @@ -413,14 +450,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -437,6 +478,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/prefix: .. rst-class:: ansible-option-title @@ -447,14 +492,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -471,6 +520,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/prefix_length: .. rst-class:: ansible-option-title @@ -481,14 +534,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -507,6 +564,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/prefix_role: .. rst-class:: ansible-option-title @@ -517,14 +578,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -541,6 +606,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -551,14 +620,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -575,6 +648,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -585,14 +662,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -609,6 +690,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -619,14 +704,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -643,6 +732,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -653,14 +746,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -677,6 +774,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/vlan: .. rst-class:: ansible-option-title @@ -687,14 +788,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -711,6 +816,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-data/vrf: .. rst-class:: ansible-option-title @@ -721,14 +830,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -756,9 +869,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html @@ -798,9 +911,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -832,9 +945,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -868,9 +981,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -906,9 +1019,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -948,9 +1061,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1094,12 +1207,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1119,9 +1233,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1159,9 +1273,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1203,12 +1317,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_provider_module.rst b/docs/plugins/netbox_provider_module.rst index f6e10d900..18baee358 100644 --- a/docs/plugins/netbox_provider_module.rst +++ b/docs/plugins/netbox_provider_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_provider module -- Create, update or delete providers within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_provider module -- Create, update or delete providers withi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/account: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/admin_contact: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/asn: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -357,9 +386,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -368,6 +397,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/noc_contact: .. rst-class:: ansible-option-title @@ -428,14 +473,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -452,6 +501,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/portal_url: .. rst-class:: ansible-option-title @@ -462,14 +515,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -486,6 +543,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -496,14 +557,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -531,9 +596,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -565,9 +630,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -601,9 +666,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -639,9 +704,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -681,9 +746,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -778,12 +843,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -803,9 +869,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -843,9 +909,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -886,12 +952,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_provider_network_module.rst b/docs/plugins/netbox_provider_network_module.rst index d7f655c2f..f1a2b19cb 100644 --- a/docs/plugins/netbox_provider_network_module.rst +++ b/docs/plugins/netbox_provider_network_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_provider_network module -- Create, update or delete provider networks within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_provider_network module -- Create, update or delete provide .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-data/provider: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-data/service_id: .. rst-class:: ansible-option-title @@ -357,9 +386,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -368,6 +397,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -429,9 +470,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -463,9 +504,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -499,9 +540,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -537,9 +578,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -579,9 +620,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -675,12 +716,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -700,9 +742,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -740,9 +782,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -783,12 +825,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_rack_group_module.rst b/docs/plugins/netbox_rack_group_module.rst index 3f39d2041..bcc012d38 100644 --- a/docs/plugins/netbox_rack_group_module.rst +++ b/docs/plugins/netbox_rack_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_rack_group module -- Create, update or delete racks groups within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_rack_group module -- Create, update or delete racks groups .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_group_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_group_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_group_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -292,9 +301,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -326,9 +335,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -362,9 +371,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -400,9 +409,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -442,9 +451,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -527,12 +536,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -552,9 +562,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -592,9 +602,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -635,12 +645,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_rack_module.rst b/docs/plugins/netbox_rack_module.rst index 456280375..2e1b00d40 100644 --- a/docs/plugins/netbox_rack_module.rst +++ b/docs/plugins/netbox_rack_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_rack module -- Create, update or delete racks within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_rack module -- Create, update or delete racks within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/asset_tag: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/desc_units: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -321,6 +338,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -331,9 +352,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -342,6 +363,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -358,6 +383,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/facility_id: .. rst-class:: ansible-option-title @@ -368,14 +397,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -392,6 +425,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/location: .. rst-class:: ansible-option-title @@ -402,9 +439,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.1.0` @@ -413,6 +450,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -429,6 +470,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/max_weight: .. rst-class:: ansible-option-title @@ -439,9 +484,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -450,6 +495,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -466,6 +515,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/mounting_depth: .. rst-class:: ansible-option-title @@ -476,9 +529,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -487,6 +540,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -503,6 +560,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -513,14 +574,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -537,6 +602,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/outer_depth: .. rst-class:: ansible-option-title @@ -547,14 +616,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -571,6 +644,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/outer_unit: .. rst-class:: ansible-option-title @@ -581,14 +658,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -613,6 +694,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/outer_width: .. rst-class:: ansible-option-title @@ -623,14 +708,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -647,6 +736,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/rack_group: .. rst-class:: ansible-option-title @@ -657,14 +750,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -683,6 +780,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/rack_role: .. rst-class:: ansible-option-title @@ -693,14 +794,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -717,6 +822,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/serial: .. rst-class:: ansible-option-title @@ -727,14 +836,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -751,6 +864,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -761,14 +878,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -785,6 +906,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -795,14 +920,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -819,6 +948,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -829,14 +962,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -853,6 +990,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -863,14 +1004,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -887,6 +1032,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -897,14 +1046,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -932,6 +1085,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/u_height: .. rst-class:: ansible-option-title @@ -942,14 +1099,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -966,6 +1127,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/weight: .. rst-class:: ansible-option-title @@ -976,9 +1141,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`float` + :ansible-option-type:`float` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -987,6 +1152,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1003,6 +1172,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/weight_unit: .. rst-class:: ansible-option-title @@ -1013,9 +1186,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -1024,6 +1197,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1050,6 +1227,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-data/width: .. rst-class:: ansible-option-title @@ -1060,14 +1241,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1105,9 +1290,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -1139,9 +1324,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -1175,9 +1360,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -1213,9 +1398,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1255,9 +1440,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1359,12 +1544,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1384,9 +1570,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1424,9 +1610,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1467,12 +1653,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_rack_role_module.rst b/docs/plugins/netbox_rack_role_module.rst index b16bf8227..ec8c5cefd 100644 --- a/docs/plugins/netbox_rack_role_module.rst +++ b/docs/plugins/netbox_rack_role_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_rack_role module -- Create, update or delete racks roles within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_rack_role module -- Create, update or delete racks roles wi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_role_module__parameter-data/color: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_role_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,9 +218,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -232,6 +229,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -239,6 +240,51 @@ Parameters Must exist in NetBox + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_rack_role_module__parameter-data/description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in netbox.netbox 3.17.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Description of the rack role + + .. raw:: html
@@ -248,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_role_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -258,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_role_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -292,14 +350,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -318,6 +380,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rack_role_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -328,9 +394,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -339,6 +405,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -366,9 +436,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -400,9 +470,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -436,9 +506,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -474,9 +544,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -516,9 +586,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -580,6 +650,16 @@ Examples color: FFFFFF state: present + - name: Create rack role within NetBox with a description + netbox.netbox.netbox_rack_role: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: Test rack role + color: FFFFFF + description: This is a test rack role + state: present + - name: Delete rack role within netbox netbox.netbox.netbox_rack_role: netbox_url: http://netbox.local @@ -600,12 +680,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -625,9 +706,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -665,9 +746,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -708,12 +789,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_rear_port_module.rst b/docs/plugins/netbox_rear_port_module.rst index 2ae3b4691..cee13bdfa 100644 --- a/docs/plugins/netbox_rear_port_module.rst +++ b/docs/plugins/netbox_rear_port_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_rear_port module -- Create, update or delete rear ports within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_rear_port module -- Create, update or delete rear ports wit .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -255,9 +260,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -266,6 +271,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-data/positions: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -449,9 +490,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -483,9 +524,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -519,9 +560,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -557,9 +598,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -599,9 +640,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -698,12 +739,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -723,9 +765,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -763,9 +805,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -806,12 +848,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_rear_port_template_module.rst b/docs/plugins/netbox_rear_port_template_module.rst index e1cb6d42d..0299ae69d 100644 --- a/docs/plugins/netbox_rear_port_template_module.rst +++ b/docs/plugins/netbox_rear_port_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_rear_port_template module -- Create, update or delete rear port templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_rear_port_template module -- Create, update or delete rear .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_template_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_template_module__parameter-data/device_type: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_template_module__parameter-data/label: .. rst-class:: ansible-option-title @@ -258,9 +263,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -269,6 +274,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -295,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -319,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_template_module__parameter-data/positions: .. rst-class:: ansible-option-title @@ -329,14 +350,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -353,6 +378,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rear_port_template_module__parameter-data/type: .. rst-class:: ansible-option-title @@ -363,14 +392,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,9 +451,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -452,9 +485,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -488,9 +521,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -526,9 +559,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -568,9 +601,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -666,12 +699,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -691,9 +725,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -731,9 +765,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -774,12 +808,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_region_module.rst b/docs/plugins/netbox_region_module.rst index 743475d5c..41f7498ea 100644 --- a/docs/plugins/netbox_region_module.rst +++ b/docs/plugins/netbox_region_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_region module -- Creates or removes regions from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_region module -- Creates or removes regions from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_region_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.5.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_region_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.5.0` @@ -235,6 +232,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -251,6 +252,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_region_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -261,14 +266,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_region_module__parameter-data/parent_region: .. rst-class:: ansible-option-title @@ -295,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -319,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_region_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -329,14 +350,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -355,6 +380,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_region_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -365,9 +394,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.5.0` @@ -376,6 +405,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -403,9 +436,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -437,9 +470,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -473,9 +506,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -511,9 +544,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -553,9 +586,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -635,12 +668,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -660,9 +694,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -700,9 +734,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -743,12 +777,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_rir_module.rst b/docs/plugins/netbox_rir_module.rst index 081405ec2..2f278b597 100644 --- a/docs/plugins/netbox_rir_module.rst +++ b/docs/plugins/netbox_rir_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_rir module -- Create, update or delete RIRs within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_rir module -- Create, update or delete RIRs within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rir_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rir_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rir_module__parameter-data/is_private: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -290,6 +299,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rir_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -300,14 +313,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -324,6 +341,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rir_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -334,14 +355,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -360,6 +385,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_rir_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -370,9 +399,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -381,6 +410,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -408,9 +441,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -442,9 +475,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -478,9 +511,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -516,9 +549,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -558,9 +591,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -650,12 +683,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -675,9 +709,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -715,9 +749,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -758,12 +792,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_route_target_module.rst b/docs/plugins/netbox_route_target_module.rst index 93ad2b4dc..7c0ee6a90 100644 --- a/docs/plugins/netbox_route_target_module.rst +++ b/docs/plugins/netbox_route_target_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_route_target module -- Creates or removes route targets from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_route_target module -- Creates or removes route targets fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_route_target_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_route_target_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_route_target_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_route_target_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_route_target_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_route_target_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -395,9 +428,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -429,9 +462,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -465,9 +498,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -503,9 +536,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -545,9 +578,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -649,12 +682,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -674,9 +708,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -714,9 +748,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -757,12 +791,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_service_module.rst b/docs/plugins/netbox_service_module.rst index 2fcf0b4d4..7c4ff7ba8 100644 --- a/docs/plugins/netbox_service_module.rst +++ b/docs/plugins/netbox_service_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_service module -- Creates or removes service from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_service module -- Creates or removes service from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/ipaddresses: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/port: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/ports: .. rst-class:: ansible-option-title @@ -428,14 +473,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` + :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -452,6 +501,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/protocol: .. rst-class:: ansible-option-title @@ -462,14 +515,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -486,6 +543,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -496,14 +557,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -520,6 +585,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-data/virtual_machine: .. rst-class:: ansible-option-title @@ -530,14 +599,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -565,9 +638,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -599,9 +672,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -635,9 +708,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -673,9 +746,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -715,9 +788,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -821,12 +894,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_service_template_module.rst b/docs/plugins/netbox_service_template_module.rst index b64de13ec..13bc0ba98 100644 --- a/docs/plugins/netbox_service_template_module.rst +++ b/docs/plugins/netbox_service_template_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_service_template module -- Create, update or delete service templates within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_service_template module -- Create, update or delete service .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-data/ports: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` + :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-data/protocol: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -390,6 +423,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -400,14 +437,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -435,9 +476,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -469,9 +510,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -505,9 +546,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -543,9 +584,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -585,9 +626,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -683,12 +724,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -708,9 +750,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -748,9 +790,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -791,12 +833,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_site_group_module.rst b/docs/plugins/netbox_site_group_module.rst index 510ff9616..90eb0f70c 100644 --- a/docs/plugins/netbox_site_group_module.rst +++ b/docs/plugins/netbox_site_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_site_group module -- Create, update, or delete site groups within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_site_group module -- Create, update, or delete site groups .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_group_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_group_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_group_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_group_module__parameter-data/parent_site_group: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_group_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -352,6 +377,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_group_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -362,9 +391,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -373,6 +402,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -400,9 +433,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -434,9 +467,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -470,9 +503,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -508,9 +541,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -550,9 +583,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -641,12 +674,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -666,9 +700,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -706,9 +740,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -749,12 +783,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_site_module.rst b/docs/plugins/netbox_site_module.rst index 633f2c5fc..d625a06a2 100644 --- a/docs/plugins/netbox_site_module.rst +++ b/docs/plugins/netbox_site_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_site module -- Creates or removes sites from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_site module -- Creates or removes sites from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/asn: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/contact_email: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/contact_name: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/contact_phone: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -381,6 +414,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -391,14 +428,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -415,6 +456,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/facility: .. rst-class:: ansible-option-title @@ -425,14 +470,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -449,6 +498,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/latitude: .. rst-class:: ansible-option-title @@ -459,14 +512,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`float` + :ansible-option-type:`float` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -483,6 +540,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/longitude: .. rst-class:: ansible-option-title @@ -493,14 +554,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`float` + :ansible-option-type:`float` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -517,6 +582,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -527,14 +596,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -551,6 +624,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/physical_address: .. rst-class:: ansible-option-title @@ -561,14 +638,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -585,6 +666,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/region: .. rst-class:: ansible-option-title @@ -595,14 +680,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -619,6 +708,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/shipping_address: .. rst-class:: ansible-option-title @@ -629,14 +722,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -653,6 +750,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/site_group: .. rst-class:: ansible-option-title @@ -663,9 +764,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.3.0` @@ -674,6 +775,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -690,6 +795,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -700,14 +809,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -724,6 +837,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -734,14 +851,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -758,6 +879,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -768,14 +893,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -792,6 +921,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -802,14 +935,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -826,6 +963,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-data/time_zone: .. rst-class:: ansible-option-title @@ -836,14 +977,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -871,9 +1016,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -905,9 +1050,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -941,9 +1086,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -979,9 +1124,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1021,9 +1166,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1128,12 +1273,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1153,9 +1299,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1193,9 +1339,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1236,12 +1382,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_tag_module.rst b/docs/plugins/netbox_tag_module.rst index 78d26b41a..e49f5b968 100644 --- a/docs/plugins/netbox_tag_module.rst +++ b/docs/plugins/netbox_tag_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_tag module -- Creates or removes tags from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_tag module -- Creates or removes tags from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tag_module__parameter-data/color: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tag_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tag_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tag_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -326,9 +343,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -360,9 +377,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -396,9 +413,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -434,9 +451,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -476,9 +493,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -564,12 +581,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -589,9 +607,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -629,9 +647,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -672,12 +690,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_tenant_group_module.rst b/docs/plugins/netbox_tenant_group_module.rst index 7c543d63d..f91fd8ae1 100644 --- a/docs/plugins/netbox_tenant_group_module.rst +++ b/docs/plugins/netbox_tenant_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_tenant_group module -- Creates or removes tenant groups from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_tenant_group module -- Creates or removes tenant groups fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_group_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_group_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_group_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_group_module__parameter-data/parent_tenant_group: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_group_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_group_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -360,9 +389,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -371,6 +400,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -398,9 +431,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -432,9 +465,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -468,9 +501,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -506,9 +539,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -548,9 +581,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -632,12 +665,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -657,9 +691,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -697,9 +731,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -740,12 +774,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_tenant_module.rst b/docs/plugins/netbox_tenant_module.rst index 307034043..b4f26f78f 100644 --- a/docs/plugins/netbox_tenant_module.rst +++ b/docs/plugins/netbox_tenant_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_tenant module -- Creates or removes tenants from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_tenant module -- Creates or removes tenants from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -381,6 +414,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-data/tenant_group: .. rst-class:: ansible-option-title @@ -391,14 +428,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -426,9 +467,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -460,9 +501,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -496,9 +537,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -534,9 +575,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -576,9 +617,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -674,12 +715,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -699,9 +741,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -739,9 +781,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -782,12 +824,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_virtual_chassis_module.rst b/docs/plugins/netbox_virtual_chassis_module.rst index 34482f484..17aa18299 100644 --- a/docs/plugins/netbox_virtual_chassis_module.rst +++ b/docs/plugins/netbox_virtual_chassis_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_virtual_chassis module -- Create, update or delete virtual chassis within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_virtual_chassis module -- Create, update or delete virtual .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,9 +263,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -269,6 +274,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -285,6 +294,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-data/domain: .. rst-class:: ansible-option-title @@ -295,14 +308,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -319,6 +336,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-data/master: .. rst-class:: ansible-option-title @@ -329,14 +350,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -353,6 +378,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -363,14 +392,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -387,6 +420,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -397,14 +434,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -432,9 +473,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -466,9 +507,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -502,9 +543,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -540,9 +581,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -582,9 +623,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -675,12 +716,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -700,9 +742,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -740,9 +782,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -783,12 +825,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_virtual_disk_module.rst b/docs/plugins/netbox_virtual_disk_module.rst new file mode 100644 index 000000000..3112d6013 --- /dev/null +++ b/docs/plugins/netbox_virtual_disk_module.rst @@ -0,0 +1,772 @@ + +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.7.0 + +.. Anchors + +.. _ansible_collections.netbox.netbox.netbox_virtual_disk_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +netbox.netbox.netbox_virtual_disk module -- Creates or removes disks from virtual machines in NetBox +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. + You need further requirements to be able to use this module, + see :ref:`Requirements ` for details. + + To use it in a playbook, specify: :code:`netbox.netbox.netbox_virtual_disk`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in netbox.netbox 3.17.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Creates or removes disks from virtual machines in NetBox + + +.. Aliases + + +.. Requirements + +.. _ansible_collections.netbox.netbox.netbox_virtual_disk_module_requirements: + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- pynetbox + + + + + + +.. Options + +Parameters +---------- + +.. tabularcolumns:: \X{1}{3}\X{2}{3} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-cert: + + .. rst-class:: ansible-option-title + + **cert** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Certificate path + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-data: + + .. rst-class:: ansible-option-title + + **data** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Defines the vm disk configuration + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-data/custom_fields: + + .. rst-class:: ansible-option-title + + **custom_fields** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Must exist in NetBox + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-data/description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The description of the disk + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-data/name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Name of the disk to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-data/size: + + .. rst-class:: ansible-option-title + + **size** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`integer` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The size (in GB) of the disk + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-data/tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Any tags that the virtual disk may need to be associated with + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-data/virtual_machine: + + .. rst-class:: ansible-option-title + + **virtual_machine** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Name of the virtual machine the disk will be associated with (case-sensitive) + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-netbox_token: + + .. rst-class:: ansible-option-title + + **netbox_token** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The NetBox API token. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-netbox_url: + + .. rst-class:: ansible-option-title + + **netbox_url** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The URL of the NetBox instance. + + Must be accessible by the Ansible control host. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that are defined + + in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The state of the object. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` + - :ansible-option-choices-entry:`"absent"` + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If \ :literal:`no`\ , SSL certificates will not be validated. + + This should only be used on personally controlled sites using a self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`true` + + .. raw:: html + +
+ + +.. Attributes + + +.. Notes + +Notes +----- + +.. note:: + - Tags should be defined as a YAML list + - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: "Test NetBox virtual disk module" + connection: local + hosts: localhost + gather_facts: False + tasks: + - name: Create virtual disk + netbox_virtual_disk: + data: + virtual_machine: test100 + name: disk0 + size: 50 + state: present + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. tabularcolumns:: \X{1}{3}\X{2}{3} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. 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.netbox.netbox.netbox_virtual_disk_module__return-virtual_disk: + + .. rst-class:: ansible-option-title + + **virtual_disk** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within NetBox + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Martin Rødvand (@rodvand) + + + +.. Extra links + +Collection links +~~~~~~~~~~~~~~~~ + +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true + + +.. Parsing errors + diff --git a/docs/plugins/netbox_virtual_machine_module.rst b/docs/plugins/netbox_virtual_machine_module.rst index 9cafdf474..71a95fbca 100644 --- a/docs/plugins/netbox_virtual_machine_module.rst +++ b/docs/plugins/netbox_virtual_machine_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_virtual_machine module -- Create, update or delete virtual\_machines within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_virtual_machine module -- Create, update or delete virtual\ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/cluster: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -236,6 +237,51 @@ Parameters Comments of the virtual machine + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/config_template: + + .. rst-class:: ansible-option-title + + **config_template** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + :ansible-option-versionadded:`added in netbox.netbox 3.17.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Configuration template + + .. raw:: html
@@ -245,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -255,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -289,9 +347,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -300,6 +358,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +378,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/device: .. rst-class:: ansible-option-title @@ -326,9 +392,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.9.0` @@ -337,6 +403,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -353,6 +423,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/disk: .. rst-class:: ansible-option-title @@ -363,14 +437,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -387,6 +465,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/local_context_data: .. rst-class:: ansible-option-title @@ -397,14 +479,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -421,6 +507,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/memory: .. rst-class:: ansible-option-title @@ -431,14 +521,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -455,6 +549,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -465,14 +563,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -489,6 +591,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/platform: .. rst-class:: ansible-option-title @@ -499,14 +605,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -523,6 +633,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/primary_ip4: .. rst-class:: ansible-option-title @@ -533,14 +647,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -557,6 +675,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/primary_ip6: .. rst-class:: ansible-option-title @@ -567,14 +689,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -591,6 +717,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -601,14 +731,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -625,6 +759,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -635,14 +773,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -659,6 +801,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -669,14 +815,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -693,6 +843,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -703,14 +857,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -727,6 +885,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/vcpus: .. rst-class:: ansible-option-title @@ -737,14 +899,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`float` + :ansible-option-type:`float` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -761,6 +927,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-data/virtual_machine_role: .. rst-class:: ansible-option-title @@ -771,14 +941,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -806,9 +980,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -840,9 +1014,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -876,9 +1050,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -914,9 +1088,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -956,9 +1130,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -1063,12 +1237,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1088,9 +1263,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1128,9 +1303,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1171,12 +1346,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_vlan_group_module.rst b/docs/plugins/netbox_vlan_group_module.rst index c6e393434..3a3714480 100644 --- a/docs/plugins/netbox_vlan_group_module.rst +++ b/docs/plugins/netbox_vlan_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_vlan_group module -- Create, update or delete vlans groups within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_vlan_group module -- Create, update or delete vlans groups .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.1.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,9 +221,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.1.0` @@ -235,6 +232,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -251,6 +252,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/max_vid: .. rst-class:: ansible-option-title @@ -261,9 +266,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -272,6 +277,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -288,6 +297,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/min_vid: .. rst-class:: ansible-option-title @@ -298,9 +311,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -309,6 +322,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -325,6 +342,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -335,14 +356,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -359,6 +384,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/scope: .. rst-class:: ansible-option-title @@ -369,9 +398,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.1.0` @@ -380,6 +409,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -396,6 +429,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/scope_type: .. rst-class:: ansible-option-title @@ -406,9 +443,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.1.0` @@ -417,6 +454,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -446,6 +487,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -456,14 +501,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -482,6 +531,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -492,14 +545,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -518,6 +575,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -528,9 +589,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -539,6 +600,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -566,9 +631,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -600,9 +665,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -636,9 +701,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -674,9 +739,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -716,9 +781,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -810,12 +875,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -835,9 +901,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -875,9 +941,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -918,12 +984,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_vlan_module.rst b/docs/plugins/netbox_vlan_module.rst index fa0b14745..d92f05cc8 100644 --- a/docs/plugins/netbox_vlan_module.rst +++ b/docs/plugins/netbox_vlan_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_vlan module -- Create, update or delete vlans within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_vlan module -- Create, update or delete vlans within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -316,6 +333,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/site: .. rst-class:: ansible-option-title @@ -326,14 +347,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -350,6 +375,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -360,14 +389,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -384,6 +417,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -394,14 +431,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -418,6 +459,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -428,14 +473,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -452,6 +501,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/vid: .. rst-class:: ansible-option-title @@ -462,14 +515,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -486,6 +543,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/vlan_group: .. rst-class:: ansible-option-title @@ -496,14 +557,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -520,6 +585,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-data/vlan_role: .. rst-class:: ansible-option-title @@ -530,14 +599,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -565,9 +638,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -599,9 +672,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -635,9 +708,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -673,9 +746,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -715,9 +788,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -796,7 +869,7 @@ Examples name: Test VLAN vid: 400 site: Test Site - group: Test VLAN Group + vlan_group: Test VLAN Group tenant: Test Tenant status: Deprecated vlan_role: Test VLAN Role @@ -817,12 +890,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -842,9 +916,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -882,9 +956,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -925,12 +999,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_vm_interface_module.rst b/docs/plugins/netbox_vm_interface_module.rst index f9c06738c..50a607ad6 100644 --- a/docs/plugins/netbox_vm_interface_module.rst +++ b/docs/plugins/netbox_vm_interface_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_vm_interface module -- Creates or removes interfaces from virtual machines in NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_vm_interface module -- Creates or removes interfaces from v .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in netbox.netbox 3.4.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/enabled: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -290,6 +299,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/mac_address: .. rst-class:: ansible-option-title @@ -300,14 +313,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -324,6 +341,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/mode: .. rst-class:: ansible-option-title @@ -334,14 +355,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -358,6 +383,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/mtu: .. rst-class:: ansible-option-title @@ -368,14 +397,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -392,6 +425,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -402,14 +439,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -426,6 +467,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/parent_vm_interface: .. rst-class:: ansible-option-title @@ -436,9 +481,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.2.0` @@ -447,6 +492,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -463,6 +512,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/tagged_vlans: .. rst-class:: ansible-option-title @@ -473,14 +526,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -497,6 +554,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -507,14 +568,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -531,6 +596,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/untagged_vlan: .. rst-class:: ansible-option-title @@ -541,14 +610,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -565,6 +638,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/virtual_machine: .. rst-class:: ansible-option-title @@ -575,14 +652,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -599,6 +680,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/vm_bridge: .. rst-class:: ansible-option-title @@ -609,9 +694,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.6.0` @@ -620,6 +705,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -636,6 +725,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-data/vrf: .. rst-class:: ansible-option-title @@ -646,9 +739,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` :ansible-option-versionadded:`added in netbox.netbox 3.7.0` @@ -657,6 +750,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -684,9 +781,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -718,9 +815,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -754,9 +851,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -792,9 +889,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -834,9 +931,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -957,12 +1054,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -982,9 +1080,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1022,9 +1120,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1065,12 +1163,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_vrf_module.rst b/docs/plugins/netbox_vrf_module.rst index f72c99164..4f9ac686c 100644 --- a/docs/plugins/netbox_vrf_module.rst +++ b/docs/plugins/netbox_vrf_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_vrf module -- Create, update or delete vrfs within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_vrf module -- Create, update or delete vrfs within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -187,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -198,6 +187,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -214,6 +207,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -224,14 +221,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -248,6 +249,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -258,14 +263,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -282,6 +291,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/enforce_unique: .. rst-class:: ansible-option-title @@ -292,14 +305,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -324,6 +341,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/export_targets: .. rst-class:: ansible-option-title @@ -334,9 +355,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` :ansible-option-versionadded:`added in netbox.netbox 2.0.0` @@ -345,6 +366,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -361,6 +386,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/import_targets: .. rst-class:: ansible-option-title @@ -371,9 +400,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` :ansible-option-versionadded:`added in netbox.netbox 2.0.0` @@ -382,6 +411,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -398,6 +431,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -408,14 +445,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -432,6 +473,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/rd: .. rst-class:: ansible-option-title @@ -442,14 +487,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -466,6 +515,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -476,14 +529,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -500,6 +557,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-data/tenant: .. rst-class:: ansible-option-title @@ -510,14 +571,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -545,9 +610,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -579,9 +644,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -615,9 +680,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -653,9 +718,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -695,9 +760,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -796,12 +861,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -821,9 +887,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -861,9 +927,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -904,12 +970,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_webhook_module.rst b/docs/plugins/netbox_webhook_module.rst index 65cdb9475..bac05070b 100644 --- a/docs/plugins/netbox_webhook_module.rst +++ b/docs/plugins/netbox_webhook_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_webhook module -- Creates, updates or deletes webhook configuration within NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_webhook module -- Creates, updates or deletes webhook confi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/additional_headers: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/body_template: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/ca_file_path: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/conditions: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/content_types: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -349,6 +374,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/enabled: .. rst-class:: ansible-option-title @@ -359,14 +388,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -391,6 +424,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/http_content_type: .. rst-class:: ansible-option-title @@ -401,14 +438,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -425,6 +466,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/http_method: .. rst-class:: ansible-option-title @@ -435,14 +480,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -459,6 +508,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -469,14 +522,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -493,6 +550,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/payload_url: .. rst-class:: ansible-option-title @@ -503,14 +564,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -529,6 +594,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/secret: .. rst-class:: ansible-option-title @@ -539,14 +608,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -563,6 +636,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/ssl_verification: .. rst-class:: ansible-option-title @@ -573,14 +650,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -605,6 +686,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/type_create: .. rst-class:: ansible-option-title @@ -615,14 +700,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -647,6 +736,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/type_delete: .. rst-class:: ansible-option-title @@ -657,14 +750,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -689,6 +786,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-data/type_update: .. rst-class:: ansible-option-title @@ -699,14 +800,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -742,9 +847,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -776,9 +881,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -812,9 +917,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -850,9 +955,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -892,9 +997,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -995,12 +1100,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1020,9 +1126,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -1060,9 +1166,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -1103,12 +1209,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_wireless_lan_group_module.rst b/docs/plugins/netbox_wireless_lan_group_module.rst index 40d0bd37d..95e066f22 100644 --- a/docs/plugins/netbox_wireless_lan_group_module.rst +++ b/docs/plugins/netbox_wireless_lan_group_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_wireless_lan_group module -- Creates or removes Wireless LAN Groups from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_wireless_lan_group module -- Creates or removes Wireless LA .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_group_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -211,6 +204,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_group_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -221,14 +218,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -245,6 +246,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_group_module__parameter-data/name: .. rst-class:: ansible-option-title @@ -255,14 +260,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -279,6 +288,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_group_module__parameter-data/parent_wireless_lan_group: .. rst-class:: ansible-option-title @@ -289,14 +302,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -313,6 +330,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_group_module__parameter-data/slug: .. rst-class:: ansible-option-title @@ -323,14 +344,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -347,6 +372,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_group_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -357,14 +386,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -392,9 +425,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -426,9 +459,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -462,9 +495,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -500,9 +533,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -542,9 +575,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -636,12 +669,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -661,9 +695,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -701,9 +735,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -744,12 +778,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_wireless_lan_module.rst b/docs/plugins/netbox_wireless_lan_module.rst index f44b643de..63adcd848 100644 --- a/docs/plugins/netbox_wireless_lan_module.rst +++ b/docs/plugins/netbox_wireless_lan_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_wireless_lan module -- Creates or removes Wireless LANs from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_wireless_lan module -- Creates or removes Wireless LANs fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/auth_cipher: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -220,6 +213,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/auth_psk: .. rst-class:: ansible-option-title @@ -230,14 +227,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -254,6 +255,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/auth_type: .. rst-class:: ansible-option-title @@ -264,14 +269,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -298,6 +307,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -308,9 +321,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -319,6 +332,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -335,6 +352,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -345,14 +366,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -369,6 +394,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -379,14 +408,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -403,6 +436,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/ssid: .. rst-class:: ansible-option-title @@ -413,14 +450,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -437,6 +478,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -447,14 +492,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -471,6 +520,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -481,14 +534,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -505,6 +562,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/vlan: .. rst-class:: ansible-option-title @@ -515,14 +576,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -539,6 +604,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-data/wireless_lan_group: .. rst-class:: ansible-option-title @@ -549,14 +618,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -584,9 +657,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -618,9 +691,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -654,9 +727,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -692,9 +765,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -734,9 +807,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -831,12 +904,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -856,9 +930,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -896,9 +970,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -939,12 +1013,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/netbox_wireless_link_module.rst b/docs/plugins/netbox_wireless_link_module.rst index 1b66c0e74..597ac26f5 100644 --- a/docs/plugins/netbox_wireless_link_module.rst +++ b/docs/plugins/netbox_wireless_link_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. role:: ansible-attribute-support-label -.. role:: ansible-attribute-support-property -.. role:: ansible-attribute-support-full -.. 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-default-mark -.. role:: ansible-option-default-bold -.. role:: ansible-option-configuration -.. role:: ansible-option-returned-bold -.. role:: ansible-option-sample-bold +.. meta:: + :antsibull-docs: 2.7.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title netbox.netbox.netbox_wireless_link module -- Creates or removes Wireless links from NetBox @@ -42,7 +23,10 @@ netbox.netbox.netbox_wireless_link module -- Creates or removes Wireless links f .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.16.0). + This module is part of the `netbox.netbox collection `_ (version 3.17.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. You need further requirements to be able to use this module, @@ -94,12 +78,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -119,9 +104,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -153,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html @@ -177,6 +162,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/auth_cipher: .. rst-class:: ansible-option-title @@ -187,14 +176,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -220,6 +213,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/auth_psk: .. rst-class:: ansible-option-title @@ -230,14 +227,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -254,6 +255,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/auth_type: .. rst-class:: ansible-option-title @@ -264,14 +269,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -298,6 +307,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/comments: .. rst-class:: ansible-option-title @@ -308,9 +321,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in netbox.netbox 3.10.0` @@ -319,6 +332,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -335,6 +352,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/custom_fields: .. rst-class:: ansible-option-title @@ -345,14 +366,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -369,6 +394,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/description: .. rst-class:: ansible-option-title @@ -379,14 +408,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -403,6 +436,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/interface_a: .. rst-class:: ansible-option-title @@ -413,14 +450,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -437,6 +478,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/interface_b: .. rst-class:: ansible-option-title @@ -447,14 +492,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` / :ansible-option-required:`required` + :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -471,6 +520,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/ssid: .. rst-class:: ansible-option-title @@ -481,14 +534,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -505,6 +562,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/status: .. rst-class:: ansible-option-title @@ -515,14 +576,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -548,6 +613,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-data/tags: .. rst-class:: ansible-option-title @@ -558,14 +627,18 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` .. raw:: html
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -593,9 +666,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -627,9 +700,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -663,9 +736,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -701,9 +774,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -743,9 +816,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`any` + :ansible-option-type:`any` .. raw:: html @@ -856,12 +929,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -881,9 +955,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -921,9 +995,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -964,12 +1038,15 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true -

- Issue Tracker - Repository (Sources) -

.. Parsing errors diff --git a/docs/requirements.txt b/docs/requirements.txt index 45d9327a5..807fdc428 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ ansible antsibull==0.48.0 -sphinx==3.4.2 -Jinja2<3.1 +sphinx +Jinja2<3.2 sphinx_rtd_theme \ No newline at end of file diff --git a/galaxy.yml b/galaxy.yml index a8ca7fcc4..ab142029b 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -10,7 +10,7 @@ namespace: netbox name: netbox # The version of the collection. Must be compatible with semantic versioning -version: 3.16.0 +version: 3.17.0 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/meta/runtime.yml b/meta/runtime.yml index 45afe534c..1c3faae8c 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -81,6 +81,7 @@ action_groups: - netbox_vlan - netbox_vlan_group - netbox_vm_interface + - netbox_virtual_disk - netbox_vrf - netbox_webhook - netbox_wireless_lan diff --git a/plugins/lookup/nb_lookup.py b/plugins/lookup/nb_lookup.py index c3a5173b1..01e4d56aa 100644 --- a/plugins/lookup/nb_lookup.py +++ b/plugins/lookup/nb_lookup.py @@ -206,8 +206,6 @@ def get_endpoint(netbox, term): "job-results": {"endpoint": netbox.extras.job_results}, "journal-entries": {"endpoint": netbox.extras.journal_entries}, "locations": {"endpoint": netbox.dcim.locations}, - "l2vpn-terminations": {"endpoint": netbox.ipam.l2vpn_terminations}, - "l2vpns": {"endpoint": netbox.ipam.l2vpns}, "manufacturers": {"endpoint": netbox.dcim.manufacturers}, "module-bays": {"endpoint": netbox.dcim.module_bays}, "module-bay-templates": {"endpoint": netbox.dcim.module_bay_templates}, @@ -257,9 +255,10 @@ def get_endpoint(netbox, term): "webhooks": {"endpoint": netbox.extras.webhooks}, } - major, minor, patch = map(int, pynetbox.__version__.split(".")) + major, minor, patch = tuple(map(int, pynetbox.__version__.split("."))) + netbox_versiontuple = tuple(map(int, netbox.version.split("."))) - if major >= 6 and minor >= 4 and patch >= 0: + if (major, minor, patch) >= (6, 4): netbox_endpoint_map["wireless-lan-groups"] = { "endpoint": netbox.wireless.wireless_lan_groups } @@ -273,10 +272,6 @@ def get_endpoint(netbox, term): "endpoint": netbox.wireless.wireless_links } - if major < 7 and minor >= 0 and patch >= 1: - netbox_endpoint_map["secret-roles"] = {"endpoint": netbox.secrets.secret_roles} - netbox_endpoint_map["secrets"] = {"endpoint": netbox.secrets.secrets} - else: if "wireless" in term: Display().v( @@ -284,6 +279,34 @@ def get_endpoint(netbox, term): % (major, minor, patch) ) + if (major, minor, patch) < (7, 0, 1): + netbox_endpoint_map["secret-roles"] = {"endpoint": netbox.secrets.secret_roles} + netbox_endpoint_map["secrets"] = {"endpoint": netbox.secrets.secrets} + + if netbox_versiontuple >= (3, 7): + if (major, minor, patch) >= (7, 3): + netbox_endpoint_map["l2vpn-terminations"] = { + "endpoint": netbox.vpn.l2vpn_terminations + } + netbox_endpoint_map["l2vpns"] = {"endpoint": netbox.vpn.l2vpns} + netbox_endpoint_map["tunnel-terminations"] = { + "endpoint": netbox.vpn.tunnel_terminations + } + netbox_endpoint_map["tunnels"] = {"endpoint": netbox.vpn.tunnels} + + else: + if "l2vpn" in term: + Display().v( + "pynetbox version %d.%d.%d does not support vpn app; please update to v7.3.0 or newer." + % (major, minor, patch) + ) + + else: + netbox_endpoint_map["l2vpn-terminations"] = { + "endpoint": netbox.ipam.l2vpn_terminations + } + netbox_endpoint_map["l2vpns"] = {"endpoint": netbox.ipam.l2vpns} + return netbox_endpoint_map[term]["endpoint"] diff --git a/plugins/module_utils/netbox_ipam.py b/plugins/module_utils/netbox_ipam.py index 64bbc314a..f8a0131dc 100644 --- a/plugins/module_utils/netbox_ipam.py +++ b/plugins/module_utils/netbox_ipam.py @@ -6,10 +6,8 @@ __metaclass__ = type # Import necessary packages -import traceback from ipaddress import ip_interface from ansible.module_utils._text import to_text -from ansible.module_utils.basic import missing_required_lib from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import ( NetboxModule, diff --git a/plugins/module_utils/netbox_utils.py b/plugins/module_utils/netbox_utils.py index 49640a317..04c327ff8 100644 --- a/plugins/module_utils/netbox_utils.py +++ b/plugins/module_utils/netbox_utils.py @@ -32,88 +32,103 @@ # Used to map endpoints to applications dynamically API_APPS_ENDPOINTS = dict( - circuits=[ - "circuits", - "circuit_types", - "circuit_terminations", - "providers", - "provider_networks", - ], - dcim=[ - "cables", - "console_ports", - "console_port_templates", - "console_server_ports", - "console_server_port_templates", - "device_bays", - "device_bay_templates", - "devices", - "device_roles", - "device_types", - "front_ports", - "front_port_templates", - "interfaces", - "interface_templates", - "inventory_items", - "inventory_item_roles", - "locations", - "manufacturers", - "module_types", - "platforms", - "power_feeds", - "power_outlets", - "power_outlet_templates", - "power_panels", - "power_ports", - "power_port_templates", - "racks", - "rack_groups", - "rack_roles", - "rear_ports", - "rear-ports", - "rear_port_templates", - "regions", - "sites", - "site_groups", - "virtual_chassis", - ], - extras=[ - "config_contexts", - "config_templates", - "tags", - "custom_fields", - "custom_links", - "export_templates", - "journal_entries", - "webhooks", - ], - ipam=[ - "aggregates", - "asns", - "fhrp_groups", - "fhrp_group_assignments", - "ip_addresses", - "l2vpns", - "l2vpn_terminations", - "prefixes", - "rirs", - "roles", - "route_targets", - "service_templates", - "vlans", - "vlan_groups", - "vrfs", - "services", - ], - secrets=[], - tenancy=["tenants", "tenant_groups", "contacts", "contact_groups", "contact_roles"], - virtualization=[ - "cluster_groups", - "cluster_types", - "clusters", - "virtual_machines", - ], - wireless=["wireless_lans", "wireless_lan_groups", "wireless_links"], + circuits={ + "circuits": {}, + "circuit_types": {}, + "circuit_terminations": {}, + "providers": {}, + "provider_networks": {}, + }, + dcim={ + "cables": {}, + "console_ports": {}, + "console_port_templates": {}, + "console_server_ports": {}, + "console_server_port_templates": {}, + "device_bays": {}, + "device_bay_templates": {}, + "devices": {}, + "device_roles": {}, + "device_types": {}, + "front_ports": {}, + "front_port_templates": {}, + "interfaces": {}, + "interface_templates": {}, + "inventory_items": {}, + "inventory_item_roles": {}, + "locations": {}, + "manufacturers": {}, + "module_types": {}, + "platforms": {}, + "power_feeds": {}, + "power_outlets": {}, + "power_outlet_templates": {}, + "power_panels": {}, + "power_ports": {}, + "power_port_templates": {}, + "racks": {}, + "rack_groups": {}, + "rack_roles": {}, + "rear_ports": {}, + "rear-ports": {}, + "rear_port_templates": {}, + "regions": {}, + "sites": {}, + "site_groups": {}, + "virtual_chassis": {}, + }, + extras={ + "config_contexts": {}, + "config_templates": {}, + "tags": {}, + "custom_fields": {}, + "custom_links": {}, + "export_templates": {}, + "journal_entries": {}, + "webhooks": {}, + }, + ipam={ + "aggregates": {}, + "asns": {}, + "fhrp_groups": {}, + "fhrp_group_assignments": {}, + "ip_addresses": {}, + "l2vpns": {"deprecated": "3.7"}, + "l2vpn_terminations": {"deprecated": "3.7"}, + "prefixes": {}, + "rirs": {}, + "roles": {}, + "route_targets": {}, + "service_templates": {}, + "vlans": {}, + "vlan_groups": {}, + "vrfs": {}, + "services": {}, + }, + secrets={}, + tenancy={ + "tenants": {}, + "tenant_groups": {}, + "contacts": {}, + "contact_groups": {}, + "contact_roles": {}, + }, + virtualization={ + "cluster_groups": {}, + "cluster_types": {}, + "clusters": {}, + "virtual_machines": {}, + "virtual_disks": {}, + }, + wireless={ + "wireless_lans": {}, + "wireless_lan_groups": {}, + "wireless_links": {}, + }, + vpn={ + "l2vpns": {"introduced": "3.7"}, + "l2vpn_terminations": {"introduced": "3.7"}, + }, ) # Used to normalize data for the respective query types used to find endpoints @@ -374,6 +389,7 @@ "tenant_groups": "tenant_group", "virtual_chassis": "virtual_chassis", "virtual_machines": "virtual_machine", + "virtual_disks": "virtual_disk", "vlans": "vlan", "vlan_groups": "vlan_group", "vrfs": "vrf", @@ -508,6 +524,7 @@ "untagged_vlan": set(["group", "name", "site", "vid", "vlan_group", "tenant"]), "virtual_chassis": set(["name", "master"]), "virtual_machine": set(["name", "cluster"]), + "virtual_disk": set(["name", "virtual_machine"]), "vm_bridge": set(["name"]), "vlan": set(["group", "name", "site", "tenant", "vid", "vlan_group"]), "vlan_group": set(["name", "slug", "site", "scope"]), @@ -1119,7 +1136,19 @@ def _find_app(self, endpoint): """ nb_app = None for k, v in API_APPS_ENDPOINTS.items(): - if endpoint in v: + if endpoint in v.keys(): + if "introduced" in v[endpoint]: + pre_introduction = self._version_check_greater( + v[endpoint]["introduced"], self.version + ) + if pre_introduction: + continue + if "deprecated" in v[endpoint]: + after_deprecation = self._version_check_greater( + self.version, v[endpoint]["deprecated"], greater_or_equal=True + ) + if after_deprecation: + continue nb_app = k if nb_app: diff --git a/plugins/module_utils/netbox_virtualization.py b/plugins/module_utils/netbox_virtualization.py index 64723bafd..cbee6871e 100644 --- a/plugins/module_utils/netbox_virtualization.py +++ b/plugins/module_utils/netbox_virtualization.py @@ -17,6 +17,7 @@ NB_CLUSTER_GROUP = "cluster_groups" NB_CLUSTER_TYPE = "cluster_types" NB_VM_INTERFACES = "interfaces" +NB_VIRTUAL_DISKS = "virtual_disks" class NetboxVirtualizationModule(NetboxModule): diff --git a/plugins/module_utils/netbox_vpn.py b/plugins/module_utils/netbox_vpn.py new file mode 100644 index 000000000..833389433 --- /dev/null +++ b/plugins/module_utils/netbox_vpn.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright: (c) 2018, Mikhail Yohman (@fragmentedpacket) +# Copyright: (c) 2024, Fred De Backer (@freddebacker) +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +# Import necessary packages + +from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import ( + NetboxModule, + ENDPOINT_NAME_MAPPING, + SLUG_REQUIRED, +) + + +NB_L2VPNS = "l2vpns" +NB_L2VPN_TERMINATIONS = "l2vpn_terminations" + + +class NetboxVpnModule(NetboxModule): + def __init__(self, module, endpoint): + super().__init__(module, endpoint) + + def run(self): + """ + This function should have all necessary code for endpoints within the application + to create/update/delete the endpoint objects + Supported endpoints: + - l2vpns + - l2vpn_terminations + """ + # Used to dynamically set key when returning results + endpoint_name = ENDPOINT_NAME_MAPPING[self.endpoint] + + self.result = {"changed": False} + + application = self._find_app(self.endpoint) + nb_app = getattr(self.nb, application) + nb_endpoint = getattr(nb_app, self.endpoint) + user_query_params = self.module.params.get("query_params") + + data = self.data + + if self.endpoint == "l2vpn_terminations": + name = "l2vpn %s <> %s %s" % ( + data.get("l2vpn"), + data.get("assigned_object_type"), + data.get("assigned_object_id"), + ) + else: + name = data.get("name") + + if self.endpoint in SLUG_REQUIRED: + if not data.get("slug"): + data["slug"] = self._to_slug(name) + + object_query_params = self._build_query_params( + endpoint_name, data, user_query_params + ) + self.nb_object = self._nb_endpoint_get(nb_endpoint, object_query_params, name) + + if self.state == "present": + self._ensure_object_exists(nb_endpoint, endpoint_name, name, data) + elif self.state == "absent": + self._ensure_object_absent(endpoint_name, name) + + try: + serialized_object = self.nb_object.serialize() + except AttributeError: + serialized_object = self.nb_object + + self.result.update({endpoint_name: serialized_object}) + + self.module.exit_json(**self.result) diff --git a/plugins/modules/netbox_circuit_type.py b/plugins/modules/netbox_circuit_type.py index 922d9e21f..5b0958afd 100644 --- a/plugins/modules/netbox_circuit_type.py +++ b/plugins/modules/netbox_circuit_type.py @@ -47,6 +47,12 @@ - This is auto-generated following NetBox rules if not provided required: false type: str + color: + description: + - Color to associate the circuit type with + required: false + type: str + version_added: "3.17.0" tags: description: - The tags to add/update @@ -122,6 +128,7 @@ def main(): name=dict(required=True, type="str"), description=dict(required=False, type="str"), slug=dict(required=False, type="str"), + color=dict(required=False, type="str"), tags=dict(required=False, type="list", elements="raw"), custom_fields=dict(required=False, type="dict"), ), diff --git a/plugins/modules/netbox_device.py b/plugins/modules/netbox_device.py index 5bd3f4763..a76cfe53f 100644 --- a/plugins/modules/netbox_device.py +++ b/plugins/modules/netbox_device.py @@ -178,6 +178,12 @@ - Arbitrary JSON data to define the devices configuration variables. required: false type: dict + config_template: + description: + - Configuration template + required: false + type: raw + version_added: "3.17.0" required: true type: dict """ @@ -321,6 +327,7 @@ def main(): comments=dict(required=False, type="str"), tags=dict(required=False, type="list", elements="raw"), local_context_data=dict(required=False, type="dict"), + config_template=dict(required=False, type="raw"), custom_fields=dict(required=False, type="dict"), ), ), diff --git a/plugins/modules/netbox_l2vpn.py b/plugins/modules/netbox_l2vpn.py index 907f8f70f..8002660f9 100644 --- a/plugins/modules/netbox_l2vpn.py +++ b/plugins/modules/netbox_l2vpn.py @@ -143,11 +143,16 @@ from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import ( NetboxAnsibleModule, + NetboxModule, NETBOX_ARG_SPEC, ) from ansible_collections.netbox.netbox.plugins.module_utils.netbox_ipam import ( NetboxIpamModule, - NB_L2VPNS, + NB_L2VPNS as NB_IPAM_L2VPNS, +) +from ansible_collections.netbox.netbox.plugins.module_utils.netbox_vpn import ( + NetboxVpnModule, + NB_L2VPNS as NB_VPN_L2VPNS, ) from copy import deepcopy @@ -186,7 +191,12 @@ def main(): argument_spec=argument_spec, supports_check_mode=True, required_if=required_if ) - netbox_l2vpn = NetboxIpamModule(module, NB_L2VPNS) + netbox_l2vpn = NetboxModule(module, "") + if netbox_l2vpn._find_app(NB_IPAM_L2VPNS) == "ipam": + netbox_l2vpn = NetboxIpamModule(module, NB_IPAM_L2VPNS) + if netbox_l2vpn._find_app(NB_VPN_L2VPNS) == "vpn": + netbox_l2vpn = NetboxVpnModule(module, NB_VPN_L2VPNS) + netbox_l2vpn.run() diff --git a/plugins/modules/netbox_l2vpn_termination.py b/plugins/modules/netbox_l2vpn_termination.py index d065abff5..965a38785 100644 --- a/plugins/modules/netbox_l2vpn_termination.py +++ b/plugins/modules/netbox_l2vpn_termination.py @@ -105,12 +105,17 @@ from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import ( NetboxAnsibleModule, + NetboxModule, NETBOX_ARG_SPEC, ) from ansible_collections.netbox.netbox.plugins.module_utils.netbox_ipam import ( NetboxIpamModule, - NB_L2VPN_TERMINATIONS, + NB_L2VPN_TERMINATIONS as NB_IPAM_L2VPN_TERMINATIONS, +) +from ansible_collections.netbox.netbox.plugins.module_utils.netbox_vpn import ( + NetboxVpnModule, + NB_L2VPN_TERMINATIONS as NB_VPN_L2VPN_TERMINATIONS, ) @@ -146,7 +151,13 @@ def main(): ) module = NetboxAnsibleModule(argument_spec=argument_spec, supports_check_mode=True) - netbox_l2vpn_termination = NetboxIpamModule(module, NB_L2VPN_TERMINATIONS) + + netbox_l2vpn_termination = NetboxModule(module, "") + if netbox_l2vpn_termination._find_app(NB_IPAM_L2VPN_TERMINATIONS) == "ipam": + netbox_l2vpn_termination = NetboxIpamModule(module, NB_IPAM_L2VPN_TERMINATIONS) + if netbox_l2vpn_termination._find_app(NB_VPN_L2VPN_TERMINATIONS) == "vpn": + netbox_l2vpn_termination = NetboxVpnModule(module, NB_VPN_L2VPN_TERMINATIONS) + netbox_l2vpn_termination.run() diff --git a/plugins/modules/netbox_rack_role.py b/plugins/modules/netbox_rack_role.py index 73c28e84f..8cbd8431e 100644 --- a/plugins/modules/netbox_rack_role.py +++ b/plugins/modules/netbox_rack_role.py @@ -45,6 +45,12 @@ - Hexidecimal code for a color, ex. FFFFFF required: false type: str + description: + description: + - Description of the rack role + required: false + type: str + version_added: "3.17.0" tags: description: - The tags to add/update @@ -77,6 +83,16 @@ color: FFFFFF state: present + - name: Create rack role within NetBox with a description + netbox.netbox.netbox_rack_role: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: Test rack role + color: FFFFFF + description: This is a test rack role + state: present + - name: Delete rack role within netbox netbox.netbox.netbox_rack_role: netbox_url: http://netbox.local @@ -122,6 +138,7 @@ def main(): name=dict(required=True, type="str"), slug=dict(required=False, type="str"), color=dict(required=False, type="str"), + description=dict(required=False, type="str"), tags=dict(required=False, type="list", elements="raw"), custom_fields=dict(required=False, type="dict"), ), diff --git a/plugins/modules/netbox_virtual_disk.py b/plugins/modules/netbox_virtual_disk.py new file mode 100644 index 000000000..fc330c640 --- /dev/null +++ b/plugins/modules/netbox_virtual_disk.py @@ -0,0 +1,139 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright: (c) 2024, Martin Rødvand (@rodvand) +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +DOCUMENTATION = r""" +--- +module: netbox_virtual_disk +short_description: Creates or removes disks from virtual machines in NetBox +description: + - Creates or removes disks from virtual machines in NetBox +notes: + - Tags should be defined as a YAML list + - This should be ran with connection C(local) and hosts C(localhost) +author: + - Martin Rødvand (@rodvand) +requirements: + - pynetbox +version_added: "3.17.0" +extends_documentation_fragment: + - netbox.netbox.common +options: + data: + description: + - Defines the vm disk configuration + suboptions: + virtual_machine: + description: + - Name of the virtual machine the disk will be associated with (case-sensitive) + required: false + type: raw + name: + description: + - Name of the disk to be created + required: true + type: str + description: + description: + - The description of the disk + required: false + type: str + size: + description: + - The size (in GB) of the disk + required: false + type: int + tags: + description: + - Any tags that the virtual disk may need to be associated with + required: false + type: list + elements: raw + custom_fields: + description: + - Must exist in NetBox + required: false + type: dict + required: true + type: dict +""" + +EXAMPLES = r""" +- name: "Test NetBox virtual disk module" + connection: local + hosts: localhost + gather_facts: False + tasks: + - name: Create virtual disk + netbox_virtual_disk: + data: + virtual_machine: test100 + name: disk0 + size: 50 + state: present +""" + +RETURN = r""" +virtual_disk: + description: Serialized object as created or already existent within NetBox + returned: on creation + type: dict +msg: + description: Message indicating failure or info about what has been achieved + returned: always + type: str +""" + +from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import ( + NetboxAnsibleModule, + NETBOX_ARG_SPEC, +) +from ansible_collections.netbox.netbox.plugins.module_utils.netbox_virtualization import ( + NetboxVirtualizationModule, + NB_VIRTUAL_DISKS, +) +from copy import deepcopy + + +def main(): + """ + Main entry point for module execution + """ + argument_spec = deepcopy(NETBOX_ARG_SPEC) + argument_spec.update( + dict( + data=dict( + type="dict", + required=True, + options=dict( + virtual_machine=dict(required=False, type="raw"), + name=dict(required=True, type="str"), + description=dict(required=False, type="str"), + size=dict(required=False, type="int"), + tags=dict(required=False, type="list", elements="raw"), + custom_fields=dict(required=False, type="dict"), + ), + ), + ) + ) + + required_if = [ + ("state", "present", ["virtual_machine", "name"]), + ("state", "absent", ["virtual_machine", "name"]), + ] + + module = NetboxAnsibleModule( + argument_spec=argument_spec, supports_check_mode=True, required_if=required_if + ) + + netbox_virtual_disk = NetboxVirtualizationModule(module, NB_VIRTUAL_DISKS) + netbox_virtual_disk.run() + + +if __name__ == "__main__": # pragma: no cover + main() diff --git a/plugins/modules/netbox_virtual_machine.py b/plugins/modules/netbox_virtual_machine.py index b5155dc81..ec5010274 100644 --- a/plugins/modules/netbox_virtual_machine.py +++ b/plugins/modules/netbox_virtual_machine.py @@ -122,6 +122,12 @@ - Comments of the virtual machine required: false type: str + config_template: + description: + - Configuration template + required: false + type: raw + version_added: "3.17.0" required: true """ @@ -223,6 +229,7 @@ def main(): custom_fields=dict(required=False, type="dict"), local_context_data=dict(required=False, type="dict"), description=dict(required=False, type="str"), + config_template=dict(required=False, type="raw"), comments=dict(required=False, type="str"), ), ), diff --git a/plugins/modules/netbox_vlan.py b/plugins/modules/netbox_vlan.py index d05dc5a33..254278463 100644 --- a/plugins/modules/netbox_vlan.py +++ b/plugins/modules/netbox_vlan.py @@ -122,7 +122,7 @@ name: Test VLAN vid: 400 site: Test Site - group: Test VLAN Group + vlan_group: Test VLAN Group tenant: Test Tenant status: Deprecated vlan_role: Test VLAN Role diff --git a/poetry.lock b/poetry.lock index 903216ebf..935931202 100644 --- a/poetry.lock +++ b/poetry.lock @@ -13,87 +13,87 @@ files = [ [[package]] name = "aiohttp" -version = "3.9.0" +version = "3.9.2" description = "Async http client/server framework (asyncio)" optional = false python-versions = ">=3.8" files = [ - {file = "aiohttp-3.9.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:6896b8416be9ada4d22cd359d7cb98955576ce863eadad5596b7cdfbf3e17c6c"}, - {file = "aiohttp-3.9.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:1736d87dad8ef46a8ec9cddd349fa9f7bd3a064c47dd6469c0d6763d3d49a4fc"}, - {file = "aiohttp-3.9.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:8c9e5f4d7208cda1a2bb600e29069eecf857e6980d0ccc922ccf9d1372c16f4b"}, - {file = "aiohttp-3.9.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8488519aa05e636c5997719fe543c8daf19f538f4fa044f3ce94bee608817cff"}, - {file = "aiohttp-3.9.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5ab16c254e2312efeb799bc3c06897f65a133b38b69682bf75d1f1ee1a9c43a9"}, - {file = "aiohttp-3.9.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7a94bde005a8f926d0fa38b88092a03dea4b4875a61fbcd9ac6f4351df1b57cd"}, - {file = "aiohttp-3.9.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4b777c9286b6c6a94f50ddb3a6e730deec327e9e2256cb08b5530db0f7d40fd8"}, - {file = "aiohttp-3.9.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:571760ad7736b34d05597a1fd38cbc7d47f7b65deb722cb8e86fd827404d1f6b"}, - {file = "aiohttp-3.9.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:deac0a32aec29608eb25d730f4bc5a261a65b6c48ded1ed861d2a1852577c932"}, - {file = "aiohttp-3.9.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:4ee1b4152bc3190cc40ddd6a14715e3004944263ea208229ab4c297712aa3075"}, - {file = "aiohttp-3.9.0-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:3607375053df58ed6f23903aa10cf3112b1240e8c799d243bbad0f7be0666986"}, - {file = "aiohttp-3.9.0-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:65b0a70a25456d329a5e1426702dde67be0fb7a4ead718005ba2ca582d023a94"}, - {file = "aiohttp-3.9.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:5a2eb5311a37fe105aa35f62f75a078537e1a9e4e1d78c86ec9893a3c97d7a30"}, - {file = "aiohttp-3.9.0-cp310-cp310-win32.whl", hash = "sha256:2cbc14a13fb6b42d344e4f27746a4b03a2cb0c1c3c5b932b0d6ad8881aa390e3"}, - {file = "aiohttp-3.9.0-cp310-cp310-win_amd64.whl", hash = "sha256:ac9669990e2016d644ba8ae4758688534aabde8dbbc81f9af129c3f5f01ca9cd"}, - {file = "aiohttp-3.9.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:f8e05f5163528962ce1d1806fce763ab893b1c5b7ace0a3538cd81a90622f844"}, - {file = "aiohttp-3.9.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4afa8f71dba3a5a2e1e1282a51cba7341ae76585345c43d8f0e624882b622218"}, - {file = "aiohttp-3.9.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f929f4c9b9a00f3e6cc0587abb95ab9c05681f8b14e0fe1daecfa83ea90f8318"}, - {file = "aiohttp-3.9.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:28185e36a78d247c55e9fbea2332d16aefa14c5276a582ce7a896231c6b1c208"}, - {file = "aiohttp-3.9.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a486ddf57ab98b6d19ad36458b9f09e6022de0381674fe00228ca7b741aacb2f"}, - {file = "aiohttp-3.9.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:70e851f596c00f40a2f00a46126c95c2e04e146015af05a9da3e4867cfc55911"}, - {file = "aiohttp-3.9.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c5b7bf8fe4d39886adc34311a233a2e01bc10eb4e842220235ed1de57541a896"}, - {file = "aiohttp-3.9.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c67a51ea415192c2e53e4e048c78bab82d21955b4281d297f517707dc836bf3d"}, - {file = "aiohttp-3.9.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:694df243f394629bcae2d8ed94c589a181e8ba8604159e6e45e7b22e58291113"}, - {file = "aiohttp-3.9.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:3dd8119752dd30dd7bca7d4bc2a92a59be6a003e4e5c2cf7e248b89751b8f4b7"}, - {file = "aiohttp-3.9.0-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:eb6dfd52063186ac97b4caa25764cdbcdb4b10d97f5c5f66b0fa95052e744eb7"}, - {file = "aiohttp-3.9.0-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:d97c3e286d0ac9af6223bc132dc4bad6540b37c8d6c0a15fe1e70fb34f9ec411"}, - {file = "aiohttp-3.9.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:816f4db40555026e4cdda604a1088577c1fb957d02f3f1292e0221353403f192"}, - {file = "aiohttp-3.9.0-cp311-cp311-win32.whl", hash = "sha256:3abf0551874fecf95f93b58f25ef4fc9a250669a2257753f38f8f592db85ddea"}, - {file = "aiohttp-3.9.0-cp311-cp311-win_amd64.whl", hash = "sha256:e18d92c3e9e22553a73e33784fcb0ed484c9874e9a3e96c16a8d6a1e74a0217b"}, - {file = "aiohttp-3.9.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:99ae01fb13a618b9942376df77a1f50c20a281390dad3c56a6ec2942e266220d"}, - {file = "aiohttp-3.9.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:05857848da443c8c12110d99285d499b4e84d59918a21132e45c3f0804876994"}, - {file = "aiohttp-3.9.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:317719d7f824eba55857fe0729363af58e27c066c731bc62cd97bc9c3d9c7ea4"}, - {file = "aiohttp-3.9.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a1e3b3c107ccb0e537f309f719994a55621acd2c8fdf6d5ce5152aed788fb940"}, - {file = "aiohttp-3.9.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:45820ddbb276113ead8d4907a7802adb77548087ff5465d5c554f9aa3928ae7d"}, - {file = "aiohttp-3.9.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:05a183f1978802588711aed0dea31e697d760ce9055292db9dc1604daa9a8ded"}, - {file = "aiohttp-3.9.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:51a4cd44788ea0b5e6bb8fa704597af3a30be75503a7ed1098bc5b8ffdf6c982"}, - {file = "aiohttp-3.9.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:673343fbc0c1ac44d0d2640addc56e97a052504beacd7ade0dc5e76d3a4c16e8"}, - {file = "aiohttp-3.9.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7e8a3b79b6d186a9c99761fd4a5e8dd575a48d96021f220ac5b5fa856e5dd029"}, - {file = "aiohttp-3.9.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:6777a390e41e78e7c45dab43a4a0196c55c3b8c30eebe017b152939372a83253"}, - {file = "aiohttp-3.9.0-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:7ae5f99a32c53731c93ac3075abd3e1e5cfbe72fc3eaac4c27c9dd64ba3b19fe"}, - {file = "aiohttp-3.9.0-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:f1e4f254e9c35d8965d377e065c4a8a55d396fe87c8e7e8429bcfdeeb229bfb3"}, - {file = "aiohttp-3.9.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:11ca808f9a6b63485059f5f6e164ef7ec826483c1212a44f268b3653c91237d8"}, - {file = "aiohttp-3.9.0-cp312-cp312-win32.whl", hash = "sha256:de3cc86f4ea8b4c34a6e43a7306c40c1275e52bfa9748d869c6b7d54aa6dad80"}, - {file = "aiohttp-3.9.0-cp312-cp312-win_amd64.whl", hash = "sha256:ca4fddf84ac7d8a7d0866664936f93318ff01ee33e32381a115b19fb5a4d1202"}, - {file = "aiohttp-3.9.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:f09960b5bb1017d16c0f9e9f7fc42160a5a49fa1e87a175fd4a2b1a1833ea0af"}, - {file = "aiohttp-3.9.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:8303531e2c17b1a494ffaeba48f2da655fe932c4e9a2626c8718403c83e5dd2b"}, - {file = "aiohttp-3.9.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4790e44f46a4aa07b64504089def5744d3b6780468c4ec3a1a36eb7f2cae9814"}, - {file = "aiohttp-3.9.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a1d7edf74a36de0e5ca50787e83a77cf352f5504eb0ffa3f07000a911ba353fb"}, - {file = "aiohttp-3.9.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:94697c7293199c2a2551e3e3e18438b4cba293e79c6bc2319f5fd652fccb7456"}, - {file = "aiohttp-3.9.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a1b66dbb8a7d5f50e9e2ea3804b01e766308331d0cac76eb30c563ac89c95985"}, - {file = "aiohttp-3.9.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9623cfd9e85b76b83ef88519d98326d4731f8d71869867e47a0b979ffec61c73"}, - {file = "aiohttp-3.9.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f32c86dc967ab8c719fd229ce71917caad13cc1e8356ee997bf02c5b368799bf"}, - {file = "aiohttp-3.9.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:f50b4663c3e0262c3a361faf440761fbef60ccdde5fe8545689a4b3a3c149fb4"}, - {file = "aiohttp-3.9.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:dcf71c55ec853826cd70eadb2b6ac62ec577416442ca1e0a97ad875a1b3a0305"}, - {file = "aiohttp-3.9.0-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:42fe4fd9f0dfcc7be4248c162d8056f1d51a04c60e53366b0098d1267c4c9da8"}, - {file = "aiohttp-3.9.0-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:76a86a9989ebf82ee61e06e2bab408aec4ea367dc6da35145c3352b60a112d11"}, - {file = "aiohttp-3.9.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:f9e09a1c83521d770d170b3801eea19b89f41ccaa61d53026ed111cb6f088887"}, - {file = "aiohttp-3.9.0-cp38-cp38-win32.whl", hash = "sha256:a00ce44c21612d185c5275c5cba4bab8d7c1590f248638b667ed8a782fa8cd6f"}, - {file = "aiohttp-3.9.0-cp38-cp38-win_amd64.whl", hash = "sha256:d5b9345ab92ebe6003ae11d8092ce822a0242146e6fa270889b9ba965457ca40"}, - {file = "aiohttp-3.9.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:98d21092bf2637c5fa724a428a69e8f5955f2182bff61f8036827cf6ce1157bf"}, - {file = "aiohttp-3.9.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:35a68cd63ca6aaef5707888f17a70c36efe62b099a4e853d33dc2e9872125be8"}, - {file = "aiohttp-3.9.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3d7f6235c7475658acfc1769d968e07ab585c79f6ca438ddfecaa9a08006aee2"}, - {file = "aiohttp-3.9.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:db04d1de548f7a62d1dd7e7cdf7c22893ee168e22701895067a28a8ed51b3735"}, - {file = "aiohttp-3.9.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:536b01513d67d10baf6f71c72decdf492fb7433c5f2f133e9a9087379d4b6f31"}, - {file = "aiohttp-3.9.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:87c8b0a6487e8109427ccf638580865b54e2e3db4a6e0e11c02639231b41fc0f"}, - {file = "aiohttp-3.9.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7276fe0017664414fdc3618fca411630405f1aaf0cc3be69def650eb50441787"}, - {file = "aiohttp-3.9.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:23170247ef89ffa842a02bbfdc425028574d9e010611659abeb24d890bc53bb8"}, - {file = "aiohttp-3.9.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:b1a2ea8252cacc7fd51df5a56d7a2bb1986ed39be9397b51a08015727dfb69bd"}, - {file = "aiohttp-3.9.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:2d71abc15ff7047412ef26bf812dfc8d0d1020d664617f4913df2df469f26b76"}, - {file = "aiohttp-3.9.0-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:2d820162c8c2bdbe97d328cd4f417c955ca370027dce593345e437b2e9ffdc4d"}, - {file = "aiohttp-3.9.0-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:2779f5e7c70f7b421915fd47db332c81de365678180a9f3ab404088f87ba5ff9"}, - {file = "aiohttp-3.9.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:366bc870d7ac61726f32a489fbe3d1d8876e87506870be66b01aeb84389e967e"}, - {file = "aiohttp-3.9.0-cp39-cp39-win32.whl", hash = "sha256:1df43596b826022b14998f0460926ce261544fedefe0d2f653e1b20f49e96454"}, - {file = "aiohttp-3.9.0-cp39-cp39-win_amd64.whl", hash = "sha256:9c196b30f1b1aa3363a69dd69079ae9bec96c2965c4707eaa6914ba099fb7d4f"}, - {file = "aiohttp-3.9.0.tar.gz", hash = "sha256:09f23292d29135025e19e8ff4f0a68df078fe4ee013bca0105b2e803989de92d"}, + {file = "aiohttp-3.9.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:772fbe371788e61c58d6d3d904268e48a594ba866804d08c995ad71b144f94cb"}, + {file = "aiohttp-3.9.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:edd4f1af2253f227ae311ab3d403d0c506c9b4410c7fc8d9573dec6d9740369f"}, + {file = "aiohttp-3.9.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:cfee9287778399fdef6f8a11c9e425e1cb13cc9920fd3a3df8f122500978292b"}, + {file = "aiohttp-3.9.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3cc158466f6a980a6095ee55174d1de5730ad7dec251be655d9a6a9dd7ea1ff9"}, + {file = "aiohttp-3.9.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:54ec82f45d57c9a65a1ead3953b51c704f9587440e6682f689da97f3e8defa35"}, + {file = "aiohttp-3.9.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:abeb813a18eb387f0d835ef51f88568540ad0325807a77a6e501fed4610f864e"}, + {file = "aiohttp-3.9.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cc91d07280d7d169f3a0f9179d8babd0ee05c79d4d891447629ff0d7d8089ec2"}, + {file = "aiohttp-3.9.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b65e861f4bebfb660f7f0f40fa3eb9f2ab9af10647d05dac824390e7af8f75b7"}, + {file = "aiohttp-3.9.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:04fd8ffd2be73d42bcf55fd78cde7958eeee6d4d8f73c3846b7cba491ecdb570"}, + {file = "aiohttp-3.9.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:3d8d962b439a859b3ded9a1e111a4615357b01620a546bc601f25b0211f2da81"}, + {file = "aiohttp-3.9.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:8ceb658afd12b27552597cf9a65d9807d58aef45adbb58616cdd5ad4c258c39e"}, + {file = "aiohttp-3.9.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:0e4ee4df741670560b1bc393672035418bf9063718fee05e1796bf867e995fad"}, + {file = "aiohttp-3.9.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:2dec87a556f300d3211decf018bfd263424f0690fcca00de94a837949fbcea02"}, + {file = "aiohttp-3.9.2-cp310-cp310-win32.whl", hash = "sha256:3e1a800f988ce7c4917f34096f81585a73dbf65b5c39618b37926b1238cf9bc4"}, + {file = "aiohttp-3.9.2-cp310-cp310-win_amd64.whl", hash = "sha256:ea510718a41b95c236c992b89fdfc3d04cc7ca60281f93aaada497c2b4e05c46"}, + {file = "aiohttp-3.9.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:6aaa6f99256dd1b5756a50891a20f0d252bd7bdb0854c5d440edab4495c9f973"}, + {file = "aiohttp-3.9.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:a27d8c70ad87bcfce2e97488652075a9bdd5b70093f50b10ae051dfe5e6baf37"}, + {file = "aiohttp-3.9.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:54287bcb74d21715ac8382e9de146d9442b5f133d9babb7e5d9e453faadd005e"}, + {file = "aiohttp-3.9.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5bb3d05569aa83011fcb346b5266e00b04180105fcacc63743fc2e4a1862a891"}, + {file = "aiohttp-3.9.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c8534e7d69bb8e8d134fe2be9890d1b863518582f30c9874ed7ed12e48abe3c4"}, + {file = "aiohttp-3.9.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4bd9d5b989d57b41e4ff56ab250c5ddf259f32db17159cce630fd543376bd96b"}, + {file = "aiohttp-3.9.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa6904088e6642609981f919ba775838ebf7df7fe64998b1a954fb411ffb4663"}, + {file = "aiohttp-3.9.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bda42eb410be91b349fb4ee3a23a30ee301c391e503996a638d05659d76ea4c2"}, + {file = "aiohttp-3.9.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:193cc1ccd69d819562cc7f345c815a6fc51d223b2ef22f23c1a0f67a88de9a72"}, + {file = "aiohttp-3.9.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:b9f1cb839b621f84a5b006848e336cf1496688059d2408e617af33e3470ba204"}, + {file = "aiohttp-3.9.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:d22a0931848b8c7a023c695fa2057c6aaac19085f257d48baa24455e67df97ec"}, + {file = "aiohttp-3.9.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4112d8ba61fbd0abd5d43a9cb312214565b446d926e282a6d7da3f5a5aa71d36"}, + {file = "aiohttp-3.9.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:c4ad4241b52bb2eb7a4d2bde060d31c2b255b8c6597dd8deac2f039168d14fd7"}, + {file = "aiohttp-3.9.2-cp311-cp311-win32.whl", hash = "sha256:ee2661a3f5b529f4fc8a8ffee9f736ae054adfb353a0d2f78218be90617194b3"}, + {file = "aiohttp-3.9.2-cp311-cp311-win_amd64.whl", hash = "sha256:4deae2c165a5db1ed97df2868ef31ca3cc999988812e82386d22937d9d6fed52"}, + {file = "aiohttp-3.9.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:6f4cdba12539215aaecf3c310ce9d067b0081a0795dd8a8805fdb67a65c0572a"}, + {file = "aiohttp-3.9.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:84e843b33d5460a5c501c05539809ff3aee07436296ff9fbc4d327e32aa3a326"}, + {file = "aiohttp-3.9.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8008d0f451d66140a5aa1c17e3eedc9d56e14207568cd42072c9d6b92bf19b52"}, + {file = "aiohttp-3.9.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:61c47ab8ef629793c086378b1df93d18438612d3ed60dca76c3422f4fbafa792"}, + {file = "aiohttp-3.9.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bc71f748e12284312f140eaa6599a520389273174b42c345d13c7e07792f4f57"}, + {file = "aiohttp-3.9.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a1c3a4d0ab2f75f22ec80bca62385db2e8810ee12efa8c9e92efea45c1849133"}, + {file = "aiohttp-3.9.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9a87aa0b13bbee025faa59fa58861303c2b064b9855d4c0e45ec70182bbeba1b"}, + {file = "aiohttp-3.9.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e2cc0d04688b9f4a7854c56c18aa7af9e5b0a87a28f934e2e596ba7e14783192"}, + {file = "aiohttp-3.9.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:1956e3ac376b1711c1533266dec4efd485f821d84c13ce1217d53e42c9e65f08"}, + {file = "aiohttp-3.9.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:114da29f39eccd71b93a0fcacff178749a5c3559009b4a4498c2c173a6d74dff"}, + {file = "aiohttp-3.9.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:3f17999ae3927d8a9a823a1283b201344a0627272f92d4f3e3a4efe276972fe8"}, + {file = "aiohttp-3.9.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:f31df6a32217a34ae2f813b152a6f348154f948c83213b690e59d9e84020925c"}, + {file = "aiohttp-3.9.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:7a75307ffe31329928a8d47eae0692192327c599113d41b278d4c12b54e1bd11"}, + {file = "aiohttp-3.9.2-cp312-cp312-win32.whl", hash = "sha256:972b63d589ff8f305463593050a31b5ce91638918da38139b9d8deaba9e0fed7"}, + {file = "aiohttp-3.9.2-cp312-cp312-win_amd64.whl", hash = "sha256:200dc0246f0cb5405c80d18ac905c8350179c063ea1587580e3335bfc243ba6a"}, + {file = "aiohttp-3.9.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:158564d0d1020e0d3fe919a81d97aadad35171e13e7b425b244ad4337fc6793a"}, + {file = "aiohttp-3.9.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:da1346cd0ccb395f0ed16b113ebb626fa43b7b07fd7344fce33e7a4f04a8897a"}, + {file = "aiohttp-3.9.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:eaa9256de26ea0334ffa25f1913ae15a51e35c529a1ed9af8e6286dd44312554"}, + {file = "aiohttp-3.9.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1543e7fb00214fb4ccead42e6a7d86f3bb7c34751ec7c605cca7388e525fd0b4"}, + {file = "aiohttp-3.9.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:186e94570433a004e05f31f632726ae0f2c9dee4762a9ce915769ce9c0a23d89"}, + {file = "aiohttp-3.9.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d52d20832ac1560f4510d68e7ba8befbc801a2b77df12bd0cd2bcf3b049e52a4"}, + {file = "aiohttp-3.9.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1c45e4e815ac6af3b72ca2bde9b608d2571737bb1e2d42299fc1ffdf60f6f9a1"}, + {file = "aiohttp-3.9.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:aa906b9bdfd4a7972dd0628dbbd6413d2062df5b431194486a78f0d2ae87bd55"}, + {file = "aiohttp-3.9.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:68bbee9e17d66f17bb0010aa15a22c6eb28583edcc8b3212e2b8e3f77f3ebe2a"}, + {file = "aiohttp-3.9.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:4c189b64bd6d9a403a1a3f86a3ab3acbc3dc41a68f73a268a4f683f89a4dec1f"}, + {file = "aiohttp-3.9.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:8a7876f794523123bca6d44bfecd89c9fec9ec897a25f3dd202ee7fc5c6525b7"}, + {file = "aiohttp-3.9.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:d23fba734e3dd7b1d679b9473129cd52e4ec0e65a4512b488981a56420e708db"}, + {file = "aiohttp-3.9.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:b141753be581fab842a25cb319f79536d19c2a51995d7d8b29ee290169868eab"}, + {file = "aiohttp-3.9.2-cp38-cp38-win32.whl", hash = "sha256:103daf41ff3b53ba6fa09ad410793e2e76c9d0269151812e5aba4b9dd674a7e8"}, + {file = "aiohttp-3.9.2-cp38-cp38-win_amd64.whl", hash = "sha256:328918a6c2835861ff7afa8c6d2c70c35fdaf996205d5932351bdd952f33fa2f"}, + {file = "aiohttp-3.9.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:5264d7327c9464786f74e4ec9342afbbb6ee70dfbb2ec9e3dfce7a54c8043aa3"}, + {file = "aiohttp-3.9.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:07205ae0015e05c78b3288c1517afa000823a678a41594b3fdc870878d645305"}, + {file = "aiohttp-3.9.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ae0a1e638cffc3ec4d4784b8b4fd1cf28968febc4bd2718ffa25b99b96a741bd"}, + {file = "aiohttp-3.9.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d43302a30ba1166325974858e6ef31727a23bdd12db40e725bec0f759abce505"}, + {file = "aiohttp-3.9.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:16a967685907003765855999af11a79b24e70b34dc710f77a38d21cd9fc4f5fe"}, + {file = "aiohttp-3.9.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6fa3ee92cd441d5c2d07ca88d7a9cef50f7ec975f0117cd0c62018022a184308"}, + {file = "aiohttp-3.9.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b500c5ad9c07639d48615a770f49618130e61be36608fc9bc2d9bae31732b8f"}, + {file = "aiohttp-3.9.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c07327b368745b1ce2393ae9e1aafed7073d9199e1dcba14e035cc646c7941bf"}, + {file = "aiohttp-3.9.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:cc7d6502c23a0ec109687bf31909b3fb7b196faf198f8cff68c81b49eb316ea9"}, + {file = "aiohttp-3.9.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:07be2be7071723c3509ab5c08108d3a74f2181d4964e869f2504aaab68f8d3e8"}, + {file = "aiohttp-3.9.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:122468f6fee5fcbe67cb07014a08c195b3d4c41ff71e7b5160a7bcc41d585a5f"}, + {file = "aiohttp-3.9.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:00a9abcea793c81e7f8778ca195a1714a64f6d7436c4c0bb168ad2a212627000"}, + {file = "aiohttp-3.9.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:7a9825fdd64ecac5c670234d80bb52bdcaa4139d1f839165f548208b3779c6c6"}, + {file = "aiohttp-3.9.2-cp39-cp39-win32.whl", hash = "sha256:5422cd9a4a00f24c7244e1b15aa9b87935c85fb6a00c8ac9b2527b38627a9211"}, + {file = "aiohttp-3.9.2-cp39-cp39-win_amd64.whl", hash = "sha256:7d579dcd5d82a86a46f725458418458fa43686f6a7b252f2966d359033ffc8ab"}, + {file = "aiohttp-3.9.2.tar.gz", hash = "sha256:b0ad0a5e86ce73f5368a164c10ada10504bf91869c05ab75d982c6048217fbf7"}, ] [package.dependencies] @@ -123,21 +123,22 @@ frozenlist = ">=1.1.0" [[package]] name = "ansible-core" -version = "2.14.3" +version = "2.15.9" description = "Radically simple IT automation" optional = false python-versions = ">=3.9" files = [ - {file = "ansible-core-2.14.3.tar.gz", hash = "sha256:093a4bc4a1259eaeb56ea37ec1d33cf1836c88f39281d89197f8d3480e068a58"}, - {file = "ansible_core-2.14.3-py3-none-any.whl", hash = "sha256:a4b36bfdd7aa3534d449e9ae6a9fd82d8e513fda8caaf5d18e1e27d217151c8c"}, + {file = "ansible-core-2.15.9.tar.gz", hash = "sha256:25f9b1b5a5af3c0986bd3928ed086eaddb867527fb5c83afef1a03cfad34f345"}, + {file = "ansible_core-2.15.9-py3-none-any.whl", hash = "sha256:5b6a4b12aa5358f60933e79d86763e3558862282fb1dc563a29b9999e5849fc3"}, ] [package.dependencies] cryptography = "*" +importlib-resources = {version = ">=5.0,<5.1", markers = "python_version < \"3.10\""} jinja2 = ">=3.0.0" packaging = "*" PyYAML = ">=5.1" -resolvelib = ">=0.5.3,<0.9.0" +resolvelib = ">=0.5.3,<1.1.0" [[package]] name = "antsibull" @@ -640,47 +641,56 @@ toml = ["tomli"] [[package]] name = "cryptography" -version = "41.0.6" +version = "42.0.0" description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers." optional = false python-versions = ">=3.7" files = [ - {file = "cryptography-41.0.6-cp37-abi3-macosx_10_12_universal2.whl", hash = "sha256:0f27acb55a4e77b9be8d550d762b0513ef3fc658cd3eb15110ebbcbd626db12c"}, - {file = "cryptography-41.0.6-cp37-abi3-macosx_10_12_x86_64.whl", hash = "sha256:ae236bb8760c1e55b7a39b6d4d32d2279bc6c7c8500b7d5a13b6fb9fc97be35b"}, - {file = "cryptography-41.0.6-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:afda76d84b053923c27ede5edc1ed7d53e3c9f475ebaf63c68e69f1403c405a8"}, - {file = "cryptography-41.0.6-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:da46e2b5df770070412c46f87bac0849b8d685c5f2679771de277a422c7d0b86"}, - {file = "cryptography-41.0.6-cp37-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:ff369dd19e8fe0528b02e8df9f2aeb2479f89b1270d90f96a63500afe9af5cae"}, - {file = "cryptography-41.0.6-cp37-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:b648fe2a45e426aaee684ddca2632f62ec4613ef362f4d681a9a6283d10e079d"}, - {file = "cryptography-41.0.6-cp37-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:5daeb18e7886a358064a68dbcaf441c036cbdb7da52ae744e7b9207b04d3908c"}, - {file = "cryptography-41.0.6-cp37-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:068bc551698c234742c40049e46840843f3d98ad7ce265fd2bd4ec0d11306596"}, - {file = "cryptography-41.0.6-cp37-abi3-win32.whl", hash = "sha256:2132d5865eea673fe6712c2ed5fb4fa49dba10768bb4cc798345748380ee3660"}, - {file = "cryptography-41.0.6-cp37-abi3-win_amd64.whl", hash = "sha256:48783b7e2bef51224020efb61b42704207dde583d7e371ef8fc2a5fb6c0aabc7"}, - {file = "cryptography-41.0.6-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:8efb2af8d4ba9dbc9c9dd8f04d19a7abb5b49eab1f3694e7b5a16a5fc2856f5c"}, - {file = "cryptography-41.0.6-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:c5a550dc7a3b50b116323e3d376241829fd326ac47bc195e04eb33a8170902a9"}, - {file = "cryptography-41.0.6-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:85abd057699b98fce40b41737afb234fef05c67e116f6f3650782c10862c43da"}, - {file = "cryptography-41.0.6-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:f39812f70fc5c71a15aa3c97b2bbe213c3f2a460b79bd21c40d033bb34a9bf36"}, - {file = "cryptography-41.0.6-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:742ae5e9a2310e9dade7932f9576606836ed174da3c7d26bc3d3ab4bd49b9f65"}, - {file = "cryptography-41.0.6-pp38-pypy38_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:35f3f288e83c3f6f10752467c48919a7a94b7d88cc00b0668372a0d2ad4f8ead"}, - {file = "cryptography-41.0.6-pp38-pypy38_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:4d03186af98b1c01a4eda396b137f29e4e3fb0173e30f885e27acec8823c1b09"}, - {file = "cryptography-41.0.6-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:b27a7fd4229abef715e064269d98a7e2909ebf92eb6912a9603c7e14c181928c"}, - {file = "cryptography-41.0.6-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:398ae1fc711b5eb78e977daa3cbf47cec20f2c08c5da129b7a296055fbb22aed"}, - {file = "cryptography-41.0.6-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:7e00fb556bda398b99b0da289ce7053639d33b572847181d6483ad89835115f6"}, - {file = "cryptography-41.0.6-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:60e746b11b937911dc70d164060d28d273e31853bb359e2b2033c9e93e6f3c43"}, - {file = "cryptography-41.0.6-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:3288acccef021e3c3c10d58933f44e8602cf04dba96d9796d70d537bb2f4bbc4"}, - {file = "cryptography-41.0.6.tar.gz", hash = "sha256:422e3e31d63743855e43e5a6fcc8b4acab860f560f9321b0ee6269cc7ed70cc3"}, + {file = "cryptography-42.0.0-cp37-abi3-macosx_10_12_universal2.whl", hash = "sha256:c640b0ef54138fde761ec99a6c7dc4ce05e80420262c20fa239e694ca371d434"}, + {file = "cryptography-42.0.0-cp37-abi3-macosx_10_12_x86_64.whl", hash = "sha256:678cfa0d1e72ef41d48993a7be75a76b0725d29b820ff3cfd606a5b2b33fda01"}, + {file = "cryptography-42.0.0-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:146e971e92a6dd042214b537a726c9750496128453146ab0ee8971a0299dc9bd"}, + {file = "cryptography-42.0.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:87086eae86a700307b544625e3ba11cc600c3c0ef8ab97b0fda0705d6db3d4e3"}, + {file = "cryptography-42.0.0-cp37-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:0a68bfcf57a6887818307600c3c0ebc3f62fbb6ccad2240aa21887cda1f8df1b"}, + {file = "cryptography-42.0.0-cp37-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:5a217bca51f3b91971400890905a9323ad805838ca3fa1e202a01844f485ee87"}, + {file = "cryptography-42.0.0-cp37-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:ca20550bb590db16223eb9ccc5852335b48b8f597e2f6f0878bbfd9e7314eb17"}, + {file = "cryptography-42.0.0-cp37-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:33588310b5c886dfb87dba5f013b8d27df7ffd31dc753775342a1e5ab139e59d"}, + {file = "cryptography-42.0.0-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:9515ea7f596c8092fdc9902627e51b23a75daa2c7815ed5aa8cf4f07469212ec"}, + {file = "cryptography-42.0.0-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:35cf6ed4c38f054478a9df14f03c1169bb14bd98f0b1705751079b25e1cb58bc"}, + {file = "cryptography-42.0.0-cp37-abi3-win32.whl", hash = "sha256:8814722cffcfd1fbd91edd9f3451b88a8f26a5fd41b28c1c9193949d1c689dc4"}, + {file = "cryptography-42.0.0-cp37-abi3-win_amd64.whl", hash = "sha256:a2a8d873667e4fd2f34aedab02ba500b824692c6542e017075a2efc38f60a4c0"}, + {file = "cryptography-42.0.0-cp39-abi3-macosx_10_12_universal2.whl", hash = "sha256:8fedec73d590fd30c4e3f0d0f4bc961aeca8390c72f3eaa1a0874d180e868ddf"}, + {file = "cryptography-42.0.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:be41b0c7366e5549265adf2145135dca107718fa44b6e418dc7499cfff6b4689"}, + {file = "cryptography-42.0.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3ca482ea80626048975360c8e62be3ceb0f11803180b73163acd24bf014133a0"}, + {file = "cryptography-42.0.0-cp39-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:c58115384bdcfe9c7f644c72f10f6f42bed7cf59f7b52fe1bf7ae0a622b3a139"}, + {file = "cryptography-42.0.0-cp39-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:56ce0c106d5c3fec1038c3cca3d55ac320a5be1b44bf15116732d0bc716979a2"}, + {file = "cryptography-42.0.0-cp39-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:324721d93b998cb7367f1e6897370644751e5580ff9b370c0a50dc60a2003513"}, + {file = "cryptography-42.0.0-cp39-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:d97aae66b7de41cdf5b12087b5509e4e9805ed6f562406dfcf60e8481a9a28f8"}, + {file = "cryptography-42.0.0-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:85f759ed59ffd1d0baad296e72780aa62ff8a71f94dc1ab340386a1207d0ea81"}, + {file = "cryptography-42.0.0-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:206aaf42e031b93f86ad60f9f5d9da1b09164f25488238ac1dc488334eb5e221"}, + {file = "cryptography-42.0.0-cp39-abi3-win32.whl", hash = "sha256:74f18a4c8ca04134d2052a140322002fef535c99cdbc2a6afc18a8024d5c9d5b"}, + {file = "cryptography-42.0.0-cp39-abi3-win_amd64.whl", hash = "sha256:14e4b909373bc5bf1095311fa0f7fcabf2d1a160ca13f1e9e467be1ac4cbdf94"}, + {file = "cryptography-42.0.0-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:3005166a39b70c8b94455fdbe78d87a444da31ff70de3331cdec2c568cf25b7e"}, + {file = "cryptography-42.0.0-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:be14b31eb3a293fc6e6aa2807c8a3224c71426f7c4e3639ccf1a2f3ffd6df8c3"}, + {file = "cryptography-42.0.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:bd7cf7a8d9f34cc67220f1195884151426ce616fdc8285df9054bfa10135925f"}, + {file = "cryptography-42.0.0-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:c310767268d88803b653fffe6d6f2f17bb9d49ffceb8d70aed50ad45ea49ab08"}, + {file = "cryptography-42.0.0-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:bdce70e562c69bb089523e75ef1d9625b7417c6297a76ac27b1b8b1eb51b7d0f"}, + {file = "cryptography-42.0.0-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:e9326ca78111e4c645f7e49cbce4ed2f3f85e17b61a563328c85a5208cf34440"}, + {file = "cryptography-42.0.0-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:69fd009a325cad6fbfd5b04c711a4da563c6c4854fc4c9544bff3088387c77c0"}, + {file = "cryptography-42.0.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:988b738f56c665366b1e4bfd9045c3efae89ee366ca3839cd5af53eaa1401bce"}, + {file = "cryptography-42.0.0.tar.gz", hash = "sha256:6cf9b76d6e93c62114bd19485e5cb003115c134cf9ce91f8ac924c44f8c8c3f4"}, ] [package.dependencies] -cffi = ">=1.12" +cffi = {version = ">=1.12", markers = "platform_python_implementation != \"PyPy\""} [package.extras] docs = ["sphinx (>=5.3.0)", "sphinx-rtd-theme (>=1.1.1)"] -docstest = ["pyenchant (>=1.6.11)", "sphinxcontrib-spelling (>=4.0.1)", "twine (>=1.12.0)"] +docstest = ["pyenchant (>=1.6.11)", "readme-renderer", "sphinxcontrib-spelling (>=4.0.1)"] nox = ["nox"] -pep8test = ["black", "check-sdist", "mypy", "ruff"] +pep8test = ["check-sdist", "click", "mypy", "ruff"] sdist = ["build"] ssh = ["bcrypt (>=3.1.5)"] -test = ["pretend", "pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-xdist"] +test = ["certifi", "pretend", "pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-xdist"] test-randomorder = ["pytest-randomly"] [[package]] @@ -854,6 +864,21 @@ docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker perf = ["ipython"] testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"] +[[package]] +name = "importlib-resources" +version = "5.0.7" +description = "Read resources from Python packages" +optional = false +python-versions = ">=3.6" +files = [ + {file = "importlib_resources-5.0.7-py3-none-any.whl", hash = "sha256:2238159eb743bd85304a16e0536048b3e991c531d1cd51c4a834d1ccf2829057"}, + {file = "importlib_resources-5.0.7.tar.gz", hash = "sha256:4df460394562b4581bb4e4087ad9447bd433148fba44241754ec3152499f1d1b"}, +] + +[package.extras] +docs = ["jaraco.packaging (>=8.2)", "rst.linker (>=1.9)", "sphinx"] +testing = ["pytest (>=3.5,!=3.7.3)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=1.2.3)", "pytest-cov", "pytest-enabler", "pytest-flake8", "pytest-mypy"] + [[package]] name = "iniconfig" version = "2.0.0" @@ -1434,6 +1459,7 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, @@ -1817,4 +1843,4 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "089edab81a1c4ada15b283f79f3c461e74b8ce139522f6ef375a7040e9f3ba84" +content-hash = "7dc51b7cbbd935048b1b613952815663128eb15b811439eb79f56feccda18ad2" diff --git a/pyproject.toml b/pyproject.toml index 93c6a634e..1eb6c8ff8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,13 +1,13 @@ [tool.poetry] name = "netbox_ansible_modules" -version = "3.14.0" +version = "3.17.0" description = "Ansible collection to interact with NetBox's API" authors = ["Mikhail Yohman "] license = "GPLv3" [tool.poetry.dependencies] python = "^3.9" -ansible-core = "2.14.3" +ansible-core = "2.15.9" black = "*" codecov = "*" coverage = "6.5.*" diff --git a/tests/integration/targets/inventory-v3.4/.gitignore b/tests/integration/targets/inventory-v3.7/.gitignore similarity index 100% rename from tests/integration/targets/inventory-v3.4/.gitignore rename to tests/integration/targets/inventory-v3.7/.gitignore diff --git a/tests/integration/targets/inventory-v3.4/aliases b/tests/integration/targets/inventory-v3.7/aliases similarity index 100% rename from tests/integration/targets/inventory-v3.4/aliases rename to tests/integration/targets/inventory-v3.7/aliases diff --git a/tests/integration/targets/inventory-v3.4/compare_inventory_json.py b/tests/integration/targets/inventory-v3.7/compare_inventory_json.py similarity index 100% rename from tests/integration/targets/inventory-v3.4/compare_inventory_json.py rename to tests/integration/targets/inventory-v3.7/compare_inventory_json.py diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-bearer-token.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-bearer-token.json similarity index 99% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-bearer-token.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-bearer-token.json index 1e52fdccd..360a7ac33 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-bearer-token.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-bearer-token.json @@ -2,6 +2,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "config_context": {}, "custom_fields": {}, "device_type": "cisco-test", @@ -13,6 +14,7 @@ "rack_role": "test-rack-role", "regions": [], "role": "core-switch", + "serial": "", "services": [], "site": "test-site2", "site_groups": [], @@ -20,9 +22,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test Nexus One": { "ansible_host": "172.16.180.12", @@ -260,6 +260,7 @@ "parent-region" ], "role": "core-switch", + "serial": "", "services": [ { "comments": "", @@ -291,8 +292,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -405,6 +405,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB12345678", "services": [], "site": "test-site", "site_groups": [], @@ -412,10 +413,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "config_context": { "ntp_servers": [ "pool.ntp.org" @@ -657,6 +658,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB01234567", "services": [ { "comments": "", @@ -724,9 +726,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -1099,28 +1099,28 @@ }, "all": { "children": [ - "cluster_Test_Cluster", - "cluster_Test_Cluster_2", - "cluster_group_test_cluster_group", - "cluster_type_test_cluster_type", - "device_type_cisco_test", - "device_type_nexus_parent", - "is_virtual", - "manufacturer_cisco", - "rack_Test_Rack", - "rack_Test_Rack_Site_2", - "rack_role_test_rack_role", + "ungrouped", + "site_test_site2", "region_other_region", "region_parent_region", - "role_core_switch", - "service_http", - "service_ssh", - "service_telnet", "site_group_other_site_group", "site_group_parent_site_group", - "site_test_site2", + "rack_Test_Rack_Site_2", + "rack_role_test_rack_role", + "role_core_switch", + "device_type_cisco_test", + "manufacturer_cisco", "status_active", - "ungrouped" + "device_type_nexus_parent", + "service_telnet", + "rack_Test_Rack", + "service_ssh", + "service_http", + "cluster_Test_Cluster_2", + "cluster_type_test_cluster_type", + "is_virtual", + "cluster_Test_Cluster", + "cluster_group_test_cluster_group" ] }, "cluster_Test_Cluster": { @@ -1237,8 +1237,8 @@ }, "service_ssh": { "hosts": [ - "Test VM With Spaces", - "test100" + "test100", + "Test VM With Spaces" ] }, "service_telnet": { @@ -1252,14 +1252,14 @@ ] }, "site_test_site": { + "children": [ + "location_parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "location_parent_rack_group" ] }, "site_test_site2": { @@ -1271,9 +1271,9 @@ "hosts": [ "R1-Device", "Test Nexus One", - "Test VM With Spaces", "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-bearer-token.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-bearer-token.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-bearer-token.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-bearer-token.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2-filter.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2-filter.json similarity index 99% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2-filter.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2-filter.json index a03b0c505..6d7249836 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2-filter.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2-filter.json @@ -237,6 +237,7 @@ "parent-region" ], "role": "core-switch", + "serial": "", "services": [ { "comments": "", @@ -268,8 +269,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "TestDeviceR1": { "config_context": {}, @@ -288,6 +288,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB12345678", "services": [], "site": "test-site", "site_groups": [], @@ -295,10 +296,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "config_context": { "ntp_servers": [ "pool.ntp.org" @@ -540,6 +541,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB01234567", "services": [ { "comments": "", @@ -607,9 +609,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -965,25 +965,25 @@ }, "all": { "children": [ - "cluster_Test_Cluster", - "cluster_group_test_cluster_group", - "cluster_type_test_cluster_type", - "device_type_cisco_test", - "device_type_nexus_parent", - "is_virtual", - "manufacturer_cisco", - "rack_Test_Rack", + "ungrouped", + "site_test_site2", "region_other_region", "region_parent_region", - "role_core_switch", - "service_http", - "service_ssh", - "service_telnet", "site_group_other_site_group", "site_group_parent_site_group", - "site_test_site2", + "role_core_switch", + "device_type_nexus_parent", + "manufacturer_cisco", + "service_telnet", "status_active", - "ungrouped" + "rack_Test_Rack", + "device_type_cisco_test", + "service_ssh", + "service_http", + "cluster_Test_Cluster", + "cluster_group_test_cluster_group", + "cluster_type_test_cluster_type", + "is_virtual" ] }, "cluster_Test_Cluster": { @@ -1010,14 +1010,6 @@ "test103-vm" ] }, - "is_virtual": { - "hosts": [ - "test100-vm", - "test101-vm", - "test102-vm", - "test103-vm" - ] - }, "device_type_cisco_test": { "hosts": [ "TestDeviceR1", @@ -1029,6 +1021,14 @@ "Test Nexus One" ] }, + "is_virtual": { + "hosts": [ + "test100-vm", + "test101-vm", + "test102-vm", + "test103-vm" + ] + }, "location_parent_rack_group": { "children": [ "location_test_rack_group" @@ -1091,14 +1091,14 @@ ] }, "site_test_site": { + "children": [ + "location_parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "location_parent_rack_group" ] }, "status_active": { diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2-filter.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2-filter.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2-filter.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2-filter.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2.json similarity index 96% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2.json index b46c5e186..119e5633d 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2.json @@ -26,6 +26,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "custom_fields": {}, "device_type": "cisco-test", "is_virtual": false, @@ -36,15 +37,14 @@ "rack_role": "test-rack-role", "regions": [], "role": "core-switch", + "serial": "", "site": "test-site2", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -76,14 +76,14 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB12345678", "site": "test-site", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "VC1": { "ansible_host": "nexus.example.com", @@ -102,16 +102,17 @@ "parent-region" ], "role": "core-switch", + "serial": "", "site": "test-site", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "test100": { + "asset_tag": "123456789", "custom_fields": {}, "device_type": "cisco-test", "is_virtual": false, @@ -130,15 +131,14 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB01234567", "site": "test-site", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -235,10 +235,10 @@ "active": { "hosts": [ "R1-Device", - "Test VM With Spaces", - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", @@ -248,33 +248,33 @@ }, "all": { "children": [ - "Test_Cluster", - "Test_Cluster_2", - "Test_Rack", - "Test_Rack_Site_2", - "active", - "cisco", - "cisco_test", - "core_switch", - "is_virtual", - "jinja_test_group", - "nexus_parent", + "ungrouped", + "test_site2", "other_region", - "other_site_group", "parent_region", + "other_site_group", "parent_site_group", - "test_cluster_group", - "test_cluster_type", + "Test_Rack_Site_2", "test_rack_role", - "test_site2", - "ungrouped" + "core_switch", + "cisco_test", + "cisco", + "active", + "nexus_parent", + "jinja_test_group", + "Test_Rack", + "Test_Cluster_2", + "test_cluster_type", + "is_virtual", + "Test_Cluster", + "test_cluster_group" ] }, "cisco": { "hosts": [ "R1-Device", - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100" ] }, @@ -288,8 +288,8 @@ "core_switch": { "hosts": [ "R1-Device", - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100" ] }, @@ -305,8 +305,8 @@ }, "jinja_test_group": { "hosts": [ - "Test VM With Spaces", - "TestDeviceR1" + "TestDeviceR1", + "Test VM With Spaces" ] }, "nexus_parent": { @@ -349,8 +349,8 @@ }, "test_rack_group": { "hosts": [ - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100" ] }, @@ -365,14 +365,14 @@ ] }, "test_site": { + "children": [ + "parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "parent_rack_group" ] }, "test_site2": { diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-jinja2.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-jinja2.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-legacy.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-legacy.json similarity index 98% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-legacy.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-legacy.json index 3ab35ce44..6df5dbf2b 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-legacy.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-legacy.json @@ -2,6 +2,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "custom_fields": {}, "device_roles": [ "core-switch" @@ -22,6 +23,7 @@ "Test Rack Site 2" ], "regions": [], + "serial": "", "services": [], "site_groups": [], "sites": [ @@ -31,9 +33,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test Nexus One": { "ansible_host": "172.16.180.12", @@ -60,6 +60,7 @@ "test-region", "parent-region" ], + "serial": "", "services": [ { "comments": "", @@ -93,8 +94,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -164,6 +164,7 @@ "test-region", "parent-region" ], + "serial": "FAB12345678", "services": [], "site_groups": [], "sites": [ @@ -173,10 +174,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "custom_fields": {}, "device_roles": [ "core-switch" @@ -203,6 +204,7 @@ "test-region", "parent-region" ], + "serial": "FAB01234567", "services": [ { "comments": "", @@ -272,9 +274,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -291,10 +291,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -316,10 +316,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -341,10 +341,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -366,10 +366,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -405,9 +405,9 @@ "hosts": [ "R1-Device", "Test Nexus One", - "Test VM With Spaces", "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-legacy.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-legacy.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-legacy.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-legacy.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-noracks.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-noracks.json similarity index 99% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-noracks.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-noracks.json index a97af7a61..b61454e00 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-noracks.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-noracks.json @@ -2,6 +2,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "config_context": [ {} ], @@ -21,6 +22,7 @@ "cisco" ], "regions": [], + "serial": "", "services": [], "site_groups": [], "sites": [ @@ -30,9 +32,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test Nexus One": { "ansible_host": "172.16.180.12", @@ -277,6 +277,7 @@ "test-region", "parent-region" ], + "serial": "", "services": [ { "comments": "", @@ -310,8 +311,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -434,6 +434,7 @@ "test-region", "parent-region" ], + "serial": "FAB12345678", "services": [], "site_groups": [], "sites": [ @@ -443,10 +444,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "config_context": [ { "ntp_servers": [ @@ -694,6 +695,7 @@ "test-region", "parent-region" ], + "serial": "FAB01234567", "services": [ { "comments": "", @@ -763,9 +765,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -916,10 +916,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1075,10 +1075,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1103,10 +1103,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1131,10 +1131,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1166,22 +1166,22 @@ }, "all": { "children": [ - "cluster_Test_Cluster", - "cluster_Test_Cluster_2", - "cluster_group_test_cluster_group", - "cluster_type_test_cluster_type", - "device_roles_core_switch", - "device_types_cisco_test", - "device_types_nexus_parent", - "is_virtual", - "manufacturers_cisco", + "ungrouped", + "sites_test_site2", "region_other_region", "region_parent_region", "site_group_other_site_group", "site_group_parent_site_group", - "sites_test_site2", + "device_roles_core_switch", + "device_types_cisco_test", + "manufacturers_cisco", "status_active", - "ungrouped" + "device_types_nexus_parent", + "cluster_Test_Cluster_2", + "cluster_type_test_cluster_type", + "is_virtual", + "cluster_Test_Cluster", + "cluster_group_test_cluster_group" ] }, "cluster_Test_Cluster": { @@ -1282,14 +1282,14 @@ ] }, "sites_test_site": { + "children": [ + "location_parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "location_parent_rack_group" ] }, "sites_test_site2": { @@ -1301,9 +1301,9 @@ "hosts": [ "R1-Device", "Test Nexus One", - "Test VM With Spaces", "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-noracks.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-noracks.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-noracks.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-noracks.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-options-flatten.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-options-flatten.json similarity index 99% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-options-flatten.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-options-flatten.json index 919c32c8c..8e019bd84 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-options-flatten.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-options-flatten.json @@ -26,6 +26,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "device_type": "cisco-test", "interfaces": [], "is_virtual": false, @@ -35,6 +36,7 @@ "rack_role": "test-rack-role", "regions": [], "role": "core-switch", + "serial": "", "services": [], "site": "test-site2", "site_groups": [], @@ -42,9 +44,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test Nexus One": { "ansible_host": "172.16.180.12", @@ -280,6 +280,7 @@ "parent-region" ], "role": "core-switch", + "serial": "", "services": [ { "comments": "", @@ -311,8 +312,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -421,6 +421,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB12345678", "services": [], "site": "test-site", "site_groups": [], @@ -428,10 +429,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "device_type": "cisco-test", "interfaces": [ { @@ -665,6 +666,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB01234567", "services": [ { "comments": "", @@ -732,9 +734,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -1099,9 +1099,9 @@ "hosts": [ "R1-Device", "Test Nexus One", - "Test VM With Spaces", "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", @@ -1111,25 +1111,25 @@ }, "all": { "children": [ - "Test_Cluster", - "Test_Cluster_2", - "Test_Rack", - "Test_Rack_Site_2", - "active", - "cisco", - "cisco_test", - "core_switch", - "is_virtual", - "nexus_parent", + "ungrouped", + "test_site2", "other_region", - "other_site_group", "parent_region", + "other_site_group", "parent_site_group", - "test_cluster_group", - "test_cluster_type", + "Test_Rack_Site_2", "test_rack_role", - "test_site2", - "ungrouped" + "core_switch", + "cisco_test", + "cisco", + "active", + "nexus_parent", + "Test_Rack", + "Test_Cluster_2", + "test_cluster_type", + "is_virtual", + "Test_Cluster", + "test_cluster_group" ] }, "cisco": { @@ -1221,14 +1221,14 @@ ] }, "test_site": { + "children": [ + "parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "parent_rack_group" ] }, "test_site2": { diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-options-flatten.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-options-flatten.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-options-flatten.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-options-flatten.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-options.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-options.json similarity index 96% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-options.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-options.json index b46c5e186..119e5633d 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-options.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-options.json @@ -26,6 +26,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "custom_fields": {}, "device_type": "cisco-test", "is_virtual": false, @@ -36,15 +37,14 @@ "rack_role": "test-rack-role", "regions": [], "role": "core-switch", + "serial": "", "site": "test-site2", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -76,14 +76,14 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB12345678", "site": "test-site", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "VC1": { "ansible_host": "nexus.example.com", @@ -102,16 +102,17 @@ "parent-region" ], "role": "core-switch", + "serial": "", "site": "test-site", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "test100": { + "asset_tag": "123456789", "custom_fields": {}, "device_type": "cisco-test", "is_virtual": false, @@ -130,15 +131,14 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB01234567", "site": "test-site", "site_groups": [], "status": { "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -235,10 +235,10 @@ "active": { "hosts": [ "R1-Device", - "Test VM With Spaces", - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", @@ -248,33 +248,33 @@ }, "all": { "children": [ - "Test_Cluster", - "Test_Cluster_2", - "Test_Rack", - "Test_Rack_Site_2", - "active", - "cisco", - "cisco_test", - "core_switch", - "is_virtual", - "jinja_test_group", - "nexus_parent", + "ungrouped", + "test_site2", "other_region", - "other_site_group", "parent_region", + "other_site_group", "parent_site_group", - "test_cluster_group", - "test_cluster_type", + "Test_Rack_Site_2", "test_rack_role", - "test_site2", - "ungrouped" + "core_switch", + "cisco_test", + "cisco", + "active", + "nexus_parent", + "jinja_test_group", + "Test_Rack", + "Test_Cluster_2", + "test_cluster_type", + "is_virtual", + "Test_Cluster", + "test_cluster_group" ] }, "cisco": { "hosts": [ "R1-Device", - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100" ] }, @@ -288,8 +288,8 @@ "core_switch": { "hosts": [ "R1-Device", - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100" ] }, @@ -305,8 +305,8 @@ }, "jinja_test_group": { "hosts": [ - "Test VM With Spaces", - "TestDeviceR1" + "TestDeviceR1", + "Test VM With Spaces" ] }, "nexus_parent": { @@ -349,8 +349,8 @@ }, "test_rack_group": { "hosts": [ - "TestDeviceR1", "VC1", + "TestDeviceR1", "test100" ] }, @@ -365,14 +365,14 @@ ] }, "test_site": { + "children": [ + "parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "parent_rack_group" ] }, "test_site2": { diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-options.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-options.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-options.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-options.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-plurals-flatten.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-plurals-flatten.json similarity index 97% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-plurals-flatten.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-plurals-flatten.json index 32e333a22..bf84ee743 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-plurals-flatten.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-plurals-flatten.json @@ -26,6 +26,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "device_roles": [ "core-switch" ], @@ -45,6 +46,7 @@ "Test Rack Site 2" ], "regions": [], + "serial": "", "site_groups": [], "sites": [ "test-site2" @@ -53,9 +55,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test Nexus One": { "ansible_host": "172.16.180.12", @@ -81,6 +81,7 @@ "test-region", "parent-region" ], + "serial": "", "site_groups": [], "sites": [ "test-site" @@ -89,8 +90,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -133,6 +133,7 @@ "test-region", "parent-region" ], + "serial": "FAB12345678", "site_groups": [], "sites": [ "test-site" @@ -141,10 +142,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "device_roles": [ "core-switch" ], @@ -173,6 +174,7 @@ "test-region", "parent-region" ], + "serial": "FAB01234567", "site_groups": [], "sites": [ "test-site" @@ -181,9 +183,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -198,10 +198,10 @@ "test-region", "parent-region" ], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -221,10 +221,10 @@ "test-region", "parent-region" ], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -244,10 +244,10 @@ "test-region", "parent-region" ], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -267,10 +267,10 @@ "test-region", "parent-region" ], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -299,9 +299,9 @@ "hosts": [ "R1-Device", "Test Nexus One", - "Test VM With Spaces", "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", @@ -311,25 +311,25 @@ }, "all": { "children": [ - "Test_Cluster", - "Test_Cluster_2", - "Test_Rack", - "Test_Rack_Site_2", - "active", - "cisco", - "cisco_test", - "core_switch", - "is_virtual", - "nexus_parent", + "ungrouped", + "test_site2", "other_region", - "other_site_group", "parent_region", + "other_site_group", "parent_site_group", - "test_cluster_group", - "test_cluster_type", + "Test_Rack_Site_2", "test_rack_role", - "test_site2", - "ungrouped" + "core_switch", + "cisco_test", + "cisco", + "active", + "nexus_parent", + "Test_Rack", + "Test_Cluster_2", + "test_cluster_type", + "is_virtual", + "Test_Cluster", + "test_cluster_group" ] }, "cisco": { @@ -421,14 +421,14 @@ ] }, "test_site": { + "children": [ + "parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "parent_rack_group" ] }, "test_site2": { diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-plurals-flatten.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-plurals-flatten.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-plurals-flatten.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-plurals-flatten.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-plurals.json b/tests/integration/targets/inventory-v3.7/files/test-inventory-plurals.json similarity index 99% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-plurals.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory-plurals.json index 63dd962ce..22f9d4e5f 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory-plurals.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory-plurals.json @@ -2,6 +2,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "config_context": [ {} ], @@ -26,6 +27,7 @@ "Test Rack Site 2" ], "regions": [], + "serial": "", "services": [], "site_groups": [], "sites": [ @@ -35,9 +37,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test Nexus One": { "ansible_host": "172.16.180.12", @@ -286,6 +286,7 @@ "test-region", "parent-region" ], + "serial": "", "services": [ { "comments": "", @@ -319,8 +320,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -451,6 +451,7 @@ "test-region", "parent-region" ], + "serial": "FAB12345678", "services": [], "site_groups": [], "sites": [ @@ -460,10 +461,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "config_context": [ { "ntp_servers": [ @@ -715,6 +716,7 @@ "test-region", "parent-region" ], + "serial": "FAB01234567", "services": [ { "comments": "", @@ -784,9 +786,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -938,10 +938,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1098,10 +1098,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1127,10 +1127,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1156,10 +1156,10 @@ "parent-region" ], "services": [], + "site_groups": [], "sites": [ "test-site" ], - "site_groups": [], "status": { "label": "Active", "value": "active" @@ -1192,25 +1192,25 @@ }, "all": { "children": [ - "cluster_Test_Cluster", - "cluster_Test_Cluster_2", - "cluster_group_test_cluster_group", - "cluster_type_test_cluster_type", - "device_roles_core_switch", - "device_types_cisco_test", - "device_types_nexus_parent", - "is_virtual", - "manufacturers_cisco", - "rack_role_test_rack_role", - "racks_Test_Rack", - "racks_Test_Rack_Site_2", + "ungrouped", + "sites_test_site2", "region_other_region", "region_parent_region", "site_group_other_site_group", "site_group_parent_site_group", - "sites_test_site2", + "racks_Test_Rack_Site_2", + "rack_role_test_rack_role", + "device_roles_core_switch", + "device_types_cisco_test", + "manufacturers_cisco", "status_active", - "ungrouped" + "device_types_nexus_parent", + "racks_Test_Rack", + "cluster_Test_Cluster_2", + "cluster_type_test_cluster_type", + "is_virtual", + "cluster_Test_Cluster", + "cluster_group_test_cluster_group" ] }, "cluster_Test_Cluster": { @@ -1326,14 +1326,14 @@ ] }, "sites_test_site": { + "children": [ + "location_parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "location_parent_rack_group" ] }, "sites_test_site2": { @@ -1345,9 +1345,9 @@ "hosts": [ "R1-Device", "Test Nexus One", - "Test VM With Spaces", "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory-plurals.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory-plurals.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory-plurals.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory-plurals.yml diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory.json b/tests/integration/targets/inventory-v3.7/files/test-inventory.json similarity index 99% rename from tests/integration/targets/inventory-v3.4/files/test-inventory.json rename to tests/integration/targets/inventory-v3.7/files/test-inventory.json index 1e52fdccd..360a7ac33 100644 --- a/tests/integration/targets/inventory-v3.4/files/test-inventory.json +++ b/tests/integration/targets/inventory-v3.7/files/test-inventory.json @@ -2,6 +2,7 @@ "_meta": { "hostvars": { "R1-Device": { + "asset_tag": "345678901", "config_context": {}, "custom_fields": {}, "device_type": "cisco-test", @@ -13,6 +14,7 @@ "rack_role": "test-rack-role", "regions": [], "role": "core-switch", + "serial": "", "services": [], "site": "test-site2", "site_groups": [], @@ -20,9 +22,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "", - "asset_tag": "345678901" + "tags": [] }, "Test Nexus One": { "ansible_host": "172.16.180.12", @@ -260,6 +260,7 @@ "parent-region" ], "role": "core-switch", + "serial": "", "services": [ { "comments": "", @@ -291,8 +292,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "" + "tags": [] }, "Test VM With Spaces": { "cluster": "Test Cluster 2", @@ -405,6 +405,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB12345678", "services": [], "site": "test-site", "site_groups": [], @@ -412,10 +413,10 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB12345678" + "tags": [] }, "test100": { + "asset_tag": "123456789", "config_context": { "ntp_servers": [ "pool.ntp.org" @@ -657,6 +658,7 @@ "parent-region" ], "role": "core-switch", + "serial": "FAB01234567", "services": [ { "comments": "", @@ -724,9 +726,7 @@ "label": "Active", "value": "active" }, - "tags": [], - "serial": "FAB01234567", - "asset_tag": "123456789" + "tags": [] }, "test100-vm": { "cluster": "Test Cluster", @@ -1099,28 +1099,28 @@ }, "all": { "children": [ - "cluster_Test_Cluster", - "cluster_Test_Cluster_2", - "cluster_group_test_cluster_group", - "cluster_type_test_cluster_type", - "device_type_cisco_test", - "device_type_nexus_parent", - "is_virtual", - "manufacturer_cisco", - "rack_Test_Rack", - "rack_Test_Rack_Site_2", - "rack_role_test_rack_role", + "ungrouped", + "site_test_site2", "region_other_region", "region_parent_region", - "role_core_switch", - "service_http", - "service_ssh", - "service_telnet", "site_group_other_site_group", "site_group_parent_site_group", - "site_test_site2", + "rack_Test_Rack_Site_2", + "rack_role_test_rack_role", + "role_core_switch", + "device_type_cisco_test", + "manufacturer_cisco", "status_active", - "ungrouped" + "device_type_nexus_parent", + "service_telnet", + "rack_Test_Rack", + "service_ssh", + "service_http", + "cluster_Test_Cluster_2", + "cluster_type_test_cluster_type", + "is_virtual", + "cluster_Test_Cluster", + "cluster_group_test_cluster_group" ] }, "cluster_Test_Cluster": { @@ -1237,8 +1237,8 @@ }, "service_ssh": { "hosts": [ - "Test VM With Spaces", - "test100" + "test100", + "Test VM With Spaces" ] }, "service_telnet": { @@ -1252,14 +1252,14 @@ ] }, "site_test_site": { + "children": [ + "location_parent_rack_group" + ], "hosts": [ "test100-vm", "test101-vm", "test102-vm", "test103-vm" - ], - "children": [ - "location_parent_rack_group" ] }, "site_test_site2": { @@ -1271,9 +1271,9 @@ "hosts": [ "R1-Device", "Test Nexus One", - "Test VM With Spaces", "TestDeviceR1", "test100", + "Test VM With Spaces", "test100-vm", "test101-vm", "test102-vm", diff --git a/tests/integration/targets/inventory-v3.4/files/test-inventory.yml b/tests/integration/targets/inventory-v3.7/files/test-inventory.yml similarity index 100% rename from tests/integration/targets/inventory-v3.4/files/test-inventory.yml rename to tests/integration/targets/inventory-v3.7/files/test-inventory.yml diff --git a/tests/integration/targets/inventory-v3.4/runme.sh b/tests/integration/targets/inventory-v3.7/runme.sh similarity index 98% rename from tests/integration/targets/inventory-v3.4/runme.sh rename to tests/integration/targets/inventory-v3.7/runme.sh index 2d2943061..18579c472 100755 --- a/tests/integration/targets/inventory-v3.4/runme.sh +++ b/tests/integration/targets/inventory-v3.7/runme.sh @@ -19,7 +19,7 @@ fi declare -a COMPARE_OPTIONS # empty array # Check if NETBOX_VERSION has been set by runme_config, and if so, pass to compare_inventory_json.py -if [[ "${NETBOX_VERSION:-}" == "v3.4" ]] +if [[ "${NETBOX_VERSION:-}" == "v3.5" ]] then COMPARE_OPTIONS+=(--netbox-version "${NETBOX_VERSION}") fi diff --git a/tests/integration/targets/inventory-v3.4/runme_config.template b/tests/integration/targets/inventory-v3.7/runme_config.template similarity index 100% rename from tests/integration/targets/inventory-v3.4/runme_config.template rename to tests/integration/targets/inventory-v3.7/runme_config.template diff --git a/tests/integration/targets/regression-v3.4/tasks/main.yml b/tests/integration/targets/regression-v3.7/tasks/main.yml similarity index 100% rename from tests/integration/targets/regression-v3.4/tasks/main.yml rename to tests/integration/targets/regression-v3.7/tasks/main.yml diff --git a/tests/integration/targets/v3.5/tasks/netbox_lookup.yml b/tests/integration/targets/v3.5/tasks/netbox_lookup.yml index d3d99c181..277454fcd 100644 --- a/tests/integration/targets/v3.5/tasks/netbox_lookup.yml +++ b/tests/integration/targets/v3.5/tasks/netbox_lookup.yml @@ -6,27 +6,27 @@ ## - name: "NETBOX_LOOKUP 1: Lookup returns exactly two sites" assert: - that: "{{ query_result|count }} == 3" + that: query_result == "3" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|count }}" - name: "NETBOX_LOOKUP 2: Query doesn't return Wibble (sanity check json_query)" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`Wibble`]')|count }} == 0" + that: query_result == "0" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`Wibble`]')|count}}" - name: "NETBOX_LOOKUP 3: Device query returns exactly one TestDeviceR1" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`TestDeviceR1`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`TestDeviceR1`]')|count }}" - name: "NETBOX_LOOKUP 4: VLAN ID 400 can be queried and is named 'Test VLAN'" assert: - that: "{{ (query_result|community.general.json_query('[?value.vid==`400`].value.name'))[0] == 'Test VLAN' }}" + that: query_result == 'Test VLAN' vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'vlans', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ (query('netbox.netbox.nb_lookup', 'vlans', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.vid==`400`].value.name'))[0] }}" - name: "NETBOX_LOOKUP 5: Add one of two devices for lookup filter test." netbox.netbox.netbox_device: @@ -58,25 +58,26 @@ - name: "NETBOX_LOOKUP 7: Device query returns exactly the L2 device" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`L2`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`L2`]')|count }}" - name: "NETBOX_LOOKUP 8: Device query specifying raw data returns payload without key/value dict" assert: - that: "{{ query_result|community.general.json_query('[?display==`L2`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True)|community.general.json_query('[?display==`L2`]')|count }}" - name: "NETBOX_LOOKUP 9: Device query specifying multiple sites, Make sure L1 and L2 are in the results" assert: that: - - "'L1' in {{ query_result |community.general.json_query('[*].display') }}" - - "'L2' in {{ query_result |community.general.json_query('[*].display') }}" + - "'L1' in query_result" + - "'L2' in query_result" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True)|community.general.json_query('[*].display') }}" - name: "NETBOX_LOOKUP 10: Device query by ID" assert: - that: - - "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + that: query_result + vars: + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" diff --git a/tests/integration/targets/v3.5/tasks/netbox_tenant_group.yml b/tests/integration/targets/v3.5/tasks/netbox_tenant_group.yml index 47ad78431..4113a2260 100644 --- a/tests/integration/targets/v3.5/tasks/netbox_tenant_group.yml +++ b/tests/integration/targets/v3.5/tasks/netbox_tenant_group.yml @@ -90,7 +90,7 @@ - test_five['diff']['before']['state'] == "absent" - test_five['diff']['after']['state'] == "present" - test_five['tenant_group']['name'] == "Child Test Tenant Group" - - test_five['tenant_group']['parent'] == {{ test_four.tenant_group.id }} + - test_five['tenant_group']['parent'] == test_four.tenant_group.id - test_five['msg'] == "tenant_group Child Test Tenant Group created" - name: "6 - Test child tenant group deletion" diff --git a/tests/integration/targets/v3.6/tasks/netbox_lookup.yml b/tests/integration/targets/v3.6/tasks/netbox_lookup.yml index d3d99c181..277454fcd 100644 --- a/tests/integration/targets/v3.6/tasks/netbox_lookup.yml +++ b/tests/integration/targets/v3.6/tasks/netbox_lookup.yml @@ -6,27 +6,27 @@ ## - name: "NETBOX_LOOKUP 1: Lookup returns exactly two sites" assert: - that: "{{ query_result|count }} == 3" + that: query_result == "3" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|count }}" - name: "NETBOX_LOOKUP 2: Query doesn't return Wibble (sanity check json_query)" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`Wibble`]')|count }} == 0" + that: query_result == "0" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`Wibble`]')|count}}" - name: "NETBOX_LOOKUP 3: Device query returns exactly one TestDeviceR1" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`TestDeviceR1`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`TestDeviceR1`]')|count }}" - name: "NETBOX_LOOKUP 4: VLAN ID 400 can be queried and is named 'Test VLAN'" assert: - that: "{{ (query_result|community.general.json_query('[?value.vid==`400`].value.name'))[0] == 'Test VLAN' }}" + that: query_result == 'Test VLAN' vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'vlans', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ (query('netbox.netbox.nb_lookup', 'vlans', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.vid==`400`].value.name'))[0] }}" - name: "NETBOX_LOOKUP 5: Add one of two devices for lookup filter test." netbox.netbox.netbox_device: @@ -58,25 +58,26 @@ - name: "NETBOX_LOOKUP 7: Device query returns exactly the L2 device" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`L2`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`L2`]')|count }}" - name: "NETBOX_LOOKUP 8: Device query specifying raw data returns payload without key/value dict" assert: - that: "{{ query_result|community.general.json_query('[?display==`L2`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True)|community.general.json_query('[?display==`L2`]')|count }}" - name: "NETBOX_LOOKUP 9: Device query specifying multiple sites, Make sure L1 and L2 are in the results" assert: that: - - "'L1' in {{ query_result |community.general.json_query('[*].display') }}" - - "'L2' in {{ query_result |community.general.json_query('[*].display') }}" + - "'L1' in query_result" + - "'L2' in query_result" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True)|community.general.json_query('[*].display') }}" - name: "NETBOX_LOOKUP 10: Device query by ID" assert: - that: - - "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + that: query_result + vars: + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" diff --git a/tests/integration/targets/v3.6/tasks/netbox_rack_role.yml b/tests/integration/targets/v3.6/tasks/netbox_rack_role.yml index 5ca9e44eb..b437a5a78 100644 --- a/tests/integration/targets/v3.6/tasks/netbox_rack_role.yml +++ b/tests/integration/targets/v3.6/tasks/netbox_rack_role.yml @@ -50,6 +50,7 @@ data: name: Rack Role color: "003EFF" + description: "This is a Rack Role test" state: present register: test_three @@ -61,6 +62,7 @@ - test_three['rack_role']['name'] == "Rack Role" - test_three['rack_role']['slug'] == "rack-role" - test_three['rack_role']['color'] == "003eff" + - test_three['rack_role']['description'] == "This is a Rack Role test" - test_three['msg'] == "rack_role Rack Role updated" - name: "RACK_ROLE 4: Delete" diff --git a/tests/integration/targets/v3.6/tasks/netbox_tenant_group.yml b/tests/integration/targets/v3.6/tasks/netbox_tenant_group.yml index 47ad78431..4113a2260 100644 --- a/tests/integration/targets/v3.6/tasks/netbox_tenant_group.yml +++ b/tests/integration/targets/v3.6/tasks/netbox_tenant_group.yml @@ -90,7 +90,7 @@ - test_five['diff']['before']['state'] == "absent" - test_five['diff']['after']['state'] == "present" - test_five['tenant_group']['name'] == "Child Test Tenant Group" - - test_five['tenant_group']['parent'] == {{ test_four.tenant_group.id }} + - test_five['tenant_group']['parent'] == test_four.tenant_group.id - test_five['msg'] == "tenant_group Child Test Tenant Group created" - name: "6 - Test child tenant group deletion" diff --git a/tests/integration/targets/v3.4/tasks/main.yml b/tests/integration/targets/v3.7/tasks/main.yml similarity index 90% rename from tests/integration/targets/v3.4/tasks/main.yml rename to tests/integration/targets/v3.7/tasks/main.yml index 38aa7d0ff..d1c4b6fe7 100644 --- a/tests/integration/targets/v3.4/tasks/main.yml +++ b/tests/integration/targets/v3.7/tasks/main.yml @@ -1,5 +1,4 @@ --- - - name: "NETBOX_DEVICE TESTS" include_tasks: "netbox_device.yml" @@ -229,32 +228,33 @@ tags: - netbox_export_template -- name: "NETBOX_WEBHOOK TESTS" - include_tasks: - file: "netbox_webhook.yml" - apply: - tags: - - netbox_webhook - tags: - - netbox_webhook - -- name: "NETBOX_L2VPN TESTS" - include_tasks: - file: "netbox_l2vpn.yml" - apply: - tags: - - netbox_l2vpn - tags: - - netbox_l2vpn - -- name: "NETBOX_L2VPN_TERMINATION TESTS" - include_tasks: - file: "netbox_l2vpn_termination.yml" - apply: - tags: - - netbox_l2vpn_termination - tags: - - netbox_l2vpn_termination +# Must update for 3.7 +#- name: "NETBOX_WEBHOOK TESTS" +# include_tasks: +# file: "netbox_webhook.yml" +# apply: +# tags: +# - netbox_webhook +# tags: +# - netbox_webhook + +#- name: "NETBOX_L2VPN TESTS" +# include_tasks: +# file: "netbox_l2vpn.yml" +# apply: +# tags: +# - netbox_l2vpn +# tags: +# - netbox_l2vpn + +#- name: "NETBOX_L2VPN_TERMINATION TESTS" +# include_tasks: +# file: "netbox_l2vpn_termination.yml" +# apply: +# tags: +# - netbox_l2vpn_termination +# tags: +# - netbox_l2vpn_termination - name: "NETBOX_INVENTORY_ITEM_ROLE TESTS" include_tasks: @@ -306,3 +306,13 @@ - netbox_fhrp_group_assignmen tags: - netbox_fhrp_group_assignmen + +- name: "NETBOX_CONFIG_TEMPLATE" + include_tasks: "netbox_config_template.yml" + tags: + - netbox_config_template + +- name: "NETBOX_VIRTUAL_DISK" + include_tasks: "netbox_virtual_disk.yml" + tags: + - netbox_virtual_disk diff --git a/tests/integration/targets/v3.4/tasks/netbox_aggregate.yml b/tests/integration/targets/v3.7/tasks/netbox_aggregate.yml similarity index 97% rename from tests/integration/targets/v3.4/tasks/netbox_aggregate.yml rename to tests/integration/targets/v3.7/tasks/netbox_aggregate.yml index 8fbd2b7dd..ac02641dc 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_aggregate.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_aggregate.yml @@ -21,7 +21,7 @@ - test_one['diff']['before']['state'] == "absent" - test_one['diff']['after']['state'] == "present" - test_one['aggregate']['prefix'] == "10.0.0.0/8" - - test_one['aggregate']['family'] == 4 + #- test_one['aggregate']['family'] == 4 - test_one['aggregate']['rir'] == 1 - test_one['msg'] == "aggregate 10.0.0.0/8 created" @@ -110,6 +110,6 @@ - test_five['diff']['before']['state'] == "absent" - test_five['diff']['after']['state'] == "present" - test_five['aggregate']['prefix'] == "2001::/32" - - test_five['aggregate']['family'] == 6 + #- test_five['aggregate']['family'] == 6 - test_five['aggregate']['rir'] == 1 - test_five['msg'] == "aggregate 2001::/32 created" diff --git a/tests/integration/targets/v3.4/tasks/netbox_asn.yml b/tests/integration/targets/v3.7/tasks/netbox_asn.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_asn.yml rename to tests/integration/targets/v3.7/tasks/netbox_asn.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_cable.yml b/tests/integration/targets/v3.7/tasks/netbox_cable.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_cable.yml rename to tests/integration/targets/v3.7/tasks/netbox_cable.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_circuit.yml b/tests/integration/targets/v3.7/tasks/netbox_circuit.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_circuit.yml rename to tests/integration/targets/v3.7/tasks/netbox_circuit.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_circuit_termination.yml b/tests/integration/targets/v3.7/tasks/netbox_circuit_termination.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_circuit_termination.yml rename to tests/integration/targets/v3.7/tasks/netbox_circuit_termination.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_circuit_type.yml b/tests/integration/targets/v3.7/tasks/netbox_circuit_type.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_circuit_type.yml rename to tests/integration/targets/v3.7/tasks/netbox_circuit_type.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_cluster.yml b/tests/integration/targets/v3.7/tasks/netbox_cluster.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_cluster.yml rename to tests/integration/targets/v3.7/tasks/netbox_cluster.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_cluster_group.yml b/tests/integration/targets/v3.7/tasks/netbox_cluster_group.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_cluster_group.yml rename to tests/integration/targets/v3.7/tasks/netbox_cluster_group.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_cluster_type.yml b/tests/integration/targets/v3.7/tasks/netbox_cluster_type.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_cluster_type.yml rename to tests/integration/targets/v3.7/tasks/netbox_cluster_type.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_config_context.yml b/tests/integration/targets/v3.7/tasks/netbox_config_context.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_config_context.yml rename to tests/integration/targets/v3.7/tasks/netbox_config_context.yml diff --git a/tests/integration/targets/v3.7/tasks/netbox_config_template.yml b/tests/integration/targets/v3.7/tasks/netbox_config_template.yml new file mode 100644 index 000000000..9abf3ea05 --- /dev/null +++ b/tests/integration/targets/v3.7/tasks/netbox_config_template.yml @@ -0,0 +1,82 @@ +--- +## +## +### NETBOX_CONFIG_TEMPLATES +## +## +- name: "CONFIG_TEMPLATES 1: Necessary info creation" + netbox.netbox.netbox_config_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: "test_template" + description: "Test template" + template_code: "test template" + state: present + register: test_one + +- name: "CONFIG_TEMPLATES 1: ASSERT - Necessary info creation" + assert: + that: + - test_one is changed + - test_one['diff']['before']['state'] == "absent" + - test_one['diff']['after']['state'] == "present" + - test_one['config_template']['name'] == "test_template" + - test_one['config_template']['description'] == "Test template" + - test_one['config_template']['template_code'] == "test template" + - test_one['msg'] == "config_template test_template created" + +- name: "CONFIG_TEMPLATES 2: Create duplicate" + netbox.netbox.netbox_config_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: "test_template" + description: "Test template" + template_code: "test template" + state: present + register: test_two + +- name: "CONFIG_TEMPLATES 2: ASSERT - Create duplicate" + assert: + that: + - not test_two['changed'] + - test_two['config_template']['name'] == "test_template" + - test_two['msg'] == "config_template test_template already exists" + +- name: "CONFIG_TEMPLATES 3: Update data" + netbox.netbox.netbox_config_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: "test_template" + description: "Updated test template" + template_code: "updated test template" + state: present + register: test_three + +- name: "CONFIG_TEMPLATES 3: ASSERT - Updated" + assert: + that: + - test_three is changed + - test_three['diff']['after']['template_code'] == "updated test template" + - test_three['diff']['after']['description'] == "Updated test template" + - test_three['config_template']['name'] == "test_template" + - test_three['msg'] == "config_template test_template updated" + +- name: "CONFIG_TEMPLATES 4: Delete" + netbox.netbox.netbox_config_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: "test_template" + state: absent + register: test_four + +- name: "CONFIG_TEMPLATES 4: ASSERT - Deleted" + assert: + that: + - test_four is changed + - test_four['diff']['after']['state'] == "absent" + - test_four['config_template']['name'] == "test_template" + - test_four['msg'] == "config_template test_template deleted" diff --git a/tests/integration/targets/v3.4/tasks/netbox_console_port.yml b/tests/integration/targets/v3.7/tasks/netbox_console_port.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_console_port.yml rename to tests/integration/targets/v3.7/tasks/netbox_console_port.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_console_port_template.yml b/tests/integration/targets/v3.7/tasks/netbox_console_port_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_console_port_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_console_port_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_console_server_port.yml b/tests/integration/targets/v3.7/tasks/netbox_console_server_port.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_console_server_port.yml rename to tests/integration/targets/v3.7/tasks/netbox_console_server_port.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_console_server_port_template.yml b/tests/integration/targets/v3.7/tasks/netbox_console_server_port_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_console_server_port_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_console_server_port_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_contact.yml b/tests/integration/targets/v3.7/tasks/netbox_contact.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_contact.yml rename to tests/integration/targets/v3.7/tasks/netbox_contact.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_contact_role.yml b/tests/integration/targets/v3.7/tasks/netbox_contact_role.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_contact_role.yml rename to tests/integration/targets/v3.7/tasks/netbox_contact_role.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_custom_field.yml b/tests/integration/targets/v3.7/tasks/netbox_custom_field.yml similarity index 84% rename from tests/integration/targets/v3.4/tasks/netbox_custom_field.yml rename to tests/integration/targets/v3.7/tasks/netbox_custom_field.yml index 0db0b5e1a..7b8525e8e 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_custom_field.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_custom_field.yml @@ -106,3 +106,24 @@ - test_five['diff']['after']['state'] == "absent" - test_five['custom_field']['name'] == "A_CustomField" - test_five['msg'] == "custom_field A_CustomField deleted" + +# Change in NetBox 3.7 +#- name: "CUSTOM_FIELD 6: UI Visibility (hidden-ifunset)" +# netbox.netbox.netbox_custom_field: +# netbox_url: http://localhost:32768 +# netbox_token: 0123456789abcdef0123456789abcdef01234567 +# data: +# content_types: +# - "dcim.device" +# name: A_CustomField +# type: text +# ui_visibility: hidden-ifunset +# state: present +# register: test_six + +#- name: "CUSTOM_FIELD 6: UI Visibility (hidden-ifunset)" +# assert: +# that: +# - test_six is changed +# - test_six['custom_field']['name'] == "A_CustomField" +# - test_six['custom_field']['ui_visibility'] == "hidden-ifunset" diff --git a/tests/integration/targets/v3.4/tasks/netbox_custom_link.yml b/tests/integration/targets/v3.7/tasks/netbox_custom_link.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_custom_link.yml rename to tests/integration/targets/v3.7/tasks/netbox_custom_link.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_device.yml b/tests/integration/targets/v3.7/tasks/netbox_device.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_device.yml rename to tests/integration/targets/v3.7/tasks/netbox_device.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_device_bay.yml b/tests/integration/targets/v3.7/tasks/netbox_device_bay.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_device_bay.yml rename to tests/integration/targets/v3.7/tasks/netbox_device_bay.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_device_bay_template.yml b/tests/integration/targets/v3.7/tasks/netbox_device_bay_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_device_bay_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_device_bay_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_device_interface.yml b/tests/integration/targets/v3.7/tasks/netbox_device_interface.yml similarity index 98% rename from tests/integration/targets/v3.4/tasks/netbox_device_interface.yml rename to tests/integration/targets/v3.7/tasks/netbox_device_interface.yml index d8e187d65..fa3f10214 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_device_interface.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_device_interface.yml @@ -1,9 +1,6 @@ --- -## -## -### NETBOX_DEVICE_INTERFACE -## -## +# NETBOX_DEVICE_INTERFACE + - name: "1 - Interface with required information" netbox.netbox.netbox_device_interface: netbox_url: "http://localhost:32768" @@ -123,7 +120,7 @@ - test_five['interface']['enabled'] == false - test_five['interface']['type'] == "1000base-t" - test_five['interface']['mgmt_only'] == false - - test_five['interface']['lag'] == 10 + - test_five['interface']['lag'] == test_four["interface"]["id"] - test_five['interface']['mode'] == "access" - test_five['interface']['mtu'] == 1600 @@ -256,6 +253,7 @@ device: Test Nexus One name: Ethernet2/2 description: "Updated child interface from parent device" + type: 1000Base-T (1GE) update_vc_child: True state: present register: test_ten @@ -280,6 +278,7 @@ device: Test Nexus One name: Ethernet2/2 description: "Updated child interface from parent device - test" + type: 1000Base-T (1GE) state: present ignore_errors: yes register: test_eleven diff --git a/tests/integration/targets/v3.4/tasks/netbox_device_interface_template.yml b/tests/integration/targets/v3.7/tasks/netbox_device_interface_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_device_interface_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_device_interface_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_device_role.yml b/tests/integration/targets/v3.7/tasks/netbox_device_role.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_device_role.yml rename to tests/integration/targets/v3.7/tasks/netbox_device_role.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_device_type.yml b/tests/integration/targets/v3.7/tasks/netbox_device_type.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_device_type.yml rename to tests/integration/targets/v3.7/tasks/netbox_device_type.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_export_template.yml b/tests/integration/targets/v3.7/tasks/netbox_export_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_export_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_export_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_fhrp_group.yml b/tests/integration/targets/v3.7/tasks/netbox_fhrp_group.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_fhrp_group.yml rename to tests/integration/targets/v3.7/tasks/netbox_fhrp_group.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_fhrp_group_assignment.yml b/tests/integration/targets/v3.7/tasks/netbox_fhrp_group_assignment.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_fhrp_group_assignment.yml rename to tests/integration/targets/v3.7/tasks/netbox_fhrp_group_assignment.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_front_port.yml b/tests/integration/targets/v3.7/tasks/netbox_front_port.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_front_port.yml rename to tests/integration/targets/v3.7/tasks/netbox_front_port.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_front_port_template.yml b/tests/integration/targets/v3.7/tasks/netbox_front_port_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_front_port_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_front_port_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_inventory_item.yml b/tests/integration/targets/v3.7/tasks/netbox_inventory_item.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_inventory_item.yml rename to tests/integration/targets/v3.7/tasks/netbox_inventory_item.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_inventory_item_role.yml b/tests/integration/targets/v3.7/tasks/netbox_inventory_item_role.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_inventory_item_role.yml rename to tests/integration/targets/v3.7/tasks/netbox_inventory_item_role.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_ip_address.yml b/tests/integration/targets/v3.7/tasks/netbox_ip_address.yml similarity index 86% rename from tests/integration/targets/v3.4/tasks/netbox_ip_address.yml rename to tests/integration/targets/v3.7/tasks/netbox_ip_address.yml index 3cda56d3c..c18cad9bd 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_ip_address.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_ip_address.yml @@ -80,23 +80,24 @@ - test_four['msg'] == "ip_address 192.168.1.20/30 created" - test_four['ip_address']['address'] == "192.168.1.20/30" -- name: "5 - Create IP in global VRF - 192.168.1.20/30 - State: New" - netbox.netbox.netbox_ip_address: - netbox_url: http://localhost:32768 - netbox_token: 0123456789abcdef0123456789abcdef01234567 - data: - address: 192.168.1.20/30 - state: new - register: test_five +# Enforce uniqueness in NetBox 3.7 +#- name: "5 - Create IP in global VRF - 192.168.1.20/30 - State: New" +# netbox.netbox.netbox_ip_address: +# netbox_url: http://localhost:32768 +# netbox_token: 0123456789abcdef0123456789abcdef01234567 +# data: +# address: 192.168.1.20/30 +# state: new +# register: test_five -- name: "5 - ASSERT" - assert: - that: - - test_five is changed - - test_five['diff']['before']['state'] == "absent" - - test_five['diff']['after']['state'] == "present" - - test_five['msg'] == "ip_address 192.168.1.20/30 created" - - test_five['ip_address']['address'] == "192.168.1.20/30" +#- name: "5 - ASSERT" +# assert: +# that: +# - test_five is changed +# - test_five['diff']['before']['state'] == "absent" +# - test_five['diff']['after']['state'] == "present" +# - test_five['msg'] == "ip_address 192.168.1.20/30 created" +# - test_five['ip_address']['address'] == "192.168.1.20/30" - name: "6 - Create new address with only prefix specified - State: new" netbox.netbox.netbox_ip_address: @@ -306,30 +307,31 @@ - test_fourteen['ip_address']['assigned_object_type'] == "virtualization.vminterface" - test_fourteen['ip_address']['assigned_object_id'] == 1 -- name: "15 - Create same IP address on Eth0 - test101-vm - State: present" - netbox.netbox.netbox_ip_address: - netbox_url: http://localhost:32768 - netbox_token: 0123456789abcdef0123456789abcdef01234567 - data: - family: 4 - address: 10.188.1.100/24 - assigned_object: - name: Eth0 - virtual_machine: test101-vm - state: "present" - register: test_fifteen +# Enforce uniqueness in NetBox 3.7 +#- name: "15 - Create same IP address on Eth0 - test101-vm - State: present" +# netbox.netbox.netbox_ip_address: +# netbox_url: http://localhost:32768 +# netbox_token: 0123456789abcdef0123456789abcdef01234567 +# data: +# family: 4 +# address: 10.188.1.100/24 +# assigned_object: +# name: Eth0 +# virtual_machine: test101-vm +# state: "present" +# register: test_fifteen -- name: "15 - ASSERT" - assert: - that: - - test_fifteen is changed - - test_fifteen['diff']['before']['state'] == "absent" - - test_fifteen['diff']['after']['state'] == "present" - - test_fifteen['msg'] == "ip_address 10.188.1.100/24 created" - - test_fifteen['ip_address']['address'] == "10.188.1.100/24" - - test_fifteen['ip_address']['family'] == 4 - - test_fifteen['ip_address']['assigned_object_type'] == "virtualization.vminterface" - - test_fifteen['ip_address']['assigned_object_id'] == 6 +#- name: "15 - ASSERT" +# assert: +# that: +# - test_fifteen is changed +# - test_fifteen['diff']['before']['state'] == "absent" +# - test_fifteen['diff']['after']['state'] == "present" +# - test_fifteen['msg'] == "ip_address 10.188.1.100/24 created" +# - test_fifteen['ip_address']['address'] == "10.188.1.100/24" +# - test_fifteen['ip_address']['family'] == 4 +# - test_fifteen['ip_address']['assigned_object_type'] == "virtualization.vminterface" +# - test_fifteen['ip_address']['assigned_object_id'] == 6 - name: "16 - Create IP address with no mask - State: Present" netbox.netbox.netbox_ip_address: diff --git a/tests/integration/targets/v3.4/tasks/netbox_ipam_role.yml b/tests/integration/targets/v3.7/tasks/netbox_ipam_role.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_ipam_role.yml rename to tests/integration/targets/v3.7/tasks/netbox_ipam_role.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_journal_entry.yml b/tests/integration/targets/v3.7/tasks/netbox_journal_entry.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_journal_entry.yml rename to tests/integration/targets/v3.7/tasks/netbox_journal_entry.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_l2vpn.yml b/tests/integration/targets/v3.7/tasks/netbox_l2vpn.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_l2vpn.yml rename to tests/integration/targets/v3.7/tasks/netbox_l2vpn.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_l2vpn_termination.yml b/tests/integration/targets/v3.7/tasks/netbox_l2vpn_termination.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_l2vpn_termination.yml rename to tests/integration/targets/v3.7/tasks/netbox_l2vpn_termination.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_location.yml b/tests/integration/targets/v3.7/tasks/netbox_location.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_location.yml rename to tests/integration/targets/v3.7/tasks/netbox_location.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_lookup.yml b/tests/integration/targets/v3.7/tasks/netbox_lookup.yml similarity index 67% rename from tests/integration/targets/v3.4/tasks/netbox_lookup.yml rename to tests/integration/targets/v3.7/tasks/netbox_lookup.yml index d3d99c181..277454fcd 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_lookup.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_lookup.yml @@ -6,27 +6,27 @@ ## - name: "NETBOX_LOOKUP 1: Lookup returns exactly two sites" assert: - that: "{{ query_result|count }} == 3" + that: query_result == "3" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'sites', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|count }}" - name: "NETBOX_LOOKUP 2: Query doesn't return Wibble (sanity check json_query)" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`Wibble`]')|count }} == 0" + that: query_result == "0" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`Wibble`]')|count}}" - name: "NETBOX_LOOKUP 3: Device query returns exactly one TestDeviceR1" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`TestDeviceR1`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`TestDeviceR1`]')|count }}" - name: "NETBOX_LOOKUP 4: VLAN ID 400 can be queried and is named 'Test VLAN'" assert: - that: "{{ (query_result|community.general.json_query('[?value.vid==`400`].value.name'))[0] == 'Test VLAN' }}" + that: query_result == 'Test VLAN' vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'vlans', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ (query('netbox.netbox.nb_lookup', 'vlans', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.vid==`400`].value.name'))[0] }}" - name: "NETBOX_LOOKUP 5: Add one of two devices for lookup filter test." netbox.netbox.netbox_device: @@ -58,25 +58,26 @@ - name: "NETBOX_LOOKUP 7: Device query returns exactly the L2 device" assert: - that: "{{ query_result|community.general.json_query('[?value.display==`L2`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567')|community.general.json_query('[?value.display==`L2`]')|count }}" - name: "NETBOX_LOOKUP 8: Device query specifying raw data returns payload without key/value dict" assert: - that: "{{ query_result|community.general.json_query('[?display==`L2`]')|count }} == 1" + that: query_result == "1" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch tag=lookup', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True)|community.general.json_query('[?display==`L2`]')|count }}" - name: "NETBOX_LOOKUP 9: Device query specifying multiple sites, Make sure L1 and L2 are in the results" assert: that: - - "'L1' in {{ query_result |community.general.json_query('[*].display') }}" - - "'L2' in {{ query_result |community.general.json_query('[*].display') }}" + - "'L1' in query_result" + - "'L2' in query_result" vars: - query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True) }}" + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='role=core-switch site=test-site site=test-site2', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567', raw_data=True)|community.general.json_query('[*].display') }}" - name: "NETBOX_LOOKUP 10: Device query by ID" assert: - that: - - "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" + that: query_result + vars: + query_result: "{{ query('netbox.netbox.nb_lookup', 'devices', api_filter='id=1', api_endpoint='http://localhost:32768', token='0123456789abcdef0123456789abcdef01234567') }}" diff --git a/tests/integration/targets/v3.4/tasks/netbox_manufacturer.yml b/tests/integration/targets/v3.7/tasks/netbox_manufacturer.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_manufacturer.yml rename to tests/integration/targets/v3.7/tasks/netbox_manufacturer.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_module_type.yml b/tests/integration/targets/v3.7/tasks/netbox_module_type.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_module_type.yml rename to tests/integration/targets/v3.7/tasks/netbox_module_type.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_platform.yml b/tests/integration/targets/v3.7/tasks/netbox_platform.yml similarity index 88% rename from tests/integration/targets/v3.4/tasks/netbox_platform.yml rename to tests/integration/targets/v3.7/tasks/netbox_platform.yml index 95ccdb4cf..1e3621add 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_platform.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_platform.yml @@ -47,9 +47,6 @@ data: name: Test Platform manufacturer: Test Manufacturer - napalm_driver: ios - napalm_args: - global_delay_factor: 2 state: present register: test_three @@ -58,11 +55,7 @@ that: - test_three is changed - test_three['diff']['after']['manufacturer'] == 3 - - test_three['diff']['after']['napalm_args']['global_delay_factor'] == 2 - - test_three['diff']['after']['napalm_driver'] == "ios" - test_three['platform']['manufacturer'] == 3 - - test_three['platform']['napalm_args']['global_delay_factor'] == 2 - - test_three['platform']['napalm_driver'] == "ios" - test_three['msg'] == "platform Test Platform updated" - name: "PLATFORM 4: ASSERT - Delete" diff --git a/tests/integration/targets/v3.4/tasks/netbox_power_feed.yml b/tests/integration/targets/v3.7/tasks/netbox_power_feed.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_power_feed.yml rename to tests/integration/targets/v3.7/tasks/netbox_power_feed.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_power_outlet.yml b/tests/integration/targets/v3.7/tasks/netbox_power_outlet.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_power_outlet.yml rename to tests/integration/targets/v3.7/tasks/netbox_power_outlet.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_power_outlet_template.yml b/tests/integration/targets/v3.7/tasks/netbox_power_outlet_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_power_outlet_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_power_outlet_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_power_panel.yml b/tests/integration/targets/v3.7/tasks/netbox_power_panel.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_power_panel.yml rename to tests/integration/targets/v3.7/tasks/netbox_power_panel.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_power_port.yml b/tests/integration/targets/v3.7/tasks/netbox_power_port.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_power_port.yml rename to tests/integration/targets/v3.7/tasks/netbox_power_port.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_power_port_template.yml b/tests/integration/targets/v3.7/tasks/netbox_power_port_template.yml similarity index 54% rename from tests/integration/targets/v3.4/tasks/netbox_power_port_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_power_port_template.yml index 9e7547fd9..aaa5eb43c 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_power_port_template.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_power_port_template.yml @@ -7,7 +7,7 @@ ### NETBOX_POWER_PORT_TEMPLATE ## ## -- name: "POWER_PORT_TEMPLATE 0: Create device type for testing power ports" +- name: "POWER_PORT_TEMPLATE 0.1: Create device type for testing power ports on device types" netbox.netbox.netbox_device_type: netbox_url: http://localhost:32768 netbox_token: 0123456789abcdef0123456789abcdef01234567 @@ -16,6 +16,15 @@ manufacturer: Test Manufacturer state: present +- name: "POWER_PORT_TEMPLATE 0.2: Create module type for testing power ports on module types" + netbox.netbox.netbox_module_type: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + model: Module Type Power Tests + manufacturer: Test Manufacturer + state: present + - name: "POWER_PORT_TEMPLATE 1: Necessary info creation" netbox.netbox.netbox_power_port_template: netbox_url: http://localhost:32768 @@ -118,3 +127,86 @@ - test_five['diff']['before']['state'] == "present" - test_five['diff']['after']['state'] == "absent" - test_five['msg'] == "power_port_template Power Port Template 2 deleted" + +- name: "POWER_PORT_TEMPLATE 6: Necessary info creation" + netbox.netbox.netbox_power_port_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: Module Power Port Template + module_type: Module Type Power Tests + state: present + register: test_six + +- name: "POWER_PORT_TEMPLATE 6: ASSERT - Necessary info creation" + assert: + that: + - test_six is changed + - test_six['diff']['before']['state'] == "absent" + - test_six['diff']['after']['state'] == "present" + - test_six['power_port_template']['name'] == "Module Power Port Template" + - test_six['power_port_template']['module_type'] == 1 + - test_six['msg'] == "power_port_template Module Power Port Template created" + +- name: "POWER_PORT_TEMPLATE 7: Create duplicate" + netbox.netbox.netbox_power_port_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: Module Power Port Template + module_type: Module Type Power Tests + state: present + register: test_seven + +- name: "POWER_PORT_TEMPLATE 7: ASSERT - Create duplicate" + assert: + that: + - not test_seven['changed'] + - test_seven['power_port_template']['name'] == "Module Power Port Template" + - test_seven['power_port_template']['module_type'] == 1 + - test_seven['msg'] == "power_port_template Module Power Port Template already exists" + +- name: "POWER_PORT_TEMPLATE 8: Update power_port_template with other fields" + netbox.netbox.netbox_power_port_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: Module Power Port Template + module_type: Module Type Power Tests + type: ita-e + allocated_draw: 10 + maximum_draw: 20 + state: present + register: test_eight + +- name: "POWER_PORT_TEMPLATE 8: ASSERT - Update power_port_template with other fields" + assert: + that: + - test_eight is changed + - test_eight['diff']['after']['type'] == "ita-e" + - test_eight['diff']['after']['allocated_draw'] == 10 + - test_eight['diff']['after']['maximum_draw'] == 20 + - test_eight['power_port_template']['name'] == "Module Power Port Template" + - test_eight['power_port_template']['module_type'] == 1 + - test_eight['power_port_template']['type'] == "ita-e" + - test_eight['power_port_template']['allocated_draw'] == 10 + - test_eight['power_port_template']['maximum_draw'] == 20 + - test_eight['msg'] == "power_port_template Module Power Port Template updated" + +- name: "POWER_PORT_TEMPLATE 9: Delete Power Port Template" + netbox.netbox.netbox_power_port_template: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: Module Power Port Template + module_type: Module Type Power Tests + state: absent + register: test_nine + +- name: "POWER_PORT_TEMPLATE 9: ASSERT - Delete Power Port Template" + assert: + that: + - test_nine is changed + - test_nine['diff']['before']['state'] == "present" + - test_nine['diff']['after']['state'] == "absent" + - test_nine['msg'] == "power_port_template Module Power Port Template deleted" diff --git a/tests/integration/targets/v3.4/tasks/netbox_prefix.yml b/tests/integration/targets/v3.7/tasks/netbox_prefix.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_prefix.yml rename to tests/integration/targets/v3.7/tasks/netbox_prefix.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_provider.yml b/tests/integration/targets/v3.7/tasks/netbox_provider.yml similarity index 92% rename from tests/integration/targets/v3.4/tasks/netbox_provider.yml rename to tests/integration/targets/v3.7/tasks/netbox_provider.yml index 246788991..cba224eb4 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_provider.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_provider.yml @@ -46,7 +46,6 @@ netbox_token: 0123456789abcdef0123456789abcdef01234567 data: name: Test Provider One - account: "200129104" comments: "BAD PROVIDER" state: present register: test_three @@ -55,11 +54,9 @@ assert: that: - test_three is changed - - test_three['diff']['after']['account'] == "200129104" - test_three['diff']['after']['comments'] == "BAD PROVIDER" - test_three['provider']['name'] == "Test Provider One" - test_three['provider']['slug'] == "test-provider-one" - - test_three['provider']['account'] == "200129104" - test_three['provider']['comments'] == "BAD PROVIDER" - test_three['msg'] == "provider Test Provider One updated" @@ -78,6 +75,5 @@ - test_four is changed - test_four['provider']['name'] == "Test Provider One" - test_four['provider']['slug'] == "test-provider-one" - - test_four['provider']['account'] == "200129104" - test_four['provider']['comments'] == "BAD PROVIDER" - test_four['msg'] == "provider Test Provider One deleted" diff --git a/tests/integration/targets/v3.4/tasks/netbox_provider_network.yml b/tests/integration/targets/v3.7/tasks/netbox_provider_network.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_provider_network.yml rename to tests/integration/targets/v3.7/tasks/netbox_provider_network.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_rack.yml b/tests/integration/targets/v3.7/tasks/netbox_rack.yml similarity index 99% rename from tests/integration/targets/v3.4/tasks/netbox_rack.yml rename to tests/integration/targets/v3.7/tasks/netbox_rack.yml index 8b96c56c1..245dd0c29 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_rack.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_rack.yml @@ -206,7 +206,7 @@ assert: that: - test_seven is failed - - "'Asset tag already exists' in test_seven['msg']" + - "'asset tag already exists' in test_seven['msg']" - name: "8 - Test delete" netbox.netbox.netbox_rack: diff --git a/tests/integration/targets/v3.4/tasks/netbox_rack_group.yml b/tests/integration/targets/v3.7/tasks/netbox_rack_group.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_rack_group.yml rename to tests/integration/targets/v3.7/tasks/netbox_rack_group.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_rack_role.yml b/tests/integration/targets/v3.7/tasks/netbox_rack_role.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_rack_role.yml rename to tests/integration/targets/v3.7/tasks/netbox_rack_role.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_rear_port.yml b/tests/integration/targets/v3.7/tasks/netbox_rear_port.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_rear_port.yml rename to tests/integration/targets/v3.7/tasks/netbox_rear_port.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_rear_port_template.yml b/tests/integration/targets/v3.7/tasks/netbox_rear_port_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_rear_port_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_rear_port_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_region.yml b/tests/integration/targets/v3.7/tasks/netbox_region.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_region.yml rename to tests/integration/targets/v3.7/tasks/netbox_region.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_rir.yml b/tests/integration/targets/v3.7/tasks/netbox_rir.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_rir.yml rename to tests/integration/targets/v3.7/tasks/netbox_rir.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_route_target.yml b/tests/integration/targets/v3.7/tasks/netbox_route_target.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_route_target.yml rename to tests/integration/targets/v3.7/tasks/netbox_route_target.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_service.yml b/tests/integration/targets/v3.7/tasks/netbox_service.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_service.yml rename to tests/integration/targets/v3.7/tasks/netbox_service.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_service_template.yml b/tests/integration/targets/v3.7/tasks/netbox_service_template.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_service_template.yml rename to tests/integration/targets/v3.7/tasks/netbox_service_template.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_site.yml b/tests/integration/targets/v3.7/tasks/netbox_site.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_site.yml rename to tests/integration/targets/v3.7/tasks/netbox_site.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_site_group.yml b/tests/integration/targets/v3.7/tasks/netbox_site_group.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_site_group.yml rename to tests/integration/targets/v3.7/tasks/netbox_site_group.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_tag.yml b/tests/integration/targets/v3.7/tasks/netbox_tag.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_tag.yml rename to tests/integration/targets/v3.7/tasks/netbox_tag.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_tenant.yml b/tests/integration/targets/v3.7/tasks/netbox_tenant.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_tenant.yml rename to tests/integration/targets/v3.7/tasks/netbox_tenant.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_tenant_group.yml b/tests/integration/targets/v3.7/tasks/netbox_tenant_group.yml similarity index 98% rename from tests/integration/targets/v3.4/tasks/netbox_tenant_group.yml rename to tests/integration/targets/v3.7/tasks/netbox_tenant_group.yml index 47ad78431..4113a2260 100644 --- a/tests/integration/targets/v3.4/tasks/netbox_tenant_group.yml +++ b/tests/integration/targets/v3.7/tasks/netbox_tenant_group.yml @@ -90,7 +90,7 @@ - test_five['diff']['before']['state'] == "absent" - test_five['diff']['after']['state'] == "present" - test_five['tenant_group']['name'] == "Child Test Tenant Group" - - test_five['tenant_group']['parent'] == {{ test_four.tenant_group.id }} + - test_five['tenant_group']['parent'] == test_four.tenant_group.id - test_five['msg'] == "tenant_group Child Test Tenant Group created" - name: "6 - Test child tenant group deletion" diff --git a/tests/integration/targets/v3.4/tasks/netbox_virtual_chassis.yml b/tests/integration/targets/v3.7/tasks/netbox_virtual_chassis.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_virtual_chassis.yml rename to tests/integration/targets/v3.7/tasks/netbox_virtual_chassis.yml diff --git a/tests/integration/targets/v3.7/tasks/netbox_virtual_disk.yml b/tests/integration/targets/v3.7/tasks/netbox_virtual_disk.yml new file mode 100644 index 000000000..999d3edc3 --- /dev/null +++ b/tests/integration/targets/v3.7/tasks/netbox_virtual_disk.yml @@ -0,0 +1,87 @@ +--- +## +## +### NETBOX_VIRTUAL_DISK +## +## +- name: "NETBOX_VIRTUAL_DISK 1: Necessary info creation" + netbox.netbox.netbox_virtual_disk: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + virtual_machine: "test100-vm" + name: "disk0" + size: 50 + state: present + register: test_one + +- name: "NETBOX_VIRTUAL_DISK 1: ASSERT - Necessary info creation" + assert: + that: + - test_one is changed + - test_one['diff']['before']['state'] == "absent" + - test_one['diff']['after']['state'] == "present" + - test_one['virtual_disk']['name'] == "disk0" + - test_one['virtual_disk']['virtual_machine'] == 1 + - test_one['msg'] == "virtual_disk disk0 created" + +- name: "NETBOX_VIRTUAL_DISK 2: Create duplicate" + netbox.netbox.netbox_virtual_disk: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + virtual_machine: "test100-vm" + name: "disk0" + size: 50 + state: present + register: test_two + +- name: "NETBOX_VIRTUAL_DISK 2: ASSERT - Create duplicate" + assert: + that: + - not test_two['changed'] + - test_two['virtual_disk']['name'] == "disk0" + - test_two['virtual_disk']['virtual_machine'] == 1 + - test_two['msg'] == "virtual_disk disk0 already exists" + +- name: "NETBOX_VIRTUAL_DISK 3: Update" + netbox.netbox.netbox_virtual_disk: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + virtual_machine: "test100-vm" + name: "disk0" + size: 60 + tags: + - "Schnozzberry" + state: present + register: test_three + +- name: "NETBOX_VIRTUAL_DISK 4: ASSERT - Updated" + assert: + that: + - test_three is changed + - test_three['diff']['after']['size'] == 60 + - test_three['virtual_disk']['name'] == "disk0" + - test_three['virtual_disk']['virtual_machine'] == 1 + - test_three['virtual_disk']['size'] == 60 + - test_three['virtual_disk']['tags'][0] == 4 + - test_three['msg'] == "virtual_disk disk0 updated" + +- name: "NETBOX_VIRTUAL_DISK 4: ASSERT - Delete" + netbox.netbox.netbox_virtual_disk: + netbox_url: http://localhost:32768 + netbox_token: 0123456789abcdef0123456789abcdef01234567 + data: + name: "disk0" + virtual_machine: "test100-vm" + state: absent + register: test_four + +- name: "NETBOX_VIRTUAL_DISK 4: ASSERT - Delete" + assert: + that: + - test_four is changed + - test_four['virtual_disk']['name'] == "disk0" + - test_four['virtual_disk']['virtual_machine'] == 1 + - test_four['msg'] == "virtual_disk disk0 deleted" diff --git a/tests/integration/targets/v3.4/tasks/netbox_virtual_machine.yml b/tests/integration/targets/v3.7/tasks/netbox_virtual_machine.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_virtual_machine.yml rename to tests/integration/targets/v3.7/tasks/netbox_virtual_machine.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_vlan.yml b/tests/integration/targets/v3.7/tasks/netbox_vlan.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_vlan.yml rename to tests/integration/targets/v3.7/tasks/netbox_vlan.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_vlan_group.yml b/tests/integration/targets/v3.7/tasks/netbox_vlan_group.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_vlan_group.yml rename to tests/integration/targets/v3.7/tasks/netbox_vlan_group.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_vm_interface.yml b/tests/integration/targets/v3.7/tasks/netbox_vm_interface.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_vm_interface.yml rename to tests/integration/targets/v3.7/tasks/netbox_vm_interface.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_vrf.yml b/tests/integration/targets/v3.7/tasks/netbox_vrf.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_vrf.yml rename to tests/integration/targets/v3.7/tasks/netbox_vrf.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_webhook.yml b/tests/integration/targets/v3.7/tasks/netbox_webhook.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_webhook.yml rename to tests/integration/targets/v3.7/tasks/netbox_webhook.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_wireless_lan.yml b/tests/integration/targets/v3.7/tasks/netbox_wireless_lan.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_wireless_lan.yml rename to tests/integration/targets/v3.7/tasks/netbox_wireless_lan.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_wireless_lan_group.yml b/tests/integration/targets/v3.7/tasks/netbox_wireless_lan_group.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_wireless_lan_group.yml rename to tests/integration/targets/v3.7/tasks/netbox_wireless_lan_group.yml diff --git a/tests/integration/targets/v3.4/tasks/netbox_wireless_link.yml b/tests/integration/targets/v3.7/tasks/netbox_wireless_link.yml similarity index 100% rename from tests/integration/targets/v3.4/tasks/netbox_wireless_link.yml rename to tests/integration/targets/v3.7/tasks/netbox_wireless_link.yml diff --git a/tests/netbox-docker/v3.2/docker-compose.override.yml b/tests/netbox-docker/v3.2/docker-compose.override.yml deleted file mode 100644 index 3a16676e7..000000000 --- a/tests/netbox-docker/v3.2/docker-compose.override.yml +++ /dev/null @@ -1,15 +0,0 @@ ---- -version: '3.4' -services: - netbox-worker: &netbox-override - image: netboxcommunity/netbox:v3.2 - netbox: - <<: *netbox-override - ports: - - 32768:8080 - environment: - SKIP_SUPERUSER: "false" - SUPERUSER_API_TOKEN: "0123456789abcdef0123456789abcdef01234567" - SUPERUSER_EMAIL: "admin@localhost.com" - SUPERUSER_NAME: "admin" - SUPERUSER_PASSWORD: "admin" diff --git a/tests/netbox-docker/v3.3/docker-compose.override.yml b/tests/netbox-docker/v3.3/docker-compose.override.yml deleted file mode 100644 index 5f86ccac8..000000000 --- a/tests/netbox-docker/v3.3/docker-compose.override.yml +++ /dev/null @@ -1,15 +0,0 @@ ---- -version: '3.4' -services: - netbox-worker: &netbox-override - image: netboxcommunity/netbox:v3.3 - netbox: - <<: *netbox-override - ports: - - 32768:8080 - environment: - SKIP_SUPERUSER: "false" - SUPERUSER_API_TOKEN: "0123456789abcdef0123456789abcdef01234567" - SUPERUSER_EMAIL: "admin@localhost.com" - SUPERUSER_NAME: "admin" - SUPERUSER_PASSWORD: "admin" diff --git a/tests/netbox-docker/v3.4/docker-compose.override.yml b/tests/netbox-docker/v3.7/docker-compose.override.yml similarity index 72% rename from tests/netbox-docker/v3.4/docker-compose.override.yml rename to tests/netbox-docker/v3.7/docker-compose.override.yml index 04d96d271..47e7e80c0 100644 --- a/tests/netbox-docker/v3.4/docker-compose.override.yml +++ b/tests/netbox-docker/v3.7/docker-compose.override.yml @@ -2,7 +2,12 @@ version: '3.4' services: netbox-worker: &netbox-override - image: netboxcommunity/netbox:v3.4 + image: netboxcommunity/netbox:v3.7 + healthcheck: + start_period: 300s + timeout: 3s + interval: 15s + test: "ps -aux | grep -v grep | grep -q rqworker || exit 1" netbox: <<: *netbox-override ports: