diff options
Diffstat (limited to 'ansible_collections/netbox/netbox/docs/plugins/index.rst')
| -rw-r--r-- | ansible_collections/netbox/netbox/docs/plugins/index.rst | 213 |
1 files changed, 213 insertions, 0 deletions
diff --git a/ansible_collections/netbox/netbox/docs/plugins/index.rst b/ansible_collections/netbox/netbox/docs/plugins/index.rst new file mode 100644 index 00000000..1970d278 --- /dev/null +++ b/ansible_collections/netbox/netbox/docs/plugins/index.rst @@ -0,0 +1,213 @@ + + + +.. _plugins_in_netbox.netbox: + +Netbox.Netbox +============= + +Collection version 3.8.1 + +.. contents:: + :local: + :depth: 1 + +Description +----------- + +This is a collection of NetBox Ansible modules + +**Authors:** + +* Mikhail Yohman <mikhail.yohman@gmail.com> +* Martin Rødvand <martin@rodvand.net> + +**Supported ansible-core versions:** + +* 2.9.10 or newer + +.. raw:: html + + <p class="ansible-links"> + <a href="https://github.com/netbox-community/ansible_modules/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> + <a href="https://github.com/netbox-community/ansible_modules" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> + </p> + + + +.. toctree:: + :maxdepth: 1 + + +Plugin Index +------------ + +These are the plugins in the netbox.netbox collection: + + +Modules +~~~~~~~ + +* :ref:`netbox_aggregate module <ansible_collections.netbox.netbox.netbox_aggregate_module>` -- Creates or removes aggregates from NetBox +* :ref:`netbox_cable module <ansible_collections.netbox.netbox.netbox_cable_module>` -- Create, update or delete cables within NetBox +* :ref:`netbox_circuit module <ansible_collections.netbox.netbox.netbox_circuit_module>` -- Create, update or delete circuits within NetBox +* :ref:`netbox_circuit_termination module <ansible_collections.netbox.netbox.netbox_circuit_termination_module>` -- Create, update or delete circuit terminations within NetBox +* :ref:`netbox_circuit_type module <ansible_collections.netbox.netbox.netbox_circuit_type_module>` -- Create, update or delete circuit types within NetBox +* :ref:`netbox_cluster module <ansible_collections.netbox.netbox.netbox_cluster_module>` -- Create, update or delete clusters within NetBox +* :ref:`netbox_cluster_group module <ansible_collections.netbox.netbox.netbox_cluster_group_module>` -- Create, update or delete cluster groups within NetBox +* :ref:`netbox_cluster_type module <ansible_collections.netbox.netbox.netbox_cluster_type_module>` -- Create, update or delete cluster types within NetBox +* :ref:`netbox_config_context module <ansible_collections.netbox.netbox.netbox_config_context_module>` -- Creates, updates or deletes configuration contexts within NetBox +* :ref:`netbox_console_port module <ansible_collections.netbox.netbox.netbox_console_port_module>` -- Create, update or delete console ports within NetBox +* :ref:`netbox_console_port_template module <ansible_collections.netbox.netbox.netbox_console_port_template_module>` -- Create, update or delete console port templates within NetBox +* :ref:`netbox_console_server_port module <ansible_collections.netbox.netbox.netbox_console_server_port_module>` -- Create, update or delete console server ports within NetBox +* :ref:`netbox_console_server_port_template module <ansible_collections.netbox.netbox.netbox_console_server_port_template_module>` -- Create, update or delete console server port templates within NetBox +* :ref:`netbox_contact module <ansible_collections.netbox.netbox.netbox_contact_module>` -- Creates or removes contacts from NetBox +* :ref:`netbox_contact_group module <ansible_collections.netbox.netbox.netbox_contact_group_module>` -- Creates or removes contact groups from NetBox +* :ref:`netbox_contact_role module <ansible_collections.netbox.netbox.netbox_contact_role_module>` -- Creates or removes contact roles from NetBox +* :ref:`netbox_custom_field module <ansible_collections.netbox.netbox.netbox_custom_field_module>` -- Creates, updates or deletes custom fields within NetBox +* :ref:`netbox_custom_link module <ansible_collections.netbox.netbox.netbox_custom_link_module>` -- Creates, updates or deletes custom links within NetBox +* :ref:`netbox_device module <ansible_collections.netbox.netbox.netbox_device_module>` -- Create, update or delete devices within NetBox +* :ref:`netbox_device_bay module <ansible_collections.netbox.netbox.netbox_device_bay_module>` -- Create, update or delete device bays within NetBox +* :ref:`netbox_device_bay_template module <ansible_collections.netbox.netbox.netbox_device_bay_template_module>` -- Create, update or delete device bay templates within NetBox +* :ref:`netbox_device_interface module <ansible_collections.netbox.netbox.netbox_device_interface_module>` -- Creates or removes interfaces on devices from NetBox +* :ref:`netbox_device_interface_template module <ansible_collections.netbox.netbox.netbox_device_interface_template_module>` -- Creates or removes interfaces on devices from NetBox +* :ref:`netbox_device_role module <ansible_collections.netbox.netbox.netbox_device_role_module>` -- Create, update or delete devices roles within NetBox +* :ref:`netbox_device_type module <ansible_collections.netbox.netbox.netbox_device_type_module>` -- Create, update or delete device types within NetBox +* :ref:`netbox_export_template module <ansible_collections.netbox.netbox.netbox_export_template_module>` -- Creates, updates or deletes export templates within NetBox +* :ref:`netbox_front_port module <ansible_collections.netbox.netbox.netbox_front_port_module>` -- Create, update or delete front ports within NetBox +* :ref:`netbox_front_port_template module <ansible_collections.netbox.netbox.netbox_front_port_template_module>` -- Create, update or delete front port templates within NetBox +* :ref:`netbox_inventory_item module <ansible_collections.netbox.netbox.netbox_inventory_item_module>` -- Creates or removes inventory items from NetBox +* :ref:`netbox_inventory_item_role module <ansible_collections.netbox.netbox.netbox_inventory_item_role_module>` -- Create, update or delete devices roles within NetBox +* :ref:`netbox_ip_address module <ansible_collections.netbox.netbox.netbox_ip_address_module>` -- Creates or removes IP addresses from NetBox +* :ref:`netbox_ipam_role module <ansible_collections.netbox.netbox.netbox_ipam_role_module>` -- Creates or removes ipam roles from NetBox +* :ref:`netbox_l2vpn module <ansible_collections.netbox.netbox.netbox_l2vpn_module>` -- Create, update or delete L2VPNs within NetBox +* :ref:`netbox_location module <ansible_collections.netbox.netbox.netbox_location_module>` -- Create, update or delete locations within NetBox +* :ref:`netbox_manufacturer module <ansible_collections.netbox.netbox.netbox_manufacturer_module>` -- Create or delete manufacturers within NetBox +* :ref:`netbox_module_type module <ansible_collections.netbox.netbox.netbox_module_type_module>` -- Create, update or delete module types within NetBox +* :ref:`netbox_platform module <ansible_collections.netbox.netbox.netbox_platform_module>` -- Create or delete platforms within NetBox +* :ref:`netbox_power_feed module <ansible_collections.netbox.netbox.netbox_power_feed_module>` -- Create, update or delete power feeds within NetBox +* :ref:`netbox_power_outlet module <ansible_collections.netbox.netbox.netbox_power_outlet_module>` -- Create, update or delete power outlets within NetBox +* :ref:`netbox_power_outlet_template module <ansible_collections.netbox.netbox.netbox_power_outlet_template_module>` -- Create, update or delete power outlet templates within NetBox +* :ref:`netbox_power_panel module <ansible_collections.netbox.netbox.netbox_power_panel_module>` -- Create, update or delete power panels within NetBox +* :ref:`netbox_power_port module <ansible_collections.netbox.netbox.netbox_power_port_module>` -- Create, update or delete power ports within NetBox +* :ref:`netbox_power_port_template module <ansible_collections.netbox.netbox.netbox_power_port_template_module>` -- Create, update or delete power port templates within NetBox +* :ref:`netbox_prefix module <ansible_collections.netbox.netbox.netbox_prefix_module>` -- Creates or removes prefixes from NetBox +* :ref:`netbox_provider module <ansible_collections.netbox.netbox.netbox_provider_module>` -- Create, update or delete providers within NetBox +* :ref:`netbox_provider_network module <ansible_collections.netbox.netbox.netbox_provider_network_module>` -- Create, update or delete provider networks within NetBox +* :ref:`netbox_rack module <ansible_collections.netbox.netbox.netbox_rack_module>` -- Create, update or delete racks within NetBox +* :ref:`netbox_rack_group module <ansible_collections.netbox.netbox.netbox_rack_group_module>` -- Create, update or delete racks groups within NetBox +* :ref:`netbox_rack_role module <ansible_collections.netbox.netbox.netbox_rack_role_module>` -- Create, update or delete racks roles within NetBox +* :ref:`netbox_rear_port module <ansible_collections.netbox.netbox.netbox_rear_port_module>` -- Create, update or delete rear ports within NetBox +* :ref:`netbox_rear_port_template module <ansible_collections.netbox.netbox.netbox_rear_port_template_module>` -- Create, update or delete rear port templates within NetBox +* :ref:`netbox_region module <ansible_collections.netbox.netbox.netbox_region_module>` -- Creates or removes regions from NetBox +* :ref:`netbox_rir module <ansible_collections.netbox.netbox.netbox_rir_module>` -- Create, update or delete RIRs within NetBox +* :ref:`netbox_route_target module <ansible_collections.netbox.netbox.netbox_route_target_module>` -- Creates or removes route targets from NetBox +* :ref:`netbox_service module <ansible_collections.netbox.netbox.netbox_service_module>` -- Creates or removes service from NetBox +* :ref:`netbox_service_template module <ansible_collections.netbox.netbox.netbox_service_template_module>` -- Create, update or delete service templates within NetBox +* :ref:`netbox_site module <ansible_collections.netbox.netbox.netbox_site_module>` -- Creates or removes sites from NetBox +* :ref:`netbox_site_group module <ansible_collections.netbox.netbox.netbox_site_group_module>` -- Create, update, or delete site groups within NetBox +* :ref:`netbox_tag module <ansible_collections.netbox.netbox.netbox_tag_module>` -- Creates or removes tags from NetBox +* :ref:`netbox_tenant module <ansible_collections.netbox.netbox.netbox_tenant_module>` -- Creates or removes tenants from NetBox +* :ref:`netbox_tenant_group module <ansible_collections.netbox.netbox.netbox_tenant_group_module>` -- Creates or removes tenant groups from NetBox +* :ref:`netbox_virtual_chassis module <ansible_collections.netbox.netbox.netbox_virtual_chassis_module>` -- Create, update or delete virtual chassis within NetBox +* :ref:`netbox_virtual_machine module <ansible_collections.netbox.netbox.netbox_virtual_machine_module>` -- Create, update or delete virtual\_machines within NetBox +* :ref:`netbox_vlan module <ansible_collections.netbox.netbox.netbox_vlan_module>` -- Create, update or delete vlans within NetBox +* :ref:`netbox_vlan_group module <ansible_collections.netbox.netbox.netbox_vlan_group_module>` -- Create, update or delete vlans groups within NetBox +* :ref:`netbox_vm_interface module <ansible_collections.netbox.netbox.netbox_vm_interface_module>` -- Creates or removes interfaces from virtual machines in NetBox +* :ref:`netbox_vrf module <ansible_collections.netbox.netbox.netbox_vrf_module>` -- Create, update or delete vrfs within NetBox +* :ref:`netbox_webhook module <ansible_collections.netbox.netbox.netbox_webhook_module>` -- Creates, updates or deletes webhook configuration within NetBox +* :ref:`netbox_wireless_lan module <ansible_collections.netbox.netbox.netbox_wireless_lan_module>` -- Creates or removes Wireless LANs from NetBox +* :ref:`netbox_wireless_lan_group module <ansible_collections.netbox.netbox.netbox_wireless_lan_group_module>` -- Creates or removes Wireless LAN Groups from NetBox +* :ref:`netbox_wireless_link module <ansible_collections.netbox.netbox.netbox_wireless_link_module>` -- Creates or removes Wireless links from NetBox + + +Inventory Plugins +~~~~~~~~~~~~~~~~~ + +* :ref:`nb_inventory inventory <ansible_collections.netbox.netbox.nb_inventory_inventory>` -- NetBox inventory source + + +Lookup Plugins +~~~~~~~~~~~~~~ + +* :ref:`nb_lookup lookup <ansible_collections.netbox.netbox.nb_lookup_lookup>` -- Queries and returns elements from NetBox + + + +.. toctree:: + :maxdepth: 1 + :hidden: + + nb_inventory_inventory + nb_lookup_lookup + netbox_aggregate_module + netbox_cable_module + netbox_circuit_module + netbox_circuit_termination_module + netbox_circuit_type_module + netbox_cluster_module + netbox_cluster_group_module + netbox_cluster_type_module + netbox_config_context_module + netbox_console_port_module + netbox_console_port_template_module + netbox_console_server_port_module + netbox_console_server_port_template_module + netbox_contact_module + netbox_contact_group_module + netbox_contact_role_module + netbox_custom_field_module + netbox_custom_link_module + netbox_device_module + netbox_device_bay_module + netbox_device_bay_template_module + netbox_device_interface_module + netbox_device_interface_template_module + netbox_device_role_module + netbox_device_type_module + netbox_export_template_module + netbox_front_port_module + netbox_front_port_template_module + netbox_inventory_item_module + netbox_inventory_item_role_module + netbox_ip_address_module + netbox_ipam_role_module + netbox_l2vpn_module + netbox_location_module + netbox_manufacturer_module + netbox_module_type_module + netbox_platform_module + netbox_power_feed_module + netbox_power_outlet_module + netbox_power_outlet_template_module + netbox_power_panel_module + netbox_power_port_module + netbox_power_port_template_module + netbox_prefix_module + netbox_provider_module + netbox_provider_network_module + netbox_rack_module + netbox_rack_group_module + netbox_rack_role_module + netbox_rear_port_module + netbox_rear_port_template_module + netbox_region_module + netbox_rir_module + netbox_route_target_module + netbox_service_module + netbox_service_template_module + netbox_site_module + netbox_site_group_module + netbox_tag_module + netbox_tenant_module + netbox_tenant_group_module + netbox_virtual_chassis_module + netbox_virtual_machine_module + netbox_vlan_module + netbox_vlan_group_module + netbox_vm_interface_module + netbox_vrf_module + netbox_webhook_module + netbox_wireless_lan_module + netbox_wireless_lan_group_module + netbox_wireless_link_module |