diff --git a/README.md b/README.md index 44b57e30..820d0072 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Navigate to version-specific API Client directories (\/pkg/client) to ## Usage The project API is intended for use by services and users accessing and provisioning project resources assigned specifically to a project. Projects are created and managed by a project administrator. Project resource limits for number of hosts and volumes and total storage capacity and project members are managed by the project administrator for the project. The scope of resource access and management by project members is limited to hosts and storage volumes created within the project limits by team members with project credentials. The project API provides access to available inventory which can be consumed for creating hosts, sshkeys, custom networks, and persistent storage volumes. Inventory usage is constrained by the project limits definitions. -The APIs use bearer authentication (also called token authentication) that requires the user to provide a bearer token in the authorization header. Two token methods are supported, the HPE GreenLake IAM token and Metal classic tokens. +The APIs use bearer authentication (also called token authentication) that requires the user to provide a bearer token in the authorization header. Three token methods are supported, the HPE GreenLake Cloud Services IAM token, HPE GreenLake Platform IAM token and Metal classic tokens. ## Code generation Client code is generated from the OpenAPI files in \/api/swagger/ using openapi-generator. In order to generate go client source code from the OpenAPI files, clone the repository https://github.com/hewlettpackard/hpegl-metal-client.git and install openapi-generator. Development and build environment requires Ubuntu 18.04. It is recommended to use this for working with hpegl-metal-client source generation also. Instructions on installing the openapi-generator on Ubuntu are below. diff --git a/v1/api/swagger/components/parameters/Role.yaml b/v1/api/swagger/components/parameters/Role.yaml new file mode 100644 index 00000000..6ac6dfdb --- /dev/null +++ b/v1/api/swagger/components/parameters/Role.yaml @@ -0,0 +1,6 @@ +name: X-Role +in: header +description: GreenLake Platform role name +schema: + type: string +example: metal-infra-admin \ No newline at end of file diff --git a/v1/api/swagger/components/parameters/Space.yaml b/v1/api/swagger/components/parameters/Space.yaml index 9722b8df..a853c29d 100644 --- a/v1/api/swagger/components/parameters/Space.yaml +++ b/v1/api/swagger/components/parameters/Space.yaml @@ -1,6 +1,6 @@ name: Space in: header -description: GreenLake space name +description: GreenLake Cloud Services space name schema: type: string example: Default diff --git a/v1/api/swagger/components/parameters/SpaceID.yaml b/v1/api/swagger/components/parameters/SpaceID.yaml index 7765bcc7..14d63d37 100644 --- a/v1/api/swagger/components/parameters/SpaceID.yaml +++ b/v1/api/swagger/components/parameters/SpaceID.yaml @@ -1,6 +1,6 @@ name: spaceid in: header -description: GreenLake space ID +description: GreenLake Cloud Services space ID schema: type: string example: 95688cf9-82ff-4e32-80fc-2b0b41648dab diff --git a/v1/api/swagger/components/parameters/WorkspaceID.yaml b/v1/api/swagger/components/parameters/WorkspaceID.yaml new file mode 100644 index 00000000..9124254d --- /dev/null +++ b/v1/api/swagger/components/parameters/WorkspaceID.yaml @@ -0,0 +1,6 @@ +name: X-Workspaceid +in: header +description: GreenLake Platform workspace ID +schema: + type: string +example: 1a2ba81600dd11efa47076a3447ec4eb \ No newline at end of file diff --git a/v1/api/swagger/components/schemas/FileInfo.yaml b/v1/api/swagger/components/schemas/FileInfo.yaml index ca9ff834..1e1828a0 100644 --- a/v1/api/swagger/components/schemas/FileInfo.yaml +++ b/v1/api/swagger/components/schemas/FileInfo.yaml @@ -61,3 +61,10 @@ properties: description: >- URL of the file that should be kept secret. If this field is set, it will be used for accessing the file and DisplayURL will be ignored. + SkipSslVerify: + type: boolean + description: >- + Indicates if the web server the file is being downloaded from should have + the SSL certificate validation bypassed. Useful for downloading from an + internal webserver with either self-signed or internal CA issued SSL certificate. + example: true diff --git a/v1/api/swagger/components/schemas/HostState.yaml b/v1/api/swagger/components/schemas/HostState.yaml index e544a4c5..2cc1b2c3 100644 --- a/v1/api/swagger/components/schemas/HostState.yaml +++ b/v1/api/swagger/components/schemas/HostState.yaml @@ -1,5 +1,6 @@ type: string enum: + - '' - New - Deleting - Deleted @@ -16,5 +17,9 @@ enum: - Releasing - Allocating - Maintenance + - Attaching + - Detaching + - ISCSI Attaching + - All Detaching description: Overall host state example: Ready diff --git a/v1/api/swagger/components/schemas/HostSubstate.yaml b/v1/api/swagger/components/schemas/HostSubstate.yaml index 6acd6649..27f46a67 100644 --- a/v1/api/swagger/components/schemas/HostSubstate.yaml +++ b/v1/api/swagger/components/schemas/HostSubstate.yaml @@ -4,7 +4,7 @@ enum: - '' - Abort Deploy - Allocate - - Attaching Volumes + - Attach Volumes - Boot Service-OS - Clear Log - Complete @@ -13,16 +13,16 @@ enum: - Connect Provisioning - DNS Add - DNS Add Init + - DNS Delete Init - DNS Delete - Deploy - Detach Volumes - - Error Recovery - - Fail Cleanup - Failed - In Maintenance - In OS Prep - Init - Init Attach Volumes + - Init Detach Volumes - Init Maintenance - Init OS Prep - Init Off diff --git a/v1/api/swagger/components/schemas/Project.yaml b/v1/api/swagger/components/schemas/Project.yaml index dd858f8b..1a2ad68e 100644 --- a/v1/api/swagger/components/schemas/Project.yaml +++ b/v1/api/swagger/components/schemas/Project.yaml @@ -40,4 +40,7 @@ allOf: - 91eec8b5-6460-4532-aad1-47b983edb63c VolumeReplicationEnabled: type: boolean - description: Indicates whether volume replication is enabled for this Project. \ No newline at end of file + description: Indicates whether volume replication is enabled for this Project. + ParentID: + type: string + description: ID of the Parent Project (optional). Applicable to GreenLake Platform (GLP) only. diff --git a/v1/api/swagger/components/schemas/VolumeAttachment.yaml b/v1/api/swagger/components/schemas/VolumeAttachment.yaml index 97484d79..c8f2d4d6 100644 --- a/v1/api/swagger/components/schemas/VolumeAttachment.yaml +++ b/v1/api/swagger/components/schemas/VolumeAttachment.yaml @@ -14,6 +14,7 @@ allOf: - State - FSConfig - AttachProtocol + - WWPNs properties: VolumeID: type: string @@ -65,4 +66,10 @@ allOf: allOf: - $ref: ./VAFSConfig.yaml AttachProtocol: - $ref: ./ProtocolKind.yaml \ No newline at end of file + $ref: ./ProtocolKind.yaml + WWPNs: + type: array + items: + type: string + example: 20:31:01:02:ad:f2:a8:e5 + description: List of FC host port wwpns. \ No newline at end of file diff --git a/v1/api/swagger/paths/allocation@server.yaml b/v1/api/swagger/paths/allocation@server.yaml index 2d079ac1..9b90058e 100644 --- a/v1/api/swagger/paths/allocation@server.yaml +++ b/v1/api/swagger/paths/allocation@server.yaml @@ -4,8 +4,11 @@ get: summary: Get servers allocation description: | Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. - When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. + When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. + If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. If the 'siteID' query parameter is present, the information returned is specific to that site ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: allocation_getBySite parameters: - name: siteID @@ -14,6 +17,8 @@ get: required: false schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/allocation@storage.yaml b/v1/api/swagger/paths/allocation@storage.yaml index 7119488b..b9b9810a 100644 --- a/v1/api/swagger/paths/allocation@storage.yaml +++ b/v1/api/swagger/paths/allocation@storage.yaml @@ -4,8 +4,11 @@ get: summary: Get storage allocation description: | Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. - When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. + When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. + If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. If the 'siteID' query parameter is present, the information returned is specific to that site ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: allocation_storage_getBySite parameters: - name: siteID @@ -14,6 +17,8 @@ get: required: false schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/available-resources.yaml b/v1/api/swagger/paths/available-resources.yaml index ac2bcbe0..59d5201e 100644 --- a/v1/api/swagger/paths/available-resources.yaml +++ b/v1/api/swagger/paths/available-resources.yaml @@ -2,6 +2,9 @@ get: tags: - available-resources operationId: AvailableResources_list + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml summary: Get lists of available resources for creating hosts and volumes description: > Used to get lists of options that are used when creating hosts and volumes. @@ -34,6 +37,9 @@ get: * Volumes - A list of current, existing volumes. If the volume is in the the right state, it could be attached to a new Host. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts.yaml b/v1/api/swagger/paths/hosts.yaml index 8b376f19..2d3499be 100644 --- a/v1/api/swagger/paths/hosts.yaml +++ b/v1/api/swagger/paths/hosts.yaml @@ -2,7 +2,10 @@ get: tags: - hosts summary: List all Hosts in project - description: Returns an array of all Host objects defined within the project. + description: >- + Returns an array of all Host objects defined within the project. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Hosts_list parameters: - in: query @@ -12,6 +15,8 @@ get: type: string enum: ["true"] description: Includes deleted Host objects in the response when set to "true". + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -37,6 +42,9 @@ post: The SvcFlavor, SvcVersion, LocationID, SSHKeyIDs, and Network attribute must all be set with appropriate ID values from the available-resources call. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Host_add requestBody: required: true @@ -47,6 +55,9 @@ post: application/json: schema: $ref: ../components/schemas/NewHost.yaml + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '201': description: created diff --git a/v1/api/swagger/paths/hosts@{hostId}.yaml b/v1/api/swagger/paths/hosts@{hostId}.yaml index f85eb65d..cad0d07e 100644 --- a/v1/api/swagger/paths/hosts@{hostId}.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}.yaml @@ -3,7 +3,10 @@ get: tags: - hosts summary: Retrieve Host by ID - description: Returns a single Host with matching ID + description: >- + Returns a single Host with matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Host_getByID parameters: - name: hostId @@ -12,6 +15,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -37,6 +42,9 @@ put: 'Description', 'Networks', 'NetworkForDefaultRoute', 'NetworkUntagged' and 'ISCSIConfig:InitiatorName' can be updated. 'ISCSIConfig:InitiatorName' can be updated only if the host has no volumes attached. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Host_update parameters: - name: hostId @@ -45,6 +53,8 @@ put: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Updated Host @@ -78,8 +88,11 @@ delete: summary: Delete a Host description: >- Deletes the Host with the matching ID. A host in the 'Ready' state must - first be powered-off before a delete will be permitted. Deletes to hosts in - other states is permitted regardless of the power state + first be powered-off before a delete will be permitted. Deletes to hosts in + other states is permitted regardless of the power state. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Host_delete parameters: - name: hostId @@ -88,6 +101,8 @@ delete: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@boothdd.yaml b/v1/api/swagger/paths/hosts@{hostId}@boothdd.yaml index c9e7af8f..99b6993f 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@boothdd.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@boothdd.yaml @@ -3,7 +3,10 @@ post: tags: - hosts summary: Set HDD boot order on Host by ID - description: Sets a single Host with matching ID to attempt HDD boot + description: >- + Sets a single Host with matching ID to attempt HDD booting. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: bootHDD parameters: - name: hostId @@ -12,6 +15,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@bootpxe.yaml b/v1/api/swagger/paths/hosts@{hostId}@bootpxe.yaml index 0a07dfa5..7ade2980 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@bootpxe.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@bootpxe.yaml @@ -3,7 +3,10 @@ post: tags: - hosts summary: Set PXE boot order on Host by ID - description: Sets a single Host with matching ID to attempt PXE boot when next booting + description: >- + Sets a single Host with matching ID to attempt PXE boot when next booting. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: bootPXE parameters: - name: hostId @@ -12,6 +15,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@maintenance.yaml b/v1/api/swagger/paths/hosts@{hostId}@maintenance.yaml index 291f6f04..2e976d4d 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@maintenance.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@maintenance.yaml @@ -5,8 +5,11 @@ post: summary: Do maintenance on a Host by ID description: >- Do maintenance on a host by executing pre-defined operations. - The host must be powered off. The host must also be in the Ready state or in + The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Maintenance workflow. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: maintenance parameters: - name: hostId @@ -15,6 +18,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@poweroff.yaml b/v1/api/swagger/paths/hosts@{hostId}@poweroff.yaml index 89536c6d..31b97e28 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@poweroff.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@poweroff.yaml @@ -3,7 +3,10 @@ post: tags: - hosts summary: Power off Host by ID - description: Powers off a single Host with matching ID + description: >- + Powers off a single Host with matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: powerOff parameters: - name: hostId @@ -12,6 +15,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@poweron.yaml b/v1/api/swagger/paths/hosts@{hostId}@poweron.yaml index 1b87df91..4fd9d319 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@poweron.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@poweron.yaml @@ -3,7 +3,10 @@ post: tags: - hosts summary: Power on Host by ID - description: Powers on a single Host with matching ID + description: >- + Powers on a single Host with matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: powerOn parameters: - name: hostId @@ -12,6 +15,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@powerreset.yaml b/v1/api/swagger/paths/hosts@{hostId}@powerreset.yaml index 2b324d95..c96a0e24 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@powerreset.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@powerreset.yaml @@ -3,7 +3,10 @@ post: tags: - hosts summary: Reset Host by ID - description: Resets a single Host with matching ID + description: >- + Resets a single Host with matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: powerReset parameters: - name: hostId @@ -12,6 +15,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml b/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml index 5c88b62e..ea5fbbf6 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml @@ -7,7 +7,10 @@ post: Re-deploys a host to the same machine. WARNING -- all drives will be erased! Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. - The host must be powered off. The host must also be in the Ready state. + The host must be powered off. The host must also be in the Ready state. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: reimage parameters: - name: hostId @@ -16,6 +19,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/hosts@{hostId}@replace.yaml b/v1/api/swagger/paths/hosts@{hostId}@replace.yaml index bc87481e..a77b3661 100644 --- a/v1/api/swagger/paths/hosts@{hostId}@replace.yaml +++ b/v1/api/swagger/paths/hosts@{hostId}@replace.yaml @@ -7,8 +7,11 @@ post: Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! Only the machine is replaced, IP addresses, volumes, etc are not changed. - The host must be powered off. The host must also be in the Ready state or in + The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: replace parameters: - name: hostId @@ -17,6 +20,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/ippools.yaml b/v1/api/swagger/paths/ippools.yaml index 0f3b37ce..52536813 100644 --- a/v1/api/swagger/paths/ippools.yaml +++ b/v1/api/swagger/paths/ippools.yaml @@ -2,8 +2,14 @@ get: tags: - ippools summary: List all ip pools in project - description: Returns an array of all ip pool objects defined within the project. + description: >- + Returns an array of all ip pool objects defined within the project. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: IPPool_list + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/ippools@{ippoolId}.yaml b/v1/api/swagger/paths/ippools@{ippoolId}.yaml index 86963679..b1ba5276 100644 --- a/v1/api/swagger/paths/ippools@{ippoolId}.yaml +++ b/v1/api/swagger/paths/ippools@{ippoolId}.yaml @@ -3,7 +3,10 @@ get: tags: - ippools summary: Retrieve IP pool by ID - description: Returns a single ip pool with matching ID + description: >- + Returns a single ip pool with matching imaged. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: IPPool_getByID parameters: - name: ippoolId @@ -12,6 +15,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -31,7 +36,10 @@ put: tags: - ippools summary: Update IP pool by ID - description: Update a single ip pool with matching ID. 'DefaultRoute' can only be updated if ip pool is not currently in-use. + description: >- + Update a single ip pool with matching ID. 'DefaultRoute' can only be updated if ip pool is not currently in-use. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: IPPool_update parameters: - name: ippoolId @@ -40,6 +48,8 @@ put: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Update IPPool diff --git a/v1/api/swagger/paths/ippools@{ippoolId}@allocation.yaml b/v1/api/swagger/paths/ippools@{ippoolId}@allocation.yaml index f59581e4..2c374e6b 100644 --- a/v1/api/swagger/paths/ippools@{ippoolId}@allocation.yaml +++ b/v1/api/swagger/paths/ippools@{ippoolId}@allocation.yaml @@ -3,7 +3,10 @@ post: tags: - ippools summary: Allocate IPs from the pool - description: Allocate IPs from the pool + description: >- + Allocate IPs from the pool + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: IPPool_allocateIPs parameters: - name: ippoolId @@ -12,6 +15,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: IPs being requested starting from an optional base IP and their usage diff --git a/v1/api/swagger/paths/ippools@{ippoolId}@return.yaml b/v1/api/swagger/paths/ippools@{ippoolId}@return.yaml index 9813e3b0..f86c1f9f 100644 --- a/v1/api/swagger/paths/ippools@{ippoolId}@return.yaml +++ b/v1/api/swagger/paths/ippools@{ippoolId}@return.yaml @@ -3,7 +3,10 @@ post: tags: - ippools summary: Return IPs to the pool - description: Return IPs to the pool + description: >- + Return IPs to the pool. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: IPPool_returnIPs parameters: - name: ippoolId @@ -12,6 +15,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: IP returned to the pool diff --git a/v1/api/swagger/paths/networks.yaml b/v1/api/swagger/paths/networks.yaml index 58f2ecd2..47f3259c 100644 --- a/v1/api/swagger/paths/networks.yaml +++ b/v1/api/swagger/paths/networks.yaml @@ -2,8 +2,14 @@ get: tags: - networks summary: List all networks in project - description: Returns an array of all network objects defined within the project. + description: >- + Returns an array of all network objects defined within the project. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Networks_list + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -21,8 +27,14 @@ post: tags: - networks summary: Add a new network - description: Adds a new network that can be referenced when creating a Host + description: >- + Adds a new network that can be referenced when creating a Host. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Network_add + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Network that is to be added to the project diff --git a/v1/api/swagger/paths/networks@{networkId}.yaml b/v1/api/swagger/paths/networks@{networkId}.yaml index 60badba0..c368c936 100644 --- a/v1/api/swagger/paths/networks@{networkId}.yaml +++ b/v1/api/swagger/paths/networks@{networkId}.yaml @@ -2,8 +2,11 @@ summary: Operations on a single network get: tags: - networks - summary: Retrieve network by ID - description: Returns a single network with matching ID + summary: Retrieve network by ID. + description: >- + Returns a single network with matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Network_getByID parameters: - name: networkId @@ -12,6 +15,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -30,8 +35,11 @@ get: put: tags: - networks - summary: Update an existing network. - description: '' + summary: Update an existing network by ID. + description: >- + Update an existing network by ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Network_update parameters: - name: networkId @@ -40,6 +48,8 @@ put: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Updated network @@ -70,7 +80,10 @@ delete: tags: - networks summary: Delete a network - description: Deletes the network with the matching ID + description: >- + Deletes the network with the matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Network_delete parameters: - name: networkId @@ -79,6 +92,8 @@ delete: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/projects-info.yaml b/v1/api/swagger/paths/projects-info.yaml index 0bbb1ff3..599bc386 100644 --- a/v1/api/swagger/paths/projects-info.yaml +++ b/v1/api/swagger/paths/projects-info.yaml @@ -9,22 +9,22 @@ get: The 'Projects' list includes projects authorized for a user, and the 'MachineSizes' and 'VolumeFlavors' list include only those machine sizes and volume flavors permitted for projects. - - When GreenLake IAM issued token is used for authentication, it is required to + When GreenLake Cloud Services IAM issued token is used for authentication, it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: ProjectsInfo_list security: - BearerAuth: [] Membership: [] - BearerAuth: [] - - BearerAuth: [] - Role: [] - Workspace: [] - parameters: - $ref: ../components/parameters/Space.yaml - $ref: ../components/parameters/SpaceID.yaml - $ref: ../components/parameters/SiteID.yaml + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/projects.yaml b/v1/api/swagger/paths/projects.yaml index ca50644a..6fe056bd 100644 --- a/v1/api/swagger/paths/projects.yaml +++ b/v1/api/swagger/paths/projects.yaml @@ -1,24 +1,26 @@ get: tags: - projects - summary: List of all Projects within an organization or cluster + summary: List of all Projects within an GLCS space or GLP workspace. description: >- Returns an array of all Project objects that have been created. This includes profile information for the project and project limits on resouces - like hosts, private networks, volumes, and volume capacity. If GreenLake IAM issued token is + like hosts, private networks, volumes, and volume capacity. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Projects_list security: - BearerAuth: [] Membership: [] - BearerAuth: [] - - BearerAuth: [] - Role: [] - Workspace: [] + Project: [] parameters: - $ref: ../components/parameters/SpaceID.yaml - $ref: ../components/parameters/Space.yaml + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -40,21 +42,23 @@ post: description: >- Adds a new Project which creates an isolated space for creating Hosts, Volumes, and private Networks. A project is often aligned to a specific team - within an organization or a cluster. If GreenLake IAM issued token is used + within an organization or a cluster. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. - Note that Hoster or BMaaS Access Owner role is required for this operation. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. + Note that a Hoster, BMaaS Access Owner, BMaaS Tenant Owner or Service Platform Owner role + is required for this operation. operationId: Project_add security: - BearerAuth: [] Membership: [] - BearerAuth: [] - - BearerAuth: [] - Role: [] - Workspace: [] parameters: - $ref: ../components/parameters/Space.yaml - $ref: ../components/parameters/SpaceID.yaml + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: NewProject parameters to create a new Project diff --git a/v1/api/swagger/paths/projects@{projectId}.yaml b/v1/api/swagger/paths/projects@{projectId}.yaml index 6206b050..40a0dd42 100644 --- a/v1/api/swagger/paths/projects@{projectId}.yaml +++ b/v1/api/swagger/paths/projects@{projectId}.yaml @@ -6,14 +6,14 @@ get: Returns a single Project object with its matching ID This includes profile information for the project and project limits on resouces like hosts, private networks, volumes, and volume capacity. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Project_getByID security: - BearerAuth: [] Membership: [] - BearerAuth: [] - - BearerAuth: [] - Role: [] - Workspace: [] + Project: [] parameters: - name: projectId in: path @@ -21,6 +21,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -43,15 +45,17 @@ put: description: >- Updates a project with a matching ID. Only Project 'Name', 'Profile' and 'Limits' can be updated with this operation. - Note that Hoster or BMaaS Access Owner role is required for this operation. + Note that a Hoster or BMaaS Access Owner (under GreenLake Cloud Services), or + BMaaS Tenant Owner or Service Platform Owner role (under GreenLake Platform) + is required for this operation. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Project_update security: - BearerAuth: [] Membership: [] - BearerAuth: [] - - BearerAuth: [] - Role: [] - Workspace: [] + Project: [] parameters: - name: projectId in: path @@ -59,6 +63,8 @@ put: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Project parameters to update an existing Project @@ -91,15 +97,17 @@ delete: summary: Delete a Project description: >- Deletes the Project with the matching ID. - Note that Hoster or BMaaS Access Owner role is required for this operation. + Note that a Hoster or BMaaS Access Owner (under GreenLake Cloud Services), or + BMaaS Tenant Owner or Service Platform Owner role (under GreenLake Platform) + is required for this operation. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Project_delete security: - BearerAuth: [] Membership: [] - BearerAuth: [] - - BearerAuth: [] - Role: [] - Workspace: [] + Project: [] parameters: - name: projectId in: path @@ -107,6 +115,8 @@ delete: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/services.yaml b/v1/api/swagger/paths/services.yaml index d2e3e257..cb5646f3 100644 --- a/v1/api/swagger/paths/services.yaml +++ b/v1/api/swagger/paths/services.yaml @@ -4,12 +4,16 @@ get: summary: List of all OS service images within an tenant description: >- Returns an array of all OS service images objects that have been created. - If GreenLake IAM issued token is used for authentication, - then it is required to pass 'spaceid' header + If GreenLake Cloud Services IAM issued token is used for authentication, + then it is required to pass 'spaceid' headers. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Services_list parameters: - $ref: ../components/parameters/SpaceID.yaml - $ref: ../components/parameters/Space.yaml + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -30,17 +34,17 @@ post: summary: Create a new OS service image description: >- Adds a new OS service image that can be referenced during host creation. - If GreenLake IAM issued token is used for authentication, then it is required + If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'spaceid' header or 'Space' header. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. Note that Hoster or BMaaS Access Owner role is required for this operation. operationId: Service_add - security: - - BearerAuth: [] - Membership: [] - - BearerAuth: [] parameters: - $ref: ../components/parameters/SpaceID.yaml - $ref: ../components/parameters/Space.yaml + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Yaml file describing the OS service image. diff --git a/v1/api/swagger/paths/services@{serviceId}.yaml b/v1/api/swagger/paths/services@{serviceId}.yaml index f0404110..c747a39e 100644 --- a/v1/api/swagger/paths/services@{serviceId}.yaml +++ b/v1/api/swagger/paths/services@{serviceId}.yaml @@ -4,6 +4,8 @@ get: summary: Retrieve an OS service image description: >- Returns a single OS service image object with its matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Service_getByID parameters: - name: serviceId @@ -12,6 +14,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -33,12 +37,10 @@ put: summary: Update an OS service image by its ID description: >- Updates an OS service image with a matching ID. - Note that Hoster or BMaaS Access Owner role is required for this operation. + Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Service_update - security: - - BearerAuth: [] - Membership: [] - - BearerAuth: [] parameters: - name: serviceId in: path @@ -46,6 +48,8 @@ put: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Yaml file describing the OS service image. @@ -78,12 +82,10 @@ delete: summary: Delete an OS service image description: >- Deletes the OS service image with the matching ID. - Note that Hoster or BMaaS Access Owner role is required for this operation. + Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Service_delete - security: - - BearerAuth: [] - Membership: [] - - BearerAuth: [] parameters: - name: serviceId in: path @@ -91,6 +93,8 @@ delete: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/sshkeys.yaml b/v1/api/swagger/paths/sshkeys.yaml index ccf8f543..9d81e4bd 100644 --- a/v1/api/swagger/paths/sshkeys.yaml +++ b/v1/api/swagger/paths/sshkeys.yaml @@ -4,7 +4,12 @@ get: summary: List all sshkeys in project description: >- Returns an array of all SSHKey objects defined within the project. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: SSHKeys_list + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -22,7 +27,10 @@ post: tags: - sshkeys summary: Add a new SSH Key - description: Adds a new SSH Key that can be referenced when creating a Host + description: >- + Adds a new SSH Key that can be referenced when creating a Host. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: SSHKey_add requestBody: required: true @@ -31,6 +39,9 @@ post: application/json: schema: $ref: ../components/schemas/NewSSHKey.yaml + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '201': description: created diff --git a/v1/api/swagger/paths/sshkeys@{sshkeyId}.yaml b/v1/api/swagger/paths/sshkeys@{sshkeyId}.yaml index 4b90caf1..e02f1389 100644 --- a/v1/api/swagger/paths/sshkeys@{sshkeyId}.yaml +++ b/v1/api/swagger/paths/sshkeys@{sshkeyId}.yaml @@ -3,7 +3,10 @@ get: tags: - sshkeys summary: Retrieve SSH Key by ID - description: Returns a single SSH key with matching ID + description: >- + Returns a single SSH key with matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: SSHKey_getByID parameters: - name: sshkeyId @@ -12,6 +15,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -30,8 +35,11 @@ get: put: tags: - sshkeys - summary: Update an existing SSH Key. Only 'Name' or 'Key' fields can be changed. - description: '' + summary: Update an existing SSH Key by ID. + description: >- + Update a single SSH key with matching ID. Only 'Name' or 'Key' fields can be changed. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: SSHKey_update parameters: - name: sshkeyId @@ -40,6 +48,8 @@ put: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Updated SSH key @@ -69,8 +79,11 @@ put: delete: tags: - sshkeys - summary: Delete an SSH key - description: Deletes the SSH key with the matching ID + summary: Delete an SSH key by ID. + description: >- + Deletes the SSH key with the matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: SSHKey_delete parameters: - name: sshkeyId @@ -79,6 +92,8 @@ delete: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/volume-attachments.yaml b/v1/api/swagger/paths/volume-attachments.yaml index a7104c91..8b6df240 100644 --- a/v1/api/swagger/paths/volume-attachments.yaml +++ b/v1/api/swagger/paths/volume-attachments.yaml @@ -2,8 +2,14 @@ get: tags: - volume-attachments summary: List all volume attachments in project - description: Returns an array of all VolumeAttachments defined within the project. + description: >- + Returns an array of all VolumeAttachments defined within the project. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: VolumeAttachments_list + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -27,7 +33,12 @@ post: this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: VolumeAttachments_add + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: NewVolumeAttachement parameters to create a new VolumeAttachment. diff --git a/v1/api/swagger/paths/volume-attachments@{attachmentId}.yaml b/v1/api/swagger/paths/volume-attachments@{attachmentId}.yaml index c645f906..1b88cf8b 100644 --- a/v1/api/swagger/paths/volume-attachments@{attachmentId}.yaml +++ b/v1/api/swagger/paths/volume-attachments@{attachmentId}.yaml @@ -3,7 +3,10 @@ get: tags: - volume-attachments summary: Retrieve volume attachment by ID - description: Returns a single volume attachment with matching ID + description: >- + Returns a single volume attachment with matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: VolumeAttachment_getByID parameters: - name: attachmentId @@ -12,6 +15,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -31,7 +36,10 @@ delete: tags: - volume-attachments summary: Delete a VolumeAttachment - description: Deletes the VolumeAttachment with the matching ID + description: >- + Deletes the VolumeAttachment with the matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: VolumeAttachment_delete parameters: - name: attachmentId @@ -40,6 +48,8 @@ delete: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/volumes.yaml b/v1/api/swagger/paths/volumes.yaml index 52d298bf..f63f1052 100644 --- a/v1/api/swagger/paths/volumes.yaml +++ b/v1/api/swagger/paths/volumes.yaml @@ -2,8 +2,14 @@ get: tags: - volumes summary: List all volumes in project - description: Returns an array of all volumes defined within the project. + description: >- + Returns an array of all volumes defined within the project. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Volumes_list + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -23,10 +29,15 @@ post: - volumes summary: Add a new volume description: > - Adds a new volume to the project. Volumes may be created separately and + Adds a new volume to the project. Volumes may be created separately and then referenced in the create Host call; or volumes may be created directly within the create Host call. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Volume_add + parameters: + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Volume that is to be added to the project diff --git a/v1/api/swagger/paths/volumes@{volumeId}.yaml b/v1/api/swagger/paths/volumes@{volumeId}.yaml index 06bc6916..753578e5 100644 --- a/v1/api/swagger/paths/volumes@{volumeId}.yaml +++ b/v1/api/swagger/paths/volumes@{volumeId}.yaml @@ -3,7 +3,10 @@ get: tags: - volumes summary: Retrieve volume by ID - description: Returns a single volume with matching ID + description: >- + Returns a single volume with matching imaged. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Volume_getByID parameters: - name: volumeId @@ -12,6 +15,8 @@ get: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success @@ -34,6 +39,8 @@ put: description: > Updates volume with matching ID. Update is permitted only when volume is in 'Allocated' or 'Visible' state. Only the Volume 'Capacity' can be updated with a value greater than the existing one to expand the volume. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Volume_update parameters: - name: volumeId @@ -42,6 +49,8 @@ put: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Volume object with its ID and Capacity in GiB indicating the expanded size to be specified. @@ -70,7 +79,10 @@ delete: tags: - volumes summary: Delete a volume - description: Deletes the volume with the matching ID + description: >- + Deletes the volume with the matching ID. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Volume_delete parameters: - name: volumeId @@ -79,6 +91,8 @@ delete: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml responses: '200': description: success diff --git a/v1/api/swagger/paths/volumes@{volumeId}@attach.yaml b/v1/api/swagger/paths/volumes@{volumeId}@attach.yaml index 758aa32a..32c5f31a 100644 --- a/v1/api/swagger/paths/volumes@{volumeId}@attach.yaml +++ b/v1/api/swagger/paths/volumes@{volumeId}@attach.yaml @@ -7,6 +7,8 @@ post: This attachment will create a VolumeAttachment object that contains details about the connection of the volume and will update the Host with iSCSI configuration information. + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Volume_attach parameters: - name: volumeId @@ -15,6 +17,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Unique ID of the Host to which the volume will be attached diff --git a/v1/api/swagger/paths/volumes@{volumeId}@detach.yaml b/v1/api/swagger/paths/volumes@{volumeId}@detach.yaml index bfbf115a..536ef8d7 100644 --- a/v1/api/swagger/paths/volumes@{volumeId}@detach.yaml +++ b/v1/api/swagger/paths/volumes@{volumeId}@detach.yaml @@ -11,6 +11,9 @@ post: Note that the HostID is required in the body of the request to ensure that the operation is well understood and that a volume is not accidently being removed from the wrong host. + + If GreenLake Platform IAM issued token is used for authentication, then it is required to pass + 'X-Role' and 'X-Workspaceid' headers. operationId: Volume_detach parameters: - name: volumeId @@ -19,6 +22,8 @@ post: required: true schema: type: string + - $ref: ../components/parameters/Role.yaml + - $ref: ../components/parameters/WorkspaceID.yaml requestBody: required: true description: Unique ID of the Host from which a volume will be detached diff --git a/v1/api/swagger/swagger.yaml b/v1/api/swagger/swagger.yaml index b258cc3e..e130575e 100644 --- a/v1/api/swagger/swagger.yaml +++ b/v1/api/swagger/swagger.yaml @@ -41,10 +41,6 @@ security: Project: [] - BearerAuth: [] Membership: [] - - BearerAuth: [] - Workspace: [] - Project: [] - Role: [] tags: - name: version @@ -169,7 +165,7 @@ components: bearerFormat: JWT Project: description: >- - The project ID. Required only when using GreenLake Cloud Services IAM issued JWT for + The project ID. Required only when using GreenLake Cloud Services/Platform IAM issued JWT for authentication type: apiKey in: header @@ -181,17 +177,3 @@ components: type: apiKey in: header name: Membership - Role: - description: >- - The GLP IAM role. Required only when using GreenLake Platform IAM issued JWT for - authentication - type: apiKey - in: header - name: X-Role - Workspace: - description: >- - The GLP IAM workspace ID. Required only when using GreenLake Platform IAM issued JWT for - authentication - type: apiKey - in: header - name: X-Workspaceid diff --git a/v1/fixup_generated_files.bash b/v1/fixup_generated_files.bash index d9344da0..2aeb2715 100755 --- a/v1/fixup_generated_files.bash +++ b/v1/fixup_generated_files.bash @@ -1,5 +1,5 @@ #! /bin/bash -COPYRIGHT="// (C) Copyright 2021-2023 Hewlett Packard Enterprise Development LP" +COPYRIGHT="// (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP" set -e if [ $# -ne 1 ]; then diff --git a/v1/html/index.html b/v1/html/index.html index 53e759e0..ccc65e21 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -2216,7 +2216,7 @@ -
API docs by Redocly
API docs by Redocly
500

