networktocode.nautobot.ipam_role module – Creates or removes ipam roles 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.ipam_role.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes ipam roles from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

name

string / required

added in 3.0.0 of networktocode.nautobot

Name of the ipam role to be created

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.

slug

string

added in 3.0.0 of networktocode.nautobot

The slugified version of the name or custom slug.

This is auto-generated following Nautobot rules if not provided

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

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”

weight

integer

added in 3.0.0 of networktocode.nautobot

The weight of the ipam role to be created

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create ipam role within Nautobot with only required information
      networktocode.nautobot.ipam_role:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test IPAM Role
        state: present

    - name: Delete ipam role within nautobot
      networktocode.nautobot.ipam_role:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test IPAM Role
        state: absent

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

role

dictionary

Serialized object as created or already existent within Nautobot

Returned: on creation

Authors

  • Mikhail Yohman (@FragmentedPacket)