netbox.netbox.netbox_location module – Create, update or delete locations within NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netbox.netbox.netbox_location.

New in netbox.netbox 3.3.0

Synopsis

• Creates, updates or removes locations from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

Parameter	Comments
cert any	Certificate path
data dictionary / required	Defines the location configuration
custom_fields dictionary added in netbox.netbox 3.6.0	Must exist in NetBox
description string	The description of the location
facility string added in netbox.netbox 3.20.0	Data center provider or facility, ex. Equinix NY7
name string / required	The name of the location
parent_location any	The parent location the location will be associated with
site any	Required if state=present and the location does not exist yet
slug string	The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided
status any added in netbox.netbox 3.20.0	Status of the location
tags list / elements=any added in netbox.netbox 3.6.0	The tags to add/update
tenant any added in netbox.netbox 3.8.0	The tenant that the location will be associated with
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state string	The state of the object. Choices: "present" ← (default) "absent"
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. Default: true

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox modules"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Create location within NetBox with only required information
      netbox.netbox.netbox_location:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test location
          site: Test Site
        state: present

    - name: Create location within NetBox with a parent location, status and facility
      netbox.netbox.netbox_location:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Child location
          site: Test Site
          parent_location: Test location
          status: planned
          facility: Test Facility
        state: present

    - name: Delete location within NetBox
      netbox.netbox.netbox_location:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test location
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
location dictionary	Serialized object as created or already existent within NetBox Returned: success (when state=present)
msg string	Message indicating failure or info about what has been achieved Returned: always

Authors

• Andrew Simmons (@andybro19)

Collection links

• Issue Tracker
• Repository (Sources)