Create Network | Cloud Assembly IaaS API

Create Network

Provision a new network based on the passed in constraints. The network should be destroyed after the machine is destroyed to free up resources.

Request

URI

POST

https://api.mgmt.cloud.vmware.com//iaas/api/networks

COPY

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Request Body

Network Specification instance

NetworkSpecification of type(s) application/json

Required

{
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "outboundAccess": true,
    "name": "string",
    "description": "string",
    "projectId": "e058",
    "constraints": [
        {
            "expression": "ha:strong",
            "mandatory": false
        }
    ],
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}

object

customProperties

Optional

Additional custom properties that may be used to extend the network.

string

deploymentId

Optional

The id of the deployment that is associated with this resource

boolean

outboundAccess

Optional

Flag to indicate if the network needs to have outbound access or not. Default is true. This field will be ignored if there is proper input for networkType customProperty

string

name

Required

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

string

projectId

Required

The id of the project the current user belongs to.

array of Constraint

constraints

Optional

Constraints that are used to drive placement policies for the network that is produced from this specification, related with the network profile. Constraint expressions are matched against tags on existing placement targets.

array of Tag

tags

Optional

A set of tag keys and optional values that should be set on any resource that is produced from this specification.

Responses

202

successful operation

Returns RequestTracker of type(s) application/json

{
    "name": "Power-off",
    "progress": 90,
    "resources": [
        "string"
    ],
    "id": "we655aew4e8e",
    "message": "In Progress",
    "status": "FINISHED",
    "selfLink": "/.../request-tracker/we655aew4e8e"
}

string

name

Optional

Name of the operation.

integer As int32 As int32

progress

Required

Progress of the request as percentage.

array of string

resources

Optional

Collection of resources.