Create Network Profile

Create Network Profile

Create network profile

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/network-profiles
COPY
Query Parameters
string
apiVersion
Optional

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


Request Body

NetworkProfile instance

NetworkProfileSpecification of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "regionId": "9.0E49"
}
{
    "name": "string",
    "description": "string",
    "fabricNetworkIds": [
        "6543"
    ],
    "securityGroupIds": [
        "6545"
    ],
    "loadBalancerIds": [
        "6545"
    ],
    "regionId": "9.0E49",
    "isolationType": "SUBNET",
    "isolationNetworkDomainId": "1234",
    "isolationNetworkDomainCIDR": "10.10.10.0/24",
    "isolationExternalFabricNetworkId": "1234",
    "isolatedNetworkCIDRPrefix": 24,
    "tags": [
        {
            "key": "dev",
            "value": "hard"
        }
    ],
    "customProperties": {
        "resourcePoolId": "resource-pool-1",
        "datastoreId": "StoragePod:group-p87839",
        "computeCluster": "/resources/compute/1234",
        "distributedLogicalRouterStateLink": "/resources/routers/1234",
        "tier0LogicalRouterStateLink": "/resources/routers/2345",
        "onDemandNetworkIPAssignmentType": "dynamic"
    },
    "externalIpBlockIds": [
        "3e2bb9bc-6a6a-11ea-bc55-0242ac130003"
    ]
}
string
name
Required

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

string
description
Optional

A human-friendly description.

array of string
fabricNetworkIds
Optional

A list of fabric network Ids which are assigned to the network profile.

array of string
securityGroupIds
Optional

A list of security group Ids which are assigned to the network profile.

array of string
loadBalancerIds
Optional

A list of load balancers which are assigned to the network profile.

string
regionId
Required

The Id of the region for which this profile is created

string
isolationType
Optional

Specifies the isolation type e.g. none, subnet or security group

Possible values are : NONE, SUBNET, SECURITY_GROUP,
string
isolationNetworkDomainId
Optional

The Id of the network domain used for creating isolated networks.

string
isolationNetworkDomainCIDR
Optional

CIDR of the isolation network domain.

string
isolationExternalFabricNetworkId
Optional

The Id of the fabric network used for outbound access.

integer As int32 As int32
isolatedNetworkCIDRPrefix
Optional

The CIDR prefix length to be used for the isolated networks that are created with the network profile.

array of object
tags
Optional

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

object
customProperties
Optional

Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, tier0LogicalRouterStateLink identifies the on-demand network tier-0 logical router (NSX Manager only). onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.

array of string
externalIpBlockIds
Optional

List of external IP blocks coming from an external IPAM provider that can be used to create subnetworks inside them

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns NetworkProfile of type(s) application/json
"NetworkProfile Object"
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

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

string
description
Optional

A human-friendly description.

string
externalRegionId
Optional

The id of the region for which this profile is defined

string
cloudAccountId
Optional

Id of the cloud account this profile belongs to.

string
isolationType
Optional

Specifies the isolation type e.g. none, subnet or security group

Possible values are : NONE, SUBNET, SECURITY_GROUP,
string
isolationNetworkDomainCIDR
Optional

CIDR of the isolation network domain.

integer As int32 As int32
isolatedNetworkCIDRPrefix
Optional

The CIDR prefix length to be used for the isolated networks that are created with the network profile.

array of object
tags
Optional

A set of tag keys and optional values that were set on this Network Profile.

object
customProperties
Optional

Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, tier0LogicalRouterStateLink identifies the on-demand network tier-0 logical router (NSX Manager only). onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.


400

Invalid request - bad data

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","regionId:"string"}' https://{api_host}/iaas/api/network-profiles