networktocode.nautobot.aggregate module – Creates or removes aggregates from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 3.4.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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.aggregate.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes aggregates from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

custom_fields

dictionary

added in 3.0.0 of networktocode.nautobot

must exist in Nautobot

date_added

string

added in 3.0.0 of networktocode.nautobot

Date added, format: YYYY-MM-DD

description

string

added in 3.0.0 of networktocode.nautobot

The description of the aggregate

prefix

raw / required

added in 3.0.0 of networktocode.nautobot

The aggregate prefix

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

rir

raw

added in 3.0.0 of networktocode.nautobot

The RIR the aggregate will be assigned to

state

string

The state of the aggregate

Choices:

  • present ← (default)

  • absent

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the aggregate may need to be associated with

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot aggregate module"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create aggregate within Nautobot with only required information
      networktocode.nautobot.aggregate:
        url: http://nautobot.local
        token: thisIsMyToken
        prefix: 192.168.0.0/16
        rir: Test RIR
        state: present

    - name: Create aggregate with several specified options
      networktocode.nautobot.aggregate:
        url: http://nautobot.local
        token: thisIsMyToken
        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 nautobot
      networktocode.nautobot.aggregate:
        url: http://nautobot.local
        token: thisIsMyToken
        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

aggregate

dictionary

Serialized object as created or already existent within Nautobot

Returned: on creation

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Mikhail Yohman (@FragmentedPacket)