NSX-T Data Center REST API

DistributedVirtualPortgroup (schema)

Distributed virtual portgroup on a VC

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
backing_type Backing type for portgroup

For distributed virtual portgroup, backing type is standard.
For logical switch portgroup, the backing type is set to nsx.
string
cm_local_id Id of the portgroup in compute manager

Id of the portgroup, eg. a mo-ref from VC.
string Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
external_id External id of the virtual portgroup string Required
Readonly
key Generated UUID of the portgroup string
origin_type Portgroup type like DistributedVirtualPortgroup string Readonly
overall_status General status of the virtual portgroup

This parameters reflects the managed entity status of the portgroup
as reported by VC.
string Readonly
Enum: RED, YELLOW, GREEN, GRAY
resource_type Must be set to the value DistributedVirtualPortgroup string Required
scope List of scopes for discovered resource

Specifies list of scope of discovered resource. e.g. if VHC path is associated with
principal identity, who owns the discovered resource, then scope id will be VHC path
and scope type will be VHC.
array of DiscoveredResourceScope
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30