netbox.netbox.netbox_aggregate – Creates or removes aggregates from Netbox¶
Note
This plugin is part of the netbox.netbox collection.
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
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:
Authors¶
Mikhail Yohman (@FragmentedPacket)