Parameter |
Choices/Defaults |
Comments |
allow_expand
boolean
|
|
Permit expansion of the target VLAN's network if the module parameters specify a larger network than the VLAN currently possesses.
If False , the module will fail under these conditions.
This is intended to prevent accidental expansion of a VLAN's network (since this operation is not reversible).
|
description
-
|
|
A description of the VLAN.
|
location
string
/ required
|
|
The target datacenter.
|
mcp_password
string
|
|
The password used to authenticate to the CloudControl API.
If not specified, will fall back to MCP_PASSWORD from environment variable or ~/.dimensiondata .
Required if mcp_user is specified.
|
mcp_user
string
|
|
The username used to authenticate to the CloudControl API.
If not specified, will fall back to MCP_USER from environment variable or ~/.dimensiondata .
|
name
-
|
|
The name of the target VLAN.
Required if state is present .
|
network_domain
-
/ required
|
|
The Id or name of the target network domain.
|
private_ipv4_base_address
-
|
|
The base address for the VLAN's IPv4 network (e.g. 192.168.1.0).
|
private_ipv4_prefix_size
-
|
|
The size of the IPv4 address space, e.g 24.
Required, if private_ipv4_base_address is specified.
|
region
string
|
Choices:
- Regions are defined in Apache libcloud project [libcloud/common/dimensiondata.py]
- They are also listed in U(https://libcloud.readthedocs.io/en/latest/compute/drivers/dimensiondata.html)
- Note that the default value "na" stands for "North America".
- The module prepends 'dd-' to the region choice.
Default:
"na"
|
The target region.
|
state
-
|
Choices:
present ←
- absent
- readonly
|
The desired state for the target VLAN.
readonly ensures that the state is only ever read, not modified (the module will fail if the resource does not exist).
|
validate_certs
boolean
|
|
If false , SSL certificates will not be validated.
This should only be used on private instances of the CloudControl API that use self-signed certificates.
|
wait
boolean
|
|
Should we wait for the task to complete before moving onto the next.
|
wait_poll_interval
integer
|
Default:
2
|
The amount of time (in seconds) to wait between checks for task completion.
Only applicable if wait=true.
|
wait_time
integer
|
Default:
600
|
The maximum amount of time (in seconds) to wait for the task to complete.
Only applicable if wait=true.
|