internal error

Response samples

Content type
application/json
{
  • "Build": "0.8.6-dev-218-g0b3b1ad"
}

projects

Operations related to Projects. A Project defines an isolated space for creating Hosts, Volumes, and private Networks. A project is a.k.a. Compute Group.

-

List of all Projects within an organization or cluster

Returns an array of all Project objects that have been created. This includes profile information for the project and project limits on resouces like hosts, private networks, volumes, and volume capacity. If GreenLake IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored.

-
Authorizations:
(BearerAuthMembership) BearerAuth(BearerAuthRoleWorkspace)
header Parameters
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake space ID

-
Space
string
Example: Default

GreenLake space name

+

List of all Projects within an GLCS space or GLP workspace.

Returns an array of all Project objects that have been created. This includes profile information for the project and project limits on resouces like hosts, private networks, volumes, and volume capacity. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthMembership) (BearerAuthProject)
header Parameters
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake Cloud Services space ID

+
Space
string
Example: Default

GreenLake Cloud Services space name

+
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new project

Adds a new Project which creates an isolated space for creating Hosts, Volumes, and private Networks. A project is often aligned to a specific team within an organization or a cluster. If GreenLake IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. Note that Hoster or BMaaS Access Owner role is required for this operation.

-
Authorizations:
(BearerAuthMembership) BearerAuth(BearerAuthRoleWorkspace)
header Parameters
Space
string
Example: Default

