netbox.netbox Ansible Collection’s documentation!

Overview

This is the documentation home of the netbox.netbox Ansible Collection. We will provide some examples of using all the different plugins included with this collection.

Contents

• Home
• Getting Started
  • Installation
    • Ansible Galaxy
    • Build From Source
    • Build From Source (Pull Request)
  • How to Use
    • Modules
      • Specifying Modules in a Playbook
      • Module Arguments & States
    • Inventory
      • Using Compose to Set ansible_network_os to Platform Slug
      • Using Keyed Groups to set ansible_network_os to Platform Slug
      • Using Inventory Plugin Within AWX/Tower
    • Advanced Usage - Modules
      • Passing in Dictionaries
      • Passing in IDs Manually
      • Using nb_lookup Plugin to Provide ID or Object
      • Using query_params Module Argument
      • Using Module defaults groups
  • Contributing
    • Modules
      • Module Architecture
      • Creating a New Ansible Module
      • Adding New Module Options
    • Inventory
• Plugins
  • Description
  • Plugin Index
    • Modules
    • Inventory Plugins
    • Lookup Plugins
• Module Utils (Python) Docs
  • netbox_circuits
    • Constants
      • NB_PROVIDERS
      • NB_CIRCUIT_TYPES
      • NB_CIRCUIT_TERMINATIONS
      • NB_CIRCUITS
    • Classes
      • NetboxCircuitsModule
  • netbox_dcim
    • Constants
      • NB_CABLES
      • NB_CONSOLE_PORTS
      • NB_CONSOLE_PORT_TEMPLATES
      • NB_CONSOLE_SERVER_PORTS
      • NB_CONSOLE_SERVER_PORT_TEMPLATES
      • NB_DEVICE_BAYS
      • NB_DEVICE_BAY_TEMPLATES
      • NB_DEVICES
      • NB_DEVICE_ROLES
      • NB_DEVICE_TYPES
      • NB_FRONT_PORTS
      • NB_FRONT_PORT_TEMPLATES
      • NB_INTERFACES
      • NB_INTERFACE_TEMPLATES
      • NB_INVENTORY_ITEMS
      • NB_MANUFACTURERS
      • NB_PLATFORMS
      • NB_POWER_FEEDS
      • NB_POWER_OUTLETS
      • NB_POWER_OUTLET_TEMPLATES
      • NB_POWER_PANELS
      • NB_POWER_PORTS
      • NB_POWER_PORT_TEMPLATES
      • NB_RACKS
      • NB_RACK_ROLES
      • NB_RACK_GROUPS
      • NB_REAR_PORTS
      • NB_REAR_PORT_TEMPLATES
      • NB_REGIONS
      • NB_SITES
      • NB_VIRTUAL_CHASSIS
    • Classes
      • NetboxDcimModule
  • netbox_extras
    • Constants
    • Classes
      • NetboxExtrasModule
  • netbox_ipam
    • Constants
      • NB_AGGREGATES
      • NB_IP_ADDRESSES
      • NB_PREFIXES
      • NB_IPAM_ROLES
      • NB_RIRS
      • NB_VLANS
      • NB_VLAN_GROUPS
      • NB_VRFS
      • NB_SERVICES
    • Classes
      • NetboxIpamModule
  • netbox_secrets
    • Constants
    • Classes
      • NetboxSecretsModule
  • netbox_tenancy
    • Constants
      • NB_TENANTS
      • NB_TENANT_GROUPS
    • Classes
      • NetboxTenancyModule
  • netbox_utils
    • Constants
      • API_APPS_ENDPOINTS
      • QUERY_TYPES
      • CONVERT_TO_ID
      • ENDPOINT_NAME_MAPPING
      • ALLOWED_QUERY_PARAMS
      • QUERY_PARAMS_IDS
      • REQUIRED_ID_FIND
      • CONVERT_KEYS
      • SLUG_REQUIRED
      • NETBOX_ARG_SPEC
    • Classes
      • NetboxAnsibleModule
      • NetboxModule
  • netbox_virtualization
    • Constants
      • NB_VIRTUAL_MACHINES
      • NB_CLUSTERS
      • NB_CLUSTER_GROUP
      • NB_CLUSTER_TYPE
      • NB_VM_INTERFACES
    • Classes
      • NetboxVirtualizationModule
• Changelog
  • NetBox.NetBox Release Notes
    • v3.20.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.19.1
      • Minor Changes
    • v3.19.0
      • Minor Changes
      • Bugfixes
    • v3.18.0
      • Minor Changes
      • New Modules
    • v3.17.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.16.0
      • Minor Changes
      • Bugfixes
    • v3.15.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.14.0
      • Minor Changes
      • Bugfixes
    • v3.13.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.12.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.11.0
      • Minor Changes
      • Bugfixes
    • v3.10.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.9.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.8.1
      • Minor Changes
      • Bugfixes
    • v3.8.0
      • Minor Changes
    • v3.7.1
      • Bugfixes
    • v3.7.0
      • Minor Changes
      • Bugfixes
    • v3.6.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.5.1
      • Bugfixes
    • v3.5.0
      • Release Summary
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.4.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v3.3.0
      • Minor Changes
      • New Modules
    • v3.2.0
      • Minor Changes
      • Bugfixes
    • v3.1.2
      • Release Summary
      • Minor Changes
    • v3.1.1
      • Minor Changes
      • Bugfixes
    • v3.1.0
      • Release Summary
      • Major Changes
      • Minor Changes
      • Bugfixes
    • v3.0.0
      • Minor Changes
      • Bugfixes
    • v2.1.0
      • Minor Changes
      • Bugfixes
    • v2.0.0
      • Minor Changes
      • Bugfixes
      • New Modules
    • v1.2.1
      • Bugfixes
    • v1.2.0
      • Major Changes
      • Minor Changes
      • Bugfixes
      • New Modules
    • v1.1.0
      • Minor Changes
      • Bugfixes
    • v1.0.2
      • Bugfixes
    • v1.0.1
      • Minor Changes
      • Bugfixes
    • v1.0.0
      • Bugfixes
    • v0.3.1
      • Bugfixes
    • v0.3.0
      • Minor Changes
      • Breaking Changes / Porting Guide
      • Bugfixes
      • New Modules
    • v0.2.3
      • Minor Changes
      • Bugfixes
      • New Modules
    • v0.2.2
      • Minor Changes
      • Bugfixes
    • v0.2.1
      • Minor Changes
      • Bugfixes
    • v0.2.0
      • Minor Changes
      • Breaking Changes / Porting Guide
      • Bugfixes
    • v0.1.10
      • Bugfixes
    • v0.1.9
      • Breaking Changes / Porting Guide
      • Bugfixes
    • v0.1.8
      • Bugfixes
    • v0.1.7
      • Minor Changes
      • Bugfixes
    • v0.1.6
      • Minor Changes
      • Bugfixes
    • v0.1.5
      • Bugfixes
      • New Modules
    • v0.1.3
      • Bugfixes
    • v0.1.2
      • Bugfixes
    • v0.1.1
      • Bugfixes
    • v0.1.0
      • Minor Changes
      • Breaking Changes / Porting Guide
      • New Modules