LogicalPort (schema)

Name Description Type Notes
_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 logical port

Each address binding must contain both an IPElement and MAC address.
VLAN ID is optional. This binding configuration can be used by
features such as spoof-guard and overrides any discovered bindings.
Any non unique entries are deduplicated to generate a unique set
of address bindings and then stored. For IP addresses, a subnet
address cannot have host bits set. A maximum of 128 unique address
bindings is allowed per port.
array of PacketAddressClassifier Minimum items: 0
Maximum items: 512
admin_state Represents Desired state of the logical port string Required
Enum: UP, DOWN
attachment Logical port attachment LogicalPortAttachment
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 logical port

This property could be used for vendor specific configuration in key value
string pairs. Logical port setting will override logical switch setting if
the same key was set on both logical switch and logical port.
array of ExtraConfig
id Unique identifier of this resource string Sortable
ignore_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 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 PacketAddressClassifier 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 (POST), and cannot be modified.
'RESTORE_VIF' fetches and restores VIF attachment from ESX host.
LogicalPortInitState
internal_id ID of the logical port in Global Manager

The internal_id of the logical port may or may not be identical to it's
managed resource ID. If a VirtualMachine connected to logical port
migrates from one site to another, then on the destination site, it
will be connected to different logical port managed resource. However,
the internal_id field will be persisted across vmotion.
string
logical_switch_id Id of the Logical switch that this port belongs to. string Required
resource_type Must be set to the value LogicalPort string
switching_profile_ids array of SwitchingProfileTypeIdEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30