GreenLake space name

-
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake space ID

+
https://client.greenlake.hpe.com{basePath}/projects

Response samples

Content type
application/json
[
  • {
    }
]

Create a new project

Adds a new Project which creates an isolated space for creating Hosts, Volumes, and private Networks. A project is often aligned to a specific team within an organization or a cluster. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers. Note that a Hoster, BMaaS Access Owner, BMaaS Tenant Owner or Service Platform Owner role is required for this operation.

+
Authorizations:
(BearerAuthMembership) BearerAuth
header Parameters
Space
string
Example: Default

GreenLake Cloud Services space name

+
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake Cloud Services space ID

+
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

NewProject parameters to create a new Project

Name
required
string
required
object (Profile)
required
object (Limits)
PermittedSites
Array of strings <uuid>

Array listing the permitted site IDs

PermittedOSImages
Array of strings <uuid>

Array listing the permitted OS service images.

@@ -2391,16 +2395,20 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "Project foobar",
  • "Profile": {
    },
  • "Limits": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Profile": {
    },
  • "Limits": {
    },
  • "Resources": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true
}

Retrieve a project by its ID

Returns a single Project object with its matching ID This includes profile information for the project and project limits on resouces like hosts, private networks, volumes, and volume capacity.

-
Authorizations:
(BearerAuthMembership) BearerAuth(BearerAuthRoleWorkspace)
path Parameters
projectId
required
string

