Create Network | vRealize Automation Cloud Infrastructure as a Service (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_host}/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

{
    "name": "string",
    "projectId": "e058",
    "description": "string",
    "constraints": [
        {
            "mandatory": false,
            "expression": "ha:strong"
        }
    ],
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "outboundAccess": true
}

string

name

Required

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

string

projectId

Required

The id of the project the current user belongs to.

string

description

Optional

A human-friendly description.

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.

object

customProperties

Optional

Additional custom properties that may be used toextend the network.

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.

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

Responses

202

successful operation

Returns RequestTracker of type(s) application/json

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

integer As int32 As int32

progress

Required

Progress of the request as percentage.

string

message

Optional

Status message of the request.

string

status

Required

Status of the request.