You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

netbox.netbox.netbox_site_group module – Create, update, or delete site groups within NetBox

Note

This module is part of the netbox.netbox collection (version 3.9.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. 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_group.

New in netbox.netbox 3.4.0

Synopsis

• Creates, updates, or deletes site groups within NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert any	Certificate path
data dictionary / required	Defines the site group configuration
custom_fields dictionary added in netbox.netbox 3.6.0	Must exist in NetBox
description string	The description of the site group
name string / required	Name of the site group to be created
parent_site_group any	The parent site group the site group will be associated with
slug string	The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided
tags list / elements=any added in netbox.netbox 3.6.0	The tags to add/update
netbox_token string / required	The NetBox API token.
netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params 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.
state string	The state of the object. Choices: "present" ← (default) "absent"
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. 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 group module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create site group within NetBox with only required information
      netbox.netbox.netbox_site_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Site group
        state: present

    - name: Create site group within NetBox with a parent site group
      netbox.netbox.netbox_site_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Child site group
          parent_site_group: Site group
        state: present

    - name: Delete site group within NetBox
      netbox.netbox.netbox_site_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Site group
        state: absent

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_group dictionary	Serialized object as created or already existent within NetBox Returned: success (when state=present)

Authors

• Andrew Simmons (@andybro19)

Collection links

Issue Tracker Repository (Sources)