ID of project to return

+
https://client.greenlake.hpe.com{basePath}/projects

Request samples

Content type
application/json
{
  • "Name": "Project foobar",
  • "Profile": {
    },
  • "Limits": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Profile": {
    },
  • "Limits": {
    },
  • "Resources": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true,
  • "ParentID": "string"
}

Retrieve a project by its ID

Returns a single Project object with its matching ID This includes profile information for the project and project limits on resouces like hosts, private networks, volumes, and volume capacity. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthMembership) (BearerAuthProject)
path Parameters
projectId
required
string

ID of project to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Profile": {
    },
  • "Limits": {
    },
  • "Resources": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true
}

Update a project by its ID

Updates a project with a matching ID. Only Project 'Name', 'Profile' and 'Limits' can be updated with this operation. Note that Hoster or BMaaS Access Owner role is required for this operation.

-
Authorizations:
(BearerAuthMembership) BearerAuth(BearerAuthRoleWorkspace)
path Parameters
projectId
required
string

ID of project to update

+
https://client.greenlake.hpe.com{basePath}/projects/{projectId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Profile": {
    },
  • "Limits": {
    },
  • "Resources": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true,
  • "ParentID": "string"
}

Update a project by its ID

Updates a project with a matching ID. Only Project 'Name', 'Profile' and 'Limits' can be updated with this operation. Note that a Hoster or BMaaS Access Owner (under GreenLake Cloud Services), or BMaaS Tenant Owner or Service Platform Owner role (under GreenLake Platform) is required for this operation. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthMembership) (BearerAuthProject)
path Parameters
projectId
required
string

