From 5fb2768bdd54dad34c01016bf10af0b4000f2274 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20R=C3=B8dvand?= Date: Thu, 12 Sep 2024 21:16:27 +0200 Subject: [PATCH] Generate changelog and docs for 3.20 (#1318) --- CHANGELOG.rst | 34 +++++++ changelogs/changelog.yaml | 52 ++++++++++ ...-ability-to-rename-host-inventory-vars.yml | 2 - ...ature-netbox_cluster-adds-status-field.yml | 2 - ...x_cluster_group-adds-description-field.yml | 2 - .../1281_move_prefix_lookup_to_secondary.yml | 2 - ...ature-netbox_vlan_group-add-vid_ranges.yml | 2 - .../1309-feature-add-serial-number-to-vm.yml | 2 - .../1312-add-hostname_field-option.yml | 2 - changelogs/fragments/41_updates.yml | 3 - changelogs/fragments/ci_netbox41.yml | 2 - changelogs/fragments/fix_issue_1268.yml | 2 - changelogs/fragments/fix_issues_1279_1280.yml | 3 - docs/conf.py | 2 +- docs/plugins/environment_variables.rst | 3 +- docs/plugins/index.rst | 8 +- docs/plugins/nb_inventory_inventory.rst | 94 ++++++++++++------- docs/plugins/nb_lookup_lookup.rst | 12 +-- docs/plugins/netbox_aggregate_module.rst | 14 +-- docs/plugins/netbox_asn_module.rst | 16 ++-- docs/plugins/netbox_cable_module.rst | 16 ++-- docs/plugins/netbox_circuit_module.rst | 16 ++-- .../netbox_circuit_termination_module.rst | 16 ++-- docs/plugins/netbox_circuit_type_module.rst | 16 ++-- docs/plugins/netbox_cluster_group_module.rst | 16 ++-- docs/plugins/netbox_cluster_module.rst | 18 ++-- docs/plugins/netbox_cluster_type_module.rst | 16 ++-- docs/plugins/netbox_config_context_module.rst | 14 +-- .../plugins/netbox_config_template_module.rst | 12 +-- docs/plugins/netbox_console_port_module.rst | 16 ++-- .../netbox_console_port_template_module.rst | 16 ++-- .../netbox_console_server_port_module.rst | 18 ++-- ...ox_console_server_port_template_module.rst | 16 ++-- docs/plugins/netbox_contact_group_module.rst | 14 +-- docs/plugins/netbox_contact_module.rst | 14 +-- docs/plugins/netbox_contact_role_module.rst | 14 +-- .../netbox_custom_field_choice_set_module.rst | 14 +-- docs/plugins/netbox_custom_field_module.rst | 14 +-- docs/plugins/netbox_custom_link_module.rst | 16 ++-- docs/plugins/netbox_device_bay_module.rst | 16 ++-- .../netbox_device_bay_template_module.rst | 16 ++-- .../netbox_device_interface_module.rst | 31 +++--- ...etbox_device_interface_template_module.rst | 19 ++-- docs/plugins/netbox_device_module.rst | 24 ++--- docs/plugins/netbox_device_role_module.rst | 16 ++-- docs/plugins/netbox_device_type_module.rst | 16 ++-- .../plugins/netbox_export_template_module.rst | 16 ++-- .../netbox_fhrp_group_assignment_module.rst | 16 ++-- docs/plugins/netbox_fhrp_group_module.rst | 16 ++-- docs/plugins/netbox_front_port_module.rst | 16 ++-- .../netbox_front_port_template_module.rst | 16 ++-- docs/plugins/netbox_interface_module.rst | 5 +- docs/plugins/netbox_inventory_item_module.rst | 16 ++-- .../netbox_inventory_item_role_module.rst | 16 ++-- docs/plugins/netbox_ip_address_module.rst | 49 +++++----- docs/plugins/netbox_ipam_role_module.rst | 14 +-- docs/plugins/netbox_journal_entry_module.rst | 17 ++-- docs/plugins/netbox_l2vpn_module.rst | 16 ++-- .../netbox_l2vpn_termination_module.rst | 16 ++-- docs/plugins/netbox_location_module.rst | 18 ++-- docs/plugins/netbox_manufacturer_module.rst | 16 ++-- docs/plugins/netbox_module_bay_module.rst | 16 ++-- docs/plugins/netbox_module_module.rst | 16 ++-- docs/plugins/netbox_module_type_module.rst | 16 ++-- docs/plugins/netbox_permission_module.rst | 22 ++--- docs/plugins/netbox_platform_module.rst | 16 ++-- docs/plugins/netbox_power_feed_module.rst | 16 ++-- docs/plugins/netbox_power_outlet_module.rst | 16 ++-- .../netbox_power_outlet_template_module.rst | 16 ++-- docs/plugins/netbox_power_panel_module.rst | 16 ++-- docs/plugins/netbox_power_port_module.rst | 16 ++-- .../netbox_power_port_template_module.rst | 20 ++-- docs/plugins/netbox_prefix_module.rst | 25 ++--- docs/plugins/netbox_provider_module.rst | 16 ++-- .../netbox_provider_network_module.rst | 16 ++-- docs/plugins/netbox_rack_group_module.rst | 18 ++-- docs/plugins/netbox_rack_module.rst | 20 ++-- docs/plugins/netbox_rack_role_module.rst | 16 ++-- docs/plugins/netbox_rear_port_module.rst | 16 ++-- .../netbox_rear_port_template_module.rst | 16 ++-- docs/plugins/netbox_region_module.rst | 14 +-- docs/plugins/netbox_rir_module.rst | 16 ++-- docs/plugins/netbox_route_target_module.rst | 14 +-- docs/plugins/netbox_service_module.rst | 14 +-- .../netbox_service_template_module.rst | 16 ++-- docs/plugins/netbox_site_group_module.rst | 16 ++-- docs/plugins/netbox_site_module.rst | 14 +-- docs/plugins/netbox_tag_module.rst | 14 +-- docs/plugins/netbox_tenant_group_module.rst | 14 +-- docs/plugins/netbox_tenant_module.rst | 14 +-- docs/plugins/netbox_token_module.rst | 77 +++++---------- docs/plugins/netbox_tunnel_group_module.rst | 16 ++-- docs/plugins/netbox_tunnel_module.rst | 16 ++-- docs/plugins/netbox_user_group_module.rst | 22 ++--- docs/plugins/netbox_user_module.rst | 29 +++--- .../plugins/netbox_virtual_chassis_module.rst | 16 ++-- docs/plugins/netbox_virtual_disk_module.rst | 14 +-- .../plugins/netbox_virtual_machine_module.rst | 69 ++++++++++++-- docs/plugins/netbox_vlan_group_module.rst | 73 ++++++++++++-- docs/plugins/netbox_vlan_module.rst | 18 ++-- docs/plugins/netbox_vm_interface_module.rst | 16 ++-- docs/plugins/netbox_vrf_module.rst | 16 ++-- docs/plugins/netbox_webhook_module.rst | 20 ++-- .../netbox_wireless_lan_group_module.rst | 14 +-- docs/plugins/netbox_wireless_lan_module.rst | 14 +-- docs/plugins/netbox_wireless_link_module.rst | 14 +-- galaxy.yml | 2 +- pyproject.toml | 2 +- 108 files changed, 846 insertions(+), 1029 deletions(-) delete mode 100644 changelogs/fragments/1273-ability-to-rename-host-inventory-vars.yml delete mode 100644 changelogs/fragments/1275-feature-netbox_cluster-adds-status-field.yml delete mode 100644 changelogs/fragments/1276-feature-netbox_cluster_group-adds-description-field.yml delete mode 100644 changelogs/fragments/1281_move_prefix_lookup_to_secondary.yml delete mode 100644 changelogs/fragments/1307-feature-netbox_vlan_group-add-vid_ranges.yml delete mode 100644 changelogs/fragments/1309-feature-add-serial-number-to-vm.yml delete mode 100644 changelogs/fragments/1312-add-hostname_field-option.yml delete mode 100644 changelogs/fragments/41_updates.yml delete mode 100644 changelogs/fragments/ci_netbox41.yml delete mode 100644 changelogs/fragments/fix_issue_1268.yml delete mode 100644 changelogs/fragments/fix_issues_1279_1280.yml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index d27d59776..aa11aa422 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,40 @@ NetBox.NetBox Release Notes .. contents:: Topics +v3.20.0 +======= + +Minor Changes +------------- + +- Add ``facility`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1280) +- Add ``related_object_type`` to ``netbox_custom_filed`` (https://github.com/netbox-community/ansible_modules/issues/1268) +- Add ``status`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1279) +- Add `description` to `netbox_cluster_group` module (https://github.com/netbox-community/ansible_modules/issues/1276) +- Add `serial` to `netbox_virtual_machine` module (https://github.com/netbox-community/ansible_modules/issues/1309) +- Add `status` to `netbox_cluster` (https://github.com/netbox-community/ansible_modules/issues/1275) +- Add `vid_ranges` to `netbox_vlan_group` module (https://github.com/netbox-community/ansible_modules/issues/1307) +- Add ability to rename variables set on the host by ``netbox.netbox.nb_inventory`` through configuration. +- Added option `hostname_field` to ``nb_inventory`` to be able to set the inventory hostname from a field in custom_fields +- Adjust tests for various modules +- Fix the form_factor option on netbox_rack +- Update CI for NetBox 4.1 + +Bugfixes +-------- + +- If `fetch_all` is `false`, prefix lookup depends on site lookup, so move it to secondary lookup (https://github.com/netbox-community/ansible_modules/issues/733) + +New Modules +----------- + +- netbox.netbox.netbox_permission - Creates or removes permissions from NetBox +- netbox.netbox.netbox_token - Creates or removes tokens from NetBox +- netbox.netbox.netbox_tunnel - Create, update or delete tunnels within NetBox +- netbox.netbox.netbox_tunnel_group - Create, update or delete tunnel groups within NetBox +- netbox.netbox.netbox_user - Creates or removes users from NetBox +- netbox.netbox.netbox_user_group - Creates or removes user groups from NetBox + v3.19.1 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 03360ec39..b8124e997 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -763,6 +763,58 @@ releases: - netbox_virtual_machine - Change vCPU to float from int (to reflect NetBox 3.0) [#605](https://github.com/netbox-community/ansible_modules/pull/605) release_date: '2021-10-18' + 3.20.0: + changes: + bugfixes: + - If `fetch_all` is `false`, prefix lookup depends on site lookup, so move it + to secondary lookup (https://github.com/netbox-community/ansible_modules/issues/733) + minor_changes: + - Add ``facility`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1280) + - Add ``related_object_type`` to ``netbox_custom_filed`` (https://github.com/netbox-community/ansible_modules/issues/1268) + - Add ``status`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1279) + - Add `description` to `netbox_cluster_group` module (https://github.com/netbox-community/ansible_modules/issues/1276) + - Add `serial` to `netbox_virtual_machine` module (https://github.com/netbox-community/ansible_modules/issues/1309) + - Add `status` to `netbox_cluster` (https://github.com/netbox-community/ansible_modules/issues/1275) + - Add `vid_ranges` to `netbox_vlan_group` module (https://github.com/netbox-community/ansible_modules/issues/1307) + - Add ability to rename variables set on the host by ``netbox.netbox.nb_inventory`` + through configuration. + - Added option `hostname_field` to ``nb_inventory`` to be able to set the inventory + hostname from a field in custom_fields + - Adjust tests for various modules + - Fix the form_factor option on netbox_rack + - Update CI for NetBox 4.1 + fragments: + - 1273-ability-to-rename-host-inventory-vars.yml + - 1275-feature-netbox_cluster-adds-status-field.yml + - 1276-feature-netbox_cluster_group-adds-description-field.yml + - 1281_move_prefix_lookup_to_secondary.yml + - 1307-feature-netbox_vlan_group-add-vid_ranges.yml + - 1309-feature-add-serial-number-to-vm.yml + - 1312-add-hostname_field-option.yml + - 41_updates.yml + - ci_netbox41.yml + - fix_issue_1268.yml + - fix_issues_1279_1280.yml + modules: + - description: Creates or removes permissions from NetBox + name: netbox_permission + namespace: '' + - description: Creates or removes tokens from NetBox + name: netbox_token + namespace: '' + - description: Create, update or delete tunnels within NetBox + name: netbox_tunnel + namespace: '' + - description: Create, update or delete tunnel groups within NetBox + name: netbox_tunnel_group + namespace: '' + - description: Creates or removes users from NetBox + name: netbox_user + namespace: '' + - description: Creates or removes user groups from NetBox + name: netbox_user_group + namespace: '' + release_date: '2024-09-12' 3.3.0: changes: minor_changes: diff --git a/changelogs/fragments/1273-ability-to-rename-host-inventory-vars.yml b/changelogs/fragments/1273-ability-to-rename-host-inventory-vars.yml deleted file mode 100644 index afba58803..000000000 --- a/changelogs/fragments/1273-ability-to-rename-host-inventory-vars.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add ability to rename variables set on the host by ``netbox.netbox.nb_inventory`` through configuration. diff --git a/changelogs/fragments/1275-feature-netbox_cluster-adds-status-field.yml b/changelogs/fragments/1275-feature-netbox_cluster-adds-status-field.yml deleted file mode 100644 index f7d606513..000000000 --- a/changelogs/fragments/1275-feature-netbox_cluster-adds-status-field.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add `status` to `netbox_cluster` (https://github.com/netbox-community/ansible_modules/issues/1275) diff --git a/changelogs/fragments/1276-feature-netbox_cluster_group-adds-description-field.yml b/changelogs/fragments/1276-feature-netbox_cluster_group-adds-description-field.yml deleted file mode 100644 index 44bc02782..000000000 --- a/changelogs/fragments/1276-feature-netbox_cluster_group-adds-description-field.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add `description` to `netbox_cluster_group` module (https://github.com/netbox-community/ansible_modules/issues/1276) diff --git a/changelogs/fragments/1281_move_prefix_lookup_to_secondary.yml b/changelogs/fragments/1281_move_prefix_lookup_to_secondary.yml deleted file mode 100644 index 31059d81e..000000000 --- a/changelogs/fragments/1281_move_prefix_lookup_to_secondary.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - If `fetch_all` is `false`, prefix lookup depends on site lookup, so move it to secondary lookup (https://github.com/netbox-community/ansible_modules/issues/733) diff --git a/changelogs/fragments/1307-feature-netbox_vlan_group-add-vid_ranges.yml b/changelogs/fragments/1307-feature-netbox_vlan_group-add-vid_ranges.yml deleted file mode 100644 index d1b0967c4..000000000 --- a/changelogs/fragments/1307-feature-netbox_vlan_group-add-vid_ranges.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add `vid_ranges` to `netbox_vlan_group` module (https://github.com/netbox-community/ansible_modules/issues/1307) diff --git a/changelogs/fragments/1309-feature-add-serial-number-to-vm.yml b/changelogs/fragments/1309-feature-add-serial-number-to-vm.yml deleted file mode 100644 index 01cd97df0..000000000 --- a/changelogs/fragments/1309-feature-add-serial-number-to-vm.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add `serial` to `netbox_virtual_machine` module (https://github.com/netbox-community/ansible_modules/issues/1309) diff --git a/changelogs/fragments/1312-add-hostname_field-option.yml b/changelogs/fragments/1312-add-hostname_field-option.yml deleted file mode 100644 index 7c9a0a47e..000000000 --- a/changelogs/fragments/1312-add-hostname_field-option.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Added option `hostname_field` to ``nb_inventory`` to be able to set the inventory hostname from a field in custom_fields diff --git a/changelogs/fragments/41_updates.yml b/changelogs/fragments/41_updates.yml deleted file mode 100644 index 583399a89..000000000 --- a/changelogs/fragments/41_updates.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - Adjust tests for various modules - - Fix the form_factor option on netbox_rack diff --git a/changelogs/fragments/ci_netbox41.yml b/changelogs/fragments/ci_netbox41.yml deleted file mode 100644 index 0bcbf5559..000000000 --- a/changelogs/fragments/ci_netbox41.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Update CI for NetBox 4.1 diff --git a/changelogs/fragments/fix_issue_1268.yml b/changelogs/fragments/fix_issue_1268.yml deleted file mode 100644 index f9d7d2611..000000000 --- a/changelogs/fragments/fix_issue_1268.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add ``related_object_type`` to ``netbox_custom_filed`` (https://github.com/netbox-community/ansible_modules/issues/1268) diff --git a/changelogs/fragments/fix_issues_1279_1280.yml b/changelogs/fragments/fix_issues_1279_1280.yml deleted file mode 100644 index a3e335353..000000000 --- a/changelogs/fragments/fix_issues_1279_1280.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - Add ``status`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1279) - - Add ``facility`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1280) diff --git a/docs/conf.py b/docs/conf.py index 47651bd12..44419cd81 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.19.1" +release = "3.20.0" # -- General configuration --------------------------------------------------- diff --git a/docs/plugins/environment_variables.rst b/docs/plugins/environment_variables.rst index bbe6a8f3a..acc06a08d 100644 --- a/docs/plugins/environment_variables.rst +++ b/docs/plugins/environment_variables.rst @@ -1,8 +1,7 @@ - :orphan: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. _list_of_collection_env_vars: diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 7c213e5b5..f97aa6735 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,7 +1,5 @@ - - .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. _plugins_in_netbox.netbox: @@ -9,7 +7,7 @@ Netbox.Netbox ============= -Collection version 3.19.1 +Collection version 3.20.0 .. contents:: :local: @@ -256,5 +254,3 @@ Lookup Plugins :hidden: nb_lookup_lookup - - diff --git a/docs/plugins/nb_inventory_inventory.rst b/docs/plugins/nb_inventory_inventory.rst index a544f8105..3f7cd2912 100644 --- a/docs/plugins/nb_inventory_inventory.rst +++ b/docs/plugins/nb_inventory_inventory.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.nb_inventory inventory -- NetBox inventory source .. Collection note .. note:: - This inventory plugin is part of the `netbox.netbox collection `_ (version 3.19.1). + This inventory plugin is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -435,21 +434,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] @@ -845,7 +829,7 @@ Parameters
- If \ :emphasis:`config\_context`\ is enabled, by default it's added as a host var named config\_context. + If :emphasis:`config\_context` is enabled, by default it's added as a host var named config\_context. If flatten\_config\_context is set to True, the config context variables will be added directly to the host instead. @@ -945,7 +929,7 @@ Parameters
- If \ :emphasis:`local\_context\_data`\ is enabled, by default it's added as a host var named local\_context\_data. + If :emphasis:`local\_context\_data` is enabled, by default it's added as a host var named local\_context\_data. If flatten\_local\_context\_data is set to True, the config context variables will be added directly to the host instead. @@ -994,7 +978,7 @@ Parameters Determine how redirects are followed. - By default, \ :emphasis:`follow\_redirects`\ is set to uses urllib2 default behavior. + By default, :emphasis:`follow\_redirects` is set to uses urllib2 default behavior. .. rst-class:: ansible-option-line @@ -1042,11 +1026,11 @@ Parameters
- Keys used to create groups. The \ :emphasis:`plurals`\ and \ :emphasis:`racks`\ options control which of these are valid. + Keys used to create groups. The :emphasis:`plurals` and :emphasis:`racks` options control which of these are valid. - \ :emphasis:`rack\_group`\ is supported on NetBox versions 2.10 or lower only + :emphasis:`rack\_group` is supported on NetBox versions 2.10 or lower only - \ :emphasis:`location`\ is supported on NetBox versions 2.11 or higher only + :emphasis:`location` is supported on NetBox versions 2.11 or higher only .. rst-class:: ansible-option-line @@ -1182,6 +1166,49 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-hostname_field: + + .. rst-class:: ansible-option-title + + **hostname_field** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + By default, the inventory hostname is the netbox device name + + If set, sets the inventory hostname from this field in custom\_fields instead + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`false` + + .. raw:: html + +
+ * - .. raw:: html
@@ -1311,7 +1338,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -1355,7 +1382,7 @@ Parameters 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 @@ -1591,9 +1618,9 @@ Parameters
- 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 @@ -1839,7 +1866,7 @@ Parameters Group names will be plural (ie. "sites\_mysite" instead of "site\_mysite") - The choices of \ :emphasis:`group\_by`\ will be changed by this option. + The choices of :emphasis:`group\_by` will be changed by this option. .. rst-class:: ansible-option-line @@ -1982,7 +2009,7 @@ Parameters If False, skip querying the racks for information, which can be slow with great amounts of racks. - The choices of \ :emphasis:`group\_by`\ will be changed by this option. + The choices of :emphasis:`group\_by` will be changed by this option. .. rst-class:: ansible-option-line @@ -2172,7 +2199,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. @@ -2375,7 +2402,7 @@ Parameters
- Allows connection when SSL certificates are not valid. Set to \ :literal:`false`\ when certificates are not trusted. + Allows connection when SSL certificates are not valid. Set to :literal:`false` when certificates are not trusted. .. rst-class:: ansible-option-line @@ -2545,7 +2572,6 @@ Examples .. code-block:: yaml+jinja - # netbox_inventory.yml file in YAML format # Example command line: ansible-inventory -v --list -i netbox_inventory.yml @@ -2655,7 +2681,6 @@ Examples - .. Facts @@ -2697,4 +2722,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/nb_lookup_lookup.rst b/docs/plugins/nb_lookup_lookup.rst index 7ac5ef3e5..70e6c0642 100644 --- a/docs/plugins/nb_lookup_lookup.rst +++ b/docs/plugins/nb_lookup_lookup.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This lookup plugin is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -262,7 +261,7 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a (DEPRECATED) - NetBox 2.11 and earlier only - The location of the private key tied to user account. Mutually exclusive with \ :emphasis:`private\_key`\ . + The location of the private key tied to user account. Mutually exclusive with :emphasis:`private\_key`. .. raw:: html @@ -338,7 +337,7 @@ examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` a (DEPRECATED) - NetBox 2.11 and earlier only - The private key as a string. Mutually exclusive with \ :emphasis:`key\_file`\ . + The private key as a string. Mutually exclusive with :emphasis:`key\_file`. .. raw:: html @@ -502,7 +501,6 @@ Examples .. code-block:: yaml+jinja - tasks: # query a list of devices - name: Obtain list of devices from NetBox @@ -527,7 +525,6 @@ Examples - .. Facts @@ -618,4 +615,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_aggregate_module.rst b/docs/plugins/netbox_aggregate_module.rst index 417e141c3..75eba0ed1 100644 --- a/docs/plugins/netbox_aggregate_module.rst +++ b/docs/plugins/netbox_aggregate_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -677,7 +676,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -701,7 +700,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -713,7 +712,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox aggregate module" connection: local hosts: localhost @@ -752,7 +750,6 @@ Examples - .. Facts @@ -882,4 +879,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_asn_module.rst b/docs/plugins/netbox_asn_module.rst index 228644804..a5c69f826 100644 --- a/docs/plugins/netbox_asn_module.rst +++ b/docs/plugins/netbox_asn_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -587,7 +586,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -611,7 +610,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -623,7 +622,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -650,7 +648,6 @@ Examples - .. Facts @@ -703,7 +700,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -780,4 +777,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_cable_module.rst b/docs/plugins/netbox_cable_module.rst index 07d8cee5c..27f2c824a 100644 --- a/docs/plugins/netbox_cable_module.rst +++ b/docs/plugins/netbox_cable_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -1052,7 +1051,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1076,7 +1075,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1088,7 +1087,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -1150,7 +1148,6 @@ Examples - .. Facts @@ -1203,7 +1200,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1280,4 +1277,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_circuit_module.rst b/docs/plugins/netbox_circuit_module.rst index af32b52f7..7b09be571 100644 --- a/docs/plugins/netbox_circuit_module.rst +++ b/docs/plugins/netbox_circuit_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -797,7 +796,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -821,7 +820,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -833,7 +832,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -876,7 +874,6 @@ Examples - .. Facts @@ -929,7 +926,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1006,4 +1003,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_circuit_termination_module.rst b/docs/plugins/netbox_circuit_termination_module.rst index 898b1a27b..5a6b767f9 100644 --- a/docs/plugins/netbox_circuit_termination_module.rst +++ b/docs/plugins/netbox_circuit_termination_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -774,7 +773,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -798,7 +797,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -810,7 +809,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -852,7 +850,6 @@ Examples - .. Facts @@ -905,7 +902,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -982,4 +979,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_circuit_type_module.rst b/docs/plugins/netbox_circuit_type_module.rst index 10fc1239b..fc87150fd 100644 --- a/docs/plugins/netbox_circuit_type_module.rst +++ b/docs/plugins/netbox_circuit_type_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -601,7 +600,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -625,7 +624,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -637,7 +636,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -662,7 +660,6 @@ Examples - .. Facts @@ -715,7 +712,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -792,4 +789,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_cluster_group_module.rst b/docs/plugins/netbox_cluster_group_module.rst index fd66c81b9..929b00695 100644 --- a/docs/plugins/netbox_cluster_group_module.rst +++ b/docs/plugins/netbox_cluster_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -556,7 +555,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -580,7 +579,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -592,7 +591,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -617,7 +615,6 @@ Examples - .. Facts @@ -670,7 +667,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -747,4 +744,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_cluster_module.rst b/docs/plugins/netbox_cluster_module.rst index 9015bfba0..9fed04ac1 100644 --- a/docs/plugins/netbox_cluster_module.rst +++ b/docs/plugins/netbox_cluster_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -447,7 +446,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the cluster does not exist yet + Required if :emphasis:`state=present` and the cluster does not exist yet .. raw:: html @@ -761,7 +760,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -785,7 +784,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -797,7 +796,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -846,7 +844,6 @@ Examples - .. Facts @@ -899,7 +896,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -976,4 +973,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_cluster_type_module.rst b/docs/plugins/netbox_cluster_type_module.rst index 63a98a426..db36fef99 100644 --- a/docs/plugins/netbox_cluster_type_module.rst +++ b/docs/plugins/netbox_cluster_type_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -553,7 +552,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -577,7 +576,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -589,7 +588,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -614,7 +612,6 @@ Examples - .. Facts @@ -667,7 +664,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -744,4 +741,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_config_context_module.rst b/docs/plugins/netbox_config_context_module.rst index 9f4efd94c..f1bcd5e7a 100644 --- a/docs/plugins/netbox_config_context_module.rst +++ b/docs/plugins/netbox_config_context_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -1057,7 +1056,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1081,7 +1080,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1093,7 +1092,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox config_context module" connection: local hosts: localhost @@ -1129,7 +1127,6 @@ Examples - .. Facts @@ -1259,4 +1256,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_config_template_module.rst b/docs/plugins/netbox_config_template_module.rst index 24fbfb9d9..76f508d68 100644 --- a/docs/plugins/netbox_config_template_module.rst +++ b/docs/plugins/netbox_config_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -545,7 +544,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -580,7 +579,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test config template creation/deletion" connection: local hosts: localhost @@ -609,7 +607,6 @@ Examples - .. Facts @@ -739,4 +736,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_console_port_module.rst b/docs/plugins/netbox_console_port_module.rst index cda040f35..44df81f5c 100644 --- a/docs/plugins/netbox_console_port_module.rst +++ b/docs/plugins/netbox_console_port_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -844,7 +843,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -868,7 +867,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -880,7 +879,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -918,7 +916,6 @@ Examples - .. Facts @@ -971,7 +968,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1048,4 +1045,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_console_port_template_module.rst b/docs/plugins/netbox_console_port_template_module.rst index 011d1a8a3..58aa745bd 100644 --- a/docs/plugins/netbox_console_port_template_module.rst +++ b/docs/plugins/netbox_console_port_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -480,7 +479,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -504,7 +503,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -516,7 +515,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -553,7 +551,6 @@ Examples - .. Facts @@ -606,7 +603,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -683,4 +680,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_console_server_port_module.rst b/docs/plugins/netbox_console_server_port_module.rst index d3d358181..dc5954a9b 100644 --- a/docs/plugins/netbox_console_server_port_module.rst +++ b/docs/plugins/netbox_console_server_port_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -195,7 +194,7 @@ Parameters
- cable to attach port to. Must exist. + cable to attach port to. Must exist. .. raw:: html @@ -799,7 +798,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -823,7 +822,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -835,7 +834,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -874,7 +872,6 @@ Examples - .. Facts @@ -927,7 +924,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1004,4 +1001,3 @@ Collection links .. 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 2990775f6..0c8bb2374 100644 --- a/docs/plugins/netbox_console_server_port_template_module.rst +++ b/docs/plugins/netbox_console_server_port_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -480,7 +479,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -504,7 +503,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -516,7 +515,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -553,7 +551,6 @@ Examples - .. Facts @@ -606,7 +603,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -683,4 +680,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_contact_group_module.rst b/docs/plugins/netbox_contact_group_module.rst index e3504abbe..769d3f49e 100644 --- a/docs/plugins/netbox_contact_group_module.rst +++ b/docs/plugins/netbox_contact_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -587,7 +586,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -611,7 +610,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -623,7 +622,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox contact group module" connection: local hosts: localhost @@ -648,7 +646,6 @@ Examples - .. Facts @@ -778,4 +775,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_contact_module.rst b/docs/plugins/netbox_contact_module.rst index c80e046b7..95aae652d 100644 --- a/docs/plugins/netbox_contact_module.rst +++ b/docs/plugins/netbox_contact_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -803,7 +802,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -827,7 +826,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -839,7 +838,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -878,7 +876,6 @@ Examples - .. Facts @@ -1008,4 +1005,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_contact_role_module.rst b/docs/plugins/netbox_contact_role_module.rst index 6ac8f61fe..514f00b6c 100644 --- a/docs/plugins/netbox_contact_role_module.rst +++ b/docs/plugins/netbox_contact_role_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -547,7 +546,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -571,7 +570,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -583,7 +582,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -607,7 +605,6 @@ Examples - .. Facts @@ -737,4 +734,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_custom_field_choice_set_module.rst b/docs/plugins/netbox_custom_field_choice_set_module.rst index 7674415a8..1de78ab7b 100644 --- a/docs/plugins/netbox_custom_field_choice_set_module.rst +++ b/docs/plugins/netbox_custom_field_choice_set_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_custom_field_choice_set module -- Creates, updates or delet .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -566,7 +565,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -589,7 +588,7 @@ Notes ----- .. note:: - - This should be run with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be run with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -601,7 +600,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test Netbox custom_field_choice_set module" connection: local hosts: localhost @@ -629,7 +627,6 @@ Examples - .. Facts @@ -759,4 +756,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_custom_field_module.rst b/docs/plugins/netbox_custom_field_module.rst index 882e278f8..35697c2f7 100644 --- a/docs/plugins/netbox_custom_field_module.rst +++ b/docs/plugins/netbox_custom_field_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -1188,7 +1187,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1211,7 +1210,7 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1223,7 +1222,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox custom_fields module" connection: local hosts: localhost @@ -1277,7 +1275,6 @@ Examples - .. Facts @@ -1407,4 +1404,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_custom_link_module.rst b/docs/plugins/netbox_custom_link_module.rst index 18ea45e60..7ceff9249 100644 --- a/docs/plugins/netbox_custom_link_module.rst +++ b/docs/plugins/netbox_custom_link_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -822,7 +821,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -845,8 +844,8 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ - - Use the \ :literal:`!unsafe`\ data type if you want jinja2 code in link\_text or link\_url + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` + - Use the :literal:`!unsafe` data type if you want jinja2 code in link\_text or link\_url .. Seealso @@ -858,7 +857,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox custom_link module" connection: local hosts: localhost @@ -886,7 +884,6 @@ Examples - .. Facts @@ -1016,4 +1013,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_device_bay_module.rst b/docs/plugins/netbox_device_bay_module.rst index e5b946fc7..ed1463129 100644 --- a/docs/plugins/netbox_device_bay_module.rst +++ b/docs/plugins/netbox_device_bay_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -590,7 +589,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -614,7 +613,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -626,7 +625,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -663,7 +661,6 @@ Examples - .. Facts @@ -716,7 +713,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -793,4 +790,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_device_bay_template_module.rst b/docs/plugins/netbox_device_bay_template_module.rst index 549897ea3..52c338130 100644 --- a/docs/plugins/netbox_device_bay_template_module.rst +++ b/docs/plugins/netbox_device_bay_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -419,7 +418,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -443,7 +442,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -455,7 +454,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -482,7 +480,6 @@ Examples - .. Facts @@ -535,7 +532,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -612,4 +609,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_device_interface_module.rst b/docs/plugins/netbox_device_interface_module.rst index 228a3d84d..83d905033 100644 --- a/docs/plugins/netbox_device_interface_module.rst +++ b/docs/plugins/netbox_device_interface_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -468,9 +467,8 @@ Parameters
Form factor of the interface: - ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) - This has to be specified exactly as what is found within UI - + ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) + This has to be specified exactly as what is found within UI .. raw:: html @@ -1044,7 +1042,7 @@ Parameters
- A list of tagged VLANS to be assigned to interface. Mode must be set to either \ :literal:`Tagged`\ or \ :literal:`Tagged All`\ + A list of tagged VLANS to be assigned to interface. Mode must be set to either :literal:`Tagged` or :literal:`Tagged All` .. raw:: html @@ -1174,9 +1172,8 @@ Parameters
Form factor of the interface: - ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) - This has to be specified exactly as what is found within UI - + ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) + This has to be specified exactly as what is found within UI .. raw:: html @@ -1493,9 +1490,8 @@ Parameters
- Use when master device is specified for \ :literal:`device`\ and the specified interface exists on a child device - and needs updated - + Use when master device is specified for :literal:`device` and the specified interface exists on a child device + and needs updated .. rst-class:: ansible-option-line @@ -1537,7 +1533,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1561,7 +1557,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1573,7 +1569,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox interface module" connection: local hosts: localhost @@ -1670,7 +1665,6 @@ Examples - .. Facts @@ -1800,4 +1794,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_device_interface_template_module.rst b/docs/plugins/netbox_device_interface_template_module.rst index 88b661de2..e2a19ee2f 100644 --- a/docs/plugins/netbox_device_interface_template_module.rst +++ b/docs/plugins/netbox_device_interface_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -417,9 +416,8 @@ Parameters
Form factor of the interface: - ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) - This has to be specified exactly as what is found within UI - + ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) + This has to be specified exactly as what is found within UI .. raw:: html @@ -604,7 +602,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -628,7 +626,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -640,7 +638,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox interface template module" connection: local hosts: localhost @@ -667,7 +664,6 @@ Examples - .. Facts @@ -797,4 +793,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_device_module.rst b/docs/plugins/netbox_device_module.rst index 3e1943f1c..ec95932cc 100644 --- a/docs/plugins/netbox_device_module.rst +++ b/docs/plugins/netbox_device_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -508,7 +507,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the device does not exist yet + Required if :emphasis:`state=present` and the device does not exist yet .. raw:: html @@ -550,7 +549,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the device does not exist yet + Required if :emphasis:`state=present` and the device does not exist yet .. raw:: html @@ -592,7 +591,7 @@ Parameters
- Required if \ :emphasis:`rack`\ is defined + Required if :emphasis:`rack` is defined .. rst-class:: ansible-option-line @@ -1070,7 +1069,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the device does not exist yet + Required if :emphasis:`state=present` and the device does not exist yet .. raw:: html @@ -1507,7 +1506,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1531,7 +1530,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1543,7 +1542,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -1608,7 +1606,6 @@ Examples - .. Facts @@ -1661,7 +1658,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1739,4 +1736,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_device_role_module.rst b/docs/plugins/netbox_device_role_module.rst index a40d701ee..81930aee8 100644 --- a/docs/plugins/netbox_device_role_module.rst +++ b/docs/plugins/netbox_device_role_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -645,7 +644,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -669,7 +668,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -681,7 +680,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -707,7 +705,6 @@ Examples - .. Facts @@ -760,7 +757,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -837,4 +834,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_device_type_module.rst b/docs/plugins/netbox_device_type_module.rst index 39b807a68..846f842f6 100644 --- a/docs/plugins/netbox_device_type_module.rst +++ b/docs/plugins/netbox_device_type_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -1025,7 +1024,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1049,7 +1048,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1061,7 +1060,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -1102,7 +1100,6 @@ Examples - .. Facts @@ -1155,7 +1152,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1232,4 +1229,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_export_template_module.rst b/docs/plugins/netbox_export_template_module.rst index bfa549727..6f0adda61 100644 --- a/docs/plugins/netbox_export_template_module.rst +++ b/docs/plugins/netbox_export_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -727,7 +726,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -750,8 +749,8 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ - - Use the \ :literal:`!unsafe`\ data type if you want jinja2 code in template\_code + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` + - Use the :literal:`!unsafe` data type if you want jinja2 code in template\_code .. Seealso @@ -763,7 +762,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox export_templates module" connection: local hosts: localhost @@ -799,7 +797,6 @@ Examples - .. Facts @@ -929,4 +926,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_fhrp_group_assignment_module.rst b/docs/plugins/netbox_fhrp_group_assignment_module.rst index 1837d0e12..a965e4f91 100644 --- a/docs/plugins/netbox_fhrp_group_assignment_module.rst +++ b/docs/plugins/netbox_fhrp_group_assignment_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -153,7 +152,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -508,7 +507,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -532,7 +531,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -551,7 +550,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" hosts: localhost connection: local @@ -580,7 +578,6 @@ Examples - .. Facts @@ -633,7 +630,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -710,4 +707,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_fhrp_group_module.rst b/docs/plugins/netbox_fhrp_group_module.rst index b7900ccf3..dc8eb37c6 100644 --- a/docs/plugins/netbox_fhrp_group_module.rst +++ b/docs/plugins/netbox_fhrp_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -650,7 +649,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -674,7 +673,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -693,7 +692,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" hosts: localhost connection: local @@ -721,7 +719,6 @@ Examples - .. Facts @@ -774,7 +771,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -851,4 +848,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_front_port_module.rst b/docs/plugins/netbox_front_port_module.rst index b0f50c52c..7618287fb 100644 --- a/docs/plugins/netbox_front_port_module.rst +++ b/docs/plugins/netbox_front_port_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -694,7 +693,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -718,7 +717,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -730,7 +729,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -774,7 +772,6 @@ Examples - .. Facts @@ -827,7 +824,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -904,4 +901,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_front_port_template_module.rst b/docs/plugins/netbox_front_port_template_module.rst index a953e2709..83586499a 100644 --- a/docs/plugins/netbox_front_port_template_module.rst +++ b/docs/plugins/netbox_front_port_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -655,7 +654,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -679,7 +678,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -691,7 +690,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -734,7 +732,6 @@ Examples - .. Facts @@ -787,7 +784,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -864,4 +861,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_interface_module.rst b/docs/plugins/netbox_interface_module.rst index 673714bf6..e5972f097 100644 --- a/docs/plugins/netbox_interface_module.rst +++ b/docs/plugins/netbox_interface_module.rst @@ -1,10 +1,9 @@ - .. Document meta :orphan: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -18,7 +17,7 @@ netbox.netbox.netbox_interface .. Collection note .. note:: - This plugin was part of the `netbox.netbox collection `_ (version 3.19.1). + This plugin was part of the `netbox.netbox collection `_ (version 3.20.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 3fc9ec1f1..92939f1be 100644 --- a/docs/plugins/netbox_inventory_item_module.rst +++ b/docs/plugins/netbox_inventory_item_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -243,7 +242,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -1089,7 +1088,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1113,7 +1112,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1125,7 +1124,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox inventory_item module" connection: local hosts: localhost @@ -1191,7 +1189,6 @@ Examples - .. Facts @@ -1321,4 +1318,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_inventory_item_role_module.rst b/docs/plugins/netbox_inventory_item_role_module.rst index 6c8576e43..d273880fe 100644 --- a/docs/plugins/netbox_inventory_item_role_module.rst +++ b/docs/plugins/netbox_inventory_item_role_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -589,7 +588,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -613,7 +612,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -625,7 +624,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -651,7 +649,6 @@ Examples - .. Facts @@ -704,7 +701,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -781,4 +778,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_ip_address_module.rst b/docs/plugins/netbox_ip_address_module.rst index 3531d8d99..e0a871a59 100644 --- a/docs/plugins/netbox_ip_address_module.rst +++ b/docs/plugins/netbox_ip_address_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -192,7 +191,7 @@ Parameters
- Required if state is \ :literal:`present`\ + Required if state is :literal:`present` .. raw:: html @@ -240,7 +239,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -627,8 +626,7 @@ Parameters
The name and device of the interface that the IP address should be assigned to - Required if state is \ :literal:`present`\ and a prefix specified. - + Required if state is :literal:`present` and a prefix specified. .. raw:: html @@ -712,16 +710,15 @@ Parameters
- With state \ :literal:`present`\ , if an interface is given, it will ensure - that an IP inside this prefix (and vrf, if given) is attached - to this interface. Otherwise, it will get the next available IP - of this prefix and attach it. - With state \ :literal:`new`\ , it will force to get the next available IP in - this prefix. If an interface is given, it will also force to attach - it. - Required if state is \ :literal:`present`\ or \ :literal:`new`\ when no address is given. - Unused if an address is specified. - + With state :literal:`present`\ , if an interface is given, it will ensure + that an IP inside this prefix (and vrf, if given) is attached + to this interface. Otherwise, it will get the next available IP + of this prefix and attach it. + With state :literal:`new`\ , it will force to get the next available IP in + this prefix. If an interface is given, it will also force to attach + it. + Required if state is :literal:`present` or :literal:`new` when no address is given. + Unused if an address is specified. .. raw:: html @@ -1088,11 +1085,10 @@ Parameters
- Use \ :literal:`present`\ , \ :literal:`new`\ or \ :literal:`absent`\ for adding, force adding or removing. - \ :literal:`present`\ will check if the IP is already created, and return it if - true. \ :literal:`new`\ will force to create it anyway (useful for anycasts, for - example). - + Use :literal:`present`\ , :literal:`new` or :literal:`absent` for adding, force adding or removing. + :literal:`present` will check if the IP is already created, and return it if + true. :literal:`new` will force to create it anyway (useful for anycasts, for + example). .. rst-class:: ansible-option-line @@ -1135,7 +1131,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1159,7 +1155,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1171,7 +1167,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox IP address module" connection: local hosts: localhost @@ -1277,7 +1272,6 @@ Examples - .. Facts @@ -1408,4 +1402,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_ipam_role_module.rst b/docs/plugins/netbox_ipam_role_module.rst index 82658f8f5..52352124f 100644 --- a/docs/plugins/netbox_ipam_role_module.rst +++ b/docs/plugins/netbox_ipam_role_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -595,7 +594,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -619,7 +618,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -631,7 +630,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -655,7 +653,6 @@ Examples - .. Facts @@ -785,4 +782,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_journal_entry_module.rst b/docs/plugins/netbox_journal_entry_module.rst index a19ce2807..44132c940 100644 --- a/docs/plugins/netbox_journal_entry_module.rst +++ b/docs/plugins/netbox_journal_entry_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_journal_entry module -- Creates a journal entry .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -587,8 +586,7 @@ Parameters
- Use \ :literal:`new`\ for adding a journal entry. - + Use :literal:`new` for adding a journal entry. .. rst-class:: ansible-option-line @@ -629,7 +627,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -653,7 +651,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -665,7 +663,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox Module" hosts: localhost connection: local @@ -693,7 +690,6 @@ Examples - .. Facts @@ -823,4 +819,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_l2vpn_module.rst b/docs/plugins/netbox_l2vpn_module.rst index 1e15e1181..92a8dd644 100644 --- a/docs/plugins/netbox_l2vpn_module.rst +++ b/docs/plugins/netbox_l2vpn_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -758,7 +757,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -782,7 +781,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -794,7 +793,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -839,7 +837,6 @@ Examples - .. Facts @@ -892,7 +889,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -969,4 +966,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_l2vpn_termination_module.rst b/docs/plugins/netbox_l2vpn_termination_module.rst index 43636937d..02ad585a7 100644 --- a/docs/plugins/netbox_l2vpn_termination_module.rst +++ b/docs/plugins/netbox_l2vpn_termination_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -554,7 +553,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -578,7 +577,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -597,7 +596,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" hosts: localhost connection: local @@ -624,7 +622,6 @@ Examples - .. Facts @@ -677,7 +674,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -754,4 +751,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_location_module.rst b/docs/plugins/netbox_location_module.rst index 49ddd056c..0523a162b 100644 --- a/docs/plugins/netbox_location_module.rst +++ b/docs/plugins/netbox_location_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -408,7 +407,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the location does not exist yet + Required if :emphasis:`state=present` and the location does not exist yet .. raw:: html @@ -772,7 +771,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -796,7 +795,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -808,7 +807,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -846,7 +844,6 @@ Examples - .. Facts @@ -899,7 +896,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -976,4 +973,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_manufacturer_module.rst b/docs/plugins/netbox_manufacturer_module.rst index b13e9e412..8a3121f2d 100644 --- a/docs/plugins/netbox_manufacturer_module.rst +++ b/docs/plugins/netbox_manufacturer_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_manufacturer module -- Create or delete manufacturers withi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -553,7 +552,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -577,7 +576,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -589,7 +588,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -614,7 +612,6 @@ Examples - .. Facts @@ -667,7 +664,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -744,4 +741,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_module_bay_module.rst b/docs/plugins/netbox_module_bay_module.rst index b9ed205e4..74ffb1181 100644 --- a/docs/plugins/netbox_module_bay_module.rst +++ b/docs/plugins/netbox_module_bay_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_module_bay module -- Create, update or delete module bay wi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -629,7 +628,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -653,7 +652,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -665,7 +664,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -692,7 +690,6 @@ Examples - .. Facts @@ -745,7 +742,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -822,4 +819,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_module_module.rst b/docs/plugins/netbox_module_module.rst index 5cd29e3be..9b221dbef 100644 --- a/docs/plugins/netbox_module_module.rst +++ b/docs/plugins/netbox_module_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_module module -- Create, update or delete module within Net .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -768,7 +767,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -792,7 +791,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -804,7 +803,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -851,7 +849,6 @@ Examples - .. Facts @@ -904,7 +901,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -981,4 +978,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_module_type_module.rst b/docs/plugins/netbox_module_type_module.rst index 987fd0236..25f733f7f 100644 --- a/docs/plugins/netbox_module_type_module.rst +++ b/docs/plugins/netbox_module_type_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -684,7 +683,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -708,7 +707,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -720,7 +719,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -756,7 +754,6 @@ Examples - .. Facts @@ -809,7 +806,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -886,4 +883,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_permission_module.rst b/docs/plugins/netbox_permission_module.rst index c6378737f..730b00bcb 100644 --- a/docs/plugins/netbox_permission_module.rst +++ b/docs/plugins/netbox_permission_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_permission module -- Creates or removes permissions from Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -595,7 +594,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -619,7 +618,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -631,7 +630,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -700,7 +698,6 @@ Examples - .. Facts @@ -764,17 +761,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
+
- .. _ansible_collections.netbox.netbox.netbox_permission_module__return-user: + .. _ansible_collections.netbox.netbox.netbox_permission_module__return-permissions: .. rst-class:: ansible-option-title - **user** + **permissions** .. raw:: html - + .. ansible-option-type-line:: @@ -830,4 +827,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_platform_module.rst b/docs/plugins/netbox_platform_module.rst index d1871e299..3945080f8 100644 --- a/docs/plugins/netbox_platform_module.rst +++ b/docs/plugins/netbox_platform_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -724,7 +723,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -748,7 +747,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -760,7 +759,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -806,7 +804,6 @@ Examples - .. Facts @@ -899,7 +896,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -936,4 +933,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_power_feed_module.rst b/docs/plugins/netbox_power_feed_module.rst index 69792d7ce..9b9dea848 100644 --- a/docs/plugins/netbox_power_feed_module.rst +++ b/docs/plugins/netbox_power_feed_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -960,7 +959,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -984,7 +983,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -996,7 +995,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -1040,7 +1038,6 @@ Examples - .. Facts @@ -1133,7 +1130,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1170,4 +1167,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_power_outlet_module.rst b/docs/plugins/netbox_power_outlet_module.rst index 20ff3bdb4..c5e83d1a6 100644 --- a/docs/plugins/netbox_power_outlet_module.rst +++ b/docs/plugins/netbox_power_outlet_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -744,7 +743,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -768,7 +767,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -780,7 +779,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -820,7 +818,6 @@ Examples - .. Facts @@ -913,7 +910,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -950,4 +947,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_power_outlet_template_module.rst b/docs/plugins/netbox_power_outlet_template_module.rst index 7a37688ae..77fe75aa0 100644 --- a/docs/plugins/netbox_power_outlet_template_module.rst +++ b/docs/plugins/netbox_power_outlet_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -615,7 +614,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -639,7 +638,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -651,7 +650,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -690,7 +688,6 @@ Examples - .. Facts @@ -783,7 +780,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -820,4 +817,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_power_panel_module.rst b/docs/plugins/netbox_power_panel_module.rst index b5aae5968..288dfd0b1 100644 --- a/docs/plugins/netbox_power_panel_module.rst +++ b/docs/plugins/netbox_power_panel_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -688,7 +687,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -712,7 +711,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -724,7 +723,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -771,7 +769,6 @@ Examples - .. Facts @@ -864,7 +861,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -901,4 +898,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_power_port_module.rst b/docs/plugins/netbox_power_port_module.rst index a6d4fd88c..b4016aba8 100644 --- a/docs/plugins/netbox_power_port_module.rst +++ b/docs/plugins/netbox_power_port_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -780,7 +779,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -804,7 +803,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -816,7 +815,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -856,7 +854,6 @@ Examples - .. Facts @@ -949,7 +946,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -986,4 +983,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_power_port_template_module.rst b/docs/plugins/netbox_power_port_template_module.rst index 81d469ba2..c1f6f0076 100644 --- a/docs/plugins/netbox_power_port_template_module.rst +++ b/docs/plugins/netbox_power_port_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -236,7 +235,7 @@ Parameters The device type the power port is attached to - Either \ :emphasis:`device\_type`\ or \ :emphasis:`module\_type`\ are required + Either :emphasis:`device\_type` or :emphasis:`module\_type` are required .. raw:: html @@ -325,7 +324,7 @@ Parameters The module type the power port is attached to - Either \ :emphasis:`device\_type`\ or \ :emphasis:`module\_type`\ are required + Either :emphasis:`device\_type` or :emphasis:`module\_type` are required .. raw:: html @@ -700,7 +699,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -724,7 +723,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -736,7 +735,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -786,7 +784,6 @@ Examples - .. Facts @@ -879,7 +876,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -916,4 +913,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_prefix_module.rst b/docs/plugins/netbox_prefix_module.rst index d300754a1..c2895ed1d 100644 --- a/docs/plugins/netbox_prefix_module.rst +++ b/docs/plugins/netbox_prefix_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -466,7 +465,7 @@ Parameters
- Required if state is \ :literal:`present`\ and first\_available is \ :literal:`yes`\ . Will get a new available prefix in this parent prefix. + Required if state is :literal:`present` and first\_available is :literal:`yes`. Will get a new available prefix in this parent prefix. .. raw:: html @@ -508,7 +507,7 @@ Parameters
- Required if state is \ :literal:`present`\ and first\_available is False. Will allocate or free this prefix. + Required if state is :literal:`present` and first\_available is False. Will allocate or free this prefix. .. raw:: html @@ -550,9 +549,8 @@ Parameters
- Required ONLY if state is \ :literal:`present`\ and first\_available is \ :literal:`yes`\ . - Will get a new available prefix of the given prefix\_length in this parent prefix. - + Required ONLY if state is :literal:`present` and first\_available is :literal:`yes`. + Will get a new available prefix of the given prefix\_length in this parent prefix. .. raw:: html @@ -881,7 +879,7 @@ Parameters
- If \ :literal:`yes`\ and state \ :literal:`present`\ , if an parent is given, it will get the first available prefix of the given prefix\_length inside the given parent (and vrf, if given). Unused with state \ :literal:`absent`\ . + If :literal:`yes` and state :literal:`present`\ , if an parent is given, it will get the first available prefix of the given prefix\_length inside the given parent (and vrf, if given). Unused with state :literal:`absent`. .. rst-class:: ansible-option-line @@ -1073,7 +1071,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1097,7 +1095,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1109,7 +1107,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox prefix module" connection: local hosts: localhost @@ -1197,7 +1194,6 @@ Examples - .. Facts @@ -1328,4 +1324,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_provider_module.rst b/docs/plugins/netbox_provider_module.rst index cd8ca3de6..f29fcbaac 100644 --- a/docs/plugins/netbox_provider_module.rst +++ b/docs/plugins/netbox_provider_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -758,7 +757,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -782,7 +781,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -794,7 +793,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -833,7 +831,6 @@ Examples - .. Facts @@ -926,7 +923,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -963,4 +960,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_provider_network_module.rst b/docs/plugins/netbox_provider_network_module.rst index 836c2a9c1..dbbbb3f3e 100644 --- a/docs/plugins/netbox_provider_network_module.rst +++ b/docs/plugins/netbox_provider_network_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -632,7 +631,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -656,7 +655,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -668,7 +667,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -706,7 +704,6 @@ Examples - .. Facts @@ -799,7 +796,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -836,4 +833,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_rack_group_module.rst b/docs/plugins/netbox_rack_group_module.rst index 03776b7c1..b69056fc8 100644 --- a/docs/plugins/netbox_rack_group_module.rst +++ b/docs/plugins/netbox_rack_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -234,7 +233,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the rack does not exist yet + Required if :emphasis:`state=present` and the rack does not exist yet .. raw:: html @@ -463,7 +462,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -487,7 +486,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -499,7 +498,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -526,7 +524,6 @@ Examples - .. Facts @@ -619,7 +616,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -656,4 +653,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_rack_module.rst b/docs/plugins/netbox_rack_module.rst index 929273ff1..74b1e071a 100644 --- a/docs/plugins/netbox_rack_module.rst +++ b/docs/plugins/netbox_rack_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -674,7 +673,7 @@ Parameters
- Whether the rack unit is in Millimeters or Inches and is \ :emphasis:`required`\ if outer\_width/outer\_depth is specified + Whether the rack unit is in Millimeters or Inches and is :emphasis:`required` if outer\_width/outer\_depth is specified .. rst-class:: ansible-option-line @@ -894,7 +893,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the rack does not exist yet + Required if :emphasis:`state=present` and the rack does not exist yet .. raw:: html @@ -1452,7 +1451,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1476,7 +1475,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1488,7 +1487,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -1534,7 +1532,6 @@ Examples - .. Facts @@ -1627,7 +1624,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1664,4 +1661,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_rack_role_module.rst b/docs/plugins/netbox_rack_role_module.rst index 17a4cfb95..556bcb8f1 100644 --- a/docs/plugins/netbox_rack_role_module.rst +++ b/docs/plugins/netbox_rack_role_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -598,7 +597,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -622,7 +621,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -634,7 +633,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -670,7 +668,6 @@ Examples - .. Facts @@ -763,7 +760,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -800,4 +797,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_rear_port_module.rst b/docs/plugins/netbox_rear_port_module.rst index b894fc221..bbf186f00 100644 --- a/docs/plugins/netbox_rear_port_module.rst +++ b/docs/plugins/netbox_rear_port_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -652,7 +651,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -676,7 +675,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -688,7 +687,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -729,7 +727,6 @@ Examples - .. Facts @@ -822,7 +819,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -859,4 +856,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_rear_port_template_module.rst b/docs/plugins/netbox_rear_port_template_module.rst index b73c13eb5..17c9aee6f 100644 --- a/docs/plugins/netbox_rear_port_template_module.rst +++ b/docs/plugins/netbox_rear_port_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -613,7 +612,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -637,7 +636,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -649,7 +648,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -689,7 +687,6 @@ Examples - .. Facts @@ -782,7 +779,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -819,4 +816,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_region_module.rst b/docs/plugins/netbox_region_module.rst index 58ac03c28..e736df1f7 100644 --- a/docs/plugins/netbox_region_module.rst +++ b/docs/plugins/netbox_region_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -598,7 +597,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -622,7 +621,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -634,7 +633,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox region module" connection: local hosts: localhost @@ -658,7 +656,6 @@ Examples - .. Facts @@ -788,4 +785,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_rir_module.rst b/docs/plugins/netbox_rir_module.rst index 8e7616f84..b35be36a1 100644 --- a/docs/plugins/netbox_rir_module.rst +++ b/docs/plugins/netbox_rir_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -603,7 +602,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -627,7 +626,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -639,7 +638,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -673,7 +671,6 @@ Examples - .. Facts @@ -766,7 +763,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -803,4 +800,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_route_target_module.rst b/docs/plugins/netbox_route_target_module.rst index 8c37378ea..8e3a76881 100644 --- a/docs/plugins/netbox_route_target_module.rst +++ b/docs/plugins/netbox_route_target_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -590,7 +589,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -614,7 +613,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -626,7 +625,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test route target creation/deletion" connection: local hosts: localhost @@ -672,7 +670,6 @@ Examples - .. Facts @@ -802,4 +799,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_service_module.rst b/docs/plugins/netbox_service_module.rst index 8c74bdbc5..3f1240155 100644 --- a/docs/plugins/netbox_service_module.rst +++ b/docs/plugins/netbox_service_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -800,7 +799,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -823,7 +822,7 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -835,7 +834,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create netbox service" connection: local hosts: localhost @@ -870,7 +868,6 @@ Examples - .. Facts @@ -905,4 +902,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_service_template_module.rst b/docs/plugins/netbox_service_template_module.rst index 5880545e6..2eae360ba 100644 --- a/docs/plugins/netbox_service_template_module.rst +++ b/docs/plugins/netbox_service_template_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -638,7 +637,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -662,7 +661,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -674,7 +673,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -714,7 +712,6 @@ Examples - .. Facts @@ -807,7 +804,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -844,4 +841,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_site_group_module.rst b/docs/plugins/netbox_site_group_module.rst index 7975300f2..98f5a5f6d 100644 --- a/docs/plugins/netbox_site_group_module.rst +++ b/docs/plugins/netbox_site_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -595,7 +594,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -619,7 +618,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -631,7 +630,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox site group module" connection: local hosts: localhost @@ -664,7 +662,6 @@ Examples - .. Facts @@ -757,7 +754,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -794,4 +791,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_site_module.rst b/docs/plugins/netbox_site_module.rst index 5d97e3d2c..e6bcb5840 100644 --- a/docs/plugins/netbox_site_module.rst +++ b/docs/plugins/netbox_site_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -1178,7 +1177,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1202,7 +1201,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1214,7 +1213,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox site module" connection: local hosts: localhost @@ -1263,7 +1261,6 @@ Examples - .. Facts @@ -1393,4 +1390,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_tag_module.rst b/docs/plugins/netbox_tag_module.rst index b283e1d28..9075a4bb2 100644 --- a/docs/plugins/netbox_tag_module.rst +++ b/docs/plugins/netbox_tag_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -505,7 +504,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -529,7 +528,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -541,7 +540,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test tags creation/deletion" connection: local hosts: localhost @@ -571,7 +569,6 @@ Examples - .. Facts @@ -701,4 +698,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_tenant_group_module.rst b/docs/plugins/netbox_tenant_group_module.rst index bc29df22b..05fb91d90 100644 --- a/docs/plugins/netbox_tenant_group_module.rst +++ b/docs/plugins/netbox_tenant_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -593,7 +592,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -617,7 +616,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -629,7 +628,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox tenant group module" connection: local hosts: localhost @@ -654,7 +652,6 @@ Examples - .. Facts @@ -784,4 +781,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_tenant_module.rst b/docs/plugins/netbox_tenant_module.rst index 4f7dbdb58..785309427 100644 --- a/docs/plugins/netbox_tenant_module.rst +++ b/docs/plugins/netbox_tenant_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -629,7 +628,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -653,7 +652,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -665,7 +664,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -705,7 +703,6 @@ Examples - .. Facts @@ -835,4 +832,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_token_module.rst b/docs/plugins/netbox_token_module.rst index 906c8784a..3158d0d6f 100644 --- a/docs/plugins/netbox_token_module.rst +++ b/docs/plugins/netbox_token_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_token module -- Creates or removes tokens from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -553,7 +552,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -577,7 +576,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -589,76 +588,51 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost gather_facts: false tasks: - - name: Create permission within NetBox with only required information - netbox.netbox.netbox_permission: - netbox_url: http://netbox.local - netbox_token: thisIsMyToken - data: - name: My Permission - actions: - - view - object_types: [] - state: present - - - name: Create user which has the permission + - name: Create user to own the token netbox.netbox.netbox_user: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: username: MyUser password: MyPassword - permissions: - - My Permission state: present - - name: Create a group which has the permission - netbox.netbox.netbox_user_group: + - name: Create token within NetBox with only required information + netbox.netbox.netbox_token: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: - name: My Group - permissions: - - My Permission - state: absent + user: TestUser + key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + state: present - - name: Delete permission within netbox - netbox.netbox.netbox_permission: + - name: Delete token within netbox + netbox.netbox.netbox_token: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: - name: My Permission + key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa state: absent - - name: Create permission with all parameters - netbox.netbox.netbox_permission: + - name: Create token with all parameters + netbox.netbox.netbox_token: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: - name: My permission - description: The permission I made - enabled: false - actions: - - view - - add - - change - - delete - - extreme_administration - object_types: - - vpn.tunneltermination - - wireless.wirelesslan - constraints: - id: 1 + user: TestUser + key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: The test token + write_enabled: false + expires: 2024-08-26T14:49:01.345000+00:00 state: present - .. Facts @@ -722,17 +696,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
+
- .. _ansible_collections.netbox.netbox.netbox_token_module__return-user: + .. _ansible_collections.netbox.netbox.netbox_token_module__return-token: .. rst-class:: ansible-option-title - **user** + **token** .. raw:: html - + .. ansible-option-type-line:: @@ -788,4 +762,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_tunnel_group_module.rst b/docs/plugins/netbox_tunnel_group_module.rst index 505ef73c2..538742a29 100644 --- a/docs/plugins/netbox_tunnel_group_module.rst +++ b/docs/plugins/netbox_tunnel_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_tunnel_group module -- Create, update or delete tunnel grou .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -547,7 +546,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -571,7 +570,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -583,7 +582,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox Tunnel Group module" connection: local hosts: localhost @@ -608,7 +606,6 @@ Examples - .. Facts @@ -701,7 +698,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -738,4 +735,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_tunnel_module.rst b/docs/plugins/netbox_tunnel_module.rst index 8a04e59ac..f2af8bbc2 100644 --- a/docs/plugins/netbox_tunnel_module.rst +++ b/docs/plugins/netbox_tunnel_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_tunnel module -- Create, update or delete tunnels within Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -807,7 +806,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -831,7 +830,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -843,7 +842,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -887,7 +885,6 @@ Examples - .. Facts @@ -980,7 +977,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1017,4 +1014,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_user_group_module.rst b/docs/plugins/netbox_user_group_module.rst index 187cb6734..af8304684 100644 --- a/docs/plugins/netbox_user_group_module.rst +++ b/docs/plugins/netbox_user_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_user_group module -- Creates or removes user groups from Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -461,7 +460,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -485,7 +484,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -497,7 +496,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -541,7 +539,6 @@ Examples - .. Facts @@ -605,17 +602,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
+
- .. _ansible_collections.netbox.netbox.netbox_user_group_module__return-user: + .. _ansible_collections.netbox.netbox.netbox_user_group_module__return-user_group: .. rst-class:: ansible-option-title - **user** + **user_group** .. raw:: html - + .. ansible-option-type-line:: @@ -671,4 +668,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_user_module.rst b/docs/plugins/netbox_user_module.rst index a38d6ee6b..953850eb2 100644 --- a/docs/plugins/netbox_user_module.rst +++ b/docs/plugins/netbox_user_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_user module -- Creates or removes users from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -234,7 +233,7 @@ Parameters
- First name of the user to be created + First name of the user to be created .. raw:: html @@ -460,7 +459,7 @@ Parameters
- Password of the user to be created + Password of the user to be created. If this is specified, the password field will always be updated. .. raw:: html @@ -729,7 +728,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -753,7 +752,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -765,7 +764,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -780,6 +778,15 @@ Examples password: MyPassword state: present + - name: Update a user's email + netbox.netbox.netbox_user: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + username: MyUser + password: my@user.com + state: present + - name: Delete user within netbox netbox.netbox.netbox_user: netbox_url: http://netbox.local @@ -793,7 +800,7 @@ Examples netbox_url: http://netbox.local netbox_token: thisIsMyToken data: - username: MyUser + username: MyUser2 password: MyPassword email: my@user.com first_name: My @@ -802,7 +809,6 @@ Examples - .. Facts @@ -932,4 +938,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_virtual_chassis_module.rst b/docs/plugins/netbox_virtual_chassis_module.rst index 77b970898..453bd9064 100644 --- a/docs/plugins/netbox_virtual_chassis_module.rst +++ b/docs/plugins/netbox_virtual_chassis_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -635,7 +634,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -659,7 +658,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -671,7 +670,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -706,7 +704,6 @@ Examples - .. Facts @@ -799,7 +796,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -836,4 +833,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_virtual_disk_module.rst b/docs/plugins/netbox_virtual_disk_module.rst index 325fa866e..e4da063b3 100644 --- a/docs/plugins/netbox_virtual_disk_module.rst +++ b/docs/plugins/netbox_virtual_disk_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ netbox.netbox.netbox_virtual_disk module -- Creates or removes disks from virtua .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -587,7 +586,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -611,7 +610,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -623,7 +622,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox virtual disk module" connection: local hosts: localhost @@ -639,7 +637,6 @@ Examples - .. Facts @@ -769,4 +766,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_virtual_machine_module.rst b/docs/plugins/netbox_virtual_machine_module.rst index 4ecbc7016..c122cc268 100644 --- a/docs/plugins/netbox_virtual_machine_module.rst +++ b/docs/plugins/netbox_virtual_machine_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -708,6 +707,51 @@ Parameters Primary IPv6 address assigned to 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/serial: + + .. rst-class:: ansible-option-title + + **serial** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in netbox.netbox 3.20.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Serial number of the virtual machine + + .. raw:: html
@@ -1142,7 +1186,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1166,7 +1210,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -1178,7 +1222,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -1225,6 +1268,15 @@ Examples disk: 8 state: present + - name: Update virtual machine within NetBox with serial number + netbox_virtual_machine: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: Test Virtual Machine + cluster: test cluster + serial: 1234abc + state: present @@ -1320,7 +1372,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1357,4 +1409,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_vlan_group_module.rst b/docs/plugins/netbox_vlan_group_module.rst index 950b8d6d9..dfa318046 100644 --- a/docs/plugins/netbox_vlan_group_module.rst +++ b/docs/plugins/netbox_vlan_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -611,6 +610,51 @@ Parameters The tags to add/update + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-data/vid_ranges: + + .. rst-class:: ansible-option-title + + **vid_ranges** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + + :ansible-option-versionadded:`added in netbox.netbox 3.20.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Array of starting and ending VLAN ID pairs + + .. raw:: html
@@ -793,7 +837,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -817,7 +861,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -829,7 +873,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -855,6 +898,18 @@ Examples scope: Test Site state: present + - name: Create vlan group within NetBox with vid_ranges + netbox_vlan_group: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: Test vlan group + vid_ranges: [ + [1300, 1329], + [1, 2] + ] + state: present + - name: Delete vlan group within netbox netbox_vlan_group: netbox_url: http://netbox.local @@ -865,7 +920,6 @@ Examples - .. Facts @@ -958,7 +1012,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -995,4 +1049,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_vlan_module.rst b/docs/plugins/netbox_vlan_module.rst index e76f2722b..64cb9c919 100644 --- a/docs/plugins/netbox_vlan_module.rst +++ b/docs/plugins/netbox_vlan_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -615,7 +614,7 @@ Parameters
- Required if \ :emphasis:`state=present`\ and the vlan does not exist yet + Required if :emphasis:`state=present` and the vlan does not exist yet .. raw:: html @@ -800,7 +799,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -824,7 +823,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -836,7 +835,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -880,7 +878,6 @@ Examples - .. Facts @@ -973,7 +970,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -1010,4 +1007,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_vm_interface_module.rst b/docs/plugins/netbox_vm_interface_module.rst index a12c89916..1798edaa5 100644 --- a/docs/plugins/netbox_vm_interface_module.rst +++ b/docs/plugins/netbox_vm_interface_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -542,7 +541,7 @@ Parameters
- A list of tagged VLANS to be assigned to interface. Mode must be set to either \ :literal:`Tagged`\ or \ :literal:`Tagged All`\ + A list of tagged VLANS to be assigned to interface. Mode must be set to either :literal:`Tagged` or :literal:`Tagged All` .. raw:: html @@ -943,7 +942,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -967,7 +966,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -979,7 +978,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox interface module" connection: local hosts: localhost @@ -1044,7 +1042,6 @@ Examples - .. Facts @@ -1174,4 +1171,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_vrf_module.rst b/docs/plugins/netbox_vrf_module.rst index 0d0fa27c1..e500d33c7 100644 --- a/docs/plugins/netbox_vrf_module.rst +++ b/docs/plugins/netbox_vrf_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -772,7 +771,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -796,7 +795,7 @@ Notes .. note:: - Tags should be defined as a YAML list - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -808,7 +807,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox modules" connection: local hosts: localhost @@ -851,7 +849,6 @@ Examples - .. Facts @@ -944,7 +941,7 @@ Common return values are documented :ref:`here `, the foll .. rst-class:: ansible-option-line - :ansible-option-returned-bold:`Returned:` success (when \ :emphasis:`state=present`\ ) + :ansible-option-returned-bold:`Returned:` success (when :emphasis:`state=present`\ ) .. raw:: html @@ -981,4 +978,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_webhook_module.rst b/docs/plugins/netbox_webhook_module.rst index c0f24966d..d4203d3ea 100644 --- a/docs/plugins/netbox_webhook_module.rst +++ b/docs/plugins/netbox_webhook_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -362,7 +361,7 @@ Parameters The content type(s) to apply this webhook to - Required when \ :emphasis:`state=present`\ + Required when :emphasis:`state=present` .. raw:: html @@ -582,7 +581,7 @@ Parameters URL for the webhook to use. - Required when \ :emphasis:`state=present`\ + Required when :emphasis:`state=present` .. raw:: html @@ -1009,7 +1008,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -1032,8 +1031,8 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ - - Use \ :literal:`!unsafe`\ when adding jinja2 code to \ :literal:`additional\_headers`\ or \ :literal:`body\_template`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` + - Use :literal:`!unsafe` when adding jinja2 code to :literal:`additional\_headers` or :literal:`body\_template` .. Seealso @@ -1045,7 +1044,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox webhook module" connection: local hosts: localhost @@ -1090,7 +1088,6 @@ Examples - .. Facts @@ -1220,4 +1217,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_wireless_lan_group_module.rst b/docs/plugins/netbox_wireless_lan_group_module.rst index b4eaaddee..5b286b43c 100644 --- a/docs/plugins/netbox_wireless_lan_group_module.rst +++ b/docs/plugins/netbox_wireless_lan_group_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -587,7 +586,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -610,7 +609,7 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -622,7 +621,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -659,7 +657,6 @@ Examples - .. Facts @@ -789,4 +786,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_wireless_lan_module.rst b/docs/plugins/netbox_wireless_lan_module.rst index c75251d8c..1cd4407f2 100644 --- a/docs/plugins/netbox_wireless_lan_module.rst +++ b/docs/plugins/netbox_wireless_lan_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -819,7 +818,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -842,7 +841,7 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -854,7 +853,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -894,7 +892,6 @@ Examples - .. Facts @@ -1024,4 +1021,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/netbox_wireless_link_module.rst b/docs/plugins/netbox_wireless_link_module.rst index b4cbe76f4..d2bdddda4 100644 --- a/docs/plugins/netbox_wireless_link_module.rst +++ b/docs/plugins/netbox_wireless_link_module.rst @@ -1,4 +1,3 @@ - .. Document meta :orphan: @@ -7,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.11.0 + :antsibull-docs: 2.13.1 .. Anchors @@ -23,7 +22,7 @@ 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.19.1). + This module is part of the `netbox.netbox collection `_ (version 3.20.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -156,7 +155,7 @@ Parameters .. raw:: html
- + * - .. raw:: html
@@ -828,7 +827,7 @@ Parameters
- If \ :literal:`no`\ , SSL certificates will not be validated. + If :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. @@ -851,7 +850,7 @@ Notes ----- .. note:: - - This should be ran with connection \ :literal:`local`\ and hosts \ :literal:`localhost`\ + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` .. Seealso @@ -863,7 +862,6 @@ Examples .. code-block:: yaml+jinja - - name: "Test NetBox module" connection: local hosts: localhost @@ -919,7 +917,6 @@ Examples - .. Facts @@ -1049,4 +1046,3 @@ Collection links .. Parsing errors - diff --git a/galaxy.yml b/galaxy.yml index 19d93bd9e..a16e960f6 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.19.1 +version: 3.20.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/pyproject.toml b/pyproject.toml index 9500eee62..84372b906 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "netbox_ansible_modules" -version = "3.19.1" +version = "3.20.0" description = "Ansible collection to interact with NetBox's API" authors = ["Mikhail Yohman "] license = "GPLv3"