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

asn

integer

added in 3.0.0 of networktocode.nautobot

The ASN associated with the site

comments

string

added in 3.0.0 of networktocode.nautobot

Comments for the site. This can be markdown syntax

contact_email

string

added in 3.0.0 of networktocode.nautobot

Contact email for site

contact_name

string

added in 3.0.0 of networktocode.nautobot

Name of contact for site

contact_phone

string

added in 3.0.0 of networktocode.nautobot

Contact phone number for site

custom_fields

dictionary

added in 3.0.0 of networktocode.nautobot

must exist in Nautobot

description

string

added in 3.0.0 of networktocode.nautobot

The description of the prefix

facility

string

added in 3.0.0 of networktocode.nautobot

Data center provider or facility, ex. Equinix NY7

latitude

string

added in 3.0.0 of networktocode.nautobot

Latitude in decimal format

longitude

string

added in 3.0.0 of networktocode.nautobot

Longitude in decimal format

name

string / required

Name of the site to be created

physical_address

string

added in 3.0.0 of networktocode.nautobot

Physical address of site

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

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.

region

raw

added in 3.0.0 of networktocode.nautobot

The region that the site should be associated with

shipping_address

string

added in 3.0.0 of networktocode.nautobot

Shipping address of site

slug

string

added in 3.0.0 of networktocode.nautobot

URL-friendly unique shorthand

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

status

raw

added in 3.0.0 of networktocode.nautobot

Status of the site

Required if state=present and does not exist yet

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the prefix may need to be associated with

tenant

raw

added in 3.0.0 of networktocode.nautobot

The tenant the site will be assigned to

time_zone

string

added in 3.0.0 of networktocode.nautobot

Timezone associated with the site, ex. America/Denver

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw
If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

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

msg

string

Message indicating failure or info about what has been achieved

Returned: always

site

dictionary

Serialized object as created or already existent within Nautobot

Returned: on creation

Authors

  • Mikhail Yohman (@FragmentedPacket)