Bridge Endpoint
A bridge endpoint can be created on a bridge cluster or on an edge
cluster. Few of the properties of this class will not be used depending on
the type of bridge endpoint being created. When creating a bridge endpoint
on a bridge cluster, following propeties will be used: vlan,
bridge_cluster_id and ha_enable. Similarly, for creating a bridge endpoint
on an edge cluster following properties will be used: vlan,
bridge_endpoint_profile_id and vlan_transport_zone_id.
Bridge Endpoint on a bridge cluster level is deprecated.
| 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 |
| bridge_cluster_id | UUID of the bridge cluster for this bridge endpoint This field will not be used if an edge cluster is being used for the bridge endpoint. This field is applicable for bridge cluster and it is deprecated. |
string | Maximum length: 36 |
| bridge_endpoint_profile_id | Bridge endpoint profile used by the edge cluster This field will not be used if a bridge cluster is being used for the bridge endpoint. |
string | |
| 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 |
| ha_enable | Controls the enabling of HA on the VLAN for this endpoint This field will not be used if an edge cluster is being used for the bridge endpoint |
boolean | Default: "True" |
| id | Unique identifier of this resource | string | Sortable |
| resource_type | Must be set to the value BridgeEndpoint | string | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| uplink_teaming_policy_name | The name of the switching uplink teaming policy for the bridge endpoint This name has to be one of the switching uplink teaming policy names listed inside the TransportZone. If this field is not specified, bridge will use the first pnic in host-switch config. This field will not be used if a bridge cluster is being used for the bridge endpoint. |
string | |
| vlan | This property is used for VLAN specification of bridge endpoint.
It's mutually exclusive with 'vlan_trunk_spec', either 'vlan' or 'vlan_trunk_spec' should be specified. |
VlanID | |
| vlan_transport_zone_id | VLAN transport zone id by the edge cluster This field will not be used if a bridge cluster is being used for the bridge endpoint. |
string | |
| vlan_trunk_spec | VLAN trunk spec of edge bridge endpoint This property is used for VLAN trunk specification of edge bridge endpoint. It's mutually exclusive with 'vlan', either 'vlan' or 'vlan_trunk_spec' should be specified. |
VlanTrunkSpec |