rir

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 1.0.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis

• Creates, updates or removes RIRs from Nautobot

Requirements

The following Python packages are needed on the host that executes this module:

• pynautobot

Parameters

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
id str		The UUID of the object to operate on Version Added: 5.13.0
is_private bool		IP space managed by this RIR is considered private Version Added: 3.0.0
name str		The name of the RIR Required if I(state=present) and the RIR does not exist yet Version Added: 3.0.0
query_params list / elements=str		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. Version Added: 3.0.0
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs raw	Default: True	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes

Note

• Tags should be defined as a YAML list
• This should be ran with connection C(local) and hosts C(localhost)

Examples

- name: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: false

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

    - name: Update Test RIR One
      networktocode.nautobot.rir:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test RIR One
        is_private: true
        state: present

    - name: Delete RIR within nautobot
      networktocode.nautobot.rir:
        url: http://nautobot.local
        token: thisIsMyToken
        name: Test RIR One
        state: absent

    - name: Delete RIR by id
      networktocode.nautobot.rir:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values

Key	Data Type	Description	Returned
msg	str	Message indicating failure or info about what has been achieved	always
rir	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors

• Mikhail Yohman (@fragmentedpacket)