Note
This plugin is part of the netbox.netbox collection (version 3.3.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 netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_site
.
New in version 0.1.0: of netbox.netbox
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
cert raw | Certificate path | ||
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 Netbox | ||
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 | ||
site_group raw added in 3.3.0 of netbox.netbox | The site group the site will be associated with (NetBox 2.11+) | ||
slug string | URL-friendly unique shorthand | ||
status raw | Status of the site | ||
tags list / elements=raw | 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 | ||
netbox_token string / required | The token created within Netbox to authorize API access | ||
netbox_url string / required | URL of the Netbox instance resolvable by Ansible control host | ||
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/netbox_utils.py and provides control to users on what may make an object unique in their environment. | ||
state string |
| Use present or absent for adding or removing. | |
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. |
Note
local
and hosts localhost
- name: "Test Netbox site module" connection: local hosts: localhost gather_facts: False tasks: - name: Create site within Netbox with only required information netbox_site: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test - Colorado state: present - name: Delete site within netbox netbox_site: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test - Colorado state: absent - name: Create site with all parameters 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: [email protected] slug: test-california comments: ### Placeholder state: present
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 Netbox |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_site_module.html