networktocode.nautobot.site module – Creates or removes sites from Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 3.4.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 networktocode.nautobot
.
To use it in a playbook, specify: networktocode.nautobot.site
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates or removes sites from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The ASN associated with the site |
|
Comments for the site. This can be markdown syntax |
|
Contact email for site |
|
Name of contact for site |
|
Contact phone number for site |
|
must exist in Nautobot |
|
The description of the prefix |
|
Data center provider or facility, ex. Equinix NY7 |
|
Latitude in decimal format |
|
Longitude in decimal format |
|
Name of the site to be created |
|
Physical address of site |
|
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. |
|
The region that the site should be associated with |
|
Shipping address of site |
|
URL-friendly unique shorthand |
|
Use Choices:
|
|
Status of the site Required if state=present and does not exist yet |
|
Any tags that the prefix may need to be associated with |
|
The tenant the site will be assigned to |
|
Timezone associated with the site, ex. America/Denver |
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
Default: “yes” |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test Nautobot site module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create site within Nautobot with only required information
networktocode.nautobot.site:
url: http://nautobot.local
token: thisIsMyToken
name: Test - Colorado
status: active
state: present
- name: Delete site within nautobot
networktocode.nautobot.site:
url: http://nautobot.local
token: thisIsMyToken
name: Test - Colorado
state: absent
- name: Create site with all parameters
networktocode.nautobot.site:
url: http://nautobot.local
token: thisIsMyToken
name: Test - California
status: Planned
region: Test Region
tenant: Test Tenant
facility: EquinoxCA7
asn: 65001
time_zone: America/Los Angeles
description: This is a test description
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@changednumber.com
slug: test-california
comments: ### Placeholder
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Message indicating failure or info about what has been achieved Returned: always |
|
Serialized object as created or already existent within Nautobot Returned: on creation |