ID of project to update

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Project parameters to update an existing Project

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2414,8 +2422,10 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Profile": {
    },
  • "Limits": {
    },
  • "PermittedOSImages": [
    ]
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Profile": {
    },
  • "Limits": {
    },
  • "Resources": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true
}

Delete a Project

Deletes the Project with the matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation.

-
Authorizations:
(BearerAuthMembership) BearerAuth(BearerAuthRoleWorkspace)
path Parameters
projectId
required
string

ID of project to delete

+
https://client.greenlake.hpe.com{basePath}/projects/{projectId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Profile": {
    },
  • "Limits": {
    },
  • "PermittedOSImages": [
    ]
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Profile": {
    },
  • "Limits": {
    },
  • "Resources": {
    },
  • "PermittedSites": [
    ],
  • "PermittedOSImages": [
    ],
  • "VolumeReplicationEnabled": true,
  • "ParentID": "string"
}

Delete a Project

Deletes the Project with the matching ID. Note that a Hoster or BMaaS Access Owner (under GreenLake Cloud Services), or BMaaS Tenant Owner or Service Platform Owner role (under GreenLake Platform) is required for this operation. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthMembership) (BearerAuthProject)
path Parameters
projectId
required
string

ID of project to delete

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

sshkeys

Operations related to SSH Keys. Clients may define SSH Keys that can then be referenced by ID when creating a Host.

