netbox.netbox.netbox_site module – Creates or removes sites from NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.0).

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 netbox.netbox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netbox.netbox.netbox_site.

New in netbox.netbox 0.1.0

Synopsis

• Creates or removes sites from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the site configuration
asn	The ASN associated with the site
comments	Comments for the site. This can be markdown syntax
contact_email	Contact email for site
contact_name	Name of contact for site
contact_phone	Contact phone number for site
custom_fields	must exist in NetBox
description	The description of the prefix
facility	Data center provider or facility, ex. Equinix NY7
latitude	Latitude in decimal format
longitude	Longitude in decimal format
name	Name of the site to be created
physical_address	Physical address of site
region	The region that the site should be associated with
shipping_address	Shipping address of site
site_group :ansible-option-versionadded:`added in netbox.netbox 3.3.0`	The site group the site will be associated with (NetBox 2.11+)
slug	URL-friendly unique shorthand
status	Status of the site
tags	Any tags that the prefix may need to be associated with
tenant	The tenant the site will be assigned to
time_zone	Timezone associated with the site, ex. America/Denver
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`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 NetBox site module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create site within NetBox with only required information
      netbox.netbox.netbox_site:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test - Colorado
        state: present

    - name: Delete site within netbox
      netbox.netbox.netbox_site:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test - Colorado
        state: absent

    - name: Create site with all parameters
      netbox.netbox.netbox_site:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Test - California
          status: Planned
          region: Test Region
          site_group: Test Site Group
          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	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
site	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links