netbox.netbox.netbox_aggregate – Creates or removes aggregates from NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.1).
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_aggregate
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates or removes aggregates from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
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_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_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_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: