Skip to content

cloud_network_prefix_assignment

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

  • Creates or removes cloud network to prefix association from Nautobot

Requirements

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

Parameters

Parameter Data Type Environment Variable Comments
api_version str API Version Nautobot REST API
Version Added: 4.1.0
cloud_network
required		 raw Cloud network to associate with a prefix.
cloud_prefix
required		 raw Prefix to associate with a cloud network.
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 should be ran with connection C(local) and hosts C(localhost)

Examples

---
- name: Create a cloud network to prefix assignment
  networktocode.nautobot.cloud_network_prefix_assignment:
    url: http://nautobot.local
    token: thisIsMyToken
    cloud_network: Cisco Quantum Network
    cloud_prefix: 10.1.198.0/23
    state: present

- name: Delete a cloud network to prefix assignment
  networktocode.nautobot.cloud_network_prefix_assignment:
    url: http://nautobot.local
    token: thisIsMyToken
    cloud_network: Cisco Quantum Network
    cloud_prefix: 10.1.198.0/23
    state: absent

Return Values

Key Data Type Description Returned
cloud_network_prefix_assignment dict Serialized object as created or already existent within Nautobot on creation
msg str Message indicating failure or info about what has been achieved always

Authors

  • Travis Smith (@tsm1th)