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

Note

This module is part of the networktocode.nautobot collection (version 4.5.0).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

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

New in networktocode.nautobot 1.0.0

Synopsis

• Creates or removes aggregates from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
custom_fields dictionary added in networktocode.nautobot 3.0.0	Must exist in Nautobot and in key/value format
date_added string added in networktocode.nautobot 3.0.0	Date added, format: YYYY-MM-DD
description string added in networktocode.nautobot 3.0.0	The description of the aggregate
prefix any / required added in networktocode.nautobot 3.0.0	The aggregate prefix
query_params list / elements=string added in networktocode.nautobot 3.0.0	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 any added in networktocode.nautobot 3.0.0	The RIR the aggregate will be assigned to
state string	Use present or absent for adding or removing. Choices: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` ← (default)
tags list / elements=any added in networktocode.nautobot 3.0.0	Any tags that this item may need to be associated with
token string / required	The token created within Nautobot to authorize API access
url string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)
validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Default: :ansible-option-default:`true`

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)

Collection links

Issue Tracker Repository (Sources)