prefix_location¶

Collection Note

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

ansible-galaxy collection install networktocode.nautobot

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

Synopsis¶

Create, update or delete Location assignments to Prefixes within Nautobot

Requirements¶

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

pynautobot

Parameters¶

Parameter	Data Type	Comments
api_version	str	API Version Nautobot REST API Version Added: 4.1.0
location required	raw	The location the Prefix will be associated to
location_prefix required	raw	The Prefix to associate with the location
query_params	list	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	Use C(present) or C(absent) for adding or removing.
token required	str	The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url required	str	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	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

This module requires Nautobot v2.2+
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: Assign Location to Prefix
      networktocode.nautobot.prefix_location:
        url: http://nautobot.local
        token: thisIsMyToken
        prefix:
          prefix: "192.0.2.0/24"
          namespace: Global
        location:
          name: My Child Location
          parent: My Parent Location
        state: present

    - name: Unassign Location from Prefix
      networktocode.nautobot.prefix_location:
        url: http://nautobot.local
        token: thisIsMyToken
        prefix: "192.0.2.0/24"
        location: My Location
        state: absent

Return Values¶

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

Authors¶

Joe Wesch (@joewesch)