{
"description": "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.",
"extends": {
"$ref": "ManagedResource
},
"id": "BridgeEndpoint",
"module_id": "BridgeEndpoint",
"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": {
"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"
},
"bridge_cluster_id": {
"description": "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.",
"maxLength": 36,
"required": false,
"title": "UUID of the bridge cluster for this bridge endpoint",
"type": "string"
},
"bridge_endpoint_profile_id": {
"description": "This field will not be used if a bridge cluster is being used for the bridge endpoint.",
"required": false,
"title": "Bridge endpoint profile used by the edge cluster",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"ha_enable": {
"default": true,
"description": "This field will not be used if an edge cluster is being used for the bridge endpoint",
"required": false,
"title": "Controls the enabling of HA on the VLAN for this endpoint",
"type": "boolean"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"uplink_teaming_policy_name": {
"description": "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.",
"required": false,
"title": "The name of the switching uplink teaming policy for the bridge endpoint",
"type": "string"
},
"vlan": {
"$ref": "VlanID,
"description": "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.",
"required": false
},
"vlan_transport_zone_id": {
"description": "This field will not be used if a bridge cluster is being used for the bridge endpoint.",
"required": false,
"title": "VLAN transport zone id by the edge cluster",
"type": "string"
},
"vlan_trunk_spec": {
"$ref": "VlanTrunkSpec,
"description": "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.",
"required": false,
"title": "VLAN trunk spec of edge bridge endpoint"
}
},
"title": "Bridge Endpoint",
"type": "object"
}