-

List all sshkeys in project

Returns an array of all SSHKey objects defined within the project.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)

Responses

List all sshkeys in project

Returns an array of all SSHKey objects defined within the project. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new SSH Key

Adds a new SSH Key that can be referenced when creating a Host

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
Request Body schema: application/json

SSH Key that is to be added to the project

+
https://client.greenlake.hpe.com{basePath}/sshkeys

Response samples

Content type
application/json
[
  • {
    }
]

Add a new SSH Key

Adds a new SSH Key that can be referenced when creating a Host. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+
Request Body schema: application/json

SSH Key that is to be added to the project

Name
required
string
Key
required
string (SSHKeyValue)

SSH key value

Responses

Request samples

Content type
application/json
{
  • "Name": "Joe's Laptop",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Retrieve SSH Key by ID

Returns a single SSH key with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
sshkeyId
required
string

ID of sshkey to return

+
https://client.greenlake.hpe.com{basePath}/sshkeys

Request samples

Content type
application/json
{
  • "Name": "Joe's Laptop",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Retrieve SSH Key by ID

Returns a single SSH key with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
sshkeyId
required
string

ID of sshkey to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Update an existing SSH Key. Only 'Name' or 'Key' fields can be changed.

Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
sshkeyId
required
string

ID of sshkey to update

+
https://client.greenlake.hpe.com{basePath}/sshkeys/{sshkeyId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Update an existing SSH Key by ID.

Update a single SSH key with matching ID. Only 'Name' or 'Key' fields can be changed. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
sshkeyId
required
string

ID of sshkey to update

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Updated SSH key

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2459,8 +2478,10 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Delete an SSH key

Deletes the SSH key with the matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
sshkeyId
required
string

ID of sshkey to delete

+
https://client.greenlake.hpe.com{basePath}/sshkeys/{sshkeyId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Key": "'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"
}

Delete an SSH key by ID.

Deletes the SSH key with the matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
sshkeyId
required
string

ID of sshkey to delete

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

hosts

Operations related to Hosts. A host is a fully-provisioned physical server. Clients may create, view, list, and delete hosts. A host is a.k.a. Compute Instance.

-

List all Hosts in project

Returns an array of all Host objects defined within the project.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
query Parameters
all
string
Value: "true"

Includes deleted Host objects in the response when set to "true".

+

List all Hosts in project

Returns an array of all Host objects defined within the project. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
query Parameters
all
string
Value: "true"

Includes deleted Host objects in the response when set to "true".

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Host

Creates a new host object which kicks off the provisioning of a physical server in accordance to the attributes provided for the Host object. Most values for these options must be selected from the set of options provided by the get available-resources API call. -The SvcFlavor, SvcVersion, LocationID, SSHKeyIDs, and Network attribute must all be set with appropriate ID values from the available-resources call.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
Request Body schema: application/json

Defines the configuration of the desired host. See the schema for descriptions of individual attributes.

+The SvcFlavor, SvcVersion, LocationID, SSHKeyIDs, and Network attribute must all be set with appropriate ID values from the available-resources call. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+
Request Body schema: application/json

Defines the configuration of the desired host. See the schema for descriptions of individual attributes.

Name
required
string

The host name used when installing the host operating system. Note that some OS implementations may require the name to be formatted as a fully qualified domain name.

Description
string
ServiceID
required
string <uuid>

The image service identifier must be identifer of one of the available imaging services provided by the AvailableImage array returned as part of the get /available-resources call. Images are typically described by category (e.g. Linux), flavor (e.g. ubuntu) and version (e.g. 18.04-20190807)

LocationID
required
string <uuid>

The location ID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call. The locations are typically described by country, region, and data center. @@ -2500,16 +2526,21 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "NewHostName",
  • "Description": "Description of new Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "SSHKeyIDs": [
    ],
  • "NetworkIDs": [
    ],
  • "PreAllocatedIPs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "VolumeIDs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "NewVolumes": [
    ],
  • "UserData": "string",
  • "NodeID": "Node21",
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Retrieve Host by ID

Returns a single Host with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to return

+
https://client.greenlake.hpe.com{basePath}/hosts

Request samples

Content type
application/json
{
  • "Name": "NewHostName",
  • "Description": "Description of new Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "SSHKeyIDs": [
    ],
  • "NetworkIDs": [
    ],
  • "PreAllocatedIPs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "VolumeIDs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "NewVolumes": [
    ],
  • "UserData": "string",
  • "NodeID": "Node21",
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Retrieve Host by ID

Returns a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Update an existing Host

Updates the Host with the matching ID. Update is permitted only if the host is in the 'Ready' or 'Connection Updating Failed' state. Only the Host 'Description', 'Networks', 'NetworkForDefaultRoute', 'NetworkUntagged' and 'ISCSIConfig:InitiatorName' can be updated. 'ISCSIConfig:InitiatorName' can be updated only if the host has no volumes attached.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of host to update

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Update an existing Host

Updates the Host with the matching ID. Update is permitted only if the host is in the 'Ready' or 'Connection Updating Failed' state. Only the Host 'Description', 'Networks', 'NetworkForDefaultRoute', 'NetworkUntagged' and 'ISCSIConfig:InitiatorName' can be updated. 'ISCSIConfig:InitiatorName' can be updated only if the host has no volumes attached. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of host to update

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Updated Host

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2530,72 +2561,94 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Description": "Description of Host",
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "ISCSIConfig": {
    },
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Delete a Host

Deletes the Host with the matching ID. A host in the 'Ready' state must first be powered-off before a delete will be permitted. Deletes to hosts in other states is permitted regardless of the power state

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to delete

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Description": "Description of Host",
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "ISCSIConfig": {
    },
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Delete a Host

Deletes the Host with the matching ID. A host in the 'Ready' state must first be powered-off before a delete will be permitted. Deletes to hosts in other states is permitted regardless of the power state. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to delete

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

Do maintenance on a Host by ID

Do maintenance on a host by executing pre-defined operations. The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Maintenance workflow.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to do maintenance on

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

Do maintenance on a Host by ID

Do maintenance on a host by executing pre-defined operations. The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Maintenance workflow. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to do maintenance on

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Power on Host by ID

Powers on a single Host with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to power on

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/maintenance

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Power on Host by ID

Powers on a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to power on

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Power off Host by ID

Powers off a single Host with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to power off

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/poweron

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Power off Host by ID

Powers off a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to power off

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Reset Host by ID

Resets a single Host with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to reset

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/poweroff

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Reset Host by ID

Resets a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to reset

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Set PXE boot order on Host by ID

Sets a single Host with matching ID to attempt PXE boot when next booting

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to set to PXE boot

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/powerreset

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Set PXE boot order on Host by ID

