Docs4dev
Docs
ansible / 2.4 / dimensiondata_network_module.html

dimensiondata_network - Create, update, and delete MCP 1.0 & 2.0 networks

New in version 2.3.

Synopsis

  • Create, update, and delete MCP 1.0 & 2.0 networks

Options

parameter required default choices comments
description
 no
Additional description of the network domain.
location
 yes
The target datacenter.
mcp_password
 no
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
 no
The username used to authenticate to the CloudControl API.
If not specified, will fall back to MCP_USER from environment variable or ~/.dimensiondata.
name
 yes
The name of the network domain to create.
region
 no na
  • 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.
The target region.
service_plan
 no ESSENTIALS
  • ESSENTIALS
  • ADVANCED
The service plan, either "ESSENTIALS" or "ADVANCED".
MCP 2.0 Only.
state
 no present
  • present
  • absent
Should the resource be present or absent.
validate_certs
 no True
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
 no
Should we wait for the task to complete before moving onto the next.
wait_poll_interval
 no 2
The amount of time (in seconds) to wait between checks for task completion.
Only applicable if wait=true.
wait_time
 no 600
The maximum amount of time (in seconds) to wait for the task to complete.
Only applicable if wait=true.

Examples

# Create an MCP 1.0 network
- dimensiondata_network:
    region: na
    location: NA5
    name: mynet
# Create an MCP 2.0 network
- dimensiondata_network:
    region: na
    mcp_user: my_user
    mcp_password: my_password
    location: NA9
    name: mynet
    service_plan: ADVANCED
# Delete a network
- dimensiondata_network:
    region: na
    location: NA1
    name: mynet
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
network
Dictionary describing the network.
On success when I(state=present). complex
contains:
name description returned type sample
status
Network status. (MCP 2.0 only)
string NORMAL
multicast
Multicast enabled? (MCP 1.0 only)
boolean False
description
Network description.
string My network description
private_net
Private network subnet. (MCP 1.0 only)
string 10.2.3.0
name
Network name.
string My network
id
Network ID.
string 8c787000-a000-4050-a215-280893411a7d
location
Datacenter location.
string NA3

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/dimensiondata_network_module.html