cloud_network¶

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 from 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
cloud_account	raw	Required if I(state=present) and the cloud network does not exist yet
cloud_resource_type	raw	Required if I(state=present) and the cloud network does not exist yet
custom_fields	dict	Must exist in Nautobot and in key/value format Version Added: 3.0.0
description	str	The description of the cloud network
extra_config	dict	Arbitrary JSON data to define the extra config.
name required	str	The name of the cloud network
parent_cloud_network	raw	The parent cloud network this network should be child to
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.
tags	list	Any tags that this item may need to be associated with Version Added: 3.0.0
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

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

Examples¶

---
- name: Create a cloud network
  networktocode.nautobot.cloud_network:
    url: http://nautobot.local
    token: thisIsMyToken
    name: Cisco Quantum Network
    cloud_resource_type: Cisco Quantum Type
    cloud_account: Cisco Quantum Account
    description: A quantum network for Cisco
    state: present

- name: Delete a cloud network
  networktocode.nautobot.cloud_network:
    url: http://nautobot.local
    token: thisIsMyToken
    name: Cisco Quantum Network
    state: absent

Return Values¶

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

Authors¶

Travis Smith (@tsm1th)