Sets a single Host with matching ID to attempt PXE boot when next booting. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to set to PXE boot

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Set HDD boot order on Host by ID

Sets a single Host with matching ID to attempt HDD boot

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to set to HDD boot

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/bootpxe

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Set HDD boot order on Host by ID

Sets a single Host with matching ID to attempt HDD booting. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to set to HDD boot

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Reimage Host by ID

Re-deploys a host to the same machine. WARNING -- all drives will be erased! Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off. The host must also be in the Ready state.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to reimage

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/boothdd

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Reimage Host by ID

Re-deploys a host to the same machine. WARNING -- all drives will be erased! Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off. The host must also be in the Ready state. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to reimage

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Replace Host by ID

Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
hostId
required
string

ID of Host to replace

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/reimage

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

Replace Host by ID

Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to replace

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

volumes

Operations related to Volumes. A Volume is an external storage volume that persists independent of the associated host.

-

List all volumes in project

Returns an array of all volumes defined within the project.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)

Responses

List all volumes in project

Returns an array of all volumes defined within the project. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new volume

Adds a new volume to the project. Volumes may be created separately and then referenced in the create Host call; or volumes may be created directly within the create Host call.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
Request Body schema: application/json

Volume that is to be added to the project

+
https://client.greenlake.hpe.com{basePath}/volumes

Response samples

Content type
application/json
[
  • {
    }
]

Add a new volume

Adds a new volume to the project. Volumes may be created separately and then referenced in the create Host call; or volumes may be created directly within the create Host call. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+
Request Body schema: application/json

Volume that is to be added to the project

Name
required
string
Description
string
FlavorID
required
string <uuid>

Adds a new volume to the project. This object requires the LocationID and is used when a new volume is created independently from the host creation therefore requiring a specified location.

Capacity
required
integer <int64> >= 0

The size of the volume in GiB

Shareable
boolean

Indicates if the volume can be attached to multiple hosts

@@ -2624,16 +2681,20 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "NewVolumeName",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Labels": {
    },
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Retrieve volume by ID

Returns a single volume with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
volumeId
required
string

ID of volume to return

+
https://client.greenlake.hpe.com{basePath}/volumes

Request samples

Content type
application/json
{
  • "Name": "NewVolumeName",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Labels": {
    },
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Retrieve volume by ID

Returns a single volume with matching imaged. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Update an existing volume

Updates volume with matching ID. Update is permitted only when volume is in 'Allocated' or 'Visible' state. Only the Volume 'Capacity' can be updated with a value greater than the existing one to expand the volume.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
volumeId
required
string

ID of volume to return

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Update an existing volume

Updates volume with matching ID. Update is permitted only when volume is in 'Allocated' or 'Visible' state. Only the Volume 'Capacity' can be updated with a value greater than the existing one to expand the volume. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Volume object with its ID and Capacity in GiB indicating the expanded size to be specified.

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2650,16 +2711,20 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Capacity": 10485760,
  • "VolumeCollectionID": "90be909e-4609-40f5-9630-f24910dc8591",
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Delete a volume

Deletes the volume with the matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
volumeId
required
string

ID of volume to delete

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Capacity": 10485760,
  • "VolumeCollectionID": "90be909e-4609-40f5-9630-f24910dc8591",
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "StoragePoolID": "4028a467-4960-41d8-94b5-7611e50c0642",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "VolumeCollectionID": "0bc8d647-85d3-4a49-8d49-8626da150790",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Delete a volume

Deletes the volume with the matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to delete

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

Attach existing volume to Host

Attaches the indicated volume to a host identified in the requestBody. This attachment will create a VolumeAttachment object that contains details about the connection of the volume and will update the Host with iSCSI configuration information.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
volumeId
required
string

ID of volume to attach

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

Attach existing volume to Host

Attaches the indicated volume to a host identified in the requestBody. This attachment will create a VolumeAttachment object that contains details about the connection of the volume and will update the Host with iSCSI configuration information. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to attach

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Unique ID of the Host to which the volume will be attached

HostID
required
string <uuid>

Unique ID of the Host to attach or detach volume

Responses

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown"
}

Detach existing volume from Host

Detaches the indicated volume from the host identified in the requestBody. This detachment will delete the VolumeAttachment object that contains details about the connection of the volume and will update the Host to remove selected iSCSI configuration information. -Note that the HostID is required in the body of the request to ensure that the operation is well understood and that a volume is not accidently being removed from the wrong host.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
volumeId
required
string

ID of volume to attach

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}/attach

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown",
  • "WWPNs": [
    ]
}

Detach existing volume from Host

Detaches the indicated volume from the host identified in the requestBody. This detachment will delete the VolumeAttachment object that contains details about the connection of the volume and will update the Host to remove selected iSCSI configuration information. +Note that the HostID is required in the body of the request to ensure that the operation is well understood and that a volume is not accidently being removed from the wrong host. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to attach

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Unique ID of the Host from which a volume will be detached

HostID
required
string <uuid>

Unique ID of the Host to attach or detach volume

Responses

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

volume-attachments

Operations related to VolumeAttachments that describe how a host is connected to a volume.

-

List all volume attachments in project

Returns an array of all VolumeAttachments defined within the project.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)

Responses

List all volume attachments in project

Returns an array of all VolumeAttachments defined within the project. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new VolumeAttachment

Adds a new VolumeAttachment which enables a machine to use a volume. Note that this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
Request Body schema: application/json

NewVolumeAttachement parameters to create a new VolumeAttachment.

+
https://client.greenlake.hpe.com{basePath}/volume-attachments

Response samples

Content type
application/json
[
  • {
    }
]

Create a new VolumeAttachment

Adds a new VolumeAttachment which enables a machine to use a volume. Note that this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+
Request Body schema: application/json

NewVolumeAttachement parameters to create a new VolumeAttachment.

Name
string

Name for the volume attachment. Must be 128 or fewer printable characters

VolumeID
required
string <uuid>

Unique ID of the volume attached to the host

required
object (ProtocolParameters)

Responses

Request samples

Content type
application/json
{
  • "Name": "My Object Name",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "Protocol": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown"
}

Retrieve volume attachment by ID

Returns a single volume attachment with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
attachmentId
required
string

ID of volume attachment to return

+
https://client.greenlake.hpe.com{basePath}/volume-attachments

Request samples

Content type
application/json
{
  • "Name": "My Object Name",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "Protocol": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown",
  • "WWPNs": [
    ]
}

Retrieve volume attachment by ID

Returns a single volume attachment with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
attachmentId
required
string

ID of volume attachment to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown"
}

Delete a VolumeAttachment

Deletes the VolumeAttachment with the matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
attachmentId
required
string

ID of VolumeAttachment to delete

+
https://client.greenlake.hpe.com{basePath}/volume-attachments/{attachmentId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    },
  • "AttachProtocol": "unknown",
  • "WWPNs": [
    ]
}

Delete a VolumeAttachment

Deletes the VolumeAttachment with the matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
attachmentId
required
string

ID of VolumeAttachment to delete

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

networks

Operations related to Networks.

-

List all networks in project

Returns an array of all network objects defined within the project.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)

Responses

List all networks in project

Returns an array of all network objects defined within the project. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new network

Adds a new network that can be referenced when creating a Host

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
Request Body schema: application/json

Network that is to be added to the project

+
https://client.greenlake.hpe.com{basePath}/networks

Response samples

Content type
application/json
[
  • {
    }
]

Add a new network

Adds a new network that can be referenced when creating a Host. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+
Request Body schema: application/json

Network that is to be added to the project

Name
required
string

Name of the network

LocationID
required
string <uuid> (LocationID)

The location ID is the data center location of the resource. The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call. The locations are typically described by country, region, and data center.

Description
string
HostUse
string (NetworkHostUse)
Enum: "Required" "Default" "Optional"

Indicates whether use of the network is required, default, or optional. If the network is required, any new create host request for that location must include this network among the requested networks. Default and Optional are both optional networks, but imply whether they should show up initially in pre-populated fields in a graphical user interface.

@@ -2731,15 +2811,20 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "Private2",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "NewIPPool": {
    },
  • "VLAN": 0,
  • "VNI": 0
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Retrieve network by ID

