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:
New in version 0.1.0: of netbox.netbox
The below requirements are needed on the host that executes this module.
| cert |
| data |
dictionary / required
Defines the aggregate configuration
| custom_fields |
must exist in Netbox
| date_added |
Date added, format: YYYY-MM-DD
| description |
The description of the aggregate
| prefix |
raw / required
The aggregate prefix
| rir |
The RIR the aggregate will be assigned to
| tags |
list / elements=raw
Any tags that the aggregate may need to be associated with
| 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 |
| || |
The state of the aggregate
| validate_certs |
| Default: |
- 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
Common return values are documented here, the following are the fields unique to this module:
| aggregate |
|on creation|| |
Serialized object as created or already existent within Netbox
| msg |
Message indicating failure or info about what has been achieved
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.