community.general.dimensiondata_network module – Create, update, and delete MCP 1.0 & 2.0 networks
Note
This module is part of the community.general collection (version 8.6.4).
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 community.general
.
To use it in a playbook, specify: community.general.dimensiondata_network
.
Synopsis
Create, update, and delete MCP 1.0 & 2.0 networks
Aliases: cloud.dimensiondata.dimensiondata_network
Parameters
Parameter |
Comments |
---|---|
Additional description of the network domain. |
|
The target datacenter. |
|
The password used to authenticate to the CloudControl API. If not specified, will fall back to Required if |
|
The username used to authenticate to the CloudControl API. If not specified, will fall back to |
|
The name of the network domain to create. |
|
The target region. Regions are defined in Apache libcloud project [libcloud/common/dimensiondata.py]. They are also listed in https://libcloud.readthedocs.io/en/latest/compute/drivers/dimensiondata.html. Note that the default value The module prepends Default: |
|
The service plan, either “ESSENTIALS” or “ADVANCED”. MCP 2.0 Only. Choices:
|
|
Should the resource be present or absent. Choices:
|
|
If This should only be used on private instances of the CloudControl API that use self-signed certificates. Choices:
|
|
Should we wait for the task to complete before moving onto the next. Choices:
|
|
The amount of time (in seconds) to wait between checks for task completion. Only applicable if Default: |
|
The maximum amount of time (in seconds) to wait for the task to complete. Only applicable if Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create an MCP 1.0 network
community.general.dimensiondata_network:
region: na
location: NA5
name: mynet
- name: Create an MCP 2.0 network
community.general.dimensiondata_network:
region: na
mcp_user: my_user
mcp_password: my_password
location: NA9
name: mynet
service_plan: ADVANCED
- name: Delete a network
community.general.dimensiondata_network:
region: na
location: NA1
name: mynet
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the network. Returned: On success when |
|
Network description. Returned: success Sample: |
|
Network ID. Returned: success Sample: |
|
Datacenter location. Returned: success Sample: |
|
Multicast enabled? (MCP 1.0 only) Returned: success Sample: |
|
Network name. Returned: success Sample: |
|
Private network subnet. (MCP 1.0 only) Returned: success Sample: |
|
Network status. (MCP 2.0 only) Returned: success Sample: |