NetworkProfile

NetworkProfile
NetworkProfile

Represents a network Profile.
HATEOAS links:
fabric-networks - array[FabricNetwork] - Fabric networks defined in this profile.
security-groups - array[SecurityGroup] - List of security groups for this profile.
network-domains - array[NetworkDomain] - List of network domains for this profile.
isolated-external-fabric-networks - array[FabricNetwork] - Isolated external fabric networks in this profile.
self - NetowrkProfile - Self link to this network profile

JSON Example
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "externalRegionId": "us-east-1",
    "cloudAccountId": "[9.0E49]",
    "isolationType": "string",
    "isolationNetworkDomainCIDR": "string",
    "isolatedNetworkCIDRPrefix": 0,
    "tags": [
        {
            "key": "ownedBy",
            "value": "Rainpole"
        }
    ],
    "customProperties": {
        "resourcePoolId": "resource-pool-1",
        "datastoreId": "StoragePod:group-p87839",
        "computeCluster": "/resources/compute/1234",
        "tier0LogicalRouterStateLink": "/resources/routers/2345",
        "onDemandNetworkIPAssignmentType": "dynamic"
    }
}
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 Tag
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.