networktocode.nautobot.location_type module – Creates or removes location types from Nautobot

Note

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

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_type.

New in networktocode.nautobot 4.3.0

Synopsis

• Creates or removes location types 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
content_types list / elements=string	Location Type content type(s). These match app.endpoint and the endpoint is singular. e.g. dcim.device, ipam.ipaddress (more can be found in the examples)
custom_fields dictionary added in networktocode.nautobot 3.0.0	Must exist in Nautobot and in key/value format
description string	Location Type description
name string / required	Name of the location type to be created
nestable boolean	Allow Locations of this type to be parents/children of other Locations of this same type Requires nautobot >= 1.5 Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
parent_location_type aliases: parent any	The parent location type this location type 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)
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 type module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create location type
      networktocode.nautobot.location_type:
        url: http://nautobot.local
        token: thisIsMyToken
        name: My Location Type
        state: present

    - name: Delete location type
      networktocode.nautobot.location_type:
        url: http://nautobot.local
        token: thisIsMyToken
        name: My Location Type
        state: absent

    - name: Create location type with all parameters
      networktocode.nautobot.location_type:
        url: http://nautobot.local
        token: thisIsMyToken
        name: My Nested Location Type
        description: My Nested Location Type Description
        parent:
          name: My Location Type
        nestable: false
        content_types:
          - "dcim.device"
        state: present

Return Values

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

Key	Description
location_type 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)