netbox_site_module.rst

orphan:

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

Note

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

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_site_module_requirements>` for details.

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

.. rst-class:: ansible-version-added

New in netbox.netbox 0.1.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates or removes sites from NetBox

Requirements

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

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the site configuration
.. rst-class:: ansible-option-title asn .. rst-class:: ansible-option-type-line integer	The ASN associated with the site
.. rst-class:: ansible-option-title comments .. rst-class:: ansible-option-type-line string	Comments for the site. This can be markdown syntax
.. rst-class:: ansible-option-title contact_email .. rst-class:: ansible-option-type-line string	Contact email for site
.. rst-class:: ansible-option-title contact_name .. rst-class:: ansible-option-type-line string	Name of contact for site
.. rst-class:: ansible-option-title contact_phone .. rst-class:: ansible-option-type-line string	Contact phone number for site
.. rst-class:: ansible-option-title custom_fields .. rst-class:: ansible-option-type-line dictionary	must exist in NetBox
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	The description of the prefix
.. rst-class:: ansible-option-title facility .. rst-class:: ansible-option-type-line string	Data center provider or facility, ex. Equinix NY7
.. rst-class:: ansible-option-title latitude .. rst-class:: ansible-option-type-line float	Latitude in decimal format
.. rst-class:: ansible-option-title longitude .. rst-class:: ansible-option-type-line float	Longitude in decimal format
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	Name of the site to be created
.. rst-class:: ansible-option-title physical_address .. rst-class:: ansible-option-type-line string	Physical address of site
.. rst-class:: ansible-option-title region .. rst-class:: ansible-option-type-line any	The region that the site should be associated with
.. rst-class:: ansible-option-title shipping_address .. rst-class:: ansible-option-type-line string	Shipping address of site
.. rst-class:: ansible-option-title site_group .. rst-class:: ansible-option-type-line any added in netbox.netbox 3.3.0	The site group the site will be associated with (NetBox 2.11+)
.. rst-class:: ansible-option-title slug .. rst-class:: ansible-option-type-line string	URL-friendly unique shorthand
.. rst-class:: ansible-option-title status .. rst-class:: ansible-option-type-line any	Status of the site
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=any	Any tags that the prefix may need to be associated with
.. rst-class:: ansible-option-title tenant .. rst-class:: ansible-option-type-line any	The tenant the site will be assigned to
.. rst-class:: ansible-option-title time_zone .. rst-class:: ansible-option-type-line string	Timezone associated with the site, ex. America/Denver
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line list / elements=string	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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line 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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always
.. rst-class:: ansible-option-title site .. rst-class:: ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: on creation

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links

Issue Tracker Repository (Sources)