NSX-T Data Center REST API
DistributedVlanConnection (type)
{
"additionalProperties": false,
"extends": {
"$ref": "PolicyConfigResource"
},
"id": "DistributedVlanConnection",
"module_id": "PolicyGatewayConnection",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp",
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp",
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink"
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"computed": true,
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink",
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"associated_ip_block_paths": {
"description": "IP address block(s) that are associated with the distributed vlan connection. If the block path(s) are set, the system will reserve the host address, network address and broadcast address (based on each gateway address in the distributed vlan connection) in the associated IP block(s) if these addresses fall into the associated IP block(s). Any other IP blocks overlapping with the gateway address(es) can be created without IP reservation. If the block path(s) are not set, the system will reserve the host address, network address and broadcast address (based on each gateway address in the distributed vlan connection) in any IP block that overlaps with the gateway address(es). When an address is reserved, any new IP block(s) overlapping with that address is not allowed to be created.",
"items": {
"type": "string"
},
"required": false,
"title": "Associated IP Address Block Paths",
"type": "array",
"x-vmw-cross-reference": [
{
"leftType": [
"DistributedVlanConnection"
],
"relationshipType": "DISTRIBUTED_VLAN_CONNECTION_TO_ASSOCIATED_IP_BLOCK_RELATIONSHIP",
"rightType": [
"IpBlock"
]
}
]
},
"children": {
"description": "Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.",
"items": {
"$ref": "ChildPolicyConfigResource"
},
"required": false,
"title": "Subtree for this type within policy tree",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"computed": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"gateway_addresses": {
"description": "Gateway IP address in network address and prefix length format",
"items": {
"$ref": "IPv4CIDRBlock"
},
"required": false,
"title": "Gateway address",
"type": "array"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"marked_for_delete": {
"default": false,
"description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.",
"readonly": true,
"required": false,
"title": "Indicates whether the intent object is marked for deletion",
"type": "boolean"
},
"origin_site_id": {
"description": "This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for knowing which site owns an object",
"type": "string"
},
"overridden": {
"default": false,
"description": "Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.",
"readonly": true,
"required": false,
"title": "Indicates whether this object is the overridden intent object",
"type": "boolean"
},
"owner_id": {
"description": "This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for the ownership of an object",
"type": "string"
},
"parent_path": {
"description": "Path of its parent",
"readonly": true,
"required": false,
"title": "Path of its parent",
"type": "string"
},
"path": {
"description": "Absolute path of this object",
"readonly": true,
"required": false,
"title": "Absolute path of this object",
"type": "string"
},
"realization_id": {
"description": "This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for realizing intent",
"type": "string"
},
"relative_path": {
"description": "Path relative from its parent",
"readonly": true,
"required": false,
"title": "Relative path of this object",
"type": "string"
},
"remote_path": {
"description": "This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.",
"readonly": true,
"required": false,
"title": "Path of the object on the remote end.",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"restricted_availability": {
"$ref": "VlanAvailability",
"description": "This defines whether the vlan availability is restricted to few clusters or zones rather than being globally accessible across entire environment. This property is optional and if not specified, which means VLAN is assumed to be available across entire environment by default. This property is intended for environments that requires restricted VLAN usage based on topology.",
"nsx_feature": "VpcTgwSpan",
"required": false,
"title": "Restricted vlan availability"
},
"subnet_extension_connection": {
"default": "DISABLED",
"description": "Controls the connectivity mode for VPC Subnets referencing this distributed VLAN connection. This property determines whether VPC Subnets can use this distributed VLAN connection and the type of connectivity allowed. DISABLED - VPC subnet cannot reference this distributed VLAN connection. ENABLED_L2 - VLAN L2 bridge is enabled. VPC Subnet with this distributed VLAN connection cannot have VPC gateway connectivity state as connected. ENABLED_L2_AND_L3 - VLAN L2 bridge is enabled. VPC Subnet with this distributed VLAN connection can have VPC gateway connectivity state as connected when DTGW is also connected with the distributed VLAN connection.",
"enum": [
"DISABLED",
"ENABLED_L2",
"ENABLED_L2_AND_L3"
],
"nsx_feature": "DlcCidrSubnetForVpc",
"required": false,
"title": "Subnet Extension Connection Mode",
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag"
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"unique_id": {
"description": "This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system",
"type": "string"
},
"vlan_id": {
"$ref": "VlanID",
"description": "Vlan id for external gateway traffic",
"required": true,
"title": "Vlan id"
}
},
"search_dsl_name": [
"distributed external connection"
],
"title": "Policy distributed vlan connection",
"type": "object"
}