Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
href | anyURI | No | always | 5.1 | The URI of the entity. | |
type | string | No | always | 5.1 | The MIME type of the entity. | |
id | string | No | none | 5.1 | The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused. | |
operationKey | string | No | create | 5.1 | Optional unique identifier to support idempotent semantics for create and delete operations. | |
name | string | Yes | always | 5.1 | The name of the entity. | |
status | int | No | none | 5.1 |
Creation status of the gateway. One of: 0 (The gateway is still being created) 1 (The gateway is ready) -1 (There was an error while creating the gateway). |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
Configuration | GatewayConfigurationType | Yes | always | 5.1 | Gateway configuration. | |
Description | string | No | always | 5.1 | Optional description. | |
GatewayBackingRef | GatewayBackingRefType | No | always | 7.0 | Provides information to access edge gateway via VC | |
Link | LinkType | No | none | 5.1 | A reference to an entity or operation associated with this object. | |
Tasks | TasksInProgressType | No | none | 5.1 | A list of queued, running, or recently completed tasks associated with this entity. | |
VCloudExtension | VCloudExtensionType | No | always | 5.1 | An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services. |
Operations
CRUD | Operation | Description | Since | Deprecated |
---|---|---|---|---|
as input | PUT /admin/edgeGateway/{id} | Update an edge gateway | 5.1 | |
as input | PUT /admin/edgeGateway/{id}/action/updateProperties | Endpoint for just updating gateway properties by themselves. | ||
as input | POST /admin/vdc/{id}/edgeGateways | Create an edge gateway. | 5.1 |