Note
This plugin is part of the community.general collection.
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.dimensiondata_network
.
Parameter | Choices/Defaults | Comments |
---|---|---|
description string | Additional description of the network domain. | |
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 string / required | The name of the network domain to create. | |
region string |
"na" | The target region. |
service_plan string |
| The service plan, either "ESSENTIALS" or "ADVANCED". MCP 2.0 Only. |
state string |
| Should the resource be present or absent. |
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. |
- 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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
network complex | On success when state=present. | Dictionary describing the network. | |
description string | success | Network description. Sample: My network description | |
id string | success | Network ID. Sample: 8c787000-a000-4050-a215-280893411a7d | |
location string | success | Datacenter location. Sample: NA3 | |
multicast boolean | success | Multicast enabled? (MCP 1.0 only) | |
name string | success | Network name. Sample: My network | |
private_net string | success | Private network subnet. (MCP 1.0 only) Sample: 10.2.3.0 | |
status string | success | Network status. (MCP 2.0 only) Sample: NORMAL |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/dimensiondata_network_module.html