netbox.netbox.netbox_aggregate module – Creates or removes aggregates from NetBox
Note
This module is part of the netbox.netbox collection (version 3.20.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_aggregate
.
New in netbox.netbox 0.1.0
Synopsis
Creates or removes aggregates from NetBox
Requirements
The below requirements are needed on the host that executes this module.
pynetbox
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the aggregate configuration |
|
Comments that may include additional information in regards to the aggregate |
|
must exist in NetBox |
|
Date added, format: YYYY-MM-DD |
|
The description of the aggregate |
|
The aggregate prefix |
|
The RIR the aggregate will be assigned to |
|
Any tags that the aggregate may need to be associated with |
|
Tenant the aggregate will be assigned to. |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples
- name: "Test NetBox aggregate module"
connection: local
hosts: localhost
gather_facts: false
tasks:
- name: Create aggregate within NetBox with only required information
netbox.netbox.netbox_aggregate:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
prefix: 192.168.0.0/16
rir: Test RIR
state: present
- name: Create aggregate with several specified options
netbox.netbox.netbox_aggregate:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
prefix: 192.168.0.0/16
rir: Test RIR
date_added: 1989-01-18
description: Test description
tags:
- Schnozzberry
state: present
- name: Delete aggregate within netbox
netbox.netbox.netbox_aggregate:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
prefix: 192.168.0.0/16
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created or already existent within NetBox Returned: on creation |
|
Message indicating failure or info about what has been achieved Returned: always |