networktocode.nautobot.prefix module – Creates or removes prefixes 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.prefix.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes prefixes 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 and in key/value format

description

string

added in 3.0.0 of networktocode.nautobot

The description of the prefix

family

integer

added in 3.0.0 of networktocode.nautobot

Specifies which address family the prefix prefix belongs to

first_available

boolean

added in 3.0.0 of networktocode.nautobot

If yes and state present, if an parent is given, it will get the first available prefix of the given prefix_length inside the given parent (and vrf, if given). Unused with state absent.

Choices:

  • no ← (default)

  • yes

is_pool

boolean

added in 3.0.0 of networktocode.nautobot

All IP Addresses within this prefix are considered usable

Choices:

  • no

  • yes

parent

raw

added in 3.0.0 of networktocode.nautobot

Required if state is present and first_available is yes. Will get a new available prefix in this parent prefix.

prefix

raw

added in 3.0.0 of networktocode.nautobot

Required if state is present and first_available is False. Will allocate or free this prefix.

prefix_length

integer

added in 3.0.0 of networktocode.nautobot

Required ONLY if state is present and first_available is yes.

Will get a new available prefix of the given prefix_length in this parent prefix.

prefix_role

raw

added in 3.0.0 of networktocode.nautobot

The role of the 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.

site

raw

added in 3.0.0 of networktocode.nautobot

Site that prefix is associated with

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

status

raw

added in 3.0.0 of networktocode.nautobot

The status of the prefix

Required if state=present and does not exist yet

tags

list / elements=raw

added in 3.0.0 of networktocode.nautobot

Any tags that the prefix may need to be associated with

tenant

raw

added in 3.0.0 of networktocode.nautobot

The tenant that the prefix will be assigned to

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”

vlan

raw

added in 3.0.0 of networktocode.nautobot

The VLAN the prefix will be assigned to

vrf

raw

added in 3.0.0 of networktocode.nautobot

VRF that prefix is associated with

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

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

  tasks:
    - name: Create prefix within Nautobot with only required information
      networktocode.nautobot.prefix:
        url: http://nautobot.local
        token: thisIsMyToken
        prefix: 10.156.0.0/19
        status: active
        state: present

    - name: Delete prefix within nautobot
      networktocode.nautobot.prefix:
        url: http://nautobot.local
        token: thisIsMyToken
        prefix: 10.156.0.0/19
        state: absent

    - name: Create prefix with several specified options
      networktocode.nautobot.prefix:
        url: http://nautobot.local
        token: thisIsMyToken
        family: 4
        prefix: 10.156.32.0/19
        site: Test Site
        vrf: Test VRF
        tenant: Test Tenant
        vlan:
          name: Test VLAN
          site: Test Site
          tenant: Test Tenant
          vlan_group: Test Vlan Group
        status: Reserved
        prefix_role: Network of care
        description: Test description
        is_pool: true
        tags:
          - Schnozzberry
        state: present

    - name: Get a new /24 inside 10.156.0.0/19 within Nautobot - Parent doesn't exist
      networktocode.nautobot.prefix:
        url: http://nautobot.local
        token: thisIsMyToken
        parent: 10.156.0.0/19
        prefix_length: 24
        state: present
        first_available: yes

    - name: Create prefix within Nautobot with only required information
      networktocode.nautobot.prefix:
        url: http://nautobot.local
        token: thisIsMyToken
        prefix: 10.156.0.0/19
        state: present

    - name: Get a new /24 inside 10.156.0.0/19 within Nautobot
      networktocode.nautobot.prefix:
        url: http://nautobot.local
        token: thisIsMyToken
        parent: 10.156.0.0/19
        prefix_length: 24
        state: present
        first_available: yes

    - name: Get a new /24 inside 10.157.0.0/19 within Nautobot with additional values
      networktocode.nautobot.prefix:
        url: http://nautobot.local
        token: thisIsMyToken
        parent: 10.157.0.0/19
        prefix_length: 24
        vrf: Test VRF
        site: Test Site
        state: present
        first_available: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Message indicating failure or info about what has been achieved

Returned: always

prefix

dictionary

Serialized object as created or already existent within Nautobot

Returned: on creation

Authors

  • Mikhail Yohman (@FragmentedPacket)

  • Anthony Ruhier (@Anthony25)