netbox_location_module.rst

orphan

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

Note

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

It is not included in ansible-core. To check whether it is installed, run 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 <ansible_collections.netbox.netbox.netbox_location_module_requirements> for details.

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

ansible-version-added

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

X{1}{3}X{2}{3}

Parameter	Comments
ansible-option-title cert any	Certificate path
ansible-option-title data dictionary / required	Defines the location configuration
ansible-option-title custom_fields dictionary added in netbox.netbox 3.6.0	Must exist in NetBox
ansible-option-title description string	The description of the location
ansible-option-title name string / required	The name of the location
ansible-option-title parent_location any	The parent location the location will be associated with
ansible-option-title site any	Required if state=present and the location does not exist yet
ansible-option-title slug string	The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided
ansible-option-title tags list / elements=any added in netbox.netbox 3.6.0	The tags to add/update
ansible-option-title tenant any added in netbox.netbox 3.8.0	The tenant that the location will be associated with
ansible-option-title netbox_token string / required	The NetBox API token.
ansible-option-title netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
ansible-option-title 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.
ansible-option-title state string	The state of the object. ansible-option-line Choices: "present" ← (default) "absent"
ansible-option-title 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. ansible-option-line 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
      netbox.netbox.netbox_location:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Child location
          site: Test Site
          parent_location: Test location
        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 <common_return_values>, the following are the fields unique to this module:

X{1}{3}X{2}{3}

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

Authors

• Andrew Simmons (@andybro19)

Collection links

• title: "Issue Tracker" url: "https://github.com/netbox-community/ansible_modules/issues" external: true
• title: "Repository (Sources)" url: "https://github.com/netbox-community/ansible_modules" external: true