networktocode.nautobot.location module – Creates or removes locations 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.
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 Nautobot REST API |
|
The ASN associated with the location |
|
Comments for the location. This can be markdown syntax |
|
Contact email for location |
|
Name of contact for location |
|
Contact phone number for location |
|
Must exist in Nautobot and in key/value format |
|
Location description |
|
Data center provider or facility, ex. Equinix NY7 |
|
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. |
|
Latitude in decimal format |
|
The type of location Required if state=present and does not exist yet |
|
Longitude in decimal format |
|
Name of the location to be created |
|
The parent location this location should be tied to |
|
Physical address of location |
|
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. |
|
Shipping address of location |
|
Use Choices: |
|
Status of the location Required if state=present and does not exist yet |
|
Any tags that this item may need to be associated with |
|
The tenant the location will be assigned to |
|
Timezone associated with the location, ex. America/Denver |
|
The token created within Nautobot to authorize API access |
|
The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) |
|
If Default: :ansible-option-default:`true` |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
localand hostslocalhost
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
tenant: Test Tenant
facility: EquinoxCA7
asn: "65001"
time_zone: America/Los Angeles
physical_address: Hollywood, CA, 90210
shipping_address: Hollywood, CA, 90210
latitude: "10.100000"
longitude: "12.200000"
contact_name: Jenny
contact_phone: 867-5309
contact_email: jenny@example.com
comments: "**This** is a `markdown` comment"
parent: My Location
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Serialized object as created or already existent within Nautobot Returned: on creation |
|
Message indicating failure or info about what has been achieved Returned: always |