Returns a single network with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
networkId
required
string

ID of network to return

+
https://client.greenlake.hpe.com{basePath}/networks

Request samples

Content type
application/json
{
  • "Name": "Private2",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "NewIPPool": {
    },
  • "VLAN": 0,
  • "VNI": 0
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Retrieve network by ID.

Returns a single network with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
networkId
required
string

ID of network to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Update an existing network.

Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
networkId
required
string

ID of network to update

+
https://client.greenlake.hpe.com{basePath}/networks/{networkId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Update an existing network by ID.

Update an existing network by ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
networkId
required
string

ID of network to update

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Updated network

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2754,8 +2839,10 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Delete a network

Deletes the network with the matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
networkId
required
string

ID of network to delete

+
https://client.greenlake.hpe.com{basePath}/networks/{networkId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Delete a network

Deletes the network with the matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
networkId
required
string

ID of network to delete

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)

Responses

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+

Responses

Response samples

Content type
application/json
{
  • "Images": [
    ],
  • "Locations": [
    ],
  • "Networks": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Volumes": [
    ],
  • "MachineInventory": [
    ],
  • "StorageInventory": [
    ],
  • "SSHKeys": [
    ],
  • "StoragePools": [
    ],
  • "VolumeCollections": [
    ]
}

projects-info

Operations related to listing information related to projects.

-

List of all projects info within an organization or cluster for which user is authorized.

Returns an object with information on projects, machine sizes, and volume flavors. The 'Projects' list includes projects authorized for a user, and the 'MachineSizes' and 'VolumeFlavors' list include only those machine sizes and volume flavors permitted for projects.

-

When GreenLake IAM issued token is used for authentication, it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored.

-
Authorizations:
(BearerAuthMembership) BearerAuth(BearerAuthRoleWorkspace)
query Parameters
siteid
string
Example: siteid=95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake site ID

-
header Parameters
Space
string
Example: Default

GreenLake space name

-
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake space ID

+

List of all projects info within an organization or cluster for which user is authorized.

Returns an object with information on projects, machine sizes, and volume flavors. The 'Projects' list includes projects authorized for a user, and the 'MachineSizes' and 'VolumeFlavors' list include only those machine sizes and volume flavors permitted for projects. +When GreenLake Cloud Services IAM issued token is used for authentication, it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthMembership) BearerAuth
query Parameters
siteid
string
Example: siteid=95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake site ID

+
header Parameters
Space
string
Example: Default

GreenLake Cloud Services space name

+
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake Cloud Services space ID

+
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "Projects": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Summary": {
    }
}

ippools

Operations related to IP pools.

-

List all ip pools in project

Returns an array of all ip pool objects defined within the project.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)

Responses

List all ip pools in project

Returns an array of all ip pool objects defined within the project. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve IP pool by ID

Returns a single ip pool with matching ID

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
ippoolId
required
string

ID of IP pool to return

+
https://client.greenlake.hpe.com{basePath}/ippools

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve IP pool by ID

Returns a single ip pool with matching imaged. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Update IP pool by ID

Update a single ip pool with matching ID. 'DefaultRoute' can only be updated if ip pool is not currently in-use.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
ippoolId
required
string

ID of IP pool to update

+
https://client.greenlake.hpe.com{basePath}/ippools/{ippoolId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Update IP pool by ID

Update a single ip pool with matching ID. 'DefaultRoute' can only be updated if ip pool is not currently in-use. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to update

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

Update IPPool

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2839,8 +2938,10 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Description": "Description of IP pool",
  • "DefaultRoute": "10.128.0.1",
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ]
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Allocate IPs from the pool

Allocate IPs from the pool

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
ippoolId
required
string

ID of IP pool to allocate IPs

+
https://client.greenlake.hpe.com{basePath}/ippools/{ippoolId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Description": "Description of IP pool",
  • "DefaultRoute": "10.128.0.1",
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ]
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Allocate IPs from the pool

Allocate IPs from the pool If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to allocate IPs

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

IPs being requested starting from an optional base IP and their usage

Array
Base
required
string

An optional base address for the allocation, if not specified first available address from the pool will be the base

Count
required
integer

Number of addresses to allocate starting from the base

@@ -2851,8 +2952,10 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Return IPs to the pool

Return IPs to the pool

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
ippoolId
required
string

ID of IP pool to return IPs

+
https://client.greenlake.hpe.com{basePath}/ippools/{ippoolId}/allocation

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Return IPs to the pool

Return IPs to the pool. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to return IPs

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: application/json

IP returned to the pool

Array
string

Responses

Request samples

Content type
application/json
[
  • "15.0.0.1"
]

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

allocation

Operations related to listing information about allocation by servers and storage.

Get servers allocation

Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. -When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. -If the 'siteID' query parameter is present, the information returned is specific to that site ID.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
query Parameters
siteID
string

site ID

+When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. +If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. +If the 'siteID' query parameter is present, the information returned is specific to that site ID. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass +'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
query Parameters
siteID
string

site ID

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get storage allocation

Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. -When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. -If the 'siteID' query parameter is present, the information returned is specific to that site ID.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
query Parameters
siteID
string

site ID

+When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. +If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. +If the 'siteID' query parameter is present, the information returned is specific to that site ID. +If GreenLake Platform IAM issued token is used for authentication, then it is required to pass +'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
query Parameters
siteID
string

site ID

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

services

Operations related to OS service images.

-

List of all OS service images within an tenant

Returns an array of all OS service images objects that have been created. If GreenLake IAM issued token is used for authentication, then it is required to pass 'spaceid' header

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
header Parameters
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake space ID

-
Space
string
Example: Default

GreenLake space name

+

List of all OS service images within an tenant

Returns an array of all OS service images objects that have been created. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass 'spaceid' headers. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake Cloud Services space ID

+
Space
string
Example: Default

GreenLake Cloud Services space name

+
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new OS service image

Adds a new OS service image that can be referenced during host creation. If GreenLake IAM issued token is used for authentication, then it is required to pass either 'spaceid' header or 'Space' header. Note that Hoster or BMaaS Access Owner role is required for this operation.

-
Authorizations:
(BearerAuthMembership) BearerAuth
header Parameters
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake space ID

-
Space
string
Example: Default

GreenLake space name

+
https://client.greenlake.hpe.com{basePath}/services

Response samples

Content type
application/json
[
  • {
    }
]

Create a new OS service image

Adds a new OS service image that can be referenced during host creation. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'spaceid' header or 'Space' header. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers. Note that Hoster or BMaaS Access Owner role is required for this operation.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake Cloud Services space ID

+
Space
string
Example: Default

GreenLake Cloud Services space name

+
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: multipart/form-data

Yaml file describing the OS service image.

fileName
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Retrieve an OS service image

Returns a single OS service image object with its matching ID.

-
Authorizations:
(BearerAuthProject) (BearerAuthMembership) (BearerAuthWorkspaceProjectRole)
path Parameters
serviceId
required
string

ID of OS service image to return

+
https://client.greenlake.hpe.com{basePath}/services

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Retrieve an OS service image

Returns a single OS service image object with its matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
serviceId
required
string

ID of OS service image to return

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Update an OS service image by its ID

Updates an OS service image with a matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation.

-
Authorizations:
(BearerAuthMembership) BearerAuth
path Parameters
serviceId
required
string

ID of OS service image to update

+
https://client.greenlake.hpe.com{basePath}/services/{serviceId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Update an OS service image by its ID

Updates an OS service image with a matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
serviceId
required
string

ID of OS service image to update

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Request Body schema: multipart/form-data

Yaml file describing the OS service image.

fileName
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Delete an OS service image

Deletes the OS service image with the matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation.

-
Authorizations:
(BearerAuthMembership) BearerAuth
path Parameters
serviceId
required
string

ID of OS service image to delete

+
https://client.greenlake.hpe.com{basePath}/services/{serviceId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Delete an OS service image

Deletes the OS service image with the matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
serviceId
required
string

ID of OS service image to delete

+
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

+
X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}