networktocode.nautobot.location module – Creates or removes locations from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.0.1).

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

To use it in a playbook, specify: networktocode.nautobot.location.

New in networktocode.nautobot 4.3.0

Synopsis

• Creates or removes locations from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
custom_fields dictionary added in networktocode.nautobot 3.0.0	Must exist in Nautobot and in key/value format
description string	Location description
id string	Primary Key of the location, used to delete the location. Because of hierarchical nature of locations and name being not unique across locations, it’s a user responsibility to query location and pass its id(PK) to the task to delete the location.
location_type any	The type of location Required if state=present and does not exist yet
name string	Name of the location to be created
parent_location any	The parent location this location should be tied to
query_params list / elements=string added in networktocode.nautobot 3.0.0	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment.
state string	Use present or absent for adding or removing. Choices: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` ← (default)
status any	Status of the location Required if state=present and does not exist yet
token string / required	The token created within Nautobot to authorize API access
url string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Default: :ansible-option-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 Nautobot location module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create location
      networktocode.nautobot.location:
        url: http://nautobot.local
        token: thisIsMyToken
        name: My Location
        status: Active
        location_type:
          name: My Location Type
        state: present

    - name: Delete location
      networktocode.nautobot.location:
        url: http://nautobot.local
        token: thisIsMyToken
        id: "{{ location_to_delete['key'] }}"
        state: absent
      vars:
        location_to_delete: "{{ lookup('networktocode.nautobot.lookup', 'locations', api_endpoint=nautobot_url, token=nautobot_token, api_filter='name=\"My Location\" parent_location=\"Location Parent\" location_type=\"Main Type\"') }}"

    - name: Create location with all parameters
      networktocode.nautobot.location:
        url: http://nautobot.local
        token: thisIsMyToken
        name: My Nested Location
        status: Active
        location_type:
          name: My Location Type
        description: My Nested Location Description
        parent_location:
          name: My Location
        state: present

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 Nautobot Returned: on creation
msg string	Message indicating failure or info about what has been achieved Returned: always

Authors

• Joe Wesch (@joewesch)

Collection links

Issue Tracker Repository (Sources)