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

From Get docs
Ansible/docs/2.7/modules/dimensiondata network module


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

Parameters

Parameter Choices/Defaults Comments

description

-

Additional description of the network domain.

location

- / required

The target datacenter.

mcp_password

-

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

-

The username used to authenticate to the CloudControl API.

If not specified, will fall back to MCP_USER from environment variable or ~/.dimensiondata.

name

- / required

The name of the network domain to create.

region

-

Default:

"na"

The target region.

service_plan

-

  • ESSENTIALS

  • ADVANCED

The service plan, either "ESSENTIALS" or "ADVANCED".

MCP 2.0 Only.

state

-

  • present

  • absent

Should the resource be present or absent.

validate_certs

-

Default:

"yes"

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

-

Default:

"no"

Should we wait for the task to complete before moving onto the next.

wait_poll_interval

-

Default:

2

The amount of time (in seconds) to wait between checks for task completion.

Only applicable if wait=true.

wait_time

-

Default:

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, 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

Network description.


Sample:

My network description

id

string

Network ID.


Sample:

8c787000-a000-4050-a215-280893411a7d

location

string

Datacenter location.


Sample:

NA3

multicast

boolean

Multicast enabled? (MCP 1.0 only)


name

string

Network name.


Sample:

My network

private_net

string

Private network subnet. (MCP 1.0 only)


Sample:

10.2.3.0

status

string

Network status. (MCP 2.0 only)


Sample:

NORMAL




Status

Authors

  • Aimon Bustardo (@aimonb)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


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