| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
| _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 |
| _protection |
Indicates protection status of this resource
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.
|
string |
Readonly |
| _revision |
Generation of this resource config
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. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| address_bindings |
Address bindings for the port
Static address binding used for the port. |
array of PortAddressBindingEntry |
Maximum items: 512 |
| admin_state |
Represents desired state of the segment port |
string |
Enum: UP, DOWN
Default: "UP" |
| attachment |
VIF attachment
Only VIF attachment is supported |
PortAttachment |
|
| children |
subtree for this type within policy tree
subtree for this type within policy tree containing nested elements.
|
array of ChildPolicyConfigResource
(Abstract type: pass one of the following concrete types)
ChildPortDiscoveryProfileBindingMap
ChildPortMonitoringProfileBindingMap
ChildPortQoSProfileBindingMap
ChildPortSecurityProfileBindingMap |
|
| 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 |
| extra_configs |
Extra configs on segment port
This property could be used for vendor specific configuration in key value
string pairs. Segment port setting will override segment setting if
the same key was set on both segment and segment port.
|
array of SegmentExtraConfig |
|
| id |
Unique identifier of this resource |
string |
Sortable |
| ignored_address_bindings |
Address bindings to be ignored by IP Discovery module
IP Discovery module uses various mechanisms to discover address
bindings being used on each segment port. If a user would like to
ignore any specific discovered address bindings or prevent the
discovery of a particular set of discovered bindings, then those
address bindings can be provided here. Currently IP range in CIDR format
is not supported.
|
array of PortAddressBindingEntry |
Minimum items: 0
Maximum items: 16 |
| init_state |
Initial state of this logical ports
Set initial state when a new logical port is created. 'UNBLOCKED_VLAN'
means new port will be unblocked on traffic in creation, also VLAN will
be set with corresponding logical switch setting. This port setting
can only be configured at port creation, and cannot be modified.
'RESTORE_VIF' fetches and restores VIF attachment from ESX host.
|
string |
Enum: UNBLOCKED_VLAN, RESTORE_VIF |
| marked_for_delete |
Indicates whether the intent object is marked for deletion
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 gets 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.
|
boolean |
Readonly
Default: "False" |
| origin_id |
ID of the distributed virtual port and the distributed virtual switch in the source vCenter
ID populated by NSX when NSX on DVPG is used to indicate the source Distributed Virtual Port
and the corresponding Distributed Virtual Switch. This ID is populated only for ports attached to
discovered segments.
|
string |
Readonly |
| overridden |
Indicates whether this object is the overridden intent object
Global intent objects cannot be modified 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.
|
boolean |
Readonly
Default: "False" |
| parent_path |
Path of its parent
Path of its parent |
string |
Readonly |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| realization_id |
A unique identifier assigned by the system for realizing intent
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 thier
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.
|
string |
Readonly |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value SegmentPort |
string |
|
| source_site_id |
source site(LM) id.
This field will refer to the source site on which the segment
port is discovered. This field is populated by GM, when it
receives corresponding notification from LM.
|
string |
Readonly |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
|
string |
Readonly |