networktocode.nautobot.site – Creates or removes sites from Nautobot

Note

This plugin is part of the networktocode.nautobot collection (version 1.0.4).

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		Choices/Defaults	Comments
data dictionary / required			Defines the site configuration
	asn integer		The ASN associated with the site
	comments string		Comments for the site. This can be markdown syntax
	contact_email string		Contact email for site
	contact_name string		Name of contact for site
	contact_phone string		Contact phone number for site
	custom_fields dictionary		must exist in Nautobot
	description string		The description of the prefix
	facility string		Data center provider or facility, ex. Equinix NY7
	latitude string		Latitude in decimal format
	longitude string		Longitude in decimal format
	name string / required		Name of the site to be created
	physical_address string		Physical address of site
	region raw		The region that the site should be associated with
	shipping_address string		Shipping address of site
	slug string		URL-friendly unique shorthand
	status raw		Status of the site
	tags list / elements=string		Any tags that the prefix may need to be associated with
	tenant raw		The tenant the site will be assigned to
	time_zone string		Timezone associated with the site, ex. America/Denver
query_params list / elements=string			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		Choices: absent present ←	Use present or absent for adding or removing.
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		Default: "yes"	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

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
        data:
          name: Test - Colorado
          status: active
        state: present

    - name: Delete site within nautobot
      networktocode.nautobot.site:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
          name: Test - Colorado
        state: absent

    - name: Create site with all parameters
      networktocode.nautobot.site:
        url: http://nautobot.local
        token: thisIsMyToken
        data:
          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	Returned	Description
msg string	always	Message indicating failure or info about what has been achieved
site dictionary	on creation	Serialized object as created or already existent within Nautobot

Authors

• Network to Code (@networktocode)