diff --git a/v1/Makefile b/v1/Makefile index b20daed7..826bb5ad 100644 --- a/v1/Makefile +++ b/v1/Makefile @@ -51,8 +51,7 @@ api_files: # fixup invokes a script to generate interfaces for all of the # generated client types to allow consumers to use mocks to test their code that -# interacts with Quake via the client and adds copyrights to all the generated -# files. +# interacts with Quake via the client and adds copyrights to all the generated files. .PHONY: fixup fixup: api_files vendor @bash fixup_generated_files.bash ${OUTPUT_DIR} diff --git a/v1/api/swagger/components/schemas/NewHost.yaml b/v1/api/swagger/components/schemas/NewHost.yaml index 1d8e32b9..37d9fc56 100644 --- a/v1/api/swagger/components/schemas/NewHost.yaml +++ b/v1/api/swagger/components/schemas/NewHost.yaml @@ -149,11 +149,3 @@ properties: example: serviceType: BMaaS region: us-west-2 - WWPNs: - type: array - description: FC HBA world wide port names - items: - type: string - example: - - 20:31:01:02:ad:f2:a8:e5 - - 21:31:01:02:ad:f2:a8:e5 diff --git a/v1/html/index.html b/v1/html/index.html index 32bc8f87..49e833a2 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -2492,16 +2492,15 @@

Option 2: Getting the token directly from UI

Array of objects (AddVolume)

New volumes may be created and connected to the Host when the host is provisioned. The information provided here to create a host is the same as required when doing a post /volumes call

UserData
string

User-provided data to be attached to the image configuration data.

NodeID
string

User-provided data to represent the identity of the host within an application environment. For example, this could be set to represent the Kubernetes node ID if the host is provisioned as a Kubernetes node.

-
object

The map of service/user specified label name to label value for this host. +

object

The map of service/user specified label name to label value for this host. Setting service labels is restricted by role.

-
WWPNs
Array of strings

FC HBA world wide port names

Responses

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",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "NetworkIDs": [
    ],
  • "PreAllocatedIPs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "VolumeIDs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "NewVolumes": [
    ],
  • "UserData": "string",
  • "NodeID": "Node21",
  • "Labels": {
    },
  • "WWPNs": [
    ]
}

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

+
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",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "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)
path Parameters
hostId
required
string

ID of Host to return

Responses

Response samples

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