From 92d3db98fc8c08c0a7fc8c68416419c8e69c31fd Mon Sep 17 00:00:00 2001
From: AnuBose <anuradha.bose@hpe.com>
Date: Thu, 9 Feb 2023 15:45:24 -0600
Subject: [PATCH] change allocation capacity to float (#67)

* change allocation caapcity to float

* Bump go version

* [auto generated] Checking in generated offline HTML doc

---------

Co-authored-by: Neil Gierman <neil.gierman@hpe.com>
Co-authored-by: neilgierman <neilgierman@users.noreply.github.com>
Co-authored-by: chaitra-mylarappachar <65302544+chaitra-mylarappachar@users.noreply.github.com>
---
 .github/workflows/ci.yml                             |  2 +-
 .../components/schemas/AllocationStorage.yaml        |  2 +-
 .../components/schemas/ServiceStorageInfo.yaml       |  4 +++-
 v1/html/index.html                                   |  2 +-
 v1/pkg/client/api/openapi.yaml                       | 12 +++++++-----
 v1/pkg/client/docs/ServiceStorageInfo.md             |  2 +-
 v1/pkg/client/model_allocation_storage.go            |  2 +-
 v1/pkg/client/model_service_storage_info.go          |  2 +-
 8 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index ccf4a991..42ad3cca 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -61,4 +61,4 @@ jobs:
             [auto generated] Checking in generated offline HTML doc
           BRANCH_REF: ${{ github.event.pull_request.head.ref }}
           REPOSITORY: ${{ github.repository }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
\ No newline at end of file
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/v1/api/swagger/components/schemas/AllocationStorage.yaml b/v1/api/swagger/components/schemas/AllocationStorage.yaml
index 537389d9..17f412b1 100644
--- a/v1/api/swagger/components/schemas/AllocationStorage.yaml
+++ b/v1/api/swagger/components/schemas/AllocationStorage.yaml
@@ -1,5 +1,5 @@
 type: object
-description: allocation of storage for each PCE service.
+description: Allocation of storage for each PCE service.
 properties:
   ResourceType:
     type: string
diff --git a/v1/api/swagger/components/schemas/ServiceStorageInfo.yaml b/v1/api/swagger/components/schemas/ServiceStorageInfo.yaml
index eb689cab..d7035306 100644
--- a/v1/api/swagger/components/schemas/ServiceStorageInfo.yaml
+++ b/v1/api/swagger/components/schemas/ServiceStorageInfo.yaml
@@ -9,5 +9,7 @@ properties:
     type: integer
     description: Allocated number of volumes.
   AllocatedCapacity:
-    type: integer
+    type: number
+    format: float
+    minimum: 0.0
     description:  Total capacity of all allocated volumes in TB for a service type.
diff --git a/v1/html/index.html b/v1/html/index.html
index 198d7c58..b267a3f5 100644
--- a/v1/html/index.html
+++ b/v1/html/index.html
@@ -2912,7 +2912,7 @@ <h2>Option 2: Getting the token directly from UI</h2>
 </span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/allocation/storage</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"><p>HPE GreenLake Central</p>
 </div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://client.greenlake.hpe.com{basePath}</span>/allocation/storage</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-478" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-479" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-480" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-481" data-rttab="true">401</li><li class="tab-error" role="tab" id="react-tabs-482" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-483" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-479" aria-labelledby="react-tabs-478"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ResourceType"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InstanceFamily"</span>: <span class="token string">&quot;Performance Optimized Block&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InstanceType"</span>: <span class="token string">&quot;SBP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllocationInfo"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ServiceType"</span>: <span class="token string">&quot;BMaaS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllocatedCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllocatedCapacity"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-481" aria-labelledby="react-tabs-480"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-483" aria-labelledby="react-tabs-482"></div></div></div></div></div></div></div><div class="sc-ellfGf bgakXB"></div></div></div>
     <script>
-    const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"HPE GreenLake for bare metal API","version":"v1","license":{"name":"HPE End User License Agreement","url":"https://www.hpe.com/us/en/software/licensing.html"},"description":" \n# Introduction\nWelcome to HPE GreenLake for bare metal APIs. \n\nThe HPE GreenLake for bare metal is included as part of the HPE GreenLake for Private Cloud\nEnterprise service, and it is sometimes also called Bare Metal as a Service or BMaaS.\n\nThis document describes the HPE GreenLake for bare metal APIs protocol and available endpoints.\n\nThe BMaaS API is built on HTTP and is RESTful. It has predictable resource URLs. It returns HTTP \nresponse codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can \nuse your favorite HTTP/REST library for your programming language to use HPE GreenLake for Private \nCloud Enterprise bare metal APIs.\n\nThe APIs provides access to bare metal service within a single project context. Clients can create \nfully-provisioned hosts, storage volumes, and project-specific private networks in an isolated \nproject environment. Clients can also access information about available services and resources \nthrough the available-resources API. This API provides detailed information about OS imaging options, \nmachine size options, storage volume options, and data center locations which are needed when creating \nhosts and volumes.\n\nThe API specification references a few resources by the deprecated name, which differs from the name \ndisplayed in HPE GreenLake Central UI. The table below maps the resource's old name in the API \nspecification with the corresponding name in HPE GreenLake Central UI.\n\n| **SN** | **Name in API Spec** | **Name in GreenLake Central** |\n|--------|----------------------|-------------------------------|\n| 1      | Project              | Compute Group                 |\n| 2      | Host                 | Compute Instance              |\n| 3      | Machine Size         | Compute Instance Type         |\n\n\n# Authentication\n\n## Bearer Auth\n\nThe HPE GreenLake for bare metal APIs use Bearer Authentication that requires the users to provide \na bearer token in the **Authorization** header. The service supports two types of tokens, the HPE \nGreenLake IAM token and the Metal classic token. The Metal classic token is for HPE internal use only.\nThe clients are required to provide HPE GreenLake IAM token to authenticate with the HPE GreenLake \nfor bare metal APIs. The access token can be obtained using any of the following ways.\n\n<h2>Option 1: API client(recommended)</h2>\n\nAn API client allows nonhuman entities (an application service account, for instance) programmatic access to a resource on a space.\n\n  + 1.\n<a\n    href=\"https://support.hpe.com/hpesc/public/docDisplay?docId=a00092451en_us&page=greenlakecentral-create-api-client.html\"\n    target=\"_blank\">\n    Create an API client\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>\n\n**Note:** Make sure to save the **Issuer Url**, **Client ID**, and **Client Secret**\n\n  + 2.\n<a\n    href=\"https://support.hpe.com/hpesc/public/docDisplay?docId=a00092451en_us&page=GUID-1CEA233B-C4B0-41B7-9A25-7A36D9FC0312.html\"\n    target=\"_blank\">\n    Creating an assignment for an API client\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>\n\n**Note:** Make sure to assign the appropriate HPE GreenLake for bare metal user roles in HPE GreenLake Central.\n\n  + 3. Make a REST call to generate the API access token:\n\n```\ncurl -i -X POST \\\n  '{issuerUrl}/v1/token' \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -d 'client_id={clientID}' \\\n  -d 'client_secret={clientSecret}' \\\n  -d grant_type=client_credentials \\\n  -d scope=hpe-tenant\n```\nObtain the `access_token` from the response.\n\n<h2>Option 2: Getting the token directly from UI</h2>\n\nTo authenticate with the BMaaS API you need to obtain the access token from\n<a\n    href=\"https://client.greenlake.hpe.com\"\n    target=\"_blank\">\n    HPE GreenLake Central\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>.\nOnce logged in to **HPE GreenLake Central**,\nClick the\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/user.svg\">\nicon in the top right corner and then click\n<input\n    type=\"button\"\n    value=\"API Access\"\n    style=\"color: #000;\n        background-color: #fff;\n        border: 2px solid #00b388;\n        border-radius: 4px;\"/>\n. In the API Access page, click the\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/clipboard.svg\">\nicon to copy the personal access token.\n\n<br>\n\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/circle-information.svg\"> **INFO**\nFor both the options, the access token lease expires in **15** minutes.\n\n## Project API Key\nThe specific Project ID must be provided with **Project** header when accessing service within a single project context.\nUsed only when using HPE GreenLake IAM issued access tokens.\n\n## Membership API Key\nHPE Internal use only. Required only when using classic Metal access tokens.\n\n# Getting a Space name or ID\nSpace name or ID is required in header for a few Project level APIs. You can obtain the Space name and the corresponding ID from \n<a\n    href=\"https://client.greenlake.hpe.com\"\n    target=\"_blank\">\n    HPE GreenLake Central\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>.   \nOnce logged in to **HPE GreenLake Central**,\nClick the\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/user.svg\">\nicon in the top right corner and copy the value of **Space** field.  \n\nThe corresponding ID for the Space can be extracted from the current URL in the address bar.  \nIt is the value of **spaceid** query parameter at the end of a URL after a '?' symbol.\n\n# HPE GreenLake for bare metal APIs\n"},"servers":[{"url":"https://client.greenlake.hpe.com{basePath}","description":"HPE GreenLake Central","variables":{"basePath":{"default":"/api/metal/rest/v1","description":"URL prefix for endpoints"}}}],"security":[{"BearerAuth":[],"Project":[]},{"BearerAuth":[],"Membership":[]}],"tags":[{"name":"version","description":"Read-only operation to get api server build version information.\n"},{"name":"projects","description":"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.\n"},{"name":"sshkeys","description":"Operations related to SSH Keys. Clients may define SSH Keys that can then be referenced by ID when creating a Host.\n"},{"name":"hosts","description":"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.\n"},{"name":"volumes","description":"Operations related to Volumes. A Volume is an external storage volume that persists independent of the associated host.\n"},{"name":"volume-attachments","description":"Operations related to VolumeAttachments that describe how a host is connected to a volume.\n"},{"name":"networks","description":"Operations related to Networks.\n"},{"name":"available-resources","description":"Operations related to listing information that is needed to construct create host and create volume calls. This provides a detailed information about the OS imaging options,  the machine size (a.k.a. Compute Instance Type) options, the storage volume options,  data center locations, and such that are needed when creating hosts and volumes.\n"},{"name":"usage-reports","description":"Operations related to retrieving information about resource usage within the project.\n"},{"name":"projects-info","description":"Operations related to listing information related to projects.\n"},{"name":"ippools","description":"Operations related to IP pools.\n"},{"name":"allocation","description":"Operations related to listing information about allocation by servers and storage.\n"}],"paths":{"/version":{"get":{"tags":["version"],"summary":"Get api server build version","operationId":"Versions_get","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/projects":{"get":{"tags":["projects"],"summary":"List of all Projects within an organization or cluster","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 used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored.","operationId":"Projects_list","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/SpaceID"},{"$ref":"#/components/parameters/Space"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["projects"],"summary":"Create a new project","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 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.","operationId":"Project_add","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Space"},{"$ref":"#/components/parameters/SpaceID"}],"requestBody":{"required":true,"description":"NewProject parameters to create a new Project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewProject"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/projects/{projectId}":{"get":{"tags":["projects"],"summary":"Retrieve a project by its ID","description":"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.","operationId":"Project_getByID","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"name":"projectId","in":"path","description":"ID of project to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["projects"],"summary":"Update a project by its ID","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.","operationId":"Project_update","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"name":"projectId","in":"path","description":"ID of project to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Project parameters to update an existing Project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["projects"],"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.","operationId":"Project_delete","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"name":"projectId","in":"path","description":"ID of project to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/projects-info":{"get":{"tags":["projects-info"],"summary":"List of all projects info within an organization or cluster for which user is authorized.","description":"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.\n\nWhen 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.","operationId":"ProjectsInfo_list","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Space"},{"$ref":"#/components/parameters/SpaceID"},{"$ref":"#/components/parameters/SiteID"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ProjectsInfo"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/sshkeys":{"get":{"tags":["sshkeys"],"summary":"List all sshkeys in project","description":"Returns an array of all SSHKey objects defined within the project.","operationId":"SSHKeys_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SSHKey"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["sshkeys"],"summary":"Add a new SSH Key","description":"Adds a new SSH Key that can be referenced when creating a Host","operationId":"SSHKey_add","requestBody":{"required":true,"description":"SSH Key that is to be added to the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSSHKey"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/sshkeys/{sshkeyId}":{"summary":"Operations on a single SSH Key","get":{"tags":["sshkeys"],"summary":"Retrieve SSH Key by ID","description":"Returns a single SSH key with matching ID","operationId":"SSHKey_getByID","parameters":[{"name":"sshkeyId","in":"path","description":"ID of sshkey to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["sshkeys"],"summary":"Update an existing SSH Key.  Only 'Name' or 'Key' fields can be changed.","description":"","operationId":"SSHKey_update","parameters":[{"name":"sshkeyId","in":"path","description":"ID of sshkey to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Updated SSH key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["sshkeys"],"summary":"Delete an SSH key","description":"Deletes the SSH key with the matching ID","operationId":"SSHKey_delete","parameters":[{"name":"sshkeyId","in":"path","description":"ID of sshkey to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts":{"get":{"tags":["hosts"],"summary":"List all Hosts in project","description":"Returns an array of all Host objects defined within the project.","operationId":"Hosts_list","parameters":[{"in":"query","name":"all","required":false,"schema":{"type":"string","enum":["true"]},"description":"Includes deleted Host objects in the response when set to \"true\"."}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Host"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["hosts"],"summary":"Create a new Host","description":"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.\nThe SvcFlavor, SvcVersion, LocationID, SSHKeyIDs, and Network attribute must all be set with appropriate ID values from the available-resources call.","operationId":"Host_add","requestBody":{"required":true,"description":"Defines the configuration of the desired host. See the schema for descriptions of individual attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewHost"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}":{"summary":"Operations associated with a specific host","get":{"tags":["hosts"],"summary":"Retrieve Host by ID","description":"Returns a single Host with matching ID","operationId":"Host_getByID","parameters":[{"name":"hostId","in":"path","description":"ID of Host to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["hosts"],"summary":"Update an existing Host","description":"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.","operationId":"Host_update","parameters":[{"name":"hostId","in":"path","description":"ID of host to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Updated Host","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["hosts"],"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","operationId":"Host_delete","parameters":[{"name":"hostId","in":"path","description":"ID of Host to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/maintenance":{"summary":"Do maintenance on a specific host","post":{"tags":["hosts"],"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 Failed state and in the Maintenance workflow.","operationId":"maintenance","parameters":[{"name":"hostId","in":"path","description":"ID of Host to do maintenance on","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/poweron":{"summary":"Power on a specific host","post":{"tags":["hosts"],"summary":"Power on Host by ID","description":"Powers on a single Host with matching ID","operationId":"powerOn","parameters":[{"name":"hostId","in":"path","description":"ID of Host to power on","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/poweroff":{"summary":"Power off a specific host","post":{"tags":["hosts"],"summary":"Power off Host by ID","description":"Powers off a single Host with matching ID","operationId":"powerOff","parameters":[{"name":"hostId","in":"path","description":"ID of Host to power off","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/powerreset":{"summary":"Reset a specific host","post":{"tags":["hosts"],"summary":"Reset Host by ID","description":"Resets a single Host with matching ID","operationId":"powerReset","parameters":[{"name":"hostId","in":"path","description":"ID of Host to reset","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/bootpxe":{"summary":"Set a specific host to attempt PXE boot","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","operationId":"bootPXE","parameters":[{"name":"hostId","in":"path","description":"ID of Host to set to PXE boot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/boothdd":{"summary":"Set a specific host to attempt HDD boot","post":{"tags":["hosts"],"summary":"Set HDD boot order on Host by ID","description":"Sets a single Host with matching ID to attempt HDD boot","operationId":"bootHDD","parameters":[{"name":"hostId","in":"path","description":"ID of Host to set to HDD boot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/replace":{"summary":"Replace a specific host","post":{"tags":["hosts"],"summary":"Replace Host by ID","description":"Re-deploys a host with a new machine that satisfies the current host settings. 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.","operationId":"replace","parameters":[{"name":"hostId","in":"path","description":"ID of Host to replace","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/available-resources":{"get":{"tags":["available-resources"],"operationId":"AvailableResources_list","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. A get /available-resources will return an object that includes the following arrays:\n* Images - A list of image service IDs along with their category (Linux), \n  flavor (ubuntu), and version (18.04)\n\n* MachineSizes - A list of machine size IDs along with the machine size \n  names and detailed descriptions\n\n* Locations - A list of location IDs along with their country, region, \n  and data center.\n\n* Networks - A list of available Network IDs along with the network name,\n  location ID, network kind, and host usage (Required, Default, Optional)\n\n* MachineInventory - Information about the available inventory of machines \n  based on location ID and machine size ID.  While this information may \n  change rapidly, it can be used by GUIs and systems to restrict host\n  creates to locations with the desired machine size.\n\n* StorageInventory - Information about the current available storage capacity \n  for a specific volume flavor by site. \n\n* VolumeFlavors - A list of volume flavor IDs along with their name and \n  detailed description.\n\n* Volumes - A list of current, existing volumes.  If the volume is in the\n  the right state, it could be attached to a new Host.\n","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableResources"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes":{"get":{"tags":["volumes"],"summary":"List all volumes in project","description":"Returns an array of all volumes defined within the project.","operationId":"Volumes_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Volume"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["volumes"],"summary":"Add a new volume","description":"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.\n","operationId":"Volume_add","requestBody":{"required":true,"description":"Volume that is to be added to the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewVolume"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes/{volumeId}":{"summary":"Operations on a single volume","get":{"tags":["volumes"],"summary":"Retrieve volume by ID","description":"Returns a single volume with matching ID","operationId":"Volume_getByID","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["volumes"],"summary":"Update an existing volume","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. \n","operationId":"Volume_update","requestBody":{"required":true,"description":"Volume object with its ID and Capacity in GiB indicating the expanded size to be specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["volumes"],"summary":"Delete a volume","description":"Deletes the volume with the matching ID","operationId":"Volume_delete","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes/{volumeId}/attach":{"post":{"tags":["volumes"],"summary":"Attach existing volume to Host","description":"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.\n","operationId":"Volume_attach","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to attach","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Unique ID of the Host to which the volume will be attached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachHostUUID"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachment"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes/{volumeId}/detach":{"post":{"tags":["volumes"],"summary":"Detach existing volume from Host","description":"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.\nNote 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.\n","operationId":"Volume_detach","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to attach","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Unique ID of the Host from which a volume will be detached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachHostUUID"}}}},"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volume-attachments":{"get":{"tags":["volume-attachments"],"summary":"List all volume attachments in project","description":"Returns an array of all VolumeAttachments defined within the project.","operationId":"VolumeAttachments_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolumeAttachment"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["volume-attachments"],"summary":"Create a new VolumeAttachment","description":"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.","operationId":"VolumeAttachments_add","requestBody":{"required":true,"description":"NewVolumeAttachement parameters to create a new VolumeAttachment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewVolumeAttachment"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachment"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volume-attachments/{attachmentId}":{"summary":"Operations on a single volume attachment","get":{"tags":["volume-attachments"],"summary":"Retrieve volume attachment by ID","description":"Returns a single volume attachment with matching ID","operationId":"VolumeAttachment_getByID","parameters":[{"name":"attachmentId","in":"path","description":"ID of volume attachment to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachment"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["volume-attachments"],"summary":"Delete a VolumeAttachment","description":"Deletes the VolumeAttachment with the matching ID","operationId":"VolumeAttachment_delete","parameters":[{"name":"attachmentId","in":"path","description":"ID of VolumeAttachment to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/networks":{"get":{"tags":["networks"],"summary":"List all networks in project","description":"Returns an array of all network objects defined within the project.","operationId":"Networks_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["networks"],"summary":"Add a new network","description":"Adds a new network that can be referenced when creating a Host","operationId":"Network_add","requestBody":{"required":true,"description":"Network that is to be added to the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewNetwork"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/networks/{networkId}":{"summary":"Operations on a single network","get":{"tags":["networks"],"summary":"Retrieve network by ID","description":"Returns a single network with matching ID","operationId":"Network_getByID","parameters":[{"name":"networkId","in":"path","description":"ID of network to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["networks"],"summary":"Update an existing network.","description":"","operationId":"Network_update","parameters":[{"name":"networkId","in":"path","description":"ID of network to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Updated network","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["networks"],"summary":"Delete a network","description":"Deletes the network with the matching ID","operationId":"Network_delete","parameters":[{"name":"networkId","in":"path","description":"ID of network to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/usage-reports":{"get":{"tags":["usage-reports"],"summary":"Get a usage report","description":"Creates and returns a usage report based on the parameters passed in the request body\n","operationId":"UsageReport_get","parameters":[{"in":"query","name":"start","required":true,"schema":{"type":"string"},"description":"Start of the billing period"},{"in":"query","name":"end","required":false,"schema":{"type":"string"},"description":"End of the billing period, default to now if omitted"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageReport"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools":{"get":{"tags":["ippools"],"summary":"List all ip pools in project","description":"Returns an array of all ip pool objects defined within the project.","operationId":"IPPool_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPPool"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools/{ippoolId}":{"summary":"Operations on a single IP pool","get":{"tags":["ippools"],"summary":"Retrieve IP pool by ID","description":"Returns a single ip pool with matching ID","operationId":"IPPool_getByID","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"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.","operationId":"IPPool_update","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Update IPPool","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools/{ippoolId}/allocation":{"summary":"Operations on a single IP pool","post":{"tags":["ippools"],"summary":"Allocate IPs from the pool","description":"Allocate IPs from the pool","operationId":"IPPool_allocateIPs","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to allocate IPs","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"IPs being requested starting from an optional base IP and their usage","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPAllocation"}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools/{ippoolId}/return":{"summary":"Operations on a single IP pool","post":{"tags":["ippools"],"summary":"Return IPs to the pool","description":"Return IPs to the pool","operationId":"IPPool_returnIPs","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to return IPs","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"IP returned to the pool","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"15.0.0.1"}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/allocation/servers":{"get":{"tags":["allocation"],"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.\nWhen 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.\nIf the 'siteID' query parameter is present, the information returned is specific to that site ID.\n","operationId":"allocation_getBySite","parameters":[{"name":"siteID","in":"query","description":"site ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Allocation"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/allocation/storage":{"get":{"tags":["allocation"],"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.\nWhen 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.\nIf the 'siteID' query parameter is present, the information returned is specific to that site ID.\n","operationId":"allocation_storage_getBySite","parameters":[{"name":"siteID","in":"query","description":"site ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AllocationStorage"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}},"components":{"securitySchemes":{"BearerAuth":{"description":"Uses JWT as a bearer token to validate access","type":"http","scheme":"bearer","bearerFormat":"JWT"},"Project":{"description":"The project ID. Required only when using GreenLake IAM issued JWT for authentication","type":"apiKey","in":"header","name":"Project"},"Membership":{"description":"The Metal membership ID. Required only when using Metal service issued JWT for authentication","type":"apiKey","in":"header","name":"Membership"}},"schemas":{"Version":{"type":"object","properties":{"Build":{"type":"string","example":"0.8.6-dev-218-g0b3b1ad"}}},"ErrorResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Description of the error condition"},"details":{"type":"string","description":"Optional verbose description of the error condition"}}},"ResourceBase":{"type":"object","required":["ID","ETag","Name"],"properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for the resource instance as generated by the Metal service"},"ETag":{"type":"string","format":"uuid","description":"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."},"Name":{"type":"string","example":"My Object Name","description":"Common name for the resource instance. Must be 128 or fewer printable characters"},"Created":{"type":"string","format":"date-time","example":"2019-06-27T22:59:01.661Z","description":"Time when the resource was created in the database"},"Modified":{"type":"string","format":"date-time","example":"2020-02-27T18:28:02.863Z","description":"Time when the resource was last modified in the database"}}},"Profile":{"type":"object","properties":{"TeamName":{"type":"string","description":"Name of the Project Team. Must not be empty, maximum 128 printable characters"},"TeamDesc":{"type":"string","description":"Optional description of the Project Team, maximum 256 printable characters"},"Company":{"type":"string","description":"Optional name of the company, maximum 256 printable characters"},"Address":{"type":"string","description":"Optional address of the company, maximum 256 printable characters"},"Email":{"type":"string","description":"Optional email address of the contact person for the team, maximum 256 printable characters"},"EmailVerified":{"type":"boolean","description":"Currently always false"},"PhoneNumber":{"type":"string","description":"Optional phone number of the contact person for the team, maximum 32 printable characters"},"PhoneVerified":{"type":"boolean","description":"Currently always false"}}},"Limits":{"type":"object","required":["Hosts","Volumes","VolumeCapacity","PrivateNetworks"],"properties":{"Hosts":{"type":"integer","description":"Maximum number of hosts to allow","minimum":0},"Volumes":{"type":"integer","description":"Maximum number of volumes to allow","minimum":0},"VolumeCapacity":{"type":"integer","format":"int64","description":"Maximum capacity to allow in TiB","minimum":0},"PrivateNetworks":{"type":"integer","description":"Maximum number of private networks to allow","minimum":0},"InstanceTypes":{"type":"object","additionalProperties":{"type":"integer"},"description":"Map of instance type ID to maximum number of hosts that can be created with that instance type","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee90":1}}}},"ProjectResources":{"type":"object","properties":{"Hosts":{"type":"integer","description":"Number of hosts in use","minimum":0},"Volumes":{"type":"integer","description":"Number of volumes in use","minimum":0},"VolumeCapacity":{"type":"integer","format":"int64","description":"Volume capacity in use in TiB","minimum":0},"PrivateNetworks":{"type":"integer","description":"Number of private networks in use","minimum":0},"InstanceTypes":{"type":"object","additionalProperties":{"type":"integer"},"description":"Number of hosts with the instance type in use","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee90":1}}}},"Project":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Profile","Limits"],"properties":{"Profile":{"description":"Profile is a generalized description of a team","$ref":"#/components/schemas/Profile"},"Limits":{"description":"Project Limits place general constraints on a project in terms of server and storage","$ref":"#/components/schemas/Limits"},"Resources":{"description":"Project resources provides resources currently utilized by the project","$ref":"#/components/schemas/ProjectResources"},"PermittedSites":{"description":"Array listing the permitted site IDs","type":"array","items":{"type":"string","format":"uuid"},"example":["046b6c7f-0b8a-43b9-b35d-6489e6daee91","91eec8b5-6460-4532-aad1-47b983edb63c"]}}}]},"NewProject":{"type":"object","required":["Name","Profile","Limits"],"properties":{"Name":{"type":"string","example":"Project foobar"},"Profile":{"description":"Profile is a generalized description of a team","$ref":"#/components/schemas/Profile"},"Limits":{"description":"Project Limits place general constraints on a project in terms of server and storage","$ref":"#/components/schemas/Limits"},"PermittedSites":{"description":"Array listing the permitted site IDs","type":"array","items":{"type":"string","format":"uuid"},"example":["046b6c7f-0b8a-43b9-b35d-6489e6daee91","91eec8b5-6460-4532-aad1-47b983edb63c"]}}},"HealthStatus":{"type":"string","enum":["OK","Warning","Critical","Unknown"]},"Country":{"type":"string","enum":["USA","AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","KHM","CMR","CAN","CPV","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MKD","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWZ","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE"]},"LocationInfo":{"type":"object","description":"Entry on data center with its location ID and country, region, and data center description strings","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for data center location"},"Country":{"$ref":"#/components/schemas/Country"},"Region":{"type":"string","example":"Central","description":"Region within the indicated country"},"DataCenter":{"type":"string","example":"FTC1","description":"Data center descriptor"}}},"ProjectInfo":{"type":"object","properties":{"ID":{"type":"string"},"Name":{"type":"string"},"Description":{"type":"string"},"NumHosts":{"type":"integer"},"NumVolumes":{"type":"integer"},"TotalStorageGB":{"type":"integer"},"Status":{"type":"string","enum":["Enabled","Disabled"]},"NumNetworks":{"type":"integer","description":"Number of project networks"},"SummaryStatus":{"$ref":"#/components/schemas/HealthStatus","description":"Project health status"},"Locations":{"type":"array","items":{"$ref":"#/components/schemas/LocationInfo"},"description":"Locations where project resources exist"}}},"MachineSizeInfo":{"type":"object","properties":{"Name":{"type":"string"},"ProjectsUsed":{"type":"integer"},"OtherUsed":{"type":"integer"},"Available":{"type":"integer"},"ID":{"type":"string","format":"uuid"},"Restricted":{"type":"boolean","description":"True if the usage of this machine size is restricted  to selected projects, false if the machine size is available to anyone.\n"}}},"VolumeFlavorsInfo":{"type":"object","properties":{"Name":{"type":"string"},"ProjectsUsed":{"type":"integer"},"OtherUsed":{"type":"integer"},"Available":{"type":"integer"}}},"SummaryInfo":{"type":"object","properties":{"Locations":{"type":"array","items":{"$ref":"#/components/schemas/LocationInfo"},"description":"Locations where resources exist for all listed projects"},"NumHosts":{"type":"integer","description":"Number of hosts for all listed projects"},"NumVolumes":{"type":"integer","description":"Number of volumes for all listed projects"},"TotalStorageGB":{"type":"integer","description":"Total storage for all listed projects"},"NumOK":{"type":"integer","description":"Number of projects with OK health summary status"},"NumWarning":{"type":"integer","description":"Number of projects with Warning health summary status"},"NumCritical":{"type":"integer","description":"Number of projects with Critical health summary status"},"NumUnknown":{"type":"integer","description":"Number of projects with Unknown health summary status"}}},"ProjectsInfo":{"type":"object","properties":{"Projects":{"type":"array","items":{"$ref":"#/components/schemas/ProjectInfo"}},"MachineSizes":{"type":"array","items":{"$ref":"#/components/schemas/MachineSizeInfo"}},"VolumeFlavors":{"type":"array","items":{"$ref":"#/components/schemas/VolumeFlavorsInfo"}},"Summary":{"$ref":"#/components/schemas/SummaryInfo","description":"Aggregate consumption and health counts of projects at the specified locations"}}},"SSHKeyValue":{"type":"string","description":"SSH key value","example":"'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"},"SSHKey":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Key"],"properties":{"Key":{"$ref":"#/components/schemas/SSHKeyValue"}}}]},"NewSSHKey":{"type":"object","required":["Name","Key"],"properties":{"Name":{"type":"string","example":"Joe's Laptop"},"Key":{"$ref":"#/components/schemas/SSHKeyValue"}}},"HostISCSIConfig":{"type":"object","nullable":true,"required":["InitiatorName"],"properties":{"InitiatorName":{"type":"string","description":"Fully qualified iSCSI intiator name of this host. This is generated when a host is created and the information is pushed to the new host\n"},"CHAPSecret":{"type":"string","description":"CHAP secret as generated by the system when attaching a volume.   Visible in VolumeAttachment object.\n"},"CHAPUser":{"type":"string","description":"CHAP user as generated by the system when attaching a volume.   Visible in VolumeAttachment object.\n"},"ISCSIDiscoveryAddress":{"type":"string"}}},"HostServerPort":{"type":"object","properties":{"Name":{"type":"string","description":"Server port name","example":"lan5"},"HWAddr":{"type":"string","description":"Hardware address for the Ethernet interface (MAC)","example":"5c:b9:01:95:64:a0"}}},"HostNetworkConnection":{"type":"object","properties":{"Name":{"type":"string","description":"Name of the network connection","example":"HostConn1"},"NetworkID":{"type":"string","format":"uuid","description":"Unique ID corresponding to a network in the local data center"},"IP":{"type":"string","description":"IP address for the network connection","example":"10.5.3.4"},"Subnet":{"type":"string","description":"The IP subnet address","example":"10.5.3.0"},"Netmask":{"type":"string","example":"/24","enum":["/8","/9","/10","/11","/12","/13","/14","/15","/16","/17","/18","/19","/20","/21","/22","/23","/24","/25","/26","/27","/28","/29","/30","/31"]},"Gateway":{"type":"string","description":"The IP subnet gateway address","example":"10.5.3.1"},"DNS":{"type":"array","items":{"type":"string","example":"8.8.8.8"},"description":"List of DNS servers for the IP subnet"},"VLAN":{"type":"integer","description":"VLAN ID of the network"},"VNI":{"type":"integer","description":"VNI ID of the network"},"Untagged":{"type":"boolean","description":"True if the network is untagged"},"Proxy":{"type":"string","example":"http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080","description":"Optional web-proxy for external internet access should the IP subnet actually be behind a firewall"},"NoProxy":{"type":"string","example":"localhost,15.10.0.10,test.com","description":"Addresses or CIDRs for which proxy requests are not made"}}},"HostConnection":{"type":"object","properties":{"Name":{"type":"string","example":"Default"},"Ports":{"type":"array","items":{"$ref":"#/components/schemas/HostServerPort"}},"HA":{"type":"boolean","description":"Indicates whether the network connection should be a link aggregation group (LAG)"},"Speed":{"type":"string","enum":["100Mb","1Gb","10Gb","25Gb","50Gb","40Gb","100Gb"],"description":"The speed of the physical connection from the server to the top of rack switch","example":"1Gb"},"Networks":{"type":"array","items":{"$ref":"#/components/schemas/HostNetworkConnection"}}}},"HostPowerState":{"type":"string","enum":["ON","OFF","UNKNOWN"],"description":"Current power status of the underlaying physical server (machine)"},"HostState":{"type":"string","enum":["New","Deleting","Deleted","Failed","Updating Connections","Imaging","Connecting","Booting","Ready","Replacing","Releasing","Allocating","Maintenance"],"description":"Overall host state","example":"Ready"},"HostSubstate":{"type":"string","description":"Host substate within HostState","enum":["","Abort Deploy","Allocate","Attach Volumes","Boot Service-OS","Clear Log","Complete","Confirm Off","Confirm On","Connect","Connect Provisioning","Deploy","Detach Volumes","Error Recovery","Fail Cleanup","Failed","Init","Init Off","Isolate","In Maintenance","Power Off","Power On","Release","Release With Problem","Set Boot Disk","Snap Log","Update"],"example":"Complete"},"HostAlertInfo":{"type":"object","properties":{"Alert":{"type":"string","enum":["substate-timed-out","op-failed","vol-att-warning","unknown-state"],"description":"Identifies the type of alert","example":"op-failed"},"State":{"$ref":"#/components/schemas/HostState"},"Substate":{"$ref":"#/components/schemas/HostSubstate"},"Message":{"type":"string","description":"Provides some detailed description about the Alert","example":"Operation XXX completed as failed with status: YYY"},"Time":{"type":"string","format":"date-time"},"Ack":{"type":"boolean","description":"Used to acknowledge the alert so that the UI can list only unacknowledged alerts"}}},"Host":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Description","NetworkIDs","NetworkForDefaultRoute","NetworkUntagged"],"properties":{"Description":{"type":"string","example":"Description of Host"},"ServiceID":{"type":"string","format":"uuid","description":"The image service identifier used to image the server. ServiceID is one of those listed by the Images array returned as part of the get /available-resources call."},"ServiceFlavor":{"type":"string","example":"ubuntu","description":"Overall flavor of server image used to image the server"},"ServiceVersion":{"type":"string","example":"18.04-20190807","description":"Version of the ServiceFlavor used to image the server"},"LocationID":{"type":"string","format":"uuid","description":"The location of the machine assigned to the host.  LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call."},"MachineSizeName":{"type":"string","example":"HPE Large","description":"Name of the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call."},"MachineSizeID":{"type":"string","format":"uuid","description":"UniqueID referring to the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call."},"MachineID":{"type":"string","format":"uuid","description":"UniqueID referring to the machine on which this host is running."},"SSHKeyIDs":{"type":"array","description":"IDs of SSH Keys used when configuring the Host","items":{"type":"string","format":"uuid"}},"SSHAuthorizedKeys":{"type":"array","description":"Specific SSH keys that were when configuring the host.","items":{"$ref":"#/components/schemas/SSHKeyValue"}},"NetworkIDs":{"type":"array","description":"The list of IDs corresponding to the networks that were provisioned to the host. These networks are among those listed in the Networks array returned by the get /available-resources call.","items":{"type":"string","format":"uuid"},"example":["046b6c7f-0b8a-43b9-b35d-6489e6daee91","91eec8b5-6460-4532-aad1-47b983edb63c"]},"NetworkForDefaultRoute":{"type":"string","format":"uuid","description":"The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee91"},"NetworkUntagged":{"type":"string","format":"uuid","description":"ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee92"},"PreAllocatedIPs":{"type":"array","description":"The list of pre-allocated IP addresses corresponding to the list of NetworkIDs. Pre-allocated IP addresses are optional, but required when updating a host containing Pre-allocated IP addresses.","items":{"type":"string"}},"ServiceNetsProviderMAC":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee91":"a2:c8:93:15:2a:76"}},"UserData":{"type":"string","description":"User-provided data attached to the image configuration data when the host was provisioned"},"NodeID":{"type":"string","example":"Node21","description":"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."},"ISCSIConfig":{"$ref":"#/components/schemas/HostISCSIConfig"},"Connections":{"type":"array","description":"Details describing host network connections","items":{"$ref":"#/components/schemas/HostConnection"}},"Deleted":{"type":"boolean","description":"True if the Host has been deleted."},"PortalCommOkay":{"type":"boolean","description":"Describes if the portal is in active communication to the device"},"PowerStatus":{"$ref":"#/components/schemas/HostPowerState"},"State":{"$ref":"#/components/schemas/HostState"},"Substate":{"$ref":"#/components/schemas/HostSubstate"},"StateTime":{"type":"string","format":"date-time"},"SubstateTime":{"type":"string","format":"date-time"},"Progress":{"type":"integer","format":"int64","minimum":0,"maximum":100},"Alert":{"type":"boolean"},"AlertInfo":{"type":"array","items":{"$ref":"#/components/schemas/HostAlertInfo"}},"Workflow":{"type":"string","description":"The current workflow the host is in"},"SummaryStatus":{"$ref":"#/components/schemas/HealthStatus","description":"Host health summary status"},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for the host.","example":{"serviceType":"BMaaS"}}}}]},"AddVolume":{"type":"object","properties":{"Name":{"type":"string","example":"NewVolumeName"},"Description":{"type":"string","example":"Description of New Volume"},"FlavorID":{"type":"string","format":"uuid","description":"This object is used for new volume creation in the host create operation. Since host create already has location ID that field is not provided in this object."},"Capacity":{"type":"integer","format":"int64","example":10,"minimum":0,"description":"The size of the volume in GiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"}}},"NewHost":{"type":"object","required":["Name","ServiceID","LocationID","MachineSizeID","SSHKeyIDs","NetworkIDs","NetworkForDefaultRoute"],"properties":{"Name":{"type":"string","example":"NewHostName","description":"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":{"type":"string","example":"Description of new Host"},"ServiceID":{"type":"string","format":"uuid","description":"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":{"type":"string","format":"uuid","description":"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.\nThe location ID must also be one that has sufficient inventory for the selected MachineSize.  See the MachineInventory array as returned by the get /available-resources call to select a location that has machines available with the correct machine size."},"MachineSizeID":{"type":"string","format":"uuid","description":"The machine size ID must be one of those listed in the MachineSizes array returned as part of the get /available-resources call.  This array provides the name and detailed description for each machine size.  Use the MachineInventory array provided by the get /available-resources call to find a location with an adequate inventory of machines with the desired machine size."},"MachineID":{"type":"string","format":"uuid","description":"The machine ID is normally not used."},"SSHKeyIDs":{"type":"array","description":"These IDs must correspond to the IDs for SSH keys already created within the context of the project.  These SSH keys and those included as SSHAuthorizedKeys will be used together to provision SSH keys when the machine is imaged.","items":{"type":"string","format":"uuid"}},"NetworkIDs":{"type":"array","description":"The list of IDs corresponding to the networks that will be provisioned to the host. These networks must be among those listed in the Networks array returned by the get /available-resources call.  This list must include the ID for any network identified by the HostUseEnum as Required.","items":{"type":"string","format":"uuid"}},"PreAllocatedIPs":{"type":"array","description":"A list of pre-allocated IP addresses to be used for corresponding networks. This array of IP addresses, if present, is in one-to-one correspondence with Networks.","items":{"type":"string"},"example":["10.0.0.4","10.0.0.8"]},"NetworkForDefaultRoute":{"type":"string","format":"uuid","description":"The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee91"},"NetworkUntagged":{"type":"string","format":"uuid","description":"ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee92"},"VolumeIDs":{"description":"The list of IDs corresponding to existing, unattached volumes that should be attached to the new host.  The volume must be one of those listed in the Volumes array returned by the get /available-resources call.  In addition, the volume must be in the visible state and not a part of any current VolumeAttachment (see get volume-attachments)","type":"array","items":{"type":"string","format":"uuid"}},"ServiceNetsProviderMAC":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee91":"a2:c8:93:15:2a:76"}},"NewVolumes":{"type":"array","description":"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","items":{"$ref":"#/components/schemas/AddVolume"}},"UserData":{"type":"string","description":"User-provided data to be attached to the image configuration data."},"NodeID":{"type":"string","example":"Node21","description":"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."},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for this host.","example":{"serviceType":"BMaaS"}}}},"AvailableImage":{"type":"object","description":"Entry describing an available imaging service","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for imaging service"},"Category":{"type":"string","example":"Linux","description":"Top-level grouping of imaging services that may reference an OS or application type"},"Flavor":{"type":"string","example":"ubuntu","description":"Second-level grouping of imaging services.  Typically references a specific OS or application."},"Version":{"type":"string","example":"18.04","description":"Specific version of a imaging service flavor."},"Description":{"type":"string","example":"ubuntu OS also including Docker runtime","description":"Additional image information for additional services added to the OS"}}},"LocationID":{"type":"string","format":"uuid","description":"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."},"NetworkHostUse":{"type":"string","enum":["Required","Default","Optional"],"example":"Default","description":"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.\n"},"NetworkPurpose":{"type":"string","enum":["Backup","Storage","vmKernel","vmNSX-T","vMotion","vCHA","vmFT","iSCSI-A","iSCSI-B","Telemetry"],"example":"Storage","description":"Indicates the purpose of the network.\n"},"AvailableNetwork":{"type":"object","description":"Entry of a network available within a data center location","properties":{"ID":{"type":"string","format":"uuid","description":"ID of the network"},"Name":{"type":"string","example":"Private","description":"The name of the network"},"LocationID":{"$ref":"#/components/schemas/LocationID"},"Description":{"type":"string","example":"Private network for intra-cluster communication"},"HostUse":{"$ref":"#/components/schemas/NetworkHostUse"},"Purpose":{"$ref":"#/components/schemas/NetworkPurpose"},"IPPoolID":{"type":"string"}}},"FlavorDesc":{"type":"object","description":"Describes the details of machine size or volume flavor","properties":{"Collection":{"type":"string","description":"Groups flavors together to make finding a specific flavor easier","example":"Collection1"},"Banner1":{"type":"string","example":"Banner1 value"},"Banner2":{"type":"string","example":"Banner2 value"},"Bullets":{"type":"array","items":{"type":"string"}},"InfoLink":{"type":"string","description":"URI to more information about the specific machine size or volume flavor"},"Tooltip":{"type":"string","description":"Supplemental tooltip text to use in GUIs"}}},"MachineSize":{"type":"object","description":"Description of a specific machine size offering","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for the machine size offering"},"Name":{"type":"string","example":"HPE-Large","description":"Typical user-visible name for a machine size offering"},"Details":{"$ref":"#/components/schemas/FlavorDesc"}}},"VolumeFlavor":{"type":"object","description":"Description of a specific volume flavor offering.  A volume flavor will typically refer to a specific level of performance and durability as defined in the Details\n","properties":{"ID":{"type":"string","format":"uuid","description":"Volume flavor unique ID"},"Name":{"type":"string","example":"HighPerfFlash","description":"Typical user-visible name for a volume flavor"},"Details":{"$ref":"#/components/schemas/FlavorDesc"}}},"VolumeState":{"description":"Current volume state expressed as a string enum value (new, allocating, allocated, visible, deleting, deleted, failed)","type":"string","enum":["new","allocating","allocated","visible","deleting","deleted","failed"]},"VolumeStatus":{"description":"Current volume status expressed as a string enum values (ok, error, degraded)","type":"string","enum":["ok","error","degraded"]},"VolumeInfo":{"type":"object","description":"Description of the details about a pre-existing volume","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for the volume.  Referenced if the volume is to be attached to a new Host\n"},"Name":{"type":"string","example":"MyVolume","description":"User-provided name for the volume"},"Description":{"type":"string","description":"User-provided description of the volume"},"FlavorID":{"type":"string","format":"uuid","description":"The ID of the volume flavor requested when creating the volume"},"Capacity":{"type":"integer","format":"int64","minimum":0,"description":"The size of the volume in KiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"},"LocationID":{"type":"string","format":"uuid","description":"The location ID of the data center where the volume exists"},"DiscoveryIP":{"type":"string","description":"The discovery IP for the iSCSI volume"},"TargetIQN":{"type":"string","description":"The target IQN for the iSCSI volume"},"State":{"$ref":"#/components/schemas/VolumeState"},"Status":{"$ref":"#/components/schemas/VolumeStatus"}}},"MachineInventory":{"type":"object","description":"An entry describing the number of machines of a particular machine size at a specific location","properties":{"LocationID":{"type":"string","format":"uuid","description":"Unique ID of the data center location"},"SizeID":{"type":"string","format":"uuid","description":"ID of a MachineSize as listed in the MachineSizes array"},"Number":{"type":"integer","minimum":0,"description":"The number of machines in inventory with indicated machine size at the indicated location"}}},"StorageInventory":{"description":"An entry describing the amount of storage available to create volumes of a specific flavor","type":"object","properties":{"FlavorID":{"type":"string","format":"uuid","description":"Unique ID of a volume flavor as listed in the the VolumeFlavors array"},"LocationID":{"type":"string","format":"uuid","description":"Unique ID of a data center location"},"Capacity":{"type":"integer","format":"int64","description":"Total capacity available (in GiB) to create new volumes of the indicated flavor at the indicated location"}}},"SSHKeyEntry":{"type":"object","description":"An entry listing an SSH key that is available for use when creating HostState","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID of the SSH key entry"},"Name":{"type":"string","example":"ExampleKey","description":"Name or description of the stored SSH key"},"Key":{"$ref":"#/components/schemas/SSHKeyValue"}}},"AvailableResources":{"type":"object","properties":{"Images":{"type":"array","description":"Array listing the available host imaging services","items":{"$ref":"#/components/schemas/AvailableImage"}},"Locations":{"type":"array","description":"Array listing the data center locations with available resources","items":{"$ref":"#/components/schemas/LocationInfo"}},"Networks":{"type":"array","description":"Array listing the networks available for host connections","items":{"$ref":"#/components/schemas/AvailableNetwork"}},"MachineSizes":{"type":"array","description":"Array listing the available machine (server) sizes","items":{"$ref":"#/components/schemas/MachineSize"}},"VolumeFlavors":{"type":"array","description":"Array listing the available volume flavors","items":{"$ref":"#/components/schemas/VolumeFlavor"}},"Volumes":{"type":"array","description":"Array listing the existing project volumes that could be attached to a host","items":{"$ref":"#/components/schemas/VolumeInfo"}},"MachineInventory":{"type":"array","description":"Array listing the number of machines of each size in each location","items":{"$ref":"#/components/schemas/MachineInventory"}},"StorageInventory":{"type":"array","description":"Array providing information on the amount of available storage of each flavor in each location","items":{"$ref":"#/components/schemas/StorageInventory"}},"SSHKeys":{"type":"array","description":"Array listing pre-defined SSH keys that could be referenced when creating a Host","items":{"$ref":"#/components/schemas/SSHKeyEntry"}}}},"VolumeSubState":{"description":"Current update state of volume expressed as a string enum value (idle, update-requested, updating)","type":"string","enum":["idle","update-requested","updating"]},"Volume":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","properties":{"Description":{"type":"string","example":"Description of New Volume"},"FlavorID":{"type":"string","format":"uuid","description":"The VolumeFlavorID matching an entry in the VolumeFlavors array returned as part of the get /available-resources call"},"Capacity":{"type":"integer","format":"int64","example":10485760,"minimum":0,"description":"The size of the volume in KiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"},"LocationID":{"type":"string","format":"uuid","description":"The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host."},"State":{"$ref":"#/components/schemas/VolumeState"},"SubState":{"$ref":"#/components/schemas/VolumeSubState"},"Status":{"$ref":"#/components/schemas/VolumeStatus"},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for the volume.","example":{"serviceType":"BMaaS"}},"WWN":{"type":"string","description":"Serial number of the volume."}}}]},"NewVolume":{"type":"object","required":["Name","FlavorID","Capacity","LocationID"],"properties":{"Name":{"type":"string","example":"NewVolumeName"},"Description":{"type":"string","example":"Description of New Volume"},"FlavorID":{"type":"string","format":"uuid","description":"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":{"type":"integer","format":"int64","example":10,"minimum":0,"description":"The size of the volume in GiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"},"LocationID":{"type":"string","format":"uuid","description":"The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host."},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for this volume.","example":{"serviceType":"BMaaS"}}}},"VolumeAttachHostUUID":{"type":"object","required":["HostID"],"properties":{"HostID":{"type":"string","format":"uuid","description":"Unique ID of the Host to attach or detach volume"}}},"VaStateEnum":{"description":"Current volume attachment state expressed as a string enum value (new, exporting, attaching, ready, detaching, unexporting, deleted, failed)","type":"string","enum":["new","exporting","attaching","ready","detaching","unexporting","deleted","failed"]},"VAFSConfig":{"type":"object","properties":{"StorageID":{"type":"string","description":"Storage identifier for an array or a SDS"},"UserName":{"type":"string","description":"Storage array or SDS user"},"Ticket":{"type":"string","description":"SDS token acquired by login into the SDS for a given user. This is required by the FUSE client to mount volumes on host."},"TicketExpiryTime":{"type":"string","description":"Ticket expiry time to help client to refresh the ticket."}}},"VolumeAttachment":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","properties":{"VolumeID":{"type":"string","format":"uuid","description":"Unique ID of the volume attached to the host"},"HostID":{"type":"string","format":"uuid","description":"Unique ID of the host connected to the volume"},"HostIPAddress":{"type":"string","format":"ipv4","description":"Host IP address for the network connection that connects to the storage array"},"IQN":{"type":"string","description":"IQN is the full initiator name used for identification during iSCSI login","example":"iqn.yyyy-mm.naming-authority:unique name"},"CHAPSecret":{"type":"string","description":"CHAPSecret is the Challenge Authentication Protocol secret to be shared between array and initiator."},"CHAPUserName":{"type":"string","description":"CHAPUserName is the CHAP username to use for CHAP authentication"},"LUN":{"type":"integer","description":"LUN is the Logical Unit Number to be assigned to the volume on export"},"VolumeTargetIQN":{"type":"string","example":"iqn.yyyy-mm.naming-authority:unique name","description":"VolumeTargetIQN is the iQN for the volume, assigned by the array corresponding to the volume"},"VolumeTargetIPAddress":{"type":"string","format":"ipv4","description":"VolumeTargetIPAddress is the IPV4 address of the iSCSI volume export"},"State":{"$ref":"#/components/schemas/VaStateEnum"},"FSConfig":{"description":"File share specific configuration parameters","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/VAFSConfig"}]}}}]},"ProtocolKind":{"description":"The protocol to be used to attach the volume","type":"string","enum":["unknown","iscsi"]},"ISCSIParameters":{"type":"object","required":["HostIPAddress","InitiatorName"],"properties":{"HostIPAddress":{"type":"string","description":"The IP address of the host in dotted notation.","example":"10.1.2.3"},"InitiatorName":{"type":"string","description":"The full initiator name to be created. The name must be at least 12 characters in length and begin with \"iqn.\".","example":"iqn.1234.com.hpe-initiator"},"CHAPSecret":{"type":"string","description":"CHAPSecret is the Challenge Authentication Protocol secret to be shared between array and initiator. If empty, no CHAP login is enabled; if set it must be a string between 12 and 16 characters."},"CHAPUserName":{"type":"string","description":"CHAPUserName is the CHAP username to use for CHAP authentication. If CHAPSecret is specified, CHAPUserName must also be specified."}}},"ProtocolParameters":{"type":"object","properties":{"Protocol":{"$ref":"#/components/schemas/ProtocolKind"},"ISCSI":{"$ref":"#/components/schemas/ISCSIParameters","description":"The ISCSI parameters for this attachment. This value must be specified if Protocol is iscsi"}}},"NewVolumeAttachment":{"type":"object","required":["VolumeID","Protocol"],"properties":{"Name":{"type":"string","example":"My Object Name","description":"Name for the volume attachment. Must be 128 or fewer printable characters"},"VolumeID":{"type":"string","format":"uuid","description":"Unique ID of the volume attached to the host"},"Protocol":{"$ref":"#/components/schemas/ProtocolParameters"}}},"Network":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","properties":{"LocationID":{"$ref":"#/components/schemas/LocationID"},"Description":{"type":"string","example":"Private network for intra-cluster communication"},"HostUse":{"$ref":"#/components/schemas/NetworkHostUse"},"Purpose":{"$ref":"#/components/schemas/NetworkPurpose"},"IPPoolID":{"type":"string"},"VLAN":{"type":"integer","description":"VLAN ID of the network"},"VNI":{"type":"integer","description":"VNI ID of the network"}}}]},"IPVer":{"type":"string","enum":["IPv4","IPv6"],"example":"IPv4","description":"Describes the IP version\n"},"Netmask":{"type":"string","enum":["/8","/9","/10","/11","/12","/13","/14","/15","/16","/17","/18","/19","/20","/21","/22","/23","/24","/25","/26","/27","/28","/29","/30","/31","/104","/105","/106","/107","/108","/109","/110","/111","/112","/113","/114","/115","/116","/117","/118","/119","/120","/121","/122","/123","/124","/125","/126","/127"]},"IPSource":{"type":"object","properties":{"Base":{"type":"string","example":"10.128.0.2","description":"Base address for the IP source"},"Count":{"type":"integer","example":1,"description":"Number of IPs to count from the base"}}},"NewIPPool":{"type":"object","nullable":true,"required":["IPVersion","BaseIP","Netmask"],"properties":{"Name":{"type":"string","description":"Name for the IP pool"},"Description":{"type":"string","description":"Description for the IP pool"},"IPVersion":{"$ref":"#/components/schemas/IPVer"},"BaseIP":{"type":"string","example":"10.128.0.0","description":"Base address of the IP pool"},"Netmask":{"$ref":"#/components/schemas/Netmask"},"DefaultRoute":{"type":"string","example":"10.128.0.1","description":"Default route associated with the IP pool"},"Sources":{"type":"array","items":{"$ref":"#/components/schemas/IPSource"}},"DNS":{"type":"array","items":{"type":"string","example":"8.8.8.8"},"description":"List of DNS servers for the IP pool"},"Proxy":{"type":"string","example":"http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080","description":"Optional web-proxy for external internet access should the pool actually be behind a firewall"},"NoProxy":{"type":"string","example":"localhost,15.10.0.10,test.com","description":"Addresses or CIDRs for which proxy requests are not made"},"NTP":{"type":"array","items":{"type":"string","example":"15.0.0.11"},"description":"List of NTP servers for the IP pool"}}},"NewNetwork":{"type":"object","required":["Name","LocationID"],"properties":{"Name":{"type":"string","description":"Name of the network","example":"Private2"},"LocationID":{"$ref":"#/components/schemas/LocationID"},"Description":{"type":"string","example":"Private network for intra-cluster communication"},"HostUse":{"$ref":"#/components/schemas/NetworkHostUse"},"Purpose":{"$ref":"#/components/schemas/NetworkPurpose"},"NewIPPool":{"$ref":"#/components/schemas/NewIPPool","description":"IP pool for the network. It is optional while creating new private network. If not specified, the network uses the default IP pool allocated from the  hoster/project IP Pool factory and if specified, a new custom IP Pool will  be created and used for IP allocations."}}},"UsageEntryBase":{"type":"object","properties":{"ProjectID":{"type":"string","format":"uuid","description":"Project ID that contained the host"},"LocationID":{"$ref":"#/components/schemas/LocationID"},"Allocated":{"type":"string","format":"date-time","description":"Timestamp of when resource (machine or storage) was allocated"},"Ready":{"type":"string","format":"date-time","description":"Timestamp of when resource (host or volume) was ready for use"},"Freed":{"type":"string","format":"date-time","description":"Timestamp of when resource (machine or storage) was freed"},"UsageStart":{"type":"string","format":"date-time","description":"The start of the usage reporting window or when the resource was allocated"},"UsageEnd":{"type":"string","format":"date-time","description":"The end of the usage reporting window or when the resource was freed"},"UsageHours":{"type":"integer","format":"int64","description":"The difference between the UsageEnd and UsageStart rounded up to the UsageHours"},"Error":{"type":"string","description":"Description of error that affected the usage reporting"}}},"HostUsageEntry":{"allOf":[{"$ref":"#/components/schemas/UsageEntryBase"},{"type":"object","properties":{"MachineSizeName":{"type":"string","example":"HPE-Large","description":"Name of the MachineSize requested when host was created"},"MachineSizeID":{"type":"string","format":"uuid","description":"Unique ID of the MachineSize requested when host was created"},"HostName":{"type":"string","description":"Name of the associated Host"},"HostID":{"type":"string","format":"uuid","description":"Unique ID of the associated Host"}}}]},"VolumeUsageEntry":{"allOf":[{"$ref":"#/components/schemas/UsageEntryBase"},{"type":"object","properties":{"VolumeName":{"type":"string","description":"Name of the volume"},"VolumeID":{"type":"string","format":"uuid","description":"Unique ID of the volume"},"FlavorName":{"type":"string","description":"Name of the volume flavor used when creating the volume"},"FlavorID":{"type":"string","format":"uuid","description":"Unique ID of the volume flavor used when creating the volume"},"Capacity":{"type":"integer","format":"int64","description":"The size of the volume in MB"}}}]},"UsageReport":{"type":"object","description":"The composite usage report","properties":{"Hosts":{"description":"list of Host usage entries for the report window","type":"array","items":{"$ref":"#/components/schemas/HostUsageEntry"}},"Volumes":{"description":"list of Volume usage entries for the report window","type":"array","items":{"$ref":"#/components/schemas/VolumeUsageEntry"}}}},"UseRecord":{"type":"object","properties":{"Base":{"type":"string","example":"10.128.0.2","description":"Address of the record"},"HostID":{"type":"string","format":"uuid","description":"Unique ID of the host associated with the record"},"RackID":{"type":"string","format":"uuid","description":"Unique ID of the rack associated with the record"},"DeviceID":{"type":"string","format":"uuid","description":"Unique ID of the device associated with the record"},"External":{"type":"boolean","example":true,"description":"Indicates if the record is used for non Metal scope"},"Usage":{"type":"string","description":"Usage of the record"},"AllocatedBy":{"type":"string","description":"User which performed the allocation of the record"}}},"IPRange":{"type":"object","properties":{"Base":{"type":"string","example":"10.128.0.2","description":"Base address for the IP range"},"Count":{"type":"integer","example":1,"description":"Number of IPs to count from the base"},"DefaultRoute":{"type":"string","example":"10.128.0.1","description":"Default route for the IP range"},"Netmask":{"$ref":"#/components/schemas/Netmask"},"SourceBase":{"type":"string","example":"10.128.0.0","description":"Base address of the Source the IPRange was allocated from"}}},"IPPoolStats":{"type":"object","properties":{"Total":{"type":"integer","format":"int32","description":"Total number of IPs (pool capacity)"},"Available":{"type":"integer","format":"int32","description":"Number of non allocated IPs"},"InUse":{"type":"integer","format":"int32","description":"Number of allocated IPs"}}},"Pool":{"type":"object","properties":{"Fragments":{"type":"array","items":{"$ref":"#/components/schemas/IPRange"},"description":"List of fragments for the IP pool"},"Stats":{"$ref":"#/components/schemas/IPPoolStats","description":"Statistics for the IP pool"}}},"IPPool":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Description","DefaultRoute","DNS","Proxy","NoProxy","NTP"],"properties":{"Description":{"type":"string","example":"Description of IP pool"},"IPVersion":{"$ref":"#/components/schemas/IPVer"},"NetworkID":{"type":"string","format":"uuid","description":"Unique ID of the network associated with the IP pool"},"BaseIP":{"type":"string","example":"10.128.0.0","description":"Base address of the IP pool"},"Netmask":{"$ref":"#/components/schemas/Netmask"},"DefaultRoute":{"type":"string","example":"10.128.0.1","description":"Default route associated with the IP pool"},"Sources":{"type":"array","items":{"$ref":"#/components/schemas/IPSource"}},"UseRecords":{"type":"array","items":{"$ref":"#/components/schemas/UseRecord"}},"DNS":{"type":"array","items":{"type":"string","example":"8.8.8.8"},"description":"List of DNS servers for the IP pool"},"Proxy":{"type":"string","example":"http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080","description":"Optional web-proxy for external internet access should the pool actually be behind a firewall"},"NoProxy":{"type":"string","example":"localhost,15.10.0.10,test.com","description":"Addresses or CIDRs for which proxy requests are not made"},"NTP":{"type":"array","items":{"type":"string","example":"15.0.0.1"},"description":"List of NTP servers for the IP pool"},"Pool":{"$ref":"#/components/schemas/Pool"}}}]},"IPAllocation":{"type":"object","required":["Base","Count","Usage"],"properties":{"Base":{"type":"string","example":"10.128.0.1","description":"An optional base address for the allocation, if not specified first available address from the pool will be the base"},"Count":{"type":"integer","example":2,"description":"Number of addresses to allocate starting from the base"},"Usage":{"type":"string","example":"Allocated IP for external storage","description":"A short description for the allocation"}}},"ServiceServerInfo":{"type":"object","description":"Server allocation information for a service type.","properties":{"ServiceType":{"type":"string","description":"Service type consuming the resource","example":"BMaaS"},"AllocatedCount":{"type":"integer","description":"Allocated number of servers."},"CoresCapacity":{"type":"integer","description":"Total available CPU cores."},"CoresAllocated":{"type":"integer","description":"Total allocated CPU cores."},"RAMCapacity":{"type":"number","format":"double","description":"Total available memory in GiB."},"RAMAllocated":{"type":"number","format":"double","description":"Total allocated memory in GiB."}}},"Allocation":{"type":"object","description":"allocation of servers for each PCE service.","properties":{"ResourceType":{"type":"string","description":"Type of the resource the allocation information is listed for."},"Total":{"type":"integer","description":"Total number of servers."},"InstanceFamily":{"type":"string","description":"Instance type family name.","example":"Compute Optimized, General Purpose"},"InstanceType":{"type":"string","description":"Server instance type","example":"C2i, M2ie"},"Available":{"type":"integer","minimum":0,"description":"Available number of servers."},"AllocationInfo":{"type":"array","description":"Array listing of server allocation information for each service type.","items":{"$ref":"#/components/schemas/ServiceServerInfo"}}}},"ServiceStorageInfo":{"type":"object","description":"Storage allocation information for service type.","properties":{"ServiceType":{"type":"string","description":"Service type consuming the resource","example":"BMaaS"},"AllocatedCount":{"type":"integer","description":"Allocated number of volumes."},"AllocatedCapacity":{"type":"integer","description":"Total capacity of all allocated volumes in TB for a service type."}}},"AllocationStorage":{"type":"object","description":"allocation of storage for each PCE service.","properties":{"ResourceType":{"type":"string","description":"Type of the resource the allocation information is listed for."},"Total":{"type":"number","format":"float","description":"Total storage capacity in TB"},"InstanceFamily":{"type":"string","description":"Instance type family name.","example":"Performance Optimized Block"},"InstanceType":{"type":"string","description":"volume type","example":"SBP"},"Available":{"type":"number","format":"float","minimum":0,"description":"Available storage space in TB"},"AllocationInfo":{"type":"array","description":"Array listing the storage allocation information for each service type.","items":{"$ref":"#/components/schemas/ServiceStorageInfo"}}}}},"responses":{"Unauthorized":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalError":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InvalidContent":{"description":"invalid content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InvalidInput":{"description":"invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":{"SpaceID":{"name":"spaceid","in":"header","description":"GreenLake space ID","schema":{"type":"string"},"example":"95688cf9-82ff-4e32-80fc-2b0b41648dab"},"Space":{"name":"Space","in":"header","description":"GreenLake space name","schema":{"type":"string"},"example":"Default"},"SiteID":{"name":"siteid","in":"query","description":"GreenLake site ID","required":false,"schema":{"type":"string"},"example":"95688cf9-82ff-4e32-80fc-2b0b41648dab"}}},"externalDocs":{"description":"API Versioning","url":"https://www.hpe.com/us/en/software/licensing.html"}}},"searchIndex":{"store":["section/Introduction","section/Authentication","section/Authentication/Bearer-Auth","section/Authentication/Project-API-Key","section/Authentication/Membership-API-Key","section/Getting-a-Space-name-or-ID","section/HPE-GreenLake-for-bare-metal-APIs","tag/version","tag/version/operation/Versions_get","tag/projects","tag/projects/operation/Projects_list","tag/projects/operation/Project_add","tag/projects/operation/Project_getByID","tag/projects/operation/Project_update","tag/projects/operation/Project_delete","tag/sshkeys","tag/sshkeys/operation/SSHKeys_list","tag/sshkeys/operation/SSHKey_add","tag/sshkeys/operation/SSHKey_getByID","tag/sshkeys/operation/SSHKey_update","tag/sshkeys/operation/SSHKey_delete","tag/hosts","tag/hosts/operation/Hosts_list","tag/hosts/operation/Host_add","tag/hosts/operation/Host_getByID","tag/hosts/operation/Host_update","tag/hosts/operation/Host_delete","tag/hosts/operation/maintenance","tag/hosts/operation/powerOn","tag/hosts/operation/powerOff","tag/hosts/operation/powerReset","tag/hosts/operation/bootPXE","tag/hosts/operation/bootHDD","tag/hosts/operation/replace","tag/volumes","tag/volumes/operation/Volumes_list","tag/volumes/operation/Volume_add","tag/volumes/operation/Volume_getByID","tag/volumes/operation/Volume_update","tag/volumes/operation/Volume_delete","tag/volumes/operation/Volume_attach","tag/volumes/operation/Volume_detach","tag/volume-attachments","tag/volume-attachments/operation/VolumeAttachments_list","tag/volume-attachments/operation/VolumeAttachments_add","tag/volume-attachments/operation/VolumeAttachment_getByID","tag/volume-attachments/operation/VolumeAttachment_delete","tag/networks","tag/networks/operation/Networks_list","tag/networks/operation/Network_add","tag/networks/operation/Network_getByID","tag/networks/operation/Network_update","tag/networks/operation/Network_delete","tag/available-resources","tag/available-resources/operation/AvailableResources_list","tag/usage-reports","tag/usage-reports/operation/UsageReport_get","tag/projects-info","tag/projects-info/operation/ProjectsInfo_list","tag/ippools","tag/ippools/operation/IPPool_list","tag/ippools/operation/IPPool_getByID","tag/ippools/operation/IPPool_update","tag/ippools/operation/IPPool_allocateIPs","tag/ippools/operation/IPPool_returnIPs","tag/allocation","tag/allocation/operation/allocation_getBySite","tag/allocation/operation/allocation_storage_getBySite"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,5.25]],["description/0",[1,0.939,2,2.43,3,2.308,4,2.817,5,2.232,6,2.305,7,0.62,8,0.939,9,1.522,10,1.69,11,1.69,12,1.737,13,0.939,14,0.62,15,1.116,16,0.939,17,0.814,18,0.939,19,1.316,20,0.939,21,0.939,22,2.303,23,0.814,24,0.939,25,1.522,26,0.731,27,0.495,28,0.67,29,0.939,30,0.731,31,0.939,32,0.939,33,0.939,34,0.731,35,0.791,36,0.939,37,0.939,38,0.939,39,0.939,40,0.939,41,1.116,42,0.979,43,0.4,44,0.366,45,0.4,46,0.814,47,1.205,48,0.536,49,0.814,50,0.251,51,1.042,52,0.453,53,0.939,54,0.31,55,0.731,56,0.939,57,0.688,58,0.939,59,0.67,60,0.62,61,0.814,62,0.731,63,1.522,64,1.042,65,1.205,66,0.62,67,0.731,68,0.731,69,0.62,70,1.042,71,0.939,72,0.814,73,0.939,74,2.232,75,0.939,76,0.939,77,1.794,78,1.69,79,0.939,80,0.939,81,0.939,82,0.939,83,0.939,84,0.814,85,4.089,86,0.939,87,0.939,88,0.814,89,1.642,90,0.67,91,0.814,92,1.042,93,0.814,94,0.62]],["title/1",[95,3.468]],["description/1",[]],["title/2",[96,3.824,97,4.412]],["description/2",[2,2.533,3,2.11,4,1.579,5,1.797,6,2.019,12,0.907,14,0.532,15,0.532,23,0.698,25,0.532,26,0.627,28,0.574,35,0.949,41,0.971,42,2.237,47,2.33,48,0.466,63,0.532,69,0.532,77,1.579,85,3.358,88,1.273,91,1.273,92,0.497,93,0.698,94,0.532,95,1.339,96,1.273,98,0.723,99,1.144,100,2.576,101,0.627,102,0.44,103,0.805,104,0.805,105,0.852,106,1.273,107,0.698,108,1.757,109,0.698,110,0.805,111,1.47,112,0.805,113,0.805,114,0.805,115,0.805,116,0.805,117,0.805,118,0.805,119,0.467,120,0.805,121,1.757,122,2.832,123,1.757,124,1.757,125,0.907,126,2.027,127,1.47,128,0.805,129,0.805,130,0.079,131,0.805,132,0.805,133,1.47,134,0.698,135,0.574,136,0.805,137,0.805,138,0.805,139,0.698,140,0.805,141,0.805,142,0.805,143,0.805,144,2.502,145,0.805,146,0.805,147,0.805,148,0.805,149,0.805,150,0.698,151,0.698,152,0.805,153,0.698,154,0.698,155,0.698,156,1.757,157,0.698,158,1.273,159,0.698,160,0.627,161,0.698,162,0.805,163,0.805,164,0.805,165,0.805,166,0.805,167,0.805,168,0.805,169,0.805,170,0.805,171,0.805,172,0.805,173,0.805,174,0.805,175,0.805,176,0.805,177,0.698,178,0.805,179,0.805,180,0.805,181,0.698,182,0.574,183,0.805,184,0.805,185,0.805,186,0.805]],["title/3",[6,1.871,45,0.661,187,1.871]],["description/3",[2,2.441,3,2.164,12,2.441,35,2.519,41,2.613,42,3.12,43,1.686,44,1.543,45,1.062,46,3.428,70,2.441,100,2.164,102,2.164,105,2.293,130,0.386,188,2.821]],["title/4",[6,1.871,187,1.871,189,2.963]],["description/4",[2,3.106,5,3.106,35,2.949,42,2.918,98,2.476,100,2.753,106,4.362,107,4.362]],["title/5",[74,2.064,119,1.939,130,0.326,150,2.899]],["description/5",[2,2.29,3,2.03,6,1.17,26,2.89,45,0.413,72,2.062,74,2.29,77,2.89,84,3.216,85,1.697,98,1.17,102,1.302,108,2.062,119,2.987,121,2.062,122,3.216,123,2.062,124,2.062,130,0.445,153,2.062,154,2.062,155,2.062,156,2.062,157,2.062,158,2.062,159,2.062,160,1.853,161,2.062,177,2.062,190,2.38,191,2.452,192,2.062,193,2.38,194,1.697,195,2.062,196,2.38,197,1.697,198,1.853,199,1.697,200,2.38,201,2.38]],["title/6",[2,1.841,3,1.632,4,2.324,5,1.841,6,1.468]],["description/6",[]],["title/7",[202,3.468]],["description/7",[6,2.605,57,2.158,202,3.499,203,5.297,204,1.898,205,2.897,206,4.59]],["title/8",[6,1.645,202,2.21,205,1.83,206,2.899]],["description/8",[202,4.148]],["title/9",[45,0.911]],["description/9",[9,2.834,45,1.107,48,1.36,50,0.467,52,0.844,54,1.416,55,3.341,89,3.059,90,3.059,119,2.487,204,1.537,207,2.008,208,2.346,209,3.341]],["title/10",[43,1.272,45,0.518,210,1.164,211,2.324,212,2.324]],["description/10",[3,1.674,7,2.023,9,2.023,27,0.896,35,1.433,45,1.017,48,0.971,50,0.333,52,0.883,54,1.011,57,1.247,95,2.023,98,1.506,100,1.674,102,2.456,105,1.775,119,2.603,182,2.183,188,2.183,197,2.183,213,1.506,214,1.433,215,2.384,216,2.384,217,2.653,218,2.183,219,2.183,220,1.586,221,2.384]],["title/11",[45,0.661,48,1.206,222,1.55]],["description/11",[3,1.494,9,1.805,15,1.805,35,1.279,42,1.584,43,1.164,45,0.863,48,1.308,50,0.297,52,0.537,54,0.902,55,2.128,70,1.686,95,1.805,98,2.029,100,1.494,102,2.257,105,1.584,119,2.882,125,1.686,135,1.948,182,1.948,188,1.948,197,1.948,204,0.979,211,2.128,212,2.128,219,1.948,220,1.415,221,2.128,222,1.113,223,1.494,224,2.732,225,2.732,226,1.805,227,2.128]],["title/12",[45,0.661,130,0.371,228,2.081]],["description/12",[7,2.613,9,2.613,27,1.158,44,1.543,45,1.062,50,0.43,52,1.059,54,1.306,57,1.612,130,0.386,214,1.851,215,3.08,216,3.08,217,3.428,218,2.821,229,1.158,230,3.08]],["title/13",[45,0.661,130,0.371,231,1.698]],["description/13",[15,2.665,42,2.338,45,0.947,74,2.489,98,1.984,125,2.489,130,0.393,135,2.877,204,1.955,215,3.142,216,3.142,226,2.665,227,3.142,229,1.181,230,3.142,231,2.434]],["title/14",[45,0.766,232,1.721]],["description/14",[15,3.026,42,2.655,45,0.795,98,2.252,125,2.826,130,0.447,135,3.266,204,1.641,226,3.026,227,3.567,229,1.341,230,3.567,232,1.786]],["title/15",[233,3.743]],["description/15",[47,3.341,48,1.485,50,0.51,130,0.457,187,2.961,204,1.679,207,2.193,208,2.563,234,3.294,235,3.341]],["title/16",[45,0.661,210,1.484,233,2.713]],["description/16",[27,1.511,43,2.2,45,0.896,208,2.823,213,2.538,214,2.416,233,4.564]],["title/17",[187,1.645,222,1.363,223,1.83,234,1.83]],["description/17",[48,1.636,50,0.561,187,2.538,222,2.103,223,2.823,233,3.681,234,2.823,235,3.681]],["title/18",[130,0.326,187,1.645,228,1.83,234,1.83]],["description/18",[27,1.55,44,2.066,130,0.517,187,2.605,229,1.55,234,2.897,236,4.124]],["title/19",[74,1.391,187,1.749,192,1.954,231,1.006,234,1.233,237,1.233,238,1.756]],["description/19",[236,4.889]],["title/20",[187,1.871,232,1.484,234,2.081]],["description/20",[130,0.53,187,2.674,229,1.592,232,2.121,234,2.975,236,4.235]],["title/21",[50,0.571]],["description/21",[47,2.996,48,1.332,49,3.641,50,0.732,89,2.996,92,2.592,204,1.505,205,2.298,207,1.966,209,3.271,210,1.639,232,1.639,239,3.641,240,4.201]],["title/22",[45,0.661,50,0.414,210,1.484]],["description/22",[27,1.511,43,2.2,45,0.896,50,0.696,208,2.823,213,2.538,214,2.416]],["title/23",[48,1.206,50,0.414,222,1.55]],["description/23",[6,1.506,14,2.967,41,2.967,48,0.971,50,0.578,54,1.011,59,3.202,63,2.967,130,0.299,134,2.653,191,2.967,205,1.674,214,2.102,220,2.326,222,1.247,239,2.653,241,3.062,242,3.062,243,3.062,244,4.491,245,2.653,246,3.062,247,3.062,248,3.062,249,3.062]],["title/24",[50,0.414,130,0.371,228,2.081]],["description/24",[27,1.592,44,2.121,50,0.591,130,0.53,229,1.592,250,4.235]],["title/25",[50,0.414,231,1.698,237,2.081]],["description/25",[50,0.687,52,0.709,54,1.19,130,0.352,229,1.055,231,2.966,250,2.807,251,2.57,252,2.57,253,2.57,254,2.807,255,2.224,256,3.124,257,3.605,258,3.605,259,5.049,260,2.089]],["title/26",[50,0.48,232,1.721]],["description/26",[50,0.666,130,0.386,229,1.158,232,2.387,250,3.08,251,3.839,252,2.821,255,3.776,261,3.956,262,3.956,263,3.956,264,3.956,265,2.293]],["title/27",[50,0.414,130,0.371,266,3.298]],["description/27",[50,0.701,204,1.57,252,3.125,254,3.413,255,3.557,265,2.54,266,4.996,267,4.383,268,4.383,269,3.798,270,4.383]],["title/28",[50,0.414,130,0.371,265,2.206]],["description/28",[44,2.121,50,0.591,130,0.53,229,1.592,265,3.152,271,5.438]],["title/29",[50,0.414,130,0.371,265,2.206]],["description/29",[44,2.121,50,0.591,130,0.53,229,1.592,265,3.152,272,5.438]],["title/30",[50,0.414,130,0.371,273,3.298]],["description/30",[44,2.121,50,0.591,130,0.53,229,1.592,273,4.713,274,5.438]],["title/31",[50,0.293,130,0.263,220,1.395,275,2.334,276,1.921,277,2.334]],["description/31",[44,1.871,50,0.522,130,0.468,220,2.484,229,1.404,275,4.156,276,4.358,278,4.156,279,4.796,280,4.796]],["title/32",[50,0.293,130,0.263,220,1.395,276,1.921,277,2.334,281,2.334]],["description/32",[44,1.963,50,0.548,130,0.491,220,2.607,229,1.473,276,3.59,278,4.362,281,4.362,282,5.034]],["title/33",[50,0.414,130,0.371,283,3.298]],["description/33",[50,0.681,52,0.696,64,3.077,194,2.526,195,3.069,220,1.834,222,1.443,238,2.758,252,2.526,254,2.758,255,3.077,265,2.053,269,3.069,283,4.322,284,3.542,285,3.542,286,1.58,287,3.542,288,3.542,289,3.542]],["title/34",[52,1.032]],["description/34",[50,0.522,51,2.959,52,1.323,204,1.719,207,2.245,290,4.796,291,4.796,292,4.796,293,4.796]],["title/35",[45,0.661,52,0.748,210,1.484]],["description/35",[27,1.55,43,2.257,45,0.919,52,1.279,208,2.897,213,2.605]],["title/36",[52,0.748,222,1.55,223,2.081]],["description/36",[14,3.604,43,1.719,45,0.7,48,2.099,50,0.593,52,1.302,151,3.496,222,1.644,223,2.207,235,2.877,294,4.034]],["title/37",[52,0.748,130,0.371,228,2.081]],["description/37",[27,1.592,44,2.121,52,1.069,130,0.53,229,1.592,295,4.235]],["title/38",[52,0.748,231,1.698,237,2.081]],["description/38",[52,1.292,130,0.386,191,2.613,218,2.821,229,1.158,231,2.731,237,2.164,251,2.821,255,2.441,295,3.08,296,2.049,297,3.956,298,3.956,299,3.956,300,3.956]],["title/39",[52,0.868,232,1.721]],["description/39",[52,1.099,130,0.545,229,1.636,232,2.179,295,4.351]],["title/40",[50,0.364,52,0.658,237,1.83,260,1.939]],["description/40",[30,3.08,48,1.254,50,0.585,52,1.059,57,1.612,60,2.613,214,1.851,231,1.765,253,2.821,260,3.12,301,3.428,302,3.428,303,2.164,304,3.428,305,3.428,306,3.428,307,3.428]],["title/41",[50,0.364,52,0.658,237,1.83,308,2.899]],["description/41",[30,2.314,34,2.314,50,0.568,52,1.028,57,1.211,60,1.963,98,1.461,125,1.834,204,1.065,214,1.391,231,1.326,232,1.159,245,2.575,253,2.119,301,2.575,302,2.575,303,1.625,304,2.575,305,2.575,306,2.575,308,3.807,309,4.394,310,2.972,311,2.119,312,2.972,313,2.972,314,2.972,315,2.972,316,2.972,317,2.972,318,2.972]],["title/42",[319,4.088]],["description/42",[17,4.59,50,0.576,52,1.042,204,1.898,207,2.479,253,3.777,303,2.897]],["title/43",[45,0.581,52,0.658,210,1.305,260,1.939]],["description/43",[27,1.55,43,2.257,45,0.919,208,2.897,213,2.605,303,2.897,319,4.124]],["title/44",[48,1.206,222,1.55,303,2.081]],["description/44",[6,2.785,25,2.261,35,2.278,48,1.085,50,0.372,52,0.673,64,2.112,125,2.112,139,2.966,222,1.395,223,1.872,232,1.898,303,3.374,307,2.966,319,2.665,320,3.423,321,3.423,322,3.423,323,2.665,324,3.423,325,3.423]],["title/45",[52,0.658,130,0.326,228,1.83,260,1.939]],["description/45",[27,1.55,44,2.066,52,1.042,130,0.517,229,1.55,260,3.07,323,4.124]],["title/46",[232,1.721,303,2.413]],["description/46",[130,0.545,229,1.636,232,2.179,303,3.056,323,4.351]],["title/47",[54,1.733]],["description/47",[54,1.952,204,2.119,207,2.767]],["title/48",[45,0.661,54,1.256,210,1.484]],["description/48",[27,1.511,43,2.2,45,0.896,54,2.113,208,2.823,213,2.538,214,2.416]],["title/49",[54,1.256,222,1.55,223,2.081]],["description/49",[48,1.679,50,0.576,54,2.147,222,2.158,223,2.897,235,3.777]],["title/50",[54,1.256,130,0.371,228,2.081]],["description/50",[27,1.592,44,2.121,54,1.795,130,0.53,229,1.592,326,4.235]],["title/51",[54,1.256,231,1.698,237,2.081]],["description/51",[326,4.889]],["title/52",[54,1.456,232,1.721]],["description/52",[54,1.844,130,0.545,229,1.636,232,2.179,326,4.351]],["title/53",[59,3.743]],["description/53",[14,2.023,41,2.023,48,1.686,50,0.488,51,1.889,52,1.046,57,1.83,60,2.023,61,2.653,62,2.384,63,3.514,64,1.889,65,2.183,66,2.023,67,2.384,68,2.384,69,2.967,89,2.183,92,1.889,94,2.023,204,1.097,207,1.433,209,2.384,210,1.194,327,3.062,328,3.062]],["title/54",[19,2.098,25,1.78,48,0.854,50,0.293,52,0.53,210,1.051]],["description/54",[7,0.817,12,0.763,19,2.232,27,0.362,35,1.342,48,0.683,50,0.373,51,0.763,52,0.841,54,1.133,57,1.168,59,1.537,60,1.424,62,1.679,63,1.424,64,2.403,65,2.448,66,0.817,67,0.962,68,3.032,70,0.763,74,1.769,85,4.405,98,0.608,109,1.071,130,0.476,160,0.962,194,1.537,202,0.817,210,1.795,213,0.608,214,0.578,218,0.881,222,0.504,237,0.676,238,0.962,255,0.763,256,1.868,260,0.716,329,3.894,330,1.236,331,1.236,332,2.484,333,1.236,334,1.236,335,1.071,336,1.236,337,1.236,338,1.236,339,0.881,340,0.962,341,1.236,342,1.236,343,1.071,344,1.236,345,1.236,346,1.236,347,1.236,348,1.236,349,1.236,350,0.962,351,1.071]],["title/55",[352,4.549]],["description/55",[25,3.41,43,2.2,45,0.896,57,2.103,204,1.85,207,2.416,228,2.823,339,3.681]],["title/56",[339,3.146,353,3.824]],["description/56",[27,1.438,34,3.825,48,1.557,199,3.503,219,3.503,311,3.503,339,3.503,343,4.257,352,4.257,353,4.257]],["title/57",[354,4.549]],["description/57",[45,0.944,57,2.216,204,1.949,207,3.093,210,2.121]],["title/58",[43,0.961,45,0.391,99,1.756,101,1.756,181,1.954,210,0.879,211,1.756,212,1.756]],["description/58",[3,1.515,7,2.754,27,0.811,35,1.296,45,0.968,52,0.82,57,1.128,64,2.572,65,2.972,95,1.83,98,1.362,99,2.157,100,1.515,101,2.157,102,2.28,105,1.605,119,2.416,182,1.975,188,1.975,197,1.975,210,1.626,214,1.296,219,1.975,220,1.434,221,2.157,251,1.975,332,3.612,335,2.4,351,2.4,354,2.4,355,2.769]],["title/59",[356,4.549]],["description/59",[204,2.059,207,2.689,286,2.564,357,2.689]],["title/60",[45,0.581,210,1.305,286,1.493,357,1.566]],["description/60",[27,1.473,43,2.145,45,0.874,208,2.753,213,2.476,214,2.356,286,2.246,356,4.362,357,2.356]],["title/61",[130,0.326,228,1.83,286,1.493,357,1.566]],["description/61",[27,1.55,44,2.066,130,0.517,229,1.55,286,2.363,357,2.479,358,4.59]],["title/62",[130,0.326,231,1.493,286,1.493,357,1.566]],["description/62",[44,1.786,130,0.447,194,3.266,229,1.341,231,2.648,286,2.648,357,2.777,358,3.969,359,4.58,360,4.58]],["title/63",[286,1.698,296,1.971,357,1.781]],["description/63",[286,2.564,296,2.976,357,2.689,361,5.746]],["title/64",[27,1.114,286,1.698,357,1.781]],["description/64",[27,1.682,286,2.564,357,2.689,362,5.746]],["title/65",[296,2.719]],["description/65",[51,3.268,57,2.158,204,1.898,205,2.897,207,2.479,210,2.066,296,2.743]],["title/66",[205,2.413,296,2.285]],["description/66",[5,1.451,12,1.451,27,1.076,28,1.677,35,1.721,45,0.786,57,1.845,66,1.554,69,1.554,70,2.269,90,1.677,92,2.269,94,2.43,100,2.012,102,2.012,105,1.364,130,0.229,189,1.832,191,1.554,198,1.832,199,1.677,205,1.287,213,1.157,226,1.554,296,2.345,311,1.677,340,1.832,350,1.832,363,3.187,364,2.039,365,2.039,366,2.039,367,3.187,368,2.039,369,2.039,370,2.039,371,3.187,372,2.039,373,2.352]],["title/67",[51,2.722,296,2.285]],["description/67",[5,1.451,12,1.451,27,1.076,28,1.677,35,1.721,45,0.786,57,1.845,66,1.554,69,1.554,70,2.269,90,1.677,92,2.269,94,2.43,100,2.012,102,2.012,105,1.364,130,0.229,189,1.832,191,1.554,198,1.832,199,1.677,205,1.287,213,1.157,226,1.554,296,2.345,311,1.677,340,1.832,350,1.832,363,3.187,364,2.039,365,2.039,366,2.039,367,3.187,368,2.039,369,2.039,370,2.039,371,3.187,372,2.039,374,2.352]]],"invertedIndex":[["",{"_index":85,"title":{},"description":{"0":{},"2":{},"5":{},"54":{}}}],["000",{"_index":166,"title":{},"description":{"2":{}}}],["00b388",{"_index":172,"title":{},"description":{"2":{}}}],["1",{"_index":88,"title":{},"description":{"0":{},"2":{}}}],["15",{"_index":185,"title":{},"description":{"2":{}}}],["18.04",{"_index":334,"title":{},"description":{"54":{}}}],["2",{"_index":91,"title":{},"description":{"0":{},"2":{}}}],["2px",{"_index":170,"title":{},"description":{"2":{}}}],["3",{"_index":93,"title":{},"description":{"0":{},"2":{}}}],["4px",{"_index":174,"title":{},"description":{"2":{}}}],["a.k.a",{"_index":209,"title":{},"description":{"9":{},"21":{},"53":{}}}],["accept",{"_index":32,"title":{},"description":{"0":{}}}],["access",{"_index":42,"title":{},"description":{"0":{},"2":{},"3":{},"4":{},"11":{},"13":{},"14":{}}}],["access_token",{"_index":149,"title":{},"description":{"2":{}}}],["accid",{"_index":315,"title":{},"description":{"41":{}}}],["accord",{"_index":243,"title":{},"description":{"23":{}}}],["account",{"_index":117,"title":{},"description":{"2":{}}}],["add",{"_index":223,"title":{"17":{},"36":{},"49":{}},"description":{"11":{},"17":{},"36":{},"44":{},"49":{}}}],["address",{"_index":195,"title":{},"description":{"5":{},"33":{}}}],["align",{"_index":224,"title":{},"description":{"11":{}}}],["alloc",{"_index":296,"title":{"63":{},"65":{},"66":{},"67":{}},"description":{"38":{},"63":{},"65":{},"66":{},"67":{}}}],["allocation/serv",{"_index":373,"title":{},"description":{"66":{}}}],["allocation/storag",{"_index":374,"title":{},"description":{"67":{}}}],["allow",{"_index":113,"title":{},"description":{"2":{}}}],["along",{"_index":329,"title":{},"description":{"54":{}}}],["api",{"_index":6,"title":{"3":{},"4":{},"6":{},"8":{}},"description":{"0":{},"2":{},"5":{},"7":{},"23":{},"44":{}}}],["applic",{"_index":116,"title":{},"description":{"2":{}}}],["application/x-www-form-urlencod",{"_index":143,"title":{},"description":{"2":{}}}],["appropri",{"_index":134,"title":{},"description":{"2":{},"23":{}}}],["array",{"_index":213,"title":{},"description":{"10":{},"16":{},"22":{},"35":{},"43":{},"48":{},"54":{},"60":{},"66":{},"67":{}}}],["assign",{"_index":133,"title":{},"description":{"2":{}}}],["associ",{"_index":293,"title":{},"description":{"34":{}}}],["attach",{"_index":260,"title":{"40":{},"43":{},"45":{}},"description":{"25":{},"40":{},"45":{},"54":{}}}],["attempt",{"_index":278,"title":{},"description":{"31":{},"32":{}}}],["attribut",{"_index":244,"title":{},"description":{"23":{}}}],["auth",{"_index":97,"title":{"2":{}},"description":{}}],["authent",{"_index":95,"title":{"1":{}},"description":{"2":{},"10":{},"11":{},"58":{}}}],["author",{"_index":101,"title":{"58":{}},"description":{"2":{},"58":{}}}],["avail",{"_index":19,"title":{"54":{}},"description":{"0":{},"54":{}}}],["available-resourc",{"_index":59,"title":{"53":{}},"description":{"0":{},"23":{},"54":{}}}],["background-color",{"_index":167,"title":{},"description":{"2":{}}}],["bar",{"_index":196,"title":{},"description":{"5":{}}}],["bare",{"_index":4,"title":{"6":{}},"description":{"0":{},"2":{}}}],["base",{"_index":343,"title":{},"description":{"54":{},"56":{}}}],["be",{"_index":316,"title":{},"description":{"41":{}}}],["bearer",{"_index":96,"title":{"2":{}},"description":{"2":{}}}],["befor",{"_index":263,"title":{},"description":{"26":{}}}],["below",{"_index":80,"title":{},"description":{"0":{}}}],["bmaa",{"_index":15,"title":{},"description":{"0":{},"2":{},"11":{},"13":{},"14":{}}}],["bodi",{"_index":34,"title":{},"description":{"0":{},"41":{},"56":{}}}],["boot",{"_index":276,"title":{"31":{},"32":{}},"description":{"31":{},"32":{}}}],["border",{"_index":169,"title":{},"description":{"2":{}}}],["border-radiu",{"_index":173,"title":{},"description":{"2":{}}}],["both",{"_index":182,"title":{},"description":{"2":{},"10":{},"11":{},"58":{}}}],["br",{"_index":179,"title":{},"description":{"2":{}}}],["build",{"_index":206,"title":{"8":{}},"description":{"7":{}}}],["built",{"_index":21,"title":{},"description":{"0":{}}}],["call",{"_index":14,"title":{},"description":{"0":{},"2":{},"23":{},"36":{},"53":{}}}],["capac",{"_index":218,"title":{},"description":{"10":{},"12":{},"38":{},"54":{}}}],["categori",{"_index":330,"title":{},"description":{"54":{}}}],["center",{"_index":67,"title":{},"description":{"0":{},"53":{},"54":{}}}],["central",{"_index":77,"title":{},"description":{"0":{},"2":{},"5":{}}}],["chang",{"_index":238,"title":{"19":{}},"description":{"33":{},"54":{}}}],["classic",{"_index":106,"title":{},"description":{"2":{},"4":{}}}],["click",{"_index":156,"title":{},"description":{"2":{},"5":{}}}],["client",{"_index":47,"title":{},"description":{"0":{},"2":{},"15":{},"21":{}}}],["client(recommended)</h2",{"_index":112,"title":{},"description":{"2":{}}}],["client_id={clientid",{"_index":145,"title":{},"description":{"2":{}}}],["client_secret={clientsecret",{"_index":146,"title":{},"description":{"2":{}}}],["cloud",{"_index":10,"title":{},"description":{"0":{}}}],["cluster",{"_index":212,"title":{"10":{},"58":{}},"description":{"11":{}}}],["code",{"_index":29,"title":{},"description":{"0":{}}}],["comput",{"_index":89,"title":{},"description":{"0":{},"9":{},"21":{},"53":{}}}],["configur",{"_index":306,"title":{},"description":{"40":{},"41":{}}}],["connect",{"_index":253,"title":{},"description":{"25":{},"40":{},"41":{},"42":{}}}],["construct",{"_index":327,"title":{},"description":{"53":{}}}],["contain",{"_index":304,"title":{},"description":{"40":{},"41":{}}}],["content-typ",{"_index":142,"title":{},"description":{"2":{}}}],["context",{"_index":46,"title":{},"description":{"0":{},"3":{}}}],["copi",{"_index":177,"title":{},"description":{"2":{},"5":{}}}],["corner",{"_index":161,"title":{},"description":{"2":{},"5":{}}}],["correspond",{"_index":84,"title":{},"description":{"0":{},"5":{}}}],["countri",{"_index":336,"title":{},"description":{"54":{}}}],["creat",{"_index":48,"title":{"11":{},"23":{},"44":{},"54":{}},"description":{"0":{},"2":{},"9":{},"10":{},"11":{},"15":{},"17":{},"21":{},"23":{},"36":{},"40":{},"44":{},"49":{},"53":{},"54":{},"56":{}}}],["creation",{"_index":321,"title":{},"description":{"44":{}}}],["curl",{"_index":137,"title":{},"description":{"2":{}}}],["current",{"_index":194,"title":{},"description":{"5":{},"33":{},"54":{},"62":{}}}],["d",{"_index":144,"title":{},"description":{"2":{}}}],["data",{"_index":66,"title":{},"description":{"0":{},"53":{},"54":{},"66":{},"67":{}}}],["default",{"_index":340,"title":{},"description":{"54":{},"66":{},"67":{}}}],["defaultrout",{"_index":359,"title":{},"description":{"62":{}}}],["defin",{"_index":208,"title":{},"description":{"9":{},"15":{},"16":{},"22":{},"35":{},"43":{},"48":{},"60":{}}}],["delet",{"_index":232,"title":{"14":{},"20":{},"26":{},"39":{},"46":{},"52":{}},"description":{"14":{},"20":{},"21":{},"26":{},"39":{},"41":{},"44":{},"46":{},"52":{}}}],["deprec",{"_index":73,"title":{},"description":{"0":{}}}],["describ",{"_index":17,"title":{},"description":{"0":{},"42":{}}}],["descript",{"_index":256,"title":{},"description":{"25":{},"54":{}}}],["desir",{"_index":348,"title":{},"description":{"54":{}}}],["detach",{"_index":308,"title":{"41":{}},"description":{"41":{}}}],["detail",{"_index":60,"title":{},"description":{"0":{},"40":{},"41":{},"53":{},"54":{}}}],["determin",{"_index":366,"title":{},"description":{"66":{},"67":{}}}],["differ",{"_index":75,"title":{},"description":{"0":{}}}],["directli",{"_index":151,"title":{},"description":{"2":{},"36":{}}}],["display",{"_index":76,"title":{},"description":{"0":{}}}],["document",{"_index":16,"title":{},"description":{"0":{}}}],["each",{"_index":363,"title":{},"description":{"66":{},"67":{}}}],["enabl",{"_index":320,"title":{},"description":{"44":{}}}],["end",{"_index":200,"title":{},"description":{"5":{}}}],["endpoint",{"_index":20,"title":{},"description":{"0":{}}}],["ensur",{"_index":312,"title":{},"description":{"41":{}}}],["enterpris",{"_index":11,"title":{},"description":{"0":{}}}],["entiti",{"_index":115,"title":{},"description":{"2":{}}}],["environ",{"_index":56,"title":{},"description":{"0":{}}}],["error",{"_index":31,"title":{},"description":{"0":{}}}],["etc",{"_index":287,"title":{},"description":{"33":{}}}],["execut",{"_index":267,"title":{},"description":{"27":{}}}],["exist",{"_index":237,"title":{"19":{},"25":{},"38":{},"40":{},"41":{},"51":{}},"description":{"38":{},"54":{}}}],["expand",{"_index":300,"title":{},"description":{"38":{}}}],["expir",{"_index":184,"title":{},"description":{"2":{}}}],["extern",{"_index":290,"title":{},"description":{"34":{}}}],["extract",{"_index":193,"title":{},"description":{"5":{}}}],["fail",{"_index":254,"title":{},"description":{"25":{},"27":{},"33":{}}}],["favorit",{"_index":36,"title":{},"description":{"0":{}}}],["few",{"_index":72,"title":{},"description":{"0":{},"5":{}}}],["fff",{"_index":168,"title":{},"description":{"2":{}}}],["field",{"_index":192,"title":{"19":{}},"description":{"5":{}}}],["first",{"_index":261,"title":{},"description":{"26":{}}}],["flavor",{"_index":332,"title":{},"description":{"54":{},"58":{}}}],["follow",{"_index":109,"title":{},"description":{"2":{},"54":{}}}],["fully-provis",{"_index":49,"title":{},"description":{"0":{},"21":{}}}],["further",{"_index":365,"title":{},"description":{"66":{},"67":{}}}],["gener",{"_index":136,"title":{},"description":{"2":{}}}],["get",{"_index":150,"title":{"5":{}},"description":{"2":{}}}],["gl",{"_index":370,"title":{},"description":{"66":{},"67":{}}}],["grant_type=client_credenti",{"_index":147,"title":{},"description":{"2":{}}}],["greater",{"_index":298,"title":{},"description":{"38":{}}}],["greenlak",{"_index":3,"title":{"6":{}},"description":{"0":{},"2":{},"3":{},"5":{},"10":{},"11":{},"58":{}}}],["group",{"_index":90,"title":{},"description":{"0":{},"9":{},"66":{},"67":{}}}],["gui",{"_index":345,"title":{},"description":{"54":{}}}],["h",{"_index":141,"title":{},"description":{"2":{}}}],["h2>option",{"_index":111,"title":{},"description":{"2":{}}}],["hdd",{"_index":281,"title":{"32":{}},"description":{"32":{}}}],["header",{"_index":102,"title":{},"description":{"2":{},"3":{},"5":{},"10":{},"11":{},"58":{},"66":{},"67":{}}}],["height=\"12",{"_index":124,"title":{},"description":{"2":{},"5":{}}}],["host",{"_index":50,"title":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"40":{},"41":{},"54":{}},"description":{"0":{},"9":{},"10":{},"11":{},"12":{},"15":{},"17":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"36":{},"40":{},"41":{},"42":{},"44":{},"49":{},"53":{},"54":{}}}],["hoster",{"_index":226,"title":{},"description":{"11":{},"13":{},"14":{},"66":{},"67":{}}}],["hostid",{"_index":310,"title":{},"description":{"41":{}}}],["hosts/{hostid",{"_index":250,"title":{},"description":{"24":{},"25":{},"26":{}}}],["hosts/{hostid}/boothdd",{"_index":282,"title":{},"description":{"32":{}}}],["hosts/{hostid}/bootpx",{"_index":280,"title":{},"description":{"31":{}}}],["hosts/{hostid}/mainten",{"_index":270,"title":{},"description":{"27":{}}}],["hosts/{hostid}/poweroff",{"_index":272,"title":{},"description":{"29":{}}}],["hosts/{hostid}/poweron",{"_index":271,"title":{},"description":{"28":{}}}],["hosts/{hostid}/powerreset",{"_index":274,"title":{},"description":{"30":{}}}],["hosts/{hostid}/replac",{"_index":289,"title":{},"description":{"33":{}}}],["hpe",{"_index":2,"title":{"6":{}},"description":{"0":{},"2":{},"3":{},"4":{},"5":{}}}],["href=\"https://client.greenlake.hpe.com",{"_index":153,"title":{},"description":{"2":{},"5":{}}}],["href=\"https://support.hpe.com/hpesc/public/docdisplay?docid=a00092451en_us&page=greenlakecentral-create-api-client.html",{"_index":120,"title":{},"description":{"2":{}}}],["href=\"https://support.hpe.com/hpesc/public/docdisplay?docid=a00092451en_us&page=guid-1cea233b-c4b0-41b7-9a25-7a36d9fc0312.html",{"_index":132,"title":{},"description":{"2":{}}}],["http",{"_index":22,"title":{},"description":{"0":{}}}],["http/rest",{"_index":37,"title":{},"description":{"0":{}}}],["i.",{"_index":368,"title":{},"description":{"66":{},"67":{}}}],["iam",{"_index":105,"title":{},"description":{"2":{},"3":{},"10":{},"11":{},"58":{},"66":{},"67":{}}}],["icon",{"_index":158,"title":{},"description":{"2":{},"5":{}}}],["id",{"_index":130,"title":{"5":{},"12":{},"13":{},"18":{},"24":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"37":{},"45":{},"50":{},"61":{},"62":{}},"description":{"2":{},"3":{},"5":{},"12":{},"13":{},"14":{},"15":{},"18":{},"20":{},"23":{},"24":{},"25":{},"26":{},"28":{},"29":{},"30":{},"31":{},"32":{},"37":{},"38":{},"39":{},"45":{},"46":{},"50":{},"52":{},"54":{},"61":{},"62":{},"66":{},"67":{}}}],["identifi",{"_index":301,"title":{},"description":{"40":{},"41":{}}}],["ignor",{"_index":221,"title":{},"description":{"10":{},"11":{},"58":{}}}],["imag",{"_index":62,"title":{},"description":{"0":{},"53":{},"54":{}}}],["img",{"_index":122,"title":{},"description":{"2":{},"5":{}}}],["in-us",{"_index":360,"title":{},"description":{"62":{}}}],["includ",{"_index":7,"title":{},"description":{"0":{},"10":{},"12":{},"54":{},"58":{}}}],["independ",{"_index":292,"title":{},"description":{"34":{}}}],["indic",{"_index":30,"title":{},"description":{"0":{},"40":{},"41":{}}}],["info",{"_index":181,"title":{"58":{}},"description":{"2":{}}}],["inform",{"_index":57,"title":{},"description":{"0":{},"7":{},"10":{},"12":{},"40":{},"41":{},"53":{},"54":{},"55":{},"57":{},"58":{},"65":{},"66":{},"67":{}}}],["input",{"_index":162,"title":{},"description":{"2":{}}}],["instanc",{"_index":92,"title":{},"description":{"0":{},"2":{},"21":{},"53":{},"66":{},"67":{}}}],["intern",{"_index":107,"title":{},"description":{"2":{},"4":{}}}],["introduct",{"_index":0,"title":{"0":{}},"description":{}}],["inventori",{"_index":342,"title":{},"description":{"54":{}}}],["ip",{"_index":286,"title":{"60":{},"61":{},"62":{},"63":{},"64":{}},"description":{"33":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{}}}],["ippool",{"_index":356,"title":{"59":{}},"description":{"60":{}}}],["ippools/{ippoolid",{"_index":358,"title":{},"description":{"61":{},"62":{}}}],["ippools/{ippoolid}/alloc",{"_index":361,"title":{},"description":{"63":{}}}],["ippools/{ippoolid}/return",{"_index":362,"title":{},"description":{"64":{}}}],["iscsi",{"_index":305,"title":{},"description":{"40":{},"41":{}}}],["iscsiconfig:initiatornam",{"_index":259,"title":{},"description":{"25":{}}}],["isol",{"_index":55,"title":{},"description":{"0":{},"9":{},"11":{}}}],["issu",{"_index":188,"title":{},"description":{"3":{},"10":{},"11":{},"58":{}}}],["issuer",{"_index":129,"title":{},"description":{"2":{}}}],["issuerurl}/v1/token",{"_index":140,"title":{},"description":{"2":{}}}],["json",{"_index":33,"title":{},"description":{"0":{}}}],["key",{"_index":187,"title":{"3":{},"4":{},"17":{},"18":{},"19":{},"20":{}},"description":{"15":{},"17":{},"18":{},"20":{}}}],["kick",{"_index":241,"title":{},"description":{"23":{}}}],["kind",{"_index":338,"title":{},"description":{"54":{}}}],["languag",{"_index":40,"title":{},"description":{"0":{}}}],["leas",{"_index":183,"title":{},"description":{"2":{}}}],["level",{"_index":190,"title":{},"description":{"5":{}}}],["librari",{"_index":38,"title":{},"description":{"0":{}}}],["limit",{"_index":216,"title":{},"description":{"10":{},"12":{},"13":{}}}],["linux",{"_index":331,"title":{},"description":{"54":{}}}],["list",{"_index":210,"title":{"10":{},"16":{},"22":{},"35":{},"43":{},"48":{},"54":{},"58":{},"60":{}},"description":{"21":{},"53":{},"54":{},"57":{},"58":{},"65":{}}}],["locat",{"_index":68,"title":{},"description":{"0":{},"53":{},"54":{}}}],["locationid",{"_index":248,"title":{},"description":{"23":{}}}],["log",{"_index":155,"title":{},"description":{"2":{},"5":{}}}],["machin",{"_index":64,"title":{},"description":{"0":{},"33":{},"44":{},"53":{},"54":{},"58":{}}}],["machineinventori",{"_index":341,"title":{},"description":{"54":{}}}],["machines",{"_index":335,"title":{},"description":{"54":{},"58":{}}}],["mainten",{"_index":266,"title":{"27":{}},"description":{"27":{}}}],["maintenac",{"_index":288,"title":{},"description":{"33":{}}}],["make",{"_index":126,"title":{},"description":{"2":{}}}],["map",{"_index":81,"title":{},"description":{"0":{}}}],["match",{"_index":229,"title":{},"description":{"12":{},"13":{},"14":{},"18":{},"20":{},"24":{},"25":{},"26":{},"28":{},"29":{},"30":{},"31":{},"32":{},"37":{},"38":{},"39":{},"45":{},"46":{},"50":{},"52":{},"61":{},"62":{}}}],["membership",{"_index":189,"title":{"4":{}},"description":{"66":{},"67":{}}}],["metal",{"_index":5,"title":{"6":{}},"description":{"0":{},"2":{},"4":{},"66":{},"67":{}}}],["minut",{"_index":186,"title":{},"description":{"2":{}}}],["name",{"_index":74,"title":{"5":{},"19":{}},"description":{"0":{},"5":{},"13":{},"54":{}}}],["need",{"_index":69,"title":{},"description":{"0":{},"2":{},"53":{},"66":{},"67":{}}}],["network",{"_index":54,"title":{"47":{},"48":{},"49":{},"50":{},"51":{},"52":{}},"description":{"0":{},"9":{},"10":{},"11":{},"12":{},"23":{},"25":{},"47":{},"48":{},"49":{},"50":{},"52":{},"54":{}}}],["networkfordefaultrout",{"_index":257,"title":{},"description":{"25":{}}}],["networks/{networkid",{"_index":326,"title":{},"description":{"50":{},"51":{},"52":{}}}],["networkuntag",{"_index":258,"title":{},"description":{"25":{}}}],["new",{"_index":222,"title":{"11":{},"17":{},"23":{},"36":{},"44":{},"49":{}},"description":{"11":{},"17":{},"23":{},"33":{},"36":{},"44":{},"49":{},"54":{}}}],["next",{"_index":279,"title":{},"description":{"31":{}}}],["non-host",{"_index":322,"title":{},"description":{"44":{}}}],["nonhuman",{"_index":114,"title":{},"description":{"2":{}}}],["note",{"_index":125,"title":{},"description":{"2":{},"11":{},"13":{},"14":{},"41":{},"44":{}}}],["object",{"_index":214,"title":{},"description":{"10":{},"12":{},"16":{},"22":{},"23":{},"40":{},"41":{},"48":{},"54":{},"58":{},"60":{}}}],["obtain",{"_index":108,"title":{},"description":{"2":{},"5":{}}}],["old",{"_index":83,"title":{},"description":{"0":{}}}],["on",{"_index":299,"title":{},"description":{"38":{}}}],["onc",{"_index":154,"title":{},"description":{"2":{},"5":{}}}],["oper",{"_index":204,"title":{},"description":{"7":{},"9":{},"11":{},"13":{},"14":{},"15":{},"21":{},"27":{},"34":{},"41":{},"42":{},"47":{},"53":{},"55":{},"57":{},"59":{},"65":{}}}],["option",{"_index":63,"title":{},"description":{"0":{},"2":{},"23":{},"53":{},"54":{}}}],["order",{"_index":277,"title":{"31":{},"32":{}},"description":{}}],["organ",{"_index":211,"title":{"10":{},"58":{}},"description":{"11":{}}}],["os",{"_index":61,"title":{},"description":{"0":{},"53":{}}}],["owner",{"_index":227,"title":{},"description":{"11":{},"13":{},"14":{}}}],["page",{"_index":175,"title":{},"description":{"2":{}}}],["paramet",{"_index":199,"title":{},"description":{"5":{},"56":{},"66":{},"67":{}}}],["part",{"_index":8,"title":{},"description":{"0":{}}}],["pass",{"_index":219,"title":{},"description":{"10":{},"11":{},"56":{},"58":{}}}],["permit",{"_index":251,"title":{},"description":{"25":{},"26":{},"38":{},"58":{}}}],["persist",{"_index":291,"title":{},"description":{"34":{}}}],["person",{"_index":178,"title":{},"description":{"2":{}}}],["physic",{"_index":239,"title":{},"description":{"21":{},"23":{}}}],["pool",{"_index":357,"title":{"60":{},"61":{},"62":{},"63":{},"64":{}},"description":{"59":{},"60":{},"61":{},"62":{},"63":{},"64":{}}}],["post",{"_index":139,"title":{},"description":{"2":{},"44":{}}}],["power",{"_index":265,"title":{"28":{},"29":{}},"description":{"26":{},"27":{},"28":{},"29":{},"33":{}}}],["powered-off",{"_index":262,"title":{},"description":{"26":{}}}],["pre-defin",{"_index":268,"title":{},"description":{"27":{}}}],["predict",{"_index":24,"title":{},"description":{"0":{}}}],["present",{"_index":371,"title":{},"description":{"66":{},"67":{}}}],["privat",{"_index":9,"title":{},"description":{"0":{},"9":{},"10":{},"11":{},"12":{}}}],["profil",{"_index":215,"title":{},"description":{"10":{},"12":{},"13":{}}}],["program",{"_index":39,"title":{},"description":{"0":{}}}],["programmat",{"_index":118,"title":{},"description":{"2":{}}}],["project",{"_index":45,"title":{"3":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"16":{},"22":{},"35":{},"43":{},"48":{},"58":{},"60":{}},"description":{"0":{},"3":{},"5":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"16":{},"22":{},"35":{},"36":{},"43":{},"48":{},"55":{},"57":{},"58":{},"60":{},"66":{},"67":{}}}],["project-specif",{"_index":53,"title":{},"description":{"0":{}}}],["projects-info",{"_index":354,"title":{"57":{}},"description":{"58":{}}}],["projects/{projectid",{"_index":230,"title":{},"description":{"12":{},"13":{},"14":{}}}],["protocol",{"_index":18,"title":{},"description":{"0":{}}}],["provid",{"_index":41,"title":{},"description":{"0":{},"2":{},"3":{},"23":{},"53":{}}}],["provis",{"_index":242,"title":{},"description":{"23":{}}}],["pxe",{"_index":275,"title":{"31":{}},"description":{"31":{}}}],["queri",{"_index":198,"title":{},"description":{"5":{},"66":{},"67":{}}}],["rapidli",{"_index":344,"title":{},"description":{"54":{}}}],["re-deploy",{"_index":284,"title":{},"description":{"33":{}}}],["read-onli",{"_index":203,"title":{},"description":{"7":{}}}],["readi",{"_index":252,"title":{},"description":{"25":{},"26":{},"27":{},"33":{}}}],["refer",{"_index":71,"title":{},"description":{"0":{}}}],["referenc",{"_index":235,"title":{},"description":{"15":{},"17":{},"36":{},"49":{}}}],["regardless",{"_index":264,"title":{},"description":{"26":{}}}],["region",{"_index":337,"title":{},"description":{"54":{}}}],["regular",{"_index":324,"title":{},"description":{"44":{}}}],["relat",{"_index":207,"title":{},"description":{"9":{},"15":{},"21":{},"34":{},"42":{},"47":{},"53":{},"55":{},"57":{},"59":{},"65":{}}}],["remov",{"_index":309,"title":{},"description":{"41":{}}}],["replac",{"_index":283,"title":{"33":{}},"description":{"33":{}}}],["report",{"_index":353,"title":{"56":{}},"description":{"56":{}}}],["request",{"_index":311,"title":{},"description":{"41":{},"56":{},"66":{},"67":{}}}],["requestbodi",{"_index":302,"title":{},"description":{"40":{},"41":{}}}],["requir",{"_index":98,"title":{},"description":{"2":{},"4":{},"5":{},"10":{},"11":{},"13":{},"14":{},"41":{},"54":{},"58":{}}}],["reset",{"_index":273,"title":{"30":{}},"description":{"30":{}}}],["resouc",{"_index":217,"title":{},"description":{"10":{},"12":{}}}],["resourc",{"_index":25,"title":{"54":{}},"description":{"0":{},"2":{},"44":{},"55":{}}}],["resource'",{"_index":82,"title":{},"description":{"0":{}}}],["respons",{"_index":28,"title":{},"description":{"0":{},"2":{},"66":{},"67":{}}}],["rest",{"_index":23,"title":{},"description":{"0":{},"2":{}}}],["restrict",{"_index":347,"title":{},"description":{"54":{}}}],["retriev",{"_index":228,"title":{"12":{},"18":{},"24":{},"37":{},"45":{},"50":{},"61":{}},"description":{"55":{}}}],["return",{"_index":27,"title":{"64":{}},"description":{"0":{},"10":{},"12":{},"16":{},"18":{},"22":{},"24":{},"35":{},"37":{},"43":{},"45":{},"48":{},"50":{},"54":{},"56":{},"58":{},"60":{},"61":{},"64":{},"66":{},"67":{}}}],["right",{"_index":160,"title":{},"description":{"2":{},"5":{},"54":{}}}],["role",{"_index":135,"title":{},"description":{"2":{},"11":{},"13":{},"14":{}}}],["satisfi",{"_index":285,"title":{},"description":{"33":{}}}],["save",{"_index":128,"title":{},"description":{"2":{}}}],["scope",{"_index":367,"title":{},"description":{"66":{},"67":{}}}],["scope=hpe-ten",{"_index":148,"title":{},"description":{"2":{}}}],["secret",{"_index":131,"title":{},"description":{"2":{}}}],["select",{"_index":245,"title":{},"description":{"23":{},"41":{}}}],["separ",{"_index":294,"title":{},"description":{"36":{}}}],["server",{"_index":205,"title":{"8":{},"66":{}},"description":{"7":{},"21":{},"23":{},"65":{},"66":{},"67":{}}}],["servic",{"_index":12,"title":{},"description":{"0":{},"2":{},"3":{},"54":{},"66":{},"67":{}}}],["set",{"_index":220,"title":{"31":{},"32":{}},"description":{"10":{},"11":{},"23":{},"31":{},"32":{},"33":{},"58":{}}}],["singl",{"_index":44,"title":{},"description":{"0":{},"3":{},"12":{},"18":{},"24":{},"28":{},"29":{},"30":{},"31":{},"32":{},"37":{},"45":{},"50":{},"61":{},"62":{}}}],["site",{"_index":350,"title":{},"description":{"54":{},"66":{},"67":{}}}],["siteid",{"_index":372,"title":{},"description":{"66":{},"67":{}}}],["size",{"_index":65,"title":{},"description":{"0":{},"53":{},"54":{},"58":{}}}],["sn",{"_index":86,"title":{},"description":{"0":{}}}],["solid",{"_index":171,"title":{},"description":{"2":{}}}],["sometim",{"_index":13,"title":{},"description":{"0":{}}}],["space",{"_index":119,"title":{"5":{}},"description":{"2":{},"5":{},"9":{},"10":{},"11":{},"58":{}}}],["spaceid",{"_index":197,"title":{},"description":{"5":{},"10":{},"11":{},"58":{}}}],["spec",{"_index":87,"title":{},"description":{"0":{}}}],["specif",{"_index":70,"title":{},"description":{"0":{},"3":{},"11":{},"54":{},"66":{},"67":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/circle-information.svg",{"_index":180,"title":{},"description":{"2":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/clipboard.svg",{"_index":176,"title":{},"description":{"2":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg",{"_index":123,"title":{},"description":{"2":{},"5":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/user.svg",{"_index":157,"title":{},"description":{"2":{},"5":{}}}],["ssh",{"_index":234,"title":{"17":{},"18":{},"19":{},"20":{}},"description":{"15":{},"17":{},"18":{},"20":{}}}],["sshkey",{"_index":233,"title":{"15":{},"16":{}},"description":{"16":{},"17":{}}}],["sshkeyid",{"_index":249,"title":{},"description":{"23":{}}}],["sshkeys/{sshkeyid",{"_index":236,"title":{},"description":{"18":{},"19":{},"20":{}}}],["state",{"_index":255,"title":{},"description":{"25":{},"26":{},"27":{},"33":{},"38":{},"54":{}}}],["storag",{"_index":51,"title":{"67":{}},"description":{"0":{},"34":{},"53":{},"54":{},"65":{}}}],["storageinventori",{"_index":349,"title":{},"description":{"54":{}}}],["style=\"color",{"_index":165,"title":{},"description":{"2":{}}}],["such",{"_index":328,"title":{},"description":{"53":{}}}],["support",{"_index":103,"title":{},"description":{"2":{}}}],["sure",{"_index":127,"title":{},"description":{"2":{}}}],["svcflavor",{"_index":246,"title":{},"description":{"23":{}}}],["svcversion",{"_index":247,"title":{},"description":{"23":{}}}],["symbol",{"_index":201,"title":{},"description":{"5":{}}}],["system",{"_index":346,"title":{},"description":{"54":{}}}],["tabl",{"_index":79,"title":{},"description":{"0":{}}}],["target=\"_blank",{"_index":121,"title":{},"description":{"2":{},"5":{}}}],["team",{"_index":225,"title":{},"description":{"11":{}}}],["tenant/host",{"_index":369,"title":{},"description":{"66":{},"67":{}}}],["those",{"_index":355,"title":{},"description":{"58":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["token",{"_index":100,"title":{},"description":{"2":{},"3":{},"4":{},"10":{},"11":{},"58":{},"66":{},"67":{}}}],["top",{"_index":159,"title":{},"description":{"2":{},"5":{}}}],["two",{"_index":104,"title":{},"description":{"2":{}}}],["type",{"_index":94,"title":{},"description":{"0":{},"2":{},"53":{},"66":{},"67":{}}}],["type'",{"_index":364,"title":{},"description":{"66":{},"67":{}}}],["type=\"button",{"_index":163,"title":{},"description":{"2":{}}}],["ubuntu",{"_index":333,"title":{},"description":{"54":{}}}],["ui",{"_index":78,"title":{},"description":{"0":{}}}],["ui</h2",{"_index":152,"title":{},"description":{"2":{}}}],["understood",{"_index":314,"title":{},"description":{"41":{}}}],["updat",{"_index":231,"title":{"13":{},"19":{},"25":{},"38":{},"51":{},"62":{}},"description":{"13":{},"25":{},"38":{},"40":{},"41":{},"62":{}}}],["url",{"_index":26,"title":{},"description":{"0":{},"2":{},"5":{}}}],["us",{"_index":35,"title":{},"description":{"0":{},"2":{},"3":{},"4":{},"10":{},"11":{},"44":{},"54":{},"58":{},"66":{},"67":{}}}],["usag",{"_index":339,"title":{"56":{}},"description":{"54":{},"55":{},"56":{}}}],["usage-report",{"_index":352,"title":{"55":{}},"description":{"56":{}}}],["user",{"_index":99,"title":{"58":{}},"description":{"2":{},"58":{}}}],["valu",{"_index":191,"title":{},"description":{"5":{},"23":{},"38":{},"66":{},"67":{}}}],["value=\"api",{"_index":164,"title":{},"description":{"2":{}}}],["version",{"_index":202,"title":{"7":{},"8":{}},"description":{"7":{},"8":{},"54":{}}}],["via",{"_index":325,"title":{},"description":{"44":{}}}],["view",{"_index":240,"title":{},"description":{"21":{}}}],["visibl",{"_index":297,"title":{},"description":{"38":{}}}],["volum",{"_index":52,"title":{"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"43":{},"45":{},"54":{}},"description":{"0":{},"9":{},"10":{},"11":{},"12":{},"25":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"44":{},"45":{},"53":{},"54":{},"58":{}}}],["volume-attach",{"_index":319,"title":{"42":{}},"description":{"43":{},"44":{}}}],["volume-attachments/{attachmentid",{"_index":323,"title":{},"description":{"44":{},"45":{},"46":{}}}],["volumeattach",{"_index":303,"title":{"44":{},"46":{}},"description":{"40":{},"41":{},"42":{},"43":{},"44":{},"46":{}}}],["volumeflavor",{"_index":351,"title":{},"description":{"54":{},"58":{}}}],["volumes/{volumeid",{"_index":295,"title":{},"description":{"37":{},"38":{},"39":{}}}],["volumes/{volumeid}/attach",{"_index":307,"title":{},"description":{"40":{},"44":{}}}],["volumes/{volumeid}/detach",{"_index":318,"title":{},"description":{"41":{}}}],["way",{"_index":110,"title":{},"description":{"2":{}}}],["welcom",{"_index":1,"title":{},"description":{"0":{}}}],["well",{"_index":313,"title":{},"description":{"41":{}}}],["within",{"_index":43,"title":{"10":{},"58":{}},"description":{"0":{},"3":{},"11":{},"16":{},"22":{},"35":{},"36":{},"43":{},"48":{},"55":{},"60":{}}}],["workflow",{"_index":269,"title":{},"description":{"27":{},"33":{}}}],["wrong",{"_index":317,"title":{},"description":{"41":{}}}],["x",{"_index":138,"title":{},"description":{"2":{}}}]],"pipeline":[]}},"options":{}};
+    const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"HPE GreenLake for bare metal API","version":"v1","license":{"name":"HPE End User License Agreement","url":"https://www.hpe.com/us/en/software/licensing.html"},"description":" \n# Introduction\nWelcome to HPE GreenLake for bare metal APIs. \n\nThe HPE GreenLake for bare metal is included as part of the HPE GreenLake for Private Cloud\nEnterprise service, and it is sometimes also called Bare Metal as a Service or BMaaS.\n\nThis document describes the HPE GreenLake for bare metal APIs protocol and available endpoints.\n\nThe BMaaS API is built on HTTP and is RESTful. It has predictable resource URLs. It returns HTTP \nresponse codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can \nuse your favorite HTTP/REST library for your programming language to use HPE GreenLake for Private \nCloud Enterprise bare metal APIs.\n\nThe APIs provides access to bare metal service within a single project context. Clients can create \nfully-provisioned hosts, storage volumes, and project-specific private networks in an isolated \nproject environment. Clients can also access information about available services and resources \nthrough the available-resources API. This API provides detailed information about OS imaging options, \nmachine size options, storage volume options, and data center locations which are needed when creating \nhosts and volumes.\n\nThe API specification references a few resources by the deprecated name, which differs from the name \ndisplayed in HPE GreenLake Central UI. The table below maps the resource's old name in the API \nspecification with the corresponding name in HPE GreenLake Central UI.\n\n| **SN** | **Name in API Spec** | **Name in GreenLake Central** |\n|--------|----------------------|-------------------------------|\n| 1      | Project              | Compute Group                 |\n| 2      | Host                 | Compute Instance              |\n| 3      | Machine Size         | Compute Instance Type         |\n\n\n# Authentication\n\n## Bearer Auth\n\nThe HPE GreenLake for bare metal APIs use Bearer Authentication that requires the users to provide \na bearer token in the **Authorization** header. The service supports two types of tokens, the HPE \nGreenLake IAM token and the Metal classic token. The Metal classic token is for HPE internal use only.\nThe clients are required to provide HPE GreenLake IAM token to authenticate with the HPE GreenLake \nfor bare metal APIs. The access token can be obtained using any of the following ways.\n\n<h2>Option 1: API client(recommended)</h2>\n\nAn API client allows nonhuman entities (an application service account, for instance) programmatic access to a resource on a space.\n\n  + 1.\n<a\n    href=\"https://support.hpe.com/hpesc/public/docDisplay?docId=a00092451en_us&page=greenlakecentral-create-api-client.html\"\n    target=\"_blank\">\n    Create an API client\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>\n\n**Note:** Make sure to save the **Issuer Url**, **Client ID**, and **Client Secret**\n\n  + 2.\n<a\n    href=\"https://support.hpe.com/hpesc/public/docDisplay?docId=a00092451en_us&page=GUID-1CEA233B-C4B0-41B7-9A25-7A36D9FC0312.html\"\n    target=\"_blank\">\n    Creating an assignment for an API client\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>\n\n**Note:** Make sure to assign the appropriate HPE GreenLake for bare metal user roles in HPE GreenLake Central.\n\n  + 3. Make a REST call to generate the API access token:\n\n```\ncurl -i -X POST \\\n  '{issuerUrl}/v1/token' \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -d 'client_id={clientID}' \\\n  -d 'client_secret={clientSecret}' \\\n  -d grant_type=client_credentials \\\n  -d scope=hpe-tenant\n```\nObtain the `access_token` from the response.\n\n<h2>Option 2: Getting the token directly from UI</h2>\n\nTo authenticate with the BMaaS API you need to obtain the access token from\n<a\n    href=\"https://client.greenlake.hpe.com\"\n    target=\"_blank\">\n    HPE GreenLake Central\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>.\nOnce logged in to **HPE GreenLake Central**,\nClick the\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/user.svg\">\nicon in the top right corner and then click\n<input\n    type=\"button\"\n    value=\"API Access\"\n    style=\"color: #000;\n        background-color: #fff;\n        border: 2px solid #00b388;\n        border-radius: 4px;\"/>\n. In the API Access page, click the\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/clipboard.svg\">\nicon to copy the personal access token.\n\n<br>\n\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/circle-information.svg\"> **INFO**\nFor both the options, the access token lease expires in **15** minutes.\n\n## Project API Key\nThe specific Project ID must be provided with **Project** header when accessing service within a single project context.\nUsed only when using HPE GreenLake IAM issued access tokens.\n\n## Membership API Key\nHPE Internal use only. Required only when using classic Metal access tokens.\n\n# Getting a Space name or ID\nSpace name or ID is required in header for a few Project level APIs. You can obtain the Space name and the corresponding ID from \n<a\n    href=\"https://client.greenlake.hpe.com\"\n    target=\"_blank\">\n    HPE GreenLake Central\n    <img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg\"\n    height=\"12\">\n</a>.   \nOnce logged in to **HPE GreenLake Central**,\nClick the\n<img src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/user.svg\">\nicon in the top right corner and copy the value of **Space** field.  \n\nThe corresponding ID for the Space can be extracted from the current URL in the address bar.  \nIt is the value of **spaceid** query parameter at the end of a URL after a '?' symbol.\n\n# HPE GreenLake for bare metal APIs\n"},"servers":[{"url":"https://client.greenlake.hpe.com{basePath}","description":"HPE GreenLake Central","variables":{"basePath":{"default":"/api/metal/rest/v1","description":"URL prefix for endpoints"}}}],"security":[{"BearerAuth":[],"Project":[]},{"BearerAuth":[],"Membership":[]}],"tags":[{"name":"version","description":"Read-only operation to get api server build version information.\n"},{"name":"projects","description":"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.\n"},{"name":"sshkeys","description":"Operations related to SSH Keys. Clients may define SSH Keys that can then be referenced by ID when creating a Host.\n"},{"name":"hosts","description":"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.\n"},{"name":"volumes","description":"Operations related to Volumes. A Volume is an external storage volume that persists independent of the associated host.\n"},{"name":"volume-attachments","description":"Operations related to VolumeAttachments that describe how a host is connected to a volume.\n"},{"name":"networks","description":"Operations related to Networks.\n"},{"name":"available-resources","description":"Operations related to listing information that is needed to construct create host and create volume calls. This provides a detailed information about the OS imaging options,  the machine size (a.k.a. Compute Instance Type) options, the storage volume options,  data center locations, and such that are needed when creating hosts and volumes.\n"},{"name":"usage-reports","description":"Operations related to retrieving information about resource usage within the project.\n"},{"name":"projects-info","description":"Operations related to listing information related to projects.\n"},{"name":"ippools","description":"Operations related to IP pools.\n"},{"name":"allocation","description":"Operations related to listing information about allocation by servers and storage.\n"}],"paths":{"/version":{"get":{"tags":["version"],"summary":"Get api server build version","operationId":"Versions_get","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/projects":{"get":{"tags":["projects"],"summary":"List of all Projects within an organization or cluster","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 used for authentication, then it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored.","operationId":"Projects_list","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/SpaceID"},{"$ref":"#/components/parameters/Space"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["projects"],"summary":"Create a new project","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 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.","operationId":"Project_add","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Space"},{"$ref":"#/components/parameters/SpaceID"}],"requestBody":{"required":true,"description":"NewProject parameters to create a new Project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewProject"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/projects/{projectId}":{"get":{"tags":["projects"],"summary":"Retrieve a project by its ID","description":"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.","operationId":"Project_getByID","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"name":"projectId","in":"path","description":"ID of project to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["projects"],"summary":"Update a project by its ID","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.","operationId":"Project_update","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"name":"projectId","in":"path","description":"ID of project to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Project parameters to update an existing Project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["projects"],"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.","operationId":"Project_delete","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"name":"projectId","in":"path","description":"ID of project to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/projects-info":{"get":{"tags":["projects-info"],"summary":"List of all projects info within an organization or cluster for which user is authorized.","description":"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.\n\nWhen 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.","operationId":"ProjectsInfo_list","security":[{"BearerAuth":[],"Membership":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/Space"},{"$ref":"#/components/parameters/SpaceID"},{"$ref":"#/components/parameters/SiteID"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ProjectsInfo"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/sshkeys":{"get":{"tags":["sshkeys"],"summary":"List all sshkeys in project","description":"Returns an array of all SSHKey objects defined within the project.","operationId":"SSHKeys_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SSHKey"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["sshkeys"],"summary":"Add a new SSH Key","description":"Adds a new SSH Key that can be referenced when creating a Host","operationId":"SSHKey_add","requestBody":{"required":true,"description":"SSH Key that is to be added to the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSSHKey"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/sshkeys/{sshkeyId}":{"summary":"Operations on a single SSH Key","get":{"tags":["sshkeys"],"summary":"Retrieve SSH Key by ID","description":"Returns a single SSH key with matching ID","operationId":"SSHKey_getByID","parameters":[{"name":"sshkeyId","in":"path","description":"ID of sshkey to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["sshkeys"],"summary":"Update an existing SSH Key.  Only 'Name' or 'Key' fields can be changed.","description":"","operationId":"SSHKey_update","parameters":[{"name":"sshkeyId","in":"path","description":"ID of sshkey to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Updated SSH key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHKey"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["sshkeys"],"summary":"Delete an SSH key","description":"Deletes the SSH key with the matching ID","operationId":"SSHKey_delete","parameters":[{"name":"sshkeyId","in":"path","description":"ID of sshkey to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts":{"get":{"tags":["hosts"],"summary":"List all Hosts in project","description":"Returns an array of all Host objects defined within the project.","operationId":"Hosts_list","parameters":[{"in":"query","name":"all","required":false,"schema":{"type":"string","enum":["true"]},"description":"Includes deleted Host objects in the response when set to \"true\"."}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Host"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["hosts"],"summary":"Create a new Host","description":"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.\nThe SvcFlavor, SvcVersion, LocationID, SSHKeyIDs, and Network attribute must all be set with appropriate ID values from the available-resources call.","operationId":"Host_add","requestBody":{"required":true,"description":"Defines the configuration of the desired host. See the schema for descriptions of individual attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewHost"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}":{"summary":"Operations associated with a specific host","get":{"tags":["hosts"],"summary":"Retrieve Host by ID","description":"Returns a single Host with matching ID","operationId":"Host_getByID","parameters":[{"name":"hostId","in":"path","description":"ID of Host to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["hosts"],"summary":"Update an existing Host","description":"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.","operationId":"Host_update","parameters":[{"name":"hostId","in":"path","description":"ID of host to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Updated Host","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["hosts"],"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","operationId":"Host_delete","parameters":[{"name":"hostId","in":"path","description":"ID of Host to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/maintenance":{"summary":"Do maintenance on a specific host","post":{"tags":["hosts"],"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 Failed state and in the Maintenance workflow.","operationId":"maintenance","parameters":[{"name":"hostId","in":"path","description":"ID of Host to do maintenance on","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/poweron":{"summary":"Power on a specific host","post":{"tags":["hosts"],"summary":"Power on Host by ID","description":"Powers on a single Host with matching ID","operationId":"powerOn","parameters":[{"name":"hostId","in":"path","description":"ID of Host to power on","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/poweroff":{"summary":"Power off a specific host","post":{"tags":["hosts"],"summary":"Power off Host by ID","description":"Powers off a single Host with matching ID","operationId":"powerOff","parameters":[{"name":"hostId","in":"path","description":"ID of Host to power off","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/powerreset":{"summary":"Reset a specific host","post":{"tags":["hosts"],"summary":"Reset Host by ID","description":"Resets a single Host with matching ID","operationId":"powerReset","parameters":[{"name":"hostId","in":"path","description":"ID of Host to reset","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/bootpxe":{"summary":"Set a specific host to attempt PXE boot","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","operationId":"bootPXE","parameters":[{"name":"hostId","in":"path","description":"ID of Host to set to PXE boot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/boothdd":{"summary":"Set a specific host to attempt HDD boot","post":{"tags":["hosts"],"summary":"Set HDD boot order on Host by ID","description":"Sets a single Host with matching ID to attempt HDD boot","operationId":"bootHDD","parameters":[{"name":"hostId","in":"path","description":"ID of Host to set to HDD boot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/hosts/{hostId}/replace":{"summary":"Replace a specific host","post":{"tags":["hosts"],"summary":"Replace Host by ID","description":"Re-deploys a host with a new machine that satisfies the current host settings. 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.","operationId":"replace","parameters":[{"name":"hostId","in":"path","description":"ID of Host to replace","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Host"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/available-resources":{"get":{"tags":["available-resources"],"operationId":"AvailableResources_list","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. A get /available-resources will return an object that includes the following arrays:\n* Images - A list of image service IDs along with their category (Linux), \n  flavor (ubuntu), and version (18.04)\n\n* MachineSizes - A list of machine size IDs along with the machine size \n  names and detailed descriptions\n\n* Locations - A list of location IDs along with their country, region, \n  and data center.\n\n* Networks - A list of available Network IDs along with the network name,\n  location ID, network kind, and host usage (Required, Default, Optional)\n\n* MachineInventory - Information about the available inventory of machines \n  based on location ID and machine size ID.  While this information may \n  change rapidly, it can be used by GUIs and systems to restrict host\n  creates to locations with the desired machine size.\n\n* StorageInventory - Information about the current available storage capacity \n  for a specific volume flavor by site. \n\n* VolumeFlavors - A list of volume flavor IDs along with their name and \n  detailed description.\n\n* Volumes - A list of current, existing volumes.  If the volume is in the\n  the right state, it could be attached to a new Host.\n","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableResources"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes":{"get":{"tags":["volumes"],"summary":"List all volumes in project","description":"Returns an array of all volumes defined within the project.","operationId":"Volumes_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Volume"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["volumes"],"summary":"Add a new volume","description":"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.\n","operationId":"Volume_add","requestBody":{"required":true,"description":"Volume that is to be added to the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewVolume"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes/{volumeId}":{"summary":"Operations on a single volume","get":{"tags":["volumes"],"summary":"Retrieve volume by ID","description":"Returns a single volume with matching ID","operationId":"Volume_getByID","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["volumes"],"summary":"Update an existing volume","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. \n","operationId":"Volume_update","requestBody":{"required":true,"description":"Volume object with its ID and Capacity in GiB indicating the expanded size to be specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volume"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["volumes"],"summary":"Delete a volume","description":"Deletes the volume with the matching ID","operationId":"Volume_delete","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes/{volumeId}/attach":{"post":{"tags":["volumes"],"summary":"Attach existing volume to Host","description":"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.\n","operationId":"Volume_attach","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to attach","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Unique ID of the Host to which the volume will be attached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachHostUUID"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachment"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volumes/{volumeId}/detach":{"post":{"tags":["volumes"],"summary":"Detach existing volume from Host","description":"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.\nNote 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.\n","operationId":"Volume_detach","parameters":[{"name":"volumeId","in":"path","description":"ID of volume to attach","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Unique ID of the Host from which a volume will be detached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachHostUUID"}}}},"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volume-attachments":{"get":{"tags":["volume-attachments"],"summary":"List all volume attachments in project","description":"Returns an array of all VolumeAttachments defined within the project.","operationId":"VolumeAttachments_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VolumeAttachment"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["volume-attachments"],"summary":"Create a new VolumeAttachment","description":"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.","operationId":"VolumeAttachments_add","requestBody":{"required":true,"description":"NewVolumeAttachement parameters to create a new VolumeAttachment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewVolumeAttachment"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachment"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/volume-attachments/{attachmentId}":{"summary":"Operations on a single volume attachment","get":{"tags":["volume-attachments"],"summary":"Retrieve volume attachment by ID","description":"Returns a single volume attachment with matching ID","operationId":"VolumeAttachment_getByID","parameters":[{"name":"attachmentId","in":"path","description":"ID of volume attachment to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VolumeAttachment"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["volume-attachments"],"summary":"Delete a VolumeAttachment","description":"Deletes the VolumeAttachment with the matching ID","operationId":"VolumeAttachment_delete","parameters":[{"name":"attachmentId","in":"path","description":"ID of VolumeAttachment to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/networks":{"get":{"tags":["networks"],"summary":"List all networks in project","description":"Returns an array of all network objects defined within the project.","operationId":"Networks_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"tags":["networks"],"summary":"Add a new network","description":"Adds a new network that can be referenced when creating a Host","operationId":"Network_add","requestBody":{"required":true,"description":"Network that is to be added to the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewNetwork"}}}},"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/networks/{networkId}":{"summary":"Operations on a single network","get":{"tags":["networks"],"summary":"Retrieve network by ID","description":"Returns a single network with matching ID","operationId":"Network_getByID","parameters":[{"name":"networkId","in":"path","description":"ID of network to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"tags":["networks"],"summary":"Update an existing network.","description":"","operationId":"Network_update","parameters":[{"name":"networkId","in":"path","description":"ID of network to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Updated network","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Network"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/InvalidInput"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"tags":["networks"],"summary":"Delete a network","description":"Deletes the network with the matching ID","operationId":"Network_delete","parameters":[{"name":"networkId","in":"path","description":"ID of network to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/usage-reports":{"get":{"tags":["usage-reports"],"summary":"Get a usage report","description":"Creates and returns a usage report based on the parameters passed in the request body\n","operationId":"UsageReport_get","parameters":[{"in":"query","name":"start","required":true,"schema":{"type":"string"},"description":"Start of the billing period"},{"in":"query","name":"end","required":false,"schema":{"type":"string"},"description":"End of the billing period, default to now if omitted"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageReport"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"405":{"$ref":"#/components/responses/InvalidInput"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools":{"get":{"tags":["ippools"],"summary":"List all ip pools in project","description":"Returns an array of all ip pool objects defined within the project.","operationId":"IPPool_list","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPPool"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools/{ippoolId}":{"summary":"Operations on a single IP pool","get":{"tags":["ippools"],"summary":"Retrieve IP pool by ID","description":"Returns a single ip pool with matching ID","operationId":"IPPool_getByID","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"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.","operationId":"IPPool_update","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to update","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Update IPPool","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools/{ippoolId}/allocation":{"summary":"Operations on a single IP pool","post":{"tags":["ippools"],"summary":"Allocate IPs from the pool","description":"Allocate IPs from the pool","operationId":"IPPool_allocateIPs","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to allocate IPs","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"IPs being requested starting from an optional base IP and their usage","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IPAllocation"}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/ippools/{ippoolId}/return":{"summary":"Operations on a single IP pool","post":{"tags":["ippools"],"summary":"Return IPs to the pool","description":"Return IPs to the pool","operationId":"IPPool_returnIPs","parameters":[{"name":"ippoolId","in":"path","description":"ID of IP pool to return IPs","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"IP returned to the pool","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"15.0.0.1"}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPPool"}}}},"400":{"$ref":"#/components/responses/InvalidContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/allocation/servers":{"get":{"tags":["allocation"],"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.\nWhen 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.\nIf the 'siteID' query parameter is present, the information returned is specific to that site ID.\n","operationId":"allocation_getBySite","parameters":[{"name":"siteID","in":"query","description":"site ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Allocation"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/allocation/storage":{"get":{"tags":["allocation"],"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.\nWhen 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.\nIf the 'siteID' query parameter is present, the information returned is specific to that site ID.\n","operationId":"allocation_storage_getBySite","parameters":[{"name":"siteID","in":"query","description":"site ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AllocationStorage"},"type":"array"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}},"components":{"securitySchemes":{"BearerAuth":{"description":"Uses JWT as a bearer token to validate access","type":"http","scheme":"bearer","bearerFormat":"JWT"},"Project":{"description":"The project ID. Required only when using GreenLake IAM issued JWT for authentication","type":"apiKey","in":"header","name":"Project"},"Membership":{"description":"The Metal membership ID. Required only when using Metal service issued JWT for authentication","type":"apiKey","in":"header","name":"Membership"}},"schemas":{"Version":{"type":"object","properties":{"Build":{"type":"string","example":"0.8.6-dev-218-g0b3b1ad"}}},"ErrorResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Description of the error condition"},"details":{"type":"string","description":"Optional verbose description of the error condition"}}},"ResourceBase":{"type":"object","required":["ID","ETag","Name"],"properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for the resource instance as generated by the Metal service"},"ETag":{"type":"string","format":"uuid","description":"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."},"Name":{"type":"string","example":"My Object Name","description":"Common name for the resource instance. Must be 128 or fewer printable characters"},"Created":{"type":"string","format":"date-time","example":"2019-06-27T22:59:01.661Z","description":"Time when the resource was created in the database"},"Modified":{"type":"string","format":"date-time","example":"2020-02-27T18:28:02.863Z","description":"Time when the resource was last modified in the database"}}},"Profile":{"type":"object","properties":{"TeamName":{"type":"string","description":"Name of the Project Team. Must not be empty, maximum 128 printable characters"},"TeamDesc":{"type":"string","description":"Optional description of the Project Team, maximum 256 printable characters"},"Company":{"type":"string","description":"Optional name of the company, maximum 256 printable characters"},"Address":{"type":"string","description":"Optional address of the company, maximum 256 printable characters"},"Email":{"type":"string","description":"Optional email address of the contact person for the team, maximum 256 printable characters"},"EmailVerified":{"type":"boolean","description":"Currently always false"},"PhoneNumber":{"type":"string","description":"Optional phone number of the contact person for the team, maximum 32 printable characters"},"PhoneVerified":{"type":"boolean","description":"Currently always false"}}},"Limits":{"type":"object","required":["Hosts","Volumes","VolumeCapacity","PrivateNetworks"],"properties":{"Hosts":{"type":"integer","description":"Maximum number of hosts to allow","minimum":0},"Volumes":{"type":"integer","description":"Maximum number of volumes to allow","minimum":0},"VolumeCapacity":{"type":"integer","format":"int64","description":"Maximum capacity to allow in TiB","minimum":0},"PrivateNetworks":{"type":"integer","description":"Maximum number of private networks to allow","minimum":0},"InstanceTypes":{"type":"object","additionalProperties":{"type":"integer"},"description":"Map of instance type ID to maximum number of hosts that can be created with that instance type","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee90":1}}}},"ProjectResources":{"type":"object","properties":{"Hosts":{"type":"integer","description":"Number of hosts in use","minimum":0},"Volumes":{"type":"integer","description":"Number of volumes in use","minimum":0},"VolumeCapacity":{"type":"integer","format":"int64","description":"Volume capacity in use in TiB","minimum":0},"PrivateNetworks":{"type":"integer","description":"Number of private networks in use","minimum":0},"InstanceTypes":{"type":"object","additionalProperties":{"type":"integer"},"description":"Number of hosts with the instance type in use","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee90":1}}}},"Project":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Profile","Limits"],"properties":{"Profile":{"description":"Profile is a generalized description of a team","$ref":"#/components/schemas/Profile"},"Limits":{"description":"Project Limits place general constraints on a project in terms of server and storage","$ref":"#/components/schemas/Limits"},"Resources":{"description":"Project resources provides resources currently utilized by the project","$ref":"#/components/schemas/ProjectResources"},"PermittedSites":{"description":"Array listing the permitted site IDs","type":"array","items":{"type":"string","format":"uuid"},"example":["046b6c7f-0b8a-43b9-b35d-6489e6daee91","91eec8b5-6460-4532-aad1-47b983edb63c"]}}}]},"NewProject":{"type":"object","required":["Name","Profile","Limits"],"properties":{"Name":{"type":"string","example":"Project foobar"},"Profile":{"description":"Profile is a generalized description of a team","$ref":"#/components/schemas/Profile"},"Limits":{"description":"Project Limits place general constraints on a project in terms of server and storage","$ref":"#/components/schemas/Limits"},"PermittedSites":{"description":"Array listing the permitted site IDs","type":"array","items":{"type":"string","format":"uuid"},"example":["046b6c7f-0b8a-43b9-b35d-6489e6daee91","91eec8b5-6460-4532-aad1-47b983edb63c"]}}},"HealthStatus":{"type":"string","enum":["OK","Warning","Critical","Unknown"]},"Country":{"type":"string","enum":["USA","AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","KHM","CMR","CAN","CPV","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MKD","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWZ","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE"]},"LocationInfo":{"type":"object","description":"Entry on data center with its location ID and country, region, and data center description strings","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for data center location"},"Country":{"$ref":"#/components/schemas/Country"},"Region":{"type":"string","example":"Central","description":"Region within the indicated country"},"DataCenter":{"type":"string","example":"FTC1","description":"Data center descriptor"}}},"ProjectInfo":{"type":"object","properties":{"ID":{"type":"string"},"Name":{"type":"string"},"Description":{"type":"string"},"NumHosts":{"type":"integer"},"NumVolumes":{"type":"integer"},"TotalStorageGB":{"type":"integer"},"Status":{"type":"string","enum":["Enabled","Disabled"]},"NumNetworks":{"type":"integer","description":"Number of project networks"},"SummaryStatus":{"$ref":"#/components/schemas/HealthStatus","description":"Project health status"},"Locations":{"type":"array","items":{"$ref":"#/components/schemas/LocationInfo"},"description":"Locations where project resources exist"}}},"MachineSizeInfo":{"type":"object","properties":{"Name":{"type":"string"},"ProjectsUsed":{"type":"integer"},"OtherUsed":{"type":"integer"},"Available":{"type":"integer"},"ID":{"type":"string","format":"uuid"},"Restricted":{"type":"boolean","description":"True if the usage of this machine size is restricted  to selected projects, false if the machine size is available to anyone.\n"}}},"VolumeFlavorsInfo":{"type":"object","properties":{"Name":{"type":"string"},"ProjectsUsed":{"type":"integer"},"OtherUsed":{"type":"integer"},"Available":{"type":"integer"}}},"SummaryInfo":{"type":"object","properties":{"Locations":{"type":"array","items":{"$ref":"#/components/schemas/LocationInfo"},"description":"Locations where resources exist for all listed projects"},"NumHosts":{"type":"integer","description":"Number of hosts for all listed projects"},"NumVolumes":{"type":"integer","description":"Number of volumes for all listed projects"},"TotalStorageGB":{"type":"integer","description":"Total storage for all listed projects"},"NumOK":{"type":"integer","description":"Number of projects with OK health summary status"},"NumWarning":{"type":"integer","description":"Number of projects with Warning health summary status"},"NumCritical":{"type":"integer","description":"Number of projects with Critical health summary status"},"NumUnknown":{"type":"integer","description":"Number of projects with Unknown health summary status"}}},"ProjectsInfo":{"type":"object","properties":{"Projects":{"type":"array","items":{"$ref":"#/components/schemas/ProjectInfo"}},"MachineSizes":{"type":"array","items":{"$ref":"#/components/schemas/MachineSizeInfo"}},"VolumeFlavors":{"type":"array","items":{"$ref":"#/components/schemas/VolumeFlavorsInfo"}},"Summary":{"$ref":"#/components/schemas/SummaryInfo","description":"Aggregate consumption and health counts of projects at the specified locations"}}},"SSHKeyValue":{"type":"string","description":"SSH key value","example":"'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCxv1C5uOeG9BBjfQbum9GupGthTFcifS4FNYxZ2ZakN9UcpD05L2lKp4OI6mfCfciOhJ9SHduZWJFM0pYfC99hIsPAHhEwWOjh3/rHKxB/U4RYN4VFWM+ShDv92+k0Hse73HhuiHKVtmRj/fltAeCFm/mPlL+McMYFhFYMIK8b/spKpXxdEBCSowHPGIn3yi0ivPWhC4wcIa9jDIela/a0t/oDnYTeIp2WMLDbpZyQsGHmKopAAvb+83JhwytQMVTI/g5pMerbqPyxKtWaWDVDtpQ7O8G877T5U3kkl4jLLOJywxrvLrfHh1UNdNvPmvRFd+ct9Q5ugj5CIMJHqWTj Joe@Laptop.local'\n"},"SSHKey":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Key"],"properties":{"Key":{"$ref":"#/components/schemas/SSHKeyValue"}}}]},"NewSSHKey":{"type":"object","required":["Name","Key"],"properties":{"Name":{"type":"string","example":"Joe's Laptop"},"Key":{"$ref":"#/components/schemas/SSHKeyValue"}}},"HostISCSIConfig":{"type":"object","nullable":true,"required":["InitiatorName"],"properties":{"InitiatorName":{"type":"string","description":"Fully qualified iSCSI intiator name of this host. This is generated when a host is created and the information is pushed to the new host\n"},"CHAPSecret":{"type":"string","description":"CHAP secret as generated by the system when attaching a volume.   Visible in VolumeAttachment object.\n"},"CHAPUser":{"type":"string","description":"CHAP user as generated by the system when attaching a volume.   Visible in VolumeAttachment object.\n"},"ISCSIDiscoveryAddress":{"type":"string"}}},"HostServerPort":{"type":"object","properties":{"Name":{"type":"string","description":"Server port name","example":"lan5"},"HWAddr":{"type":"string","description":"Hardware address for the Ethernet interface (MAC)","example":"5c:b9:01:95:64:a0"}}},"HostNetworkConnection":{"type":"object","properties":{"Name":{"type":"string","description":"Name of the network connection","example":"HostConn1"},"NetworkID":{"type":"string","format":"uuid","description":"Unique ID corresponding to a network in the local data center"},"IP":{"type":"string","description":"IP address for the network connection","example":"10.5.3.4"},"Subnet":{"type":"string","description":"The IP subnet address","example":"10.5.3.0"},"Netmask":{"type":"string","example":"/24","enum":["/8","/9","/10","/11","/12","/13","/14","/15","/16","/17","/18","/19","/20","/21","/22","/23","/24","/25","/26","/27","/28","/29","/30","/31"]},"Gateway":{"type":"string","description":"The IP subnet gateway address","example":"10.5.3.1"},"DNS":{"type":"array","items":{"type":"string","example":"8.8.8.8"},"description":"List of DNS servers for the IP subnet"},"VLAN":{"type":"integer","description":"VLAN ID of the network"},"VNI":{"type":"integer","description":"VNI ID of the network"},"Untagged":{"type":"boolean","description":"True if the network is untagged"},"Proxy":{"type":"string","example":"http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080","description":"Optional web-proxy for external internet access should the IP subnet actually be behind a firewall"},"NoProxy":{"type":"string","example":"localhost,15.10.0.10,test.com","description":"Addresses or CIDRs for which proxy requests are not made"}}},"HostConnection":{"type":"object","properties":{"Name":{"type":"string","example":"Default"},"Ports":{"type":"array","items":{"$ref":"#/components/schemas/HostServerPort"}},"HA":{"type":"boolean","description":"Indicates whether the network connection should be a link aggregation group (LAG)"},"Speed":{"type":"string","enum":["100Mb","1Gb","10Gb","25Gb","50Gb","40Gb","100Gb"],"description":"The speed of the physical connection from the server to the top of rack switch","example":"1Gb"},"Networks":{"type":"array","items":{"$ref":"#/components/schemas/HostNetworkConnection"}}}},"HostPowerState":{"type":"string","enum":["ON","OFF","UNKNOWN"],"description":"Current power status of the underlaying physical server (machine)"},"HostState":{"type":"string","enum":["New","Deleting","Deleted","Failed","Updating Connections","Imaging","Connecting","Booting","Ready","Replacing","Releasing","Allocating","Maintenance"],"description":"Overall host state","example":"Ready"},"HostSubstate":{"type":"string","description":"Host substate within HostState","enum":["","Abort Deploy","Allocate","Attach Volumes","Boot Service-OS","Clear Log","Complete","Confirm Off","Confirm On","Connect","Connect Provisioning","Deploy","Detach Volumes","Error Recovery","Fail Cleanup","Failed","Init","Init Off","Isolate","In Maintenance","Power Off","Power On","Release","Release With Problem","Set Boot Disk","Snap Log","Update"],"example":"Complete"},"HostAlertInfo":{"type":"object","properties":{"Alert":{"type":"string","enum":["substate-timed-out","op-failed","vol-att-warning","unknown-state"],"description":"Identifies the type of alert","example":"op-failed"},"State":{"$ref":"#/components/schemas/HostState"},"Substate":{"$ref":"#/components/schemas/HostSubstate"},"Message":{"type":"string","description":"Provides some detailed description about the Alert","example":"Operation XXX completed as failed with status: YYY"},"Time":{"type":"string","format":"date-time"},"Ack":{"type":"boolean","description":"Used to acknowledge the alert so that the UI can list only unacknowledged alerts"}}},"Host":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Description","NetworkIDs","NetworkForDefaultRoute","NetworkUntagged"],"properties":{"Description":{"type":"string","example":"Description of Host"},"ServiceID":{"type":"string","format":"uuid","description":"The image service identifier used to image the server. ServiceID is one of those listed by the Images array returned as part of the get /available-resources call."},"ServiceFlavor":{"type":"string","example":"ubuntu","description":"Overall flavor of server image used to image the server"},"ServiceVersion":{"type":"string","example":"18.04-20190807","description":"Version of the ServiceFlavor used to image the server"},"LocationID":{"type":"string","format":"uuid","description":"The location of the machine assigned to the host.  LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call."},"MachineSizeName":{"type":"string","example":"HPE Large","description":"Name of the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call."},"MachineSizeID":{"type":"string","format":"uuid","description":"UniqueID referring to the machine size used to identify and select the machine assigned to the host.  MachineSizes are described by the MachineSize array returned by the get /available-resources call."},"MachineID":{"type":"string","format":"uuid","description":"UniqueID referring to the machine on which this host is running."},"SSHKeyIDs":{"type":"array","description":"IDs of SSH Keys used when configuring the Host","items":{"type":"string","format":"uuid"}},"SSHAuthorizedKeys":{"type":"array","description":"Specific SSH keys that were when configuring the host.","items":{"$ref":"#/components/schemas/SSHKeyValue"}},"NetworkIDs":{"type":"array","description":"The list of IDs corresponding to the networks that were provisioned to the host. These networks are among those listed in the Networks array returned by the get /available-resources call.","items":{"type":"string","format":"uuid"},"example":["046b6c7f-0b8a-43b9-b35d-6489e6daee91","91eec8b5-6460-4532-aad1-47b983edb63c"]},"NetworkForDefaultRoute":{"type":"string","format":"uuid","description":"The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee91"},"NetworkUntagged":{"type":"string","format":"uuid","description":"ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee92"},"PreAllocatedIPs":{"type":"array","description":"The list of pre-allocated IP addresses corresponding to the list of NetworkIDs. Pre-allocated IP addresses are optional, but required when updating a host containing Pre-allocated IP addresses.","items":{"type":"string"}},"ServiceNetsProviderMAC":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee91":"a2:c8:93:15:2a:76"}},"UserData":{"type":"string","description":"User-provided data attached to the image configuration data when the host was provisioned"},"NodeID":{"type":"string","example":"Node21","description":"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."},"ISCSIConfig":{"$ref":"#/components/schemas/HostISCSIConfig"},"Connections":{"type":"array","description":"Details describing host network connections","items":{"$ref":"#/components/schemas/HostConnection"}},"Deleted":{"type":"boolean","description":"True if the Host has been deleted."},"PortalCommOkay":{"type":"boolean","description":"Describes if the portal is in active communication to the device"},"PowerStatus":{"$ref":"#/components/schemas/HostPowerState"},"State":{"$ref":"#/components/schemas/HostState"},"Substate":{"$ref":"#/components/schemas/HostSubstate"},"StateTime":{"type":"string","format":"date-time"},"SubstateTime":{"type":"string","format":"date-time"},"Progress":{"type":"integer","format":"int64","minimum":0,"maximum":100},"Alert":{"type":"boolean"},"AlertInfo":{"type":"array","items":{"$ref":"#/components/schemas/HostAlertInfo"}},"Workflow":{"type":"string","description":"The current workflow the host is in"},"SummaryStatus":{"$ref":"#/components/schemas/HealthStatus","description":"Host health summary status"},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for the host.","example":{"serviceType":"BMaaS"}}}}]},"AddVolume":{"type":"object","properties":{"Name":{"type":"string","example":"NewVolumeName"},"Description":{"type":"string","example":"Description of New Volume"},"FlavorID":{"type":"string","format":"uuid","description":"This object is used for new volume creation in the host create operation. Since host create already has location ID that field is not provided in this object."},"Capacity":{"type":"integer","format":"int64","example":10,"minimum":0,"description":"The size of the volume in GiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"}}},"NewHost":{"type":"object","required":["Name","ServiceID","LocationID","MachineSizeID","SSHKeyIDs","NetworkIDs","NetworkForDefaultRoute"],"properties":{"Name":{"type":"string","example":"NewHostName","description":"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":{"type":"string","example":"Description of new Host"},"ServiceID":{"type":"string","format":"uuid","description":"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":{"type":"string","format":"uuid","description":"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.\nThe location ID must also be one that has sufficient inventory for the selected MachineSize.  See the MachineInventory array as returned by the get /available-resources call to select a location that has machines available with the correct machine size."},"MachineSizeID":{"type":"string","format":"uuid","description":"The machine size ID must be one of those listed in the MachineSizes array returned as part of the get /available-resources call.  This array provides the name and detailed description for each machine size.  Use the MachineInventory array provided by the get /available-resources call to find a location with an adequate inventory of machines with the desired machine size."},"MachineID":{"type":"string","format":"uuid","description":"The machine ID is normally not used."},"SSHKeyIDs":{"type":"array","description":"These IDs must correspond to the IDs for SSH keys already created within the context of the project.  These SSH keys and those included as SSHAuthorizedKeys will be used together to provision SSH keys when the machine is imaged.","items":{"type":"string","format":"uuid"}},"NetworkIDs":{"type":"array","description":"The list of IDs corresponding to the networks that will be provisioned to the host. These networks must be among those listed in the Networks array returned by the get /available-resources call.  This list must include the ID for any network identified by the HostUseEnum as Required.","items":{"type":"string","format":"uuid"}},"PreAllocatedIPs":{"type":"array","description":"A list of pre-allocated IP addresses to be used for corresponding networks. This array of IP addresses, if present, is in one-to-one correspondence with Networks.","items":{"type":"string"},"example":["10.0.0.4","10.0.0.8"]},"NetworkForDefaultRoute":{"type":"string","format":"uuid","description":"The host's default network ID. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee91"},"NetworkUntagged":{"type":"string","format":"uuid","description":"ID of the network selected to be untagged. This needs to be one of the values in the  \"NetworkIDs\" list.","example":"046b6c7f-0b8a-43b9-b35d-6489e6daee92"},"VolumeIDs":{"description":"The list of IDs corresponding to existing, unattached volumes that should be attached to the new host.  The volume must be one of those listed in the Volumes array returned by the get /available-resources call.  In addition, the volume must be in the visible state and not a part of any current VolumeAttachment (see get volume-attachments)","type":"array","items":{"type":"string","format":"uuid"}},"ServiceNetsProviderMAC":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of Service Network (Provider) ID to Provider MAC address.   The Service Network must be a provider network provisioned to this host. Any Service Networks not included here will default to the physical MAC learned during machine discovery.","example":{"046b6c7f-0b8a-43b9-b35d-6489e6daee91":"a2:c8:93:15:2a:76"}},"NewVolumes":{"type":"array","description":"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","items":{"$ref":"#/components/schemas/AddVolume"}},"UserData":{"type":"string","description":"User-provided data to be attached to the image configuration data."},"NodeID":{"type":"string","example":"Node21","description":"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."},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for this host.","example":{"serviceType":"BMaaS"}}}},"AvailableImage":{"type":"object","description":"Entry describing an available imaging service","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for imaging service"},"Category":{"type":"string","example":"Linux","description":"Top-level grouping of imaging services that may reference an OS or application type"},"Flavor":{"type":"string","example":"ubuntu","description":"Second-level grouping of imaging services.  Typically references a specific OS or application."},"Version":{"type":"string","example":"18.04","description":"Specific version of a imaging service flavor."},"Description":{"type":"string","example":"ubuntu OS also including Docker runtime","description":"Additional image information for additional services added to the OS"}}},"LocationID":{"type":"string","format":"uuid","description":"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."},"NetworkHostUse":{"type":"string","enum":["Required","Default","Optional"],"example":"Default","description":"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.\n"},"NetworkPurpose":{"type":"string","enum":["Backup","Storage","vmKernel","vmNSX-T","vMotion","vCHA","vmFT","iSCSI-A","iSCSI-B","Telemetry"],"example":"Storage","description":"Indicates the purpose of the network.\n"},"AvailableNetwork":{"type":"object","description":"Entry of a network available within a data center location","properties":{"ID":{"type":"string","format":"uuid","description":"ID of the network"},"Name":{"type":"string","example":"Private","description":"The name of the network"},"LocationID":{"$ref":"#/components/schemas/LocationID"},"Description":{"type":"string","example":"Private network for intra-cluster communication"},"HostUse":{"$ref":"#/components/schemas/NetworkHostUse"},"Purpose":{"$ref":"#/components/schemas/NetworkPurpose"},"IPPoolID":{"type":"string"}}},"FlavorDesc":{"type":"object","description":"Describes the details of machine size or volume flavor","properties":{"Collection":{"type":"string","description":"Groups flavors together to make finding a specific flavor easier","example":"Collection1"},"Banner1":{"type":"string","example":"Banner1 value"},"Banner2":{"type":"string","example":"Banner2 value"},"Bullets":{"type":"array","items":{"type":"string"}},"InfoLink":{"type":"string","description":"URI to more information about the specific machine size or volume flavor"},"Tooltip":{"type":"string","description":"Supplemental tooltip text to use in GUIs"}}},"MachineSize":{"type":"object","description":"Description of a specific machine size offering","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for the machine size offering"},"Name":{"type":"string","example":"HPE-Large","description":"Typical user-visible name for a machine size offering"},"Details":{"$ref":"#/components/schemas/FlavorDesc"}}},"VolumeFlavor":{"type":"object","description":"Description of a specific volume flavor offering.  A volume flavor will typically refer to a specific level of performance and durability as defined in the Details\n","properties":{"ID":{"type":"string","format":"uuid","description":"Volume flavor unique ID"},"Name":{"type":"string","example":"HighPerfFlash","description":"Typical user-visible name for a volume flavor"},"Details":{"$ref":"#/components/schemas/FlavorDesc"}}},"VolumeState":{"description":"Current volume state expressed as a string enum value (new, allocating, allocated, visible, deleting, deleted, failed)","type":"string","enum":["new","allocating","allocated","visible","deleting","deleted","failed"]},"VolumeStatus":{"description":"Current volume status expressed as a string enum values (ok, error, degraded)","type":"string","enum":["ok","error","degraded"]},"VolumeInfo":{"type":"object","description":"Description of the details about a pre-existing volume","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID for the volume.  Referenced if the volume is to be attached to a new Host\n"},"Name":{"type":"string","example":"MyVolume","description":"User-provided name for the volume"},"Description":{"type":"string","description":"User-provided description of the volume"},"FlavorID":{"type":"string","format":"uuid","description":"The ID of the volume flavor requested when creating the volume"},"Capacity":{"type":"integer","format":"int64","minimum":0,"description":"The size of the volume in KiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"},"LocationID":{"type":"string","format":"uuid","description":"The location ID of the data center where the volume exists"},"DiscoveryIP":{"type":"string","description":"The discovery IP for the iSCSI volume"},"TargetIQN":{"type":"string","description":"The target IQN for the iSCSI volume"},"State":{"$ref":"#/components/schemas/VolumeState"},"Status":{"$ref":"#/components/schemas/VolumeStatus"}}},"MachineInventory":{"type":"object","description":"An entry describing the number of machines of a particular machine size at a specific location","properties":{"LocationID":{"type":"string","format":"uuid","description":"Unique ID of the data center location"},"SizeID":{"type":"string","format":"uuid","description":"ID of a MachineSize as listed in the MachineSizes array"},"Number":{"type":"integer","minimum":0,"description":"The number of machines in inventory with indicated machine size at the indicated location"}}},"StorageInventory":{"description":"An entry describing the amount of storage available to create volumes of a specific flavor","type":"object","properties":{"FlavorID":{"type":"string","format":"uuid","description":"Unique ID of a volume flavor as listed in the the VolumeFlavors array"},"LocationID":{"type":"string","format":"uuid","description":"Unique ID of a data center location"},"Capacity":{"type":"integer","format":"int64","description":"Total capacity available (in GiB) to create new volumes of the indicated flavor at the indicated location"}}},"SSHKeyEntry":{"type":"object","description":"An entry listing an SSH key that is available for use when creating HostState","properties":{"ID":{"type":"string","format":"uuid","description":"Unique ID of the SSH key entry"},"Name":{"type":"string","example":"ExampleKey","description":"Name or description of the stored SSH key"},"Key":{"$ref":"#/components/schemas/SSHKeyValue"}}},"AvailableResources":{"type":"object","properties":{"Images":{"type":"array","description":"Array listing the available host imaging services","items":{"$ref":"#/components/schemas/AvailableImage"}},"Locations":{"type":"array","description":"Array listing the data center locations with available resources","items":{"$ref":"#/components/schemas/LocationInfo"}},"Networks":{"type":"array","description":"Array listing the networks available for host connections","items":{"$ref":"#/components/schemas/AvailableNetwork"}},"MachineSizes":{"type":"array","description":"Array listing the available machine (server) sizes","items":{"$ref":"#/components/schemas/MachineSize"}},"VolumeFlavors":{"type":"array","description":"Array listing the available volume flavors","items":{"$ref":"#/components/schemas/VolumeFlavor"}},"Volumes":{"type":"array","description":"Array listing the existing project volumes that could be attached to a host","items":{"$ref":"#/components/schemas/VolumeInfo"}},"MachineInventory":{"type":"array","description":"Array listing the number of machines of each size in each location","items":{"$ref":"#/components/schemas/MachineInventory"}},"StorageInventory":{"type":"array","description":"Array providing information on the amount of available storage of each flavor in each location","items":{"$ref":"#/components/schemas/StorageInventory"}},"SSHKeys":{"type":"array","description":"Array listing pre-defined SSH keys that could be referenced when creating a Host","items":{"$ref":"#/components/schemas/SSHKeyEntry"}}}},"VolumeSubState":{"description":"Current update state of volume expressed as a string enum value (idle, update-requested, updating)","type":"string","enum":["idle","update-requested","updating"]},"Volume":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","properties":{"Description":{"type":"string","example":"Description of New Volume"},"FlavorID":{"type":"string","format":"uuid","description":"The VolumeFlavorID matching an entry in the VolumeFlavors array returned as part of the get /available-resources call"},"Capacity":{"type":"integer","format":"int64","example":10485760,"minimum":0,"description":"The size of the volume in KiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"},"LocationID":{"type":"string","format":"uuid","description":"The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host."},"State":{"$ref":"#/components/schemas/VolumeState"},"SubState":{"$ref":"#/components/schemas/VolumeSubState"},"Status":{"$ref":"#/components/schemas/VolumeStatus"},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for the volume.","example":{"serviceType":"BMaaS"}},"WWN":{"type":"string","description":"Serial number of the volume."}}}]},"NewVolume":{"type":"object","required":["Name","FlavorID","Capacity","LocationID"],"properties":{"Name":{"type":"string","example":"NewVolumeName"},"Description":{"type":"string","example":"Description of New Volume"},"FlavorID":{"type":"string","format":"uuid","description":"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":{"type":"integer","format":"int64","example":10,"minimum":0,"description":"The size of the volume in GiB"},"Shareable":{"type":"boolean","description":"Indicates if the volume can be attached to multiple hosts"},"LocationID":{"type":"string","format":"uuid","description":"The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host."},"Labels":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of label name to label value for this volume.","example":{"serviceType":"BMaaS"}}}},"VolumeAttachHostUUID":{"type":"object","required":["HostID"],"properties":{"HostID":{"type":"string","format":"uuid","description":"Unique ID of the Host to attach or detach volume"}}},"VaStateEnum":{"description":"Current volume attachment state expressed as a string enum value (new, exporting, attaching, ready, detaching, unexporting, deleted, failed)","type":"string","enum":["new","exporting","attaching","ready","detaching","unexporting","deleted","failed"]},"VAFSConfig":{"type":"object","properties":{"StorageID":{"type":"string","description":"Storage identifier for an array or a SDS"},"UserName":{"type":"string","description":"Storage array or SDS user"},"Ticket":{"type":"string","description":"SDS token acquired by login into the SDS for a given user. This is required by the FUSE client to mount volumes on host."},"TicketExpiryTime":{"type":"string","description":"Ticket expiry time to help client to refresh the ticket."}}},"VolumeAttachment":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","properties":{"VolumeID":{"type":"string","format":"uuid","description":"Unique ID of the volume attached to the host"},"HostID":{"type":"string","format":"uuid","description":"Unique ID of the host connected to the volume"},"HostIPAddress":{"type":"string","format":"ipv4","description":"Host IP address for the network connection that connects to the storage array"},"IQN":{"type":"string","description":"IQN is the full initiator name used for identification during iSCSI login","example":"iqn.yyyy-mm.naming-authority:unique name"},"CHAPSecret":{"type":"string","description":"CHAPSecret is the Challenge Authentication Protocol secret to be shared between array and initiator."},"CHAPUserName":{"type":"string","description":"CHAPUserName is the CHAP username to use for CHAP authentication"},"LUN":{"type":"integer","description":"LUN is the Logical Unit Number to be assigned to the volume on export"},"VolumeTargetIQN":{"type":"string","example":"iqn.yyyy-mm.naming-authority:unique name","description":"VolumeTargetIQN is the iQN for the volume, assigned by the array corresponding to the volume"},"VolumeTargetIPAddress":{"type":"string","format":"ipv4","description":"VolumeTargetIPAddress is the IPV4 address of the iSCSI volume export"},"State":{"$ref":"#/components/schemas/VaStateEnum"},"FSConfig":{"description":"File share specific configuration parameters","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/VAFSConfig"}]}}}]},"ProtocolKind":{"description":"The protocol to be used to attach the volume","type":"string","enum":["unknown","iscsi"]},"ISCSIParameters":{"type":"object","required":["HostIPAddress","InitiatorName"],"properties":{"HostIPAddress":{"type":"string","description":"The IP address of the host in dotted notation.","example":"10.1.2.3"},"InitiatorName":{"type":"string","description":"The full initiator name to be created. The name must be at least 12 characters in length and begin with \"iqn.\".","example":"iqn.1234.com.hpe-initiator"},"CHAPSecret":{"type":"string","description":"CHAPSecret is the Challenge Authentication Protocol secret to be shared between array and initiator. If empty, no CHAP login is enabled; if set it must be a string between 12 and 16 characters."},"CHAPUserName":{"type":"string","description":"CHAPUserName is the CHAP username to use for CHAP authentication. If CHAPSecret is specified, CHAPUserName must also be specified."}}},"ProtocolParameters":{"type":"object","properties":{"Protocol":{"$ref":"#/components/schemas/ProtocolKind"},"ISCSI":{"$ref":"#/components/schemas/ISCSIParameters","description":"The ISCSI parameters for this attachment. This value must be specified if Protocol is iscsi"}}},"NewVolumeAttachment":{"type":"object","required":["VolumeID","Protocol"],"properties":{"Name":{"type":"string","example":"My Object Name","description":"Name for the volume attachment. Must be 128 or fewer printable characters"},"VolumeID":{"type":"string","format":"uuid","description":"Unique ID of the volume attached to the host"},"Protocol":{"$ref":"#/components/schemas/ProtocolParameters"}}},"Network":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","properties":{"LocationID":{"$ref":"#/components/schemas/LocationID"},"Description":{"type":"string","example":"Private network for intra-cluster communication"},"HostUse":{"$ref":"#/components/schemas/NetworkHostUse"},"Purpose":{"$ref":"#/components/schemas/NetworkPurpose"},"IPPoolID":{"type":"string"},"VLAN":{"type":"integer","description":"VLAN ID of the network"},"VNI":{"type":"integer","description":"VNI ID of the network"}}}]},"IPVer":{"type":"string","enum":["IPv4","IPv6"],"example":"IPv4","description":"Describes the IP version\n"},"Netmask":{"type":"string","enum":["/8","/9","/10","/11","/12","/13","/14","/15","/16","/17","/18","/19","/20","/21","/22","/23","/24","/25","/26","/27","/28","/29","/30","/31","/104","/105","/106","/107","/108","/109","/110","/111","/112","/113","/114","/115","/116","/117","/118","/119","/120","/121","/122","/123","/124","/125","/126","/127"]},"IPSource":{"type":"object","properties":{"Base":{"type":"string","example":"10.128.0.2","description":"Base address for the IP source"},"Count":{"type":"integer","example":1,"description":"Number of IPs to count from the base"}}},"NewIPPool":{"type":"object","nullable":true,"required":["IPVersion","BaseIP","Netmask"],"properties":{"Name":{"type":"string","description":"Name for the IP pool"},"Description":{"type":"string","description":"Description for the IP pool"},"IPVersion":{"$ref":"#/components/schemas/IPVer"},"BaseIP":{"type":"string","example":"10.128.0.0","description":"Base address of the IP pool"},"Netmask":{"$ref":"#/components/schemas/Netmask"},"DefaultRoute":{"type":"string","example":"10.128.0.1","description":"Default route associated with the IP pool"},"Sources":{"type":"array","items":{"$ref":"#/components/schemas/IPSource"}},"DNS":{"type":"array","items":{"type":"string","example":"8.8.8.8"},"description":"List of DNS servers for the IP pool"},"Proxy":{"type":"string","example":"http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080","description":"Optional web-proxy for external internet access should the pool actually be behind a firewall"},"NoProxy":{"type":"string","example":"localhost,15.10.0.10,test.com","description":"Addresses or CIDRs for which proxy requests are not made"},"NTP":{"type":"array","items":{"type":"string","example":"15.0.0.11"},"description":"List of NTP servers for the IP pool"}}},"NewNetwork":{"type":"object","required":["Name","LocationID"],"properties":{"Name":{"type":"string","description":"Name of the network","example":"Private2"},"LocationID":{"$ref":"#/components/schemas/LocationID"},"Description":{"type":"string","example":"Private network for intra-cluster communication"},"HostUse":{"$ref":"#/components/schemas/NetworkHostUse"},"Purpose":{"$ref":"#/components/schemas/NetworkPurpose"},"NewIPPool":{"$ref":"#/components/schemas/NewIPPool","description":"IP pool for the network. It is optional while creating new private network. If not specified, the network uses the default IP pool allocated from the  hoster/project IP Pool factory and if specified, a new custom IP Pool will  be created and used for IP allocations."}}},"UsageEntryBase":{"type":"object","properties":{"ProjectID":{"type":"string","format":"uuid","description":"Project ID that contained the host"},"LocationID":{"$ref":"#/components/schemas/LocationID"},"Allocated":{"type":"string","format":"date-time","description":"Timestamp of when resource (machine or storage) was allocated"},"Ready":{"type":"string","format":"date-time","description":"Timestamp of when resource (host or volume) was ready for use"},"Freed":{"type":"string","format":"date-time","description":"Timestamp of when resource (machine or storage) was freed"},"UsageStart":{"type":"string","format":"date-time","description":"The start of the usage reporting window or when the resource was allocated"},"UsageEnd":{"type":"string","format":"date-time","description":"The end of the usage reporting window or when the resource was freed"},"UsageHours":{"type":"integer","format":"int64","description":"The difference between the UsageEnd and UsageStart rounded up to the UsageHours"},"Error":{"type":"string","description":"Description of error that affected the usage reporting"}}},"HostUsageEntry":{"allOf":[{"$ref":"#/components/schemas/UsageEntryBase"},{"type":"object","properties":{"MachineSizeName":{"type":"string","example":"HPE-Large","description":"Name of the MachineSize requested when host was created"},"MachineSizeID":{"type":"string","format":"uuid","description":"Unique ID of the MachineSize requested when host was created"},"HostName":{"type":"string","description":"Name of the associated Host"},"HostID":{"type":"string","format":"uuid","description":"Unique ID of the associated Host"}}}]},"VolumeUsageEntry":{"allOf":[{"$ref":"#/components/schemas/UsageEntryBase"},{"type":"object","properties":{"VolumeName":{"type":"string","description":"Name of the volume"},"VolumeID":{"type":"string","format":"uuid","description":"Unique ID of the volume"},"FlavorName":{"type":"string","description":"Name of the volume flavor used when creating the volume"},"FlavorID":{"type":"string","format":"uuid","description":"Unique ID of the volume flavor used when creating the volume"},"Capacity":{"type":"integer","format":"int64","description":"The size of the volume in MB"}}}]},"UsageReport":{"type":"object","description":"The composite usage report","properties":{"Hosts":{"description":"list of Host usage entries for the report window","type":"array","items":{"$ref":"#/components/schemas/HostUsageEntry"}},"Volumes":{"description":"list of Volume usage entries for the report window","type":"array","items":{"$ref":"#/components/schemas/VolumeUsageEntry"}}}},"UseRecord":{"type":"object","properties":{"Base":{"type":"string","example":"10.128.0.2","description":"Address of the record"},"HostID":{"type":"string","format":"uuid","description":"Unique ID of the host associated with the record"},"RackID":{"type":"string","format":"uuid","description":"Unique ID of the rack associated with the record"},"DeviceID":{"type":"string","format":"uuid","description":"Unique ID of the device associated with the record"},"External":{"type":"boolean","example":true,"description":"Indicates if the record is used for non Metal scope"},"Usage":{"type":"string","description":"Usage of the record"},"AllocatedBy":{"type":"string","description":"User which performed the allocation of the record"}}},"IPRange":{"type":"object","properties":{"Base":{"type":"string","example":"10.128.0.2","description":"Base address for the IP range"},"Count":{"type":"integer","example":1,"description":"Number of IPs to count from the base"},"DefaultRoute":{"type":"string","example":"10.128.0.1","description":"Default route for the IP range"},"Netmask":{"$ref":"#/components/schemas/Netmask"},"SourceBase":{"type":"string","example":"10.128.0.0","description":"Base address of the Source the IPRange was allocated from"}}},"IPPoolStats":{"type":"object","properties":{"Total":{"type":"integer","format":"int32","description":"Total number of IPs (pool capacity)"},"Available":{"type":"integer","format":"int32","description":"Number of non allocated IPs"},"InUse":{"type":"integer","format":"int32","description":"Number of allocated IPs"}}},"Pool":{"type":"object","properties":{"Fragments":{"type":"array","items":{"$ref":"#/components/schemas/IPRange"},"description":"List of fragments for the IP pool"},"Stats":{"$ref":"#/components/schemas/IPPoolStats","description":"Statistics for the IP pool"}}},"IPPool":{"allOf":[{"$ref":"#/components/schemas/ResourceBase"},{"type":"object","required":["Description","DefaultRoute","DNS","Proxy","NoProxy","NTP"],"properties":{"Description":{"type":"string","example":"Description of IP pool"},"IPVersion":{"$ref":"#/components/schemas/IPVer"},"NetworkID":{"type":"string","format":"uuid","description":"Unique ID of the network associated with the IP pool"},"BaseIP":{"type":"string","example":"10.128.0.0","description":"Base address of the IP pool"},"Netmask":{"$ref":"#/components/schemas/Netmask"},"DefaultRoute":{"type":"string","example":"10.128.0.1","description":"Default route associated with the IP pool"},"Sources":{"type":"array","items":{"$ref":"#/components/schemas/IPSource"}},"UseRecords":{"type":"array","items":{"$ref":"#/components/schemas/UseRecord"}},"DNS":{"type":"array","items":{"type":"string","example":"8.8.8.8"},"description":"List of DNS servers for the IP pool"},"Proxy":{"type":"string","example":"http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080","description":"Optional web-proxy for external internet access should the pool actually be behind a firewall"},"NoProxy":{"type":"string","example":"localhost,15.10.0.10,test.com","description":"Addresses or CIDRs for which proxy requests are not made"},"NTP":{"type":"array","items":{"type":"string","example":"15.0.0.1"},"description":"List of NTP servers for the IP pool"},"Pool":{"$ref":"#/components/schemas/Pool"}}}]},"IPAllocation":{"type":"object","required":["Base","Count","Usage"],"properties":{"Base":{"type":"string","example":"10.128.0.1","description":"An optional base address for the allocation, if not specified first available address from the pool will be the base"},"Count":{"type":"integer","example":2,"description":"Number of addresses to allocate starting from the base"},"Usage":{"type":"string","example":"Allocated IP for external storage","description":"A short description for the allocation"}}},"ServiceServerInfo":{"type":"object","description":"Server allocation information for a service type.","properties":{"ServiceType":{"type":"string","description":"Service type consuming the resource","example":"BMaaS"},"AllocatedCount":{"type":"integer","description":"Allocated number of servers."},"CoresCapacity":{"type":"integer","description":"Total available CPU cores."},"CoresAllocated":{"type":"integer","description":"Total allocated CPU cores."},"RAMCapacity":{"type":"number","format":"double","description":"Total available memory in GiB."},"RAMAllocated":{"type":"number","format":"double","description":"Total allocated memory in GiB."}}},"Allocation":{"type":"object","description":"allocation of servers for each PCE service.","properties":{"ResourceType":{"type":"string","description":"Type of the resource the allocation information is listed for."},"Total":{"type":"integer","description":"Total number of servers."},"InstanceFamily":{"type":"string","description":"Instance type family name.","example":"Compute Optimized, General Purpose"},"InstanceType":{"type":"string","description":"Server instance type","example":"C2i, M2ie"},"Available":{"type":"integer","minimum":0,"description":"Available number of servers."},"AllocationInfo":{"type":"array","description":"Array listing of server allocation information for each service type.","items":{"$ref":"#/components/schemas/ServiceServerInfo"}}}},"ServiceStorageInfo":{"type":"object","description":"Storage allocation information for service type.","properties":{"ServiceType":{"type":"string","description":"Service type consuming the resource","example":"BMaaS"},"AllocatedCount":{"type":"integer","description":"Allocated number of volumes."},"AllocatedCapacity":{"type":"number","format":"float","minimum":0,"description":"Total capacity of all allocated volumes in TB for a service type."}}},"AllocationStorage":{"type":"object","description":"Allocation of storage for each PCE service.","properties":{"ResourceType":{"type":"string","description":"Type of the resource the allocation information is listed for."},"Total":{"type":"number","format":"float","description":"Total storage capacity in TB"},"InstanceFamily":{"type":"string","description":"Instance type family name.","example":"Performance Optimized Block"},"InstanceType":{"type":"string","description":"volume type","example":"SBP"},"Available":{"type":"number","format":"float","minimum":0,"description":"Available storage space in TB"},"AllocationInfo":{"type":"array","description":"Array listing the storage allocation information for each service type.","items":{"$ref":"#/components/schemas/ServiceStorageInfo"}}}}},"responses":{"Unauthorized":{"description":"unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalError":{"description":"internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InvalidContent":{"description":"invalid content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InvalidInput":{"description":"invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":{"SpaceID":{"name":"spaceid","in":"header","description":"GreenLake space ID","schema":{"type":"string"},"example":"95688cf9-82ff-4e32-80fc-2b0b41648dab"},"Space":{"name":"Space","in":"header","description":"GreenLake space name","schema":{"type":"string"},"example":"Default"},"SiteID":{"name":"siteid","in":"query","description":"GreenLake site ID","required":false,"schema":{"type":"string"},"example":"95688cf9-82ff-4e32-80fc-2b0b41648dab"}}},"externalDocs":{"description":"API Versioning","url":"https://www.hpe.com/us/en/software/licensing.html"}}},"searchIndex":{"store":["section/Introduction","section/Authentication","section/Authentication/Bearer-Auth","section/Authentication/Project-API-Key","section/Authentication/Membership-API-Key","section/Getting-a-Space-name-or-ID","section/HPE-GreenLake-for-bare-metal-APIs","tag/version","tag/version/operation/Versions_get","tag/projects","tag/projects/operation/Projects_list","tag/projects/operation/Project_add","tag/projects/operation/Project_getByID","tag/projects/operation/Project_update","tag/projects/operation/Project_delete","tag/sshkeys","tag/sshkeys/operation/SSHKeys_list","tag/sshkeys/operation/SSHKey_add","tag/sshkeys/operation/SSHKey_getByID","tag/sshkeys/operation/SSHKey_update","tag/sshkeys/operation/SSHKey_delete","tag/hosts","tag/hosts/operation/Hosts_list","tag/hosts/operation/Host_add","tag/hosts/operation/Host_getByID","tag/hosts/operation/Host_update","tag/hosts/operation/Host_delete","tag/hosts/operation/maintenance","tag/hosts/operation/powerOn","tag/hosts/operation/powerOff","tag/hosts/operation/powerReset","tag/hosts/operation/bootPXE","tag/hosts/operation/bootHDD","tag/hosts/operation/replace","tag/volumes","tag/volumes/operation/Volumes_list","tag/volumes/operation/Volume_add","tag/volumes/operation/Volume_getByID","tag/volumes/operation/Volume_update","tag/volumes/operation/Volume_delete","tag/volumes/operation/Volume_attach","tag/volumes/operation/Volume_detach","tag/volume-attachments","tag/volume-attachments/operation/VolumeAttachments_list","tag/volume-attachments/operation/VolumeAttachments_add","tag/volume-attachments/operation/VolumeAttachment_getByID","tag/volume-attachments/operation/VolumeAttachment_delete","tag/networks","tag/networks/operation/Networks_list","tag/networks/operation/Network_add","tag/networks/operation/Network_getByID","tag/networks/operation/Network_update","tag/networks/operation/Network_delete","tag/available-resources","tag/available-resources/operation/AvailableResources_list","tag/usage-reports","tag/usage-reports/operation/UsageReport_get","tag/projects-info","tag/projects-info/operation/ProjectsInfo_list","tag/ippools","tag/ippools/operation/IPPool_list","tag/ippools/operation/IPPool_getByID","tag/ippools/operation/IPPool_update","tag/ippools/operation/IPPool_allocateIPs","tag/ippools/operation/IPPool_returnIPs","tag/allocation","tag/allocation/operation/allocation_getBySite","tag/allocation/operation/allocation_storage_getBySite"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,5.25]],["description/0",[1,0.939,2,2.43,3,2.308,4,2.817,5,2.232,6,2.305,7,0.62,8,0.939,9,1.522,10,1.69,11,1.69,12,1.737,13,0.939,14,0.62,15,1.116,16,0.939,17,0.814,18,0.939,19,1.316,20,0.939,21,0.939,22,2.303,23,0.814,24,0.939,25,1.522,26,0.731,27,0.495,28,0.67,29,0.939,30,0.731,31,0.939,32,0.939,33,0.939,34,0.731,35,0.791,36,0.939,37,0.939,38,0.939,39,0.939,40,0.939,41,1.116,42,0.979,43,0.4,44,0.366,45,0.4,46,0.814,47,1.205,48,0.536,49,0.814,50,0.251,51,1.042,52,0.453,53,0.939,54,0.31,55,0.731,56,0.939,57,0.688,58,0.939,59,0.67,60,0.62,61,0.814,62,0.731,63,1.522,64,1.042,65,1.205,66,0.62,67,0.731,68,0.731,69,0.62,70,1.042,71,0.939,72,0.814,73,0.939,74,2.232,75,0.939,76,0.939,77,1.794,78,1.69,79,0.939,80,0.939,81,0.939,82,0.939,83,0.939,84,0.814,85,4.089,86,0.939,87,0.939,88,0.814,89,1.642,90,0.67,91,0.814,92,1.042,93,0.814,94,0.62]],["title/1",[95,3.468]],["description/1",[]],["title/2",[96,3.824,97,4.412]],["description/2",[2,2.533,3,2.11,4,1.579,5,1.797,6,2.019,12,0.907,14,0.532,15,0.532,23,0.698,25,0.532,26,0.627,28,0.574,35,0.949,41,0.971,42,2.237,47,2.33,48,0.466,63,0.532,69,0.532,77,1.579,85,3.358,88,1.273,91,1.273,92,0.497,93,0.698,94,0.532,95,1.339,96,1.273,98,0.723,99,1.144,100,2.576,101,0.627,102,0.44,103,0.805,104,0.805,105,0.852,106,1.273,107,0.698,108,1.757,109,0.698,110,0.805,111,1.47,112,0.805,113,0.805,114,0.805,115,0.805,116,0.805,117,0.805,118,0.805,119,0.467,120,0.805,121,1.757,122,2.832,123,1.757,124,1.757,125,0.907,126,2.027,127,1.47,128,0.805,129,0.805,130,0.079,131,0.805,132,0.805,133,1.47,134,0.698,135,0.574,136,0.805,137,0.805,138,0.805,139,0.698,140,0.805,141,0.805,142,0.805,143,0.805,144,2.502,145,0.805,146,0.805,147,0.805,148,0.805,149,0.805,150,0.698,151,0.698,152,0.805,153,0.698,154,0.698,155,0.698,156,1.757,157,0.698,158,1.273,159,0.698,160,0.627,161,0.698,162,0.805,163,0.805,164,0.805,165,0.805,166,0.805,167,0.805,168,0.805,169,0.805,170,0.805,171,0.805,172,0.805,173,0.805,174,0.805,175,0.805,176,0.805,177,0.698,178,0.805,179,0.805,180,0.805,181,0.698,182,0.574,183,0.805,184,0.805,185,0.805,186,0.805]],["title/3",[6,1.871,45,0.661,187,1.871]],["description/3",[2,2.441,3,2.164,12,2.441,35,2.519,41,2.613,42,3.12,43,1.686,44,1.543,45,1.062,46,3.428,70,2.441,100,2.164,102,2.164,105,2.293,130,0.386,188,2.821]],["title/4",[6,1.871,187,1.871,189,2.963]],["description/4",[2,3.106,5,3.106,35,2.949,42,2.918,98,2.476,100,2.753,106,4.362,107,4.362]],["title/5",[74,2.064,119,1.939,130,0.326,150,2.899]],["description/5",[2,2.29,3,2.03,6,1.17,26,2.89,45,0.413,72,2.062,74,2.29,77,2.89,84,3.216,85,1.697,98,1.17,102,1.302,108,2.062,119,2.987,121,2.062,122,3.216,123,2.062,124,2.062,130,0.445,153,2.062,154,2.062,155,2.062,156,2.062,157,2.062,158,2.062,159,2.062,160,1.853,161,2.062,177,2.062,190,2.38,191,2.452,192,2.062,193,2.38,194,1.697,195,2.062,196,2.38,197,1.697,198,1.853,199,1.697,200,2.38,201,2.38]],["title/6",[2,1.841,3,1.632,4,2.324,5,1.841,6,1.468]],["description/6",[]],["title/7",[202,3.468]],["description/7",[6,2.605,57,2.158,202,3.499,203,5.297,204,1.898,205,2.897,206,4.59]],["title/8",[6,1.645,202,2.21,205,1.83,206,2.899]],["description/8",[202,4.148]],["title/9",[45,0.911]],["description/9",[9,2.834,45,1.107,48,1.36,50,0.467,52,0.844,54,1.416,55,3.341,89,3.059,90,3.059,119,2.487,204,1.537,207,2.008,208,2.346,209,3.341]],["title/10",[43,1.272,45,0.518,210,1.164,211,2.324,212,2.324]],["description/10",[3,1.674,7,2.023,9,2.023,27,0.896,35,1.433,45,1.017,48,0.971,50,0.333,52,0.883,54,1.011,57,1.247,95,2.023,98,1.506,100,1.674,102,2.456,105,1.775,119,2.603,182,2.183,188,2.183,197,2.183,213,1.506,214,1.433,215,2.384,216,2.384,217,2.653,218,2.183,219,2.183,220,1.586,221,2.384]],["title/11",[45,0.661,48,1.206,222,1.55]],["description/11",[3,1.494,9,1.805,15,1.805,35,1.279,42,1.584,43,1.164,45,0.863,48,1.308,50,0.297,52,0.537,54,0.902,55,2.128,70,1.686,95,1.805,98,2.029,100,1.494,102,2.257,105,1.584,119,2.882,125,1.686,135,1.948,182,1.948,188,1.948,197,1.948,204,0.979,211,2.128,212,2.128,219,1.948,220,1.415,221,2.128,222,1.113,223,1.494,224,2.732,225,2.732,226,1.805,227,2.128]],["title/12",[45,0.661,130,0.371,228,2.081]],["description/12",[7,2.613,9,2.613,27,1.158,44,1.543,45,1.062,50,0.43,52,1.059,54,1.306,57,1.612,130,0.386,214,1.851,215,3.08,216,3.08,217,3.428,218,2.821,229,1.158,230,3.08]],["title/13",[45,0.661,130,0.371,231,1.698]],["description/13",[15,2.665,42,2.338,45,0.947,74,2.489,98,1.984,125,2.489,130,0.393,135,2.877,204,1.955,215,3.142,216,3.142,226,2.665,227,3.142,229,1.181,230,3.142,231,2.434]],["title/14",[45,0.766,232,1.721]],["description/14",[15,3.026,42,2.655,45,0.795,98,2.252,125,2.826,130,0.447,135,3.266,204,1.641,226,3.026,227,3.567,229,1.341,230,3.567,232,1.786]],["title/15",[233,3.743]],["description/15",[47,3.341,48,1.485,50,0.51,130,0.457,187,2.961,204,1.679,207,2.193,208,2.563,234,3.294,235,3.341]],["title/16",[45,0.661,210,1.484,233,2.713]],["description/16",[27,1.511,43,2.2,45,0.896,208,2.823,213,2.538,214,2.416,233,4.564]],["title/17",[187,1.645,222,1.363,223,1.83,234,1.83]],["description/17",[48,1.636,50,0.561,187,2.538,222,2.103,223,2.823,233,3.681,234,2.823,235,3.681]],["title/18",[130,0.326,187,1.645,228,1.83,234,1.83]],["description/18",[27,1.55,44,2.066,130,0.517,187,2.605,229,1.55,234,2.897,236,4.124]],["title/19",[74,1.391,187,1.749,192,1.954,231,1.006,234,1.233,237,1.233,238,1.756]],["description/19",[236,4.889]],["title/20",[187,1.871,232,1.484,234,2.081]],["description/20",[130,0.53,187,2.674,229,1.592,232,2.121,234,2.975,236,4.235]],["title/21",[50,0.571]],["description/21",[47,2.996,48,1.332,49,3.641,50,0.732,89,2.996,92,2.592,204,1.505,205,2.298,207,1.966,209,3.271,210,1.639,232,1.639,239,3.641,240,4.201]],["title/22",[45,0.661,50,0.414,210,1.484]],["description/22",[27,1.511,43,2.2,45,0.896,50,0.696,208,2.823,213,2.538,214,2.416]],["title/23",[48,1.206,50,0.414,222,1.55]],["description/23",[6,1.506,14,2.967,41,2.967,48,0.971,50,0.578,54,1.011,59,3.202,63,2.967,130,0.299,134,2.653,191,2.967,205,1.674,214,2.102,220,2.326,222,1.247,239,2.653,241,3.062,242,3.062,243,3.062,244,4.491,245,2.653,246,3.062,247,3.062,248,3.062,249,3.062]],["title/24",[50,0.414,130,0.371,228,2.081]],["description/24",[27,1.592,44,2.121,50,0.591,130,0.53,229,1.592,250,4.235]],["title/25",[50,0.414,231,1.698,237,2.081]],["description/25",[50,0.687,52,0.709,54,1.19,130,0.352,229,1.055,231,2.966,250,2.807,251,2.57,252,2.57,253,2.57,254,2.807,255,2.224,256,3.124,257,3.605,258,3.605,259,5.049,260,2.089]],["title/26",[50,0.48,232,1.721]],["description/26",[50,0.666,130,0.386,229,1.158,232,2.387,250,3.08,251,3.839,252,2.821,255,3.776,261,3.956,262,3.956,263,3.956,264,3.956,265,2.293]],["title/27",[50,0.414,130,0.371,266,3.298]],["description/27",[50,0.701,204,1.57,252,3.125,254,3.413,255,3.557,265,2.54,266,4.996,267,4.383,268,4.383,269,3.798,270,4.383]],["title/28",[50,0.414,130,0.371,265,2.206]],["description/28",[44,2.121,50,0.591,130,0.53,229,1.592,265,3.152,271,5.438]],["title/29",[50,0.414,130,0.371,265,2.206]],["description/29",[44,2.121,50,0.591,130,0.53,229,1.592,265,3.152,272,5.438]],["title/30",[50,0.414,130,0.371,273,3.298]],["description/30",[44,2.121,50,0.591,130,0.53,229,1.592,273,4.713,274,5.438]],["title/31",[50,0.293,130,0.263,220,1.395,275,2.334,276,1.921,277,2.334]],["description/31",[44,1.871,50,0.522,130,0.468,220,2.484,229,1.404,275,4.156,276,4.358,278,4.156,279,4.796,280,4.796]],["title/32",[50,0.293,130,0.263,220,1.395,276,1.921,277,2.334,281,2.334]],["description/32",[44,1.963,50,0.548,130,0.491,220,2.607,229,1.473,276,3.59,278,4.362,281,4.362,282,5.034]],["title/33",[50,0.414,130,0.371,283,3.298]],["description/33",[50,0.681,52,0.696,64,3.077,194,2.526,195,3.069,220,1.834,222,1.443,238,2.758,252,2.526,254,2.758,255,3.077,265,2.053,269,3.069,283,4.322,284,3.542,285,3.542,286,1.58,287,3.542,288,3.542,289,3.542]],["title/34",[52,1.032]],["description/34",[50,0.522,51,2.959,52,1.323,204,1.719,207,2.245,290,4.796,291,4.796,292,4.796,293,4.796]],["title/35",[45,0.661,52,0.748,210,1.484]],["description/35",[27,1.55,43,2.257,45,0.919,52,1.279,208,2.897,213,2.605]],["title/36",[52,0.748,222,1.55,223,2.081]],["description/36",[14,3.604,43,1.719,45,0.7,48,2.099,50,0.593,52,1.302,151,3.496,222,1.644,223,2.207,235,2.877,294,4.034]],["title/37",[52,0.748,130,0.371,228,2.081]],["description/37",[27,1.592,44,2.121,52,1.069,130,0.53,229,1.592,295,4.235]],["title/38",[52,0.748,231,1.698,237,2.081]],["description/38",[52,1.292,130,0.386,191,2.613,218,2.821,229,1.158,231,2.731,237,2.164,251,2.821,255,2.441,295,3.08,296,2.049,297,3.956,298,3.956,299,3.956,300,3.956]],["title/39",[52,0.868,232,1.721]],["description/39",[52,1.099,130,0.545,229,1.636,232,2.179,295,4.351]],["title/40",[50,0.364,52,0.658,237,1.83,260,1.939]],["description/40",[30,3.08,48,1.254,50,0.585,52,1.059,57,1.612,60,2.613,214,1.851,231,1.765,253,2.821,260,3.12,301,3.428,302,3.428,303,2.164,304,3.428,305,3.428,306,3.428,307,3.428]],["title/41",[50,0.364,52,0.658,237,1.83,308,2.899]],["description/41",[30,2.314,34,2.314,50,0.568,52,1.028,57,1.211,60,1.963,98,1.461,125,1.834,204,1.065,214,1.391,231,1.326,232,1.159,245,2.575,253,2.119,301,2.575,302,2.575,303,1.625,304,2.575,305,2.575,306,2.575,308,3.807,309,4.394,310,2.972,311,2.119,312,2.972,313,2.972,314,2.972,315,2.972,316,2.972,317,2.972,318,2.972]],["title/42",[319,4.088]],["description/42",[17,4.59,50,0.576,52,1.042,204,1.898,207,2.479,253,3.777,303,2.897]],["title/43",[45,0.581,52,0.658,210,1.305,260,1.939]],["description/43",[27,1.55,43,2.257,45,0.919,208,2.897,213,2.605,303,2.897,319,4.124]],["title/44",[48,1.206,222,1.55,303,2.081]],["description/44",[6,2.785,25,2.261,35,2.278,48,1.085,50,0.372,52,0.673,64,2.112,125,2.112,139,2.966,222,1.395,223,1.872,232,1.898,303,3.374,307,2.966,319,2.665,320,3.423,321,3.423,322,3.423,323,2.665,324,3.423,325,3.423]],["title/45",[52,0.658,130,0.326,228,1.83,260,1.939]],["description/45",[27,1.55,44,2.066,52,1.042,130,0.517,229,1.55,260,3.07,323,4.124]],["title/46",[232,1.721,303,2.413]],["description/46",[130,0.545,229,1.636,232,2.179,303,3.056,323,4.351]],["title/47",[54,1.733]],["description/47",[54,1.952,204,2.119,207,2.767]],["title/48",[45,0.661,54,1.256,210,1.484]],["description/48",[27,1.511,43,2.2,45,0.896,54,2.113,208,2.823,213,2.538,214,2.416]],["title/49",[54,1.256,222,1.55,223,2.081]],["description/49",[48,1.679,50,0.576,54,2.147,222,2.158,223,2.897,235,3.777]],["title/50",[54,1.256,130,0.371,228,2.081]],["description/50",[27,1.592,44,2.121,54,1.795,130,0.53,229,1.592,326,4.235]],["title/51",[54,1.256,231,1.698,237,2.081]],["description/51",[326,4.889]],["title/52",[54,1.456,232,1.721]],["description/52",[54,1.844,130,0.545,229,1.636,232,2.179,326,4.351]],["title/53",[59,3.743]],["description/53",[14,2.023,41,2.023,48,1.686,50,0.488,51,1.889,52,1.046,57,1.83,60,2.023,61,2.653,62,2.384,63,3.514,64,1.889,65,2.183,66,2.023,67,2.384,68,2.384,69,2.967,89,2.183,92,1.889,94,2.023,204,1.097,207,1.433,209,2.384,210,1.194,327,3.062,328,3.062]],["title/54",[19,2.098,25,1.78,48,0.854,50,0.293,52,0.53,210,1.051]],["description/54",[7,0.817,12,0.763,19,2.232,27,0.362,35,1.342,48,0.683,50,0.373,51,0.763,52,0.841,54,1.133,57,1.168,59,1.537,60,1.424,62,1.679,63,1.424,64,2.403,65,2.448,66,0.817,67,0.962,68,3.032,70,0.763,74,1.769,85,4.405,98,0.608,109,1.071,130,0.476,160,0.962,194,1.537,202,0.817,210,1.795,213,0.608,214,0.578,218,0.881,222,0.504,237,0.676,238,0.962,255,0.763,256,1.868,260,0.716,329,3.894,330,1.236,331,1.236,332,2.484,333,1.236,334,1.236,335,1.071,336,1.236,337,1.236,338,1.236,339,0.881,340,0.962,341,1.236,342,1.236,343,1.071,344,1.236,345,1.236,346,1.236,347,1.236,348,1.236,349,1.236,350,0.962,351,1.071]],["title/55",[352,4.549]],["description/55",[25,3.41,43,2.2,45,0.896,57,2.103,204,1.85,207,2.416,228,2.823,339,3.681]],["title/56",[339,3.146,353,3.824]],["description/56",[27,1.438,34,3.825,48,1.557,199,3.503,219,3.503,311,3.503,339,3.503,343,4.257,352,4.257,353,4.257]],["title/57",[354,4.549]],["description/57",[45,0.944,57,2.216,204,1.949,207,3.093,210,2.121]],["title/58",[43,0.961,45,0.391,99,1.756,101,1.756,181,1.954,210,0.879,211,1.756,212,1.756]],["description/58",[3,1.515,7,2.754,27,0.811,35,1.296,45,0.968,52,0.82,57,1.128,64,2.572,65,2.972,95,1.83,98,1.362,99,2.157,100,1.515,101,2.157,102,2.28,105,1.605,119,2.416,182,1.975,188,1.975,197,1.975,210,1.626,214,1.296,219,1.975,220,1.434,221,2.157,251,1.975,332,3.612,335,2.4,351,2.4,354,2.4,355,2.769]],["title/59",[356,4.549]],["description/59",[204,2.059,207,2.689,286,2.564,357,2.689]],["title/60",[45,0.581,210,1.305,286,1.493,357,1.566]],["description/60",[27,1.473,43,2.145,45,0.874,208,2.753,213,2.476,214,2.356,286,2.246,356,4.362,357,2.356]],["title/61",[130,0.326,228,1.83,286,1.493,357,1.566]],["description/61",[27,1.55,44,2.066,130,0.517,229,1.55,286,2.363,357,2.479,358,4.59]],["title/62",[130,0.326,231,1.493,286,1.493,357,1.566]],["description/62",[44,1.786,130,0.447,194,3.266,229,1.341,231,2.648,286,2.648,357,2.777,358,3.969,359,4.58,360,4.58]],["title/63",[286,1.698,296,1.971,357,1.781]],["description/63",[286,2.564,296,2.976,357,2.689,361,5.746]],["title/64",[27,1.114,286,1.698,357,1.781]],["description/64",[27,1.682,286,2.564,357,2.689,362,5.746]],["title/65",[296,2.719]],["description/65",[51,3.268,57,2.158,204,1.898,205,2.897,207,2.479,210,2.066,296,2.743]],["title/66",[205,2.413,296,2.285]],["description/66",[5,1.451,12,1.451,27,1.076,28,1.677,35,1.721,45,0.786,57,1.845,66,1.554,69,1.554,70,2.269,90,1.677,92,2.269,94,2.43,100,2.012,102,2.012,105,1.364,130,0.229,189,1.832,191,1.554,198,1.832,199,1.677,205,1.287,213,1.157,226,1.554,296,2.345,311,1.677,340,1.832,350,1.832,363,3.187,364,2.039,365,2.039,366,2.039,367,3.187,368,2.039,369,2.039,370,2.039,371,3.187,372,2.039,373,2.352]],["title/67",[51,2.722,296,2.285]],["description/67",[5,1.451,12,1.451,27,1.076,28,1.677,35,1.721,45,0.786,57,1.845,66,1.554,69,1.554,70,2.269,90,1.677,92,2.269,94,2.43,100,2.012,102,2.012,105,1.364,130,0.229,189,1.832,191,1.554,198,1.832,199,1.677,205,1.287,213,1.157,226,1.554,296,2.345,311,1.677,340,1.832,350,1.832,363,3.187,364,2.039,365,2.039,366,2.039,367,3.187,368,2.039,369,2.039,370,2.039,371,3.187,372,2.039,374,2.352]]],"invertedIndex":[["",{"_index":85,"title":{},"description":{"0":{},"2":{},"5":{},"54":{}}}],["000",{"_index":166,"title":{},"description":{"2":{}}}],["00b388",{"_index":172,"title":{},"description":{"2":{}}}],["1",{"_index":88,"title":{},"description":{"0":{},"2":{}}}],["15",{"_index":185,"title":{},"description":{"2":{}}}],["18.04",{"_index":334,"title":{},"description":{"54":{}}}],["2",{"_index":91,"title":{},"description":{"0":{},"2":{}}}],["2px",{"_index":170,"title":{},"description":{"2":{}}}],["3",{"_index":93,"title":{},"description":{"0":{},"2":{}}}],["4px",{"_index":174,"title":{},"description":{"2":{}}}],["a.k.a",{"_index":209,"title":{},"description":{"9":{},"21":{},"53":{}}}],["accept",{"_index":32,"title":{},"description":{"0":{}}}],["access",{"_index":42,"title":{},"description":{"0":{},"2":{},"3":{},"4":{},"11":{},"13":{},"14":{}}}],["access_token",{"_index":149,"title":{},"description":{"2":{}}}],["accid",{"_index":315,"title":{},"description":{"41":{}}}],["accord",{"_index":243,"title":{},"description":{"23":{}}}],["account",{"_index":117,"title":{},"description":{"2":{}}}],["add",{"_index":223,"title":{"17":{},"36":{},"49":{}},"description":{"11":{},"17":{},"36":{},"44":{},"49":{}}}],["address",{"_index":195,"title":{},"description":{"5":{},"33":{}}}],["align",{"_index":224,"title":{},"description":{"11":{}}}],["alloc",{"_index":296,"title":{"63":{},"65":{},"66":{},"67":{}},"description":{"38":{},"63":{},"65":{},"66":{},"67":{}}}],["allocation/serv",{"_index":373,"title":{},"description":{"66":{}}}],["allocation/storag",{"_index":374,"title":{},"description":{"67":{}}}],["allow",{"_index":113,"title":{},"description":{"2":{}}}],["along",{"_index":329,"title":{},"description":{"54":{}}}],["api",{"_index":6,"title":{"3":{},"4":{},"6":{},"8":{}},"description":{"0":{},"2":{},"5":{},"7":{},"23":{},"44":{}}}],["applic",{"_index":116,"title":{},"description":{"2":{}}}],["application/x-www-form-urlencod",{"_index":143,"title":{},"description":{"2":{}}}],["appropri",{"_index":134,"title":{},"description":{"2":{},"23":{}}}],["array",{"_index":213,"title":{},"description":{"10":{},"16":{},"22":{},"35":{},"43":{},"48":{},"54":{},"60":{},"66":{},"67":{}}}],["assign",{"_index":133,"title":{},"description":{"2":{}}}],["associ",{"_index":293,"title":{},"description":{"34":{}}}],["attach",{"_index":260,"title":{"40":{},"43":{},"45":{}},"description":{"25":{},"40":{},"45":{},"54":{}}}],["attempt",{"_index":278,"title":{},"description":{"31":{},"32":{}}}],["attribut",{"_index":244,"title":{},"description":{"23":{}}}],["auth",{"_index":97,"title":{"2":{}},"description":{}}],["authent",{"_index":95,"title":{"1":{}},"description":{"2":{},"10":{},"11":{},"58":{}}}],["author",{"_index":101,"title":{"58":{}},"description":{"2":{},"58":{}}}],["avail",{"_index":19,"title":{"54":{}},"description":{"0":{},"54":{}}}],["available-resourc",{"_index":59,"title":{"53":{}},"description":{"0":{},"23":{},"54":{}}}],["background-color",{"_index":167,"title":{},"description":{"2":{}}}],["bar",{"_index":196,"title":{},"description":{"5":{}}}],["bare",{"_index":4,"title":{"6":{}},"description":{"0":{},"2":{}}}],["base",{"_index":343,"title":{},"description":{"54":{},"56":{}}}],["be",{"_index":316,"title":{},"description":{"41":{}}}],["bearer",{"_index":96,"title":{"2":{}},"description":{"2":{}}}],["befor",{"_index":263,"title":{},"description":{"26":{}}}],["below",{"_index":80,"title":{},"description":{"0":{}}}],["bmaa",{"_index":15,"title":{},"description":{"0":{},"2":{},"11":{},"13":{},"14":{}}}],["bodi",{"_index":34,"title":{},"description":{"0":{},"41":{},"56":{}}}],["boot",{"_index":276,"title":{"31":{},"32":{}},"description":{"31":{},"32":{}}}],["border",{"_index":169,"title":{},"description":{"2":{}}}],["border-radiu",{"_index":173,"title":{},"description":{"2":{}}}],["both",{"_index":182,"title":{},"description":{"2":{},"10":{},"11":{},"58":{}}}],["br",{"_index":179,"title":{},"description":{"2":{}}}],["build",{"_index":206,"title":{"8":{}},"description":{"7":{}}}],["built",{"_index":21,"title":{},"description":{"0":{}}}],["call",{"_index":14,"title":{},"description":{"0":{},"2":{},"23":{},"36":{},"53":{}}}],["capac",{"_index":218,"title":{},"description":{"10":{},"12":{},"38":{},"54":{}}}],["categori",{"_index":330,"title":{},"description":{"54":{}}}],["center",{"_index":67,"title":{},"description":{"0":{},"53":{},"54":{}}}],["central",{"_index":77,"title":{},"description":{"0":{},"2":{},"5":{}}}],["chang",{"_index":238,"title":{"19":{}},"description":{"33":{},"54":{}}}],["classic",{"_index":106,"title":{},"description":{"2":{},"4":{}}}],["click",{"_index":156,"title":{},"description":{"2":{},"5":{}}}],["client",{"_index":47,"title":{},"description":{"0":{},"2":{},"15":{},"21":{}}}],["client(recommended)</h2",{"_index":112,"title":{},"description":{"2":{}}}],["client_id={clientid",{"_index":145,"title":{},"description":{"2":{}}}],["client_secret={clientsecret",{"_index":146,"title":{},"description":{"2":{}}}],["cloud",{"_index":10,"title":{},"description":{"0":{}}}],["cluster",{"_index":212,"title":{"10":{},"58":{}},"description":{"11":{}}}],["code",{"_index":29,"title":{},"description":{"0":{}}}],["comput",{"_index":89,"title":{},"description":{"0":{},"9":{},"21":{},"53":{}}}],["configur",{"_index":306,"title":{},"description":{"40":{},"41":{}}}],["connect",{"_index":253,"title":{},"description":{"25":{},"40":{},"41":{},"42":{}}}],["construct",{"_index":327,"title":{},"description":{"53":{}}}],["contain",{"_index":304,"title":{},"description":{"40":{},"41":{}}}],["content-typ",{"_index":142,"title":{},"description":{"2":{}}}],["context",{"_index":46,"title":{},"description":{"0":{},"3":{}}}],["copi",{"_index":177,"title":{},"description":{"2":{},"5":{}}}],["corner",{"_index":161,"title":{},"description":{"2":{},"5":{}}}],["correspond",{"_index":84,"title":{},"description":{"0":{},"5":{}}}],["countri",{"_index":336,"title":{},"description":{"54":{}}}],["creat",{"_index":48,"title":{"11":{},"23":{},"44":{},"54":{}},"description":{"0":{},"2":{},"9":{},"10":{},"11":{},"15":{},"17":{},"21":{},"23":{},"36":{},"40":{},"44":{},"49":{},"53":{},"54":{},"56":{}}}],["creation",{"_index":321,"title":{},"description":{"44":{}}}],["curl",{"_index":137,"title":{},"description":{"2":{}}}],["current",{"_index":194,"title":{},"description":{"5":{},"33":{},"54":{},"62":{}}}],["d",{"_index":144,"title":{},"description":{"2":{}}}],["data",{"_index":66,"title":{},"description":{"0":{},"53":{},"54":{},"66":{},"67":{}}}],["default",{"_index":340,"title":{},"description":{"54":{},"66":{},"67":{}}}],["defaultrout",{"_index":359,"title":{},"description":{"62":{}}}],["defin",{"_index":208,"title":{},"description":{"9":{},"15":{},"16":{},"22":{},"35":{},"43":{},"48":{},"60":{}}}],["delet",{"_index":232,"title":{"14":{},"20":{},"26":{},"39":{},"46":{},"52":{}},"description":{"14":{},"20":{},"21":{},"26":{},"39":{},"41":{},"44":{},"46":{},"52":{}}}],["deprec",{"_index":73,"title":{},"description":{"0":{}}}],["describ",{"_index":17,"title":{},"description":{"0":{},"42":{}}}],["descript",{"_index":256,"title":{},"description":{"25":{},"54":{}}}],["desir",{"_index":348,"title":{},"description":{"54":{}}}],["detach",{"_index":308,"title":{"41":{}},"description":{"41":{}}}],["detail",{"_index":60,"title":{},"description":{"0":{},"40":{},"41":{},"53":{},"54":{}}}],["determin",{"_index":366,"title":{},"description":{"66":{},"67":{}}}],["differ",{"_index":75,"title":{},"description":{"0":{}}}],["directli",{"_index":151,"title":{},"description":{"2":{},"36":{}}}],["display",{"_index":76,"title":{},"description":{"0":{}}}],["document",{"_index":16,"title":{},"description":{"0":{}}}],["each",{"_index":363,"title":{},"description":{"66":{},"67":{}}}],["enabl",{"_index":320,"title":{},"description":{"44":{}}}],["end",{"_index":200,"title":{},"description":{"5":{}}}],["endpoint",{"_index":20,"title":{},"description":{"0":{}}}],["ensur",{"_index":312,"title":{},"description":{"41":{}}}],["enterpris",{"_index":11,"title":{},"description":{"0":{}}}],["entiti",{"_index":115,"title":{},"description":{"2":{}}}],["environ",{"_index":56,"title":{},"description":{"0":{}}}],["error",{"_index":31,"title":{},"description":{"0":{}}}],["etc",{"_index":287,"title":{},"description":{"33":{}}}],["execut",{"_index":267,"title":{},"description":{"27":{}}}],["exist",{"_index":237,"title":{"19":{},"25":{},"38":{},"40":{},"41":{},"51":{}},"description":{"38":{},"54":{}}}],["expand",{"_index":300,"title":{},"description":{"38":{}}}],["expir",{"_index":184,"title":{},"description":{"2":{}}}],["extern",{"_index":290,"title":{},"description":{"34":{}}}],["extract",{"_index":193,"title":{},"description":{"5":{}}}],["fail",{"_index":254,"title":{},"description":{"25":{},"27":{},"33":{}}}],["favorit",{"_index":36,"title":{},"description":{"0":{}}}],["few",{"_index":72,"title":{},"description":{"0":{},"5":{}}}],["fff",{"_index":168,"title":{},"description":{"2":{}}}],["field",{"_index":192,"title":{"19":{}},"description":{"5":{}}}],["first",{"_index":261,"title":{},"description":{"26":{}}}],["flavor",{"_index":332,"title":{},"description":{"54":{},"58":{}}}],["follow",{"_index":109,"title":{},"description":{"2":{},"54":{}}}],["fully-provis",{"_index":49,"title":{},"description":{"0":{},"21":{}}}],["further",{"_index":365,"title":{},"description":{"66":{},"67":{}}}],["gener",{"_index":136,"title":{},"description":{"2":{}}}],["get",{"_index":150,"title":{"5":{}},"description":{"2":{}}}],["gl",{"_index":370,"title":{},"description":{"66":{},"67":{}}}],["grant_type=client_credenti",{"_index":147,"title":{},"description":{"2":{}}}],["greater",{"_index":298,"title":{},"description":{"38":{}}}],["greenlak",{"_index":3,"title":{"6":{}},"description":{"0":{},"2":{},"3":{},"5":{},"10":{},"11":{},"58":{}}}],["group",{"_index":90,"title":{},"description":{"0":{},"9":{},"66":{},"67":{}}}],["gui",{"_index":345,"title":{},"description":{"54":{}}}],["h",{"_index":141,"title":{},"description":{"2":{}}}],["h2>option",{"_index":111,"title":{},"description":{"2":{}}}],["hdd",{"_index":281,"title":{"32":{}},"description":{"32":{}}}],["header",{"_index":102,"title":{},"description":{"2":{},"3":{},"5":{},"10":{},"11":{},"58":{},"66":{},"67":{}}}],["height=\"12",{"_index":124,"title":{},"description":{"2":{},"5":{}}}],["host",{"_index":50,"title":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"40":{},"41":{},"54":{}},"description":{"0":{},"9":{},"10":{},"11":{},"12":{},"15":{},"17":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"36":{},"40":{},"41":{},"42":{},"44":{},"49":{},"53":{},"54":{}}}],["hoster",{"_index":226,"title":{},"description":{"11":{},"13":{},"14":{},"66":{},"67":{}}}],["hostid",{"_index":310,"title":{},"description":{"41":{}}}],["hosts/{hostid",{"_index":250,"title":{},"description":{"24":{},"25":{},"26":{}}}],["hosts/{hostid}/boothdd",{"_index":282,"title":{},"description":{"32":{}}}],["hosts/{hostid}/bootpx",{"_index":280,"title":{},"description":{"31":{}}}],["hosts/{hostid}/mainten",{"_index":270,"title":{},"description":{"27":{}}}],["hosts/{hostid}/poweroff",{"_index":272,"title":{},"description":{"29":{}}}],["hosts/{hostid}/poweron",{"_index":271,"title":{},"description":{"28":{}}}],["hosts/{hostid}/powerreset",{"_index":274,"title":{},"description":{"30":{}}}],["hosts/{hostid}/replac",{"_index":289,"title":{},"description":{"33":{}}}],["hpe",{"_index":2,"title":{"6":{}},"description":{"0":{},"2":{},"3":{},"4":{},"5":{}}}],["href=\"https://client.greenlake.hpe.com",{"_index":153,"title":{},"description":{"2":{},"5":{}}}],["href=\"https://support.hpe.com/hpesc/public/docdisplay?docid=a00092451en_us&page=greenlakecentral-create-api-client.html",{"_index":120,"title":{},"description":{"2":{}}}],["href=\"https://support.hpe.com/hpesc/public/docdisplay?docid=a00092451en_us&page=guid-1cea233b-c4b0-41b7-9a25-7a36d9fc0312.html",{"_index":132,"title":{},"description":{"2":{}}}],["http",{"_index":22,"title":{},"description":{"0":{}}}],["http/rest",{"_index":37,"title":{},"description":{"0":{}}}],["i.",{"_index":368,"title":{},"description":{"66":{},"67":{}}}],["iam",{"_index":105,"title":{},"description":{"2":{},"3":{},"10":{},"11":{},"58":{},"66":{},"67":{}}}],["icon",{"_index":158,"title":{},"description":{"2":{},"5":{}}}],["id",{"_index":130,"title":{"5":{},"12":{},"13":{},"18":{},"24":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"37":{},"45":{},"50":{},"61":{},"62":{}},"description":{"2":{},"3":{},"5":{},"12":{},"13":{},"14":{},"15":{},"18":{},"20":{},"23":{},"24":{},"25":{},"26":{},"28":{},"29":{},"30":{},"31":{},"32":{},"37":{},"38":{},"39":{},"45":{},"46":{},"50":{},"52":{},"54":{},"61":{},"62":{},"66":{},"67":{}}}],["identifi",{"_index":301,"title":{},"description":{"40":{},"41":{}}}],["ignor",{"_index":221,"title":{},"description":{"10":{},"11":{},"58":{}}}],["imag",{"_index":62,"title":{},"description":{"0":{},"53":{},"54":{}}}],["img",{"_index":122,"title":{},"description":{"2":{},"5":{}}}],["in-us",{"_index":360,"title":{},"description":{"62":{}}}],["includ",{"_index":7,"title":{},"description":{"0":{},"10":{},"12":{},"54":{},"58":{}}}],["independ",{"_index":292,"title":{},"description":{"34":{}}}],["indic",{"_index":30,"title":{},"description":{"0":{},"40":{},"41":{}}}],["info",{"_index":181,"title":{"58":{}},"description":{"2":{}}}],["inform",{"_index":57,"title":{},"description":{"0":{},"7":{},"10":{},"12":{},"40":{},"41":{},"53":{},"54":{},"55":{},"57":{},"58":{},"65":{},"66":{},"67":{}}}],["input",{"_index":162,"title":{},"description":{"2":{}}}],["instanc",{"_index":92,"title":{},"description":{"0":{},"2":{},"21":{},"53":{},"66":{},"67":{}}}],["intern",{"_index":107,"title":{},"description":{"2":{},"4":{}}}],["introduct",{"_index":0,"title":{"0":{}},"description":{}}],["inventori",{"_index":342,"title":{},"description":{"54":{}}}],["ip",{"_index":286,"title":{"60":{},"61":{},"62":{},"63":{},"64":{}},"description":{"33":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{}}}],["ippool",{"_index":356,"title":{"59":{}},"description":{"60":{}}}],["ippools/{ippoolid",{"_index":358,"title":{},"description":{"61":{},"62":{}}}],["ippools/{ippoolid}/alloc",{"_index":361,"title":{},"description":{"63":{}}}],["ippools/{ippoolid}/return",{"_index":362,"title":{},"description":{"64":{}}}],["iscsi",{"_index":305,"title":{},"description":{"40":{},"41":{}}}],["iscsiconfig:initiatornam",{"_index":259,"title":{},"description":{"25":{}}}],["isol",{"_index":55,"title":{},"description":{"0":{},"9":{},"11":{}}}],["issu",{"_index":188,"title":{},"description":{"3":{},"10":{},"11":{},"58":{}}}],["issuer",{"_index":129,"title":{},"description":{"2":{}}}],["issuerurl}/v1/token",{"_index":140,"title":{},"description":{"2":{}}}],["json",{"_index":33,"title":{},"description":{"0":{}}}],["key",{"_index":187,"title":{"3":{},"4":{},"17":{},"18":{},"19":{},"20":{}},"description":{"15":{},"17":{},"18":{},"20":{}}}],["kick",{"_index":241,"title":{},"description":{"23":{}}}],["kind",{"_index":338,"title":{},"description":{"54":{}}}],["languag",{"_index":40,"title":{},"description":{"0":{}}}],["leas",{"_index":183,"title":{},"description":{"2":{}}}],["level",{"_index":190,"title":{},"description":{"5":{}}}],["librari",{"_index":38,"title":{},"description":{"0":{}}}],["limit",{"_index":216,"title":{},"description":{"10":{},"12":{},"13":{}}}],["linux",{"_index":331,"title":{},"description":{"54":{}}}],["list",{"_index":210,"title":{"10":{},"16":{},"22":{},"35":{},"43":{},"48":{},"54":{},"58":{},"60":{}},"description":{"21":{},"53":{},"54":{},"57":{},"58":{},"65":{}}}],["locat",{"_index":68,"title":{},"description":{"0":{},"53":{},"54":{}}}],["locationid",{"_index":248,"title":{},"description":{"23":{}}}],["log",{"_index":155,"title":{},"description":{"2":{},"5":{}}}],["machin",{"_index":64,"title":{},"description":{"0":{},"33":{},"44":{},"53":{},"54":{},"58":{}}}],["machineinventori",{"_index":341,"title":{},"description":{"54":{}}}],["machines",{"_index":335,"title":{},"description":{"54":{},"58":{}}}],["mainten",{"_index":266,"title":{"27":{}},"description":{"27":{}}}],["maintenac",{"_index":288,"title":{},"description":{"33":{}}}],["make",{"_index":126,"title":{},"description":{"2":{}}}],["map",{"_index":81,"title":{},"description":{"0":{}}}],["match",{"_index":229,"title":{},"description":{"12":{},"13":{},"14":{},"18":{},"20":{},"24":{},"25":{},"26":{},"28":{},"29":{},"30":{},"31":{},"32":{},"37":{},"38":{},"39":{},"45":{},"46":{},"50":{},"52":{},"61":{},"62":{}}}],["membership",{"_index":189,"title":{"4":{}},"description":{"66":{},"67":{}}}],["metal",{"_index":5,"title":{"6":{}},"description":{"0":{},"2":{},"4":{},"66":{},"67":{}}}],["minut",{"_index":186,"title":{},"description":{"2":{}}}],["name",{"_index":74,"title":{"5":{},"19":{}},"description":{"0":{},"5":{},"13":{},"54":{}}}],["need",{"_index":69,"title":{},"description":{"0":{},"2":{},"53":{},"66":{},"67":{}}}],["network",{"_index":54,"title":{"47":{},"48":{},"49":{},"50":{},"51":{},"52":{}},"description":{"0":{},"9":{},"10":{},"11":{},"12":{},"23":{},"25":{},"47":{},"48":{},"49":{},"50":{},"52":{},"54":{}}}],["networkfordefaultrout",{"_index":257,"title":{},"description":{"25":{}}}],["networks/{networkid",{"_index":326,"title":{},"description":{"50":{},"51":{},"52":{}}}],["networkuntag",{"_index":258,"title":{},"description":{"25":{}}}],["new",{"_index":222,"title":{"11":{},"17":{},"23":{},"36":{},"44":{},"49":{}},"description":{"11":{},"17":{},"23":{},"33":{},"36":{},"44":{},"49":{},"54":{}}}],["next",{"_index":279,"title":{},"description":{"31":{}}}],["non-host",{"_index":322,"title":{},"description":{"44":{}}}],["nonhuman",{"_index":114,"title":{},"description":{"2":{}}}],["note",{"_index":125,"title":{},"description":{"2":{},"11":{},"13":{},"14":{},"41":{},"44":{}}}],["object",{"_index":214,"title":{},"description":{"10":{},"12":{},"16":{},"22":{},"23":{},"40":{},"41":{},"48":{},"54":{},"58":{},"60":{}}}],["obtain",{"_index":108,"title":{},"description":{"2":{},"5":{}}}],["old",{"_index":83,"title":{},"description":{"0":{}}}],["on",{"_index":299,"title":{},"description":{"38":{}}}],["onc",{"_index":154,"title":{},"description":{"2":{},"5":{}}}],["oper",{"_index":204,"title":{},"description":{"7":{},"9":{},"11":{},"13":{},"14":{},"15":{},"21":{},"27":{},"34":{},"41":{},"42":{},"47":{},"53":{},"55":{},"57":{},"59":{},"65":{}}}],["option",{"_index":63,"title":{},"description":{"0":{},"2":{},"23":{},"53":{},"54":{}}}],["order",{"_index":277,"title":{"31":{},"32":{}},"description":{}}],["organ",{"_index":211,"title":{"10":{},"58":{}},"description":{"11":{}}}],["os",{"_index":61,"title":{},"description":{"0":{},"53":{}}}],["owner",{"_index":227,"title":{},"description":{"11":{},"13":{},"14":{}}}],["page",{"_index":175,"title":{},"description":{"2":{}}}],["paramet",{"_index":199,"title":{},"description":{"5":{},"56":{},"66":{},"67":{}}}],["part",{"_index":8,"title":{},"description":{"0":{}}}],["pass",{"_index":219,"title":{},"description":{"10":{},"11":{},"56":{},"58":{}}}],["permit",{"_index":251,"title":{},"description":{"25":{},"26":{},"38":{},"58":{}}}],["persist",{"_index":291,"title":{},"description":{"34":{}}}],["person",{"_index":178,"title":{},"description":{"2":{}}}],["physic",{"_index":239,"title":{},"description":{"21":{},"23":{}}}],["pool",{"_index":357,"title":{"60":{},"61":{},"62":{},"63":{},"64":{}},"description":{"59":{},"60":{},"61":{},"62":{},"63":{},"64":{}}}],["post",{"_index":139,"title":{},"description":{"2":{},"44":{}}}],["power",{"_index":265,"title":{"28":{},"29":{}},"description":{"26":{},"27":{},"28":{},"29":{},"33":{}}}],["powered-off",{"_index":262,"title":{},"description":{"26":{}}}],["pre-defin",{"_index":268,"title":{},"description":{"27":{}}}],["predict",{"_index":24,"title":{},"description":{"0":{}}}],["present",{"_index":371,"title":{},"description":{"66":{},"67":{}}}],["privat",{"_index":9,"title":{},"description":{"0":{},"9":{},"10":{},"11":{},"12":{}}}],["profil",{"_index":215,"title":{},"description":{"10":{},"12":{},"13":{}}}],["program",{"_index":39,"title":{},"description":{"0":{}}}],["programmat",{"_index":118,"title":{},"description":{"2":{}}}],["project",{"_index":45,"title":{"3":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"16":{},"22":{},"35":{},"43":{},"48":{},"58":{},"60":{}},"description":{"0":{},"3":{},"5":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"16":{},"22":{},"35":{},"36":{},"43":{},"48":{},"55":{},"57":{},"58":{},"60":{},"66":{},"67":{}}}],["project-specif",{"_index":53,"title":{},"description":{"0":{}}}],["projects-info",{"_index":354,"title":{"57":{}},"description":{"58":{}}}],["projects/{projectid",{"_index":230,"title":{},"description":{"12":{},"13":{},"14":{}}}],["protocol",{"_index":18,"title":{},"description":{"0":{}}}],["provid",{"_index":41,"title":{},"description":{"0":{},"2":{},"3":{},"23":{},"53":{}}}],["provis",{"_index":242,"title":{},"description":{"23":{}}}],["pxe",{"_index":275,"title":{"31":{}},"description":{"31":{}}}],["queri",{"_index":198,"title":{},"description":{"5":{},"66":{},"67":{}}}],["rapidli",{"_index":344,"title":{},"description":{"54":{}}}],["re-deploy",{"_index":284,"title":{},"description":{"33":{}}}],["read-onli",{"_index":203,"title":{},"description":{"7":{}}}],["readi",{"_index":252,"title":{},"description":{"25":{},"26":{},"27":{},"33":{}}}],["refer",{"_index":71,"title":{},"description":{"0":{}}}],["referenc",{"_index":235,"title":{},"description":{"15":{},"17":{},"36":{},"49":{}}}],["regardless",{"_index":264,"title":{},"description":{"26":{}}}],["region",{"_index":337,"title":{},"description":{"54":{}}}],["regular",{"_index":324,"title":{},"description":{"44":{}}}],["relat",{"_index":207,"title":{},"description":{"9":{},"15":{},"21":{},"34":{},"42":{},"47":{},"53":{},"55":{},"57":{},"59":{},"65":{}}}],["remov",{"_index":309,"title":{},"description":{"41":{}}}],["replac",{"_index":283,"title":{"33":{}},"description":{"33":{}}}],["report",{"_index":353,"title":{"56":{}},"description":{"56":{}}}],["request",{"_index":311,"title":{},"description":{"41":{},"56":{},"66":{},"67":{}}}],["requestbodi",{"_index":302,"title":{},"description":{"40":{},"41":{}}}],["requir",{"_index":98,"title":{},"description":{"2":{},"4":{},"5":{},"10":{},"11":{},"13":{},"14":{},"41":{},"54":{},"58":{}}}],["reset",{"_index":273,"title":{"30":{}},"description":{"30":{}}}],["resouc",{"_index":217,"title":{},"description":{"10":{},"12":{}}}],["resourc",{"_index":25,"title":{"54":{}},"description":{"0":{},"2":{},"44":{},"55":{}}}],["resource'",{"_index":82,"title":{},"description":{"0":{}}}],["respons",{"_index":28,"title":{},"description":{"0":{},"2":{},"66":{},"67":{}}}],["rest",{"_index":23,"title":{},"description":{"0":{},"2":{}}}],["restrict",{"_index":347,"title":{},"description":{"54":{}}}],["retriev",{"_index":228,"title":{"12":{},"18":{},"24":{},"37":{},"45":{},"50":{},"61":{}},"description":{"55":{}}}],["return",{"_index":27,"title":{"64":{}},"description":{"0":{},"10":{},"12":{},"16":{},"18":{},"22":{},"24":{},"35":{},"37":{},"43":{},"45":{},"48":{},"50":{},"54":{},"56":{},"58":{},"60":{},"61":{},"64":{},"66":{},"67":{}}}],["right",{"_index":160,"title":{},"description":{"2":{},"5":{},"54":{}}}],["role",{"_index":135,"title":{},"description":{"2":{},"11":{},"13":{},"14":{}}}],["satisfi",{"_index":285,"title":{},"description":{"33":{}}}],["save",{"_index":128,"title":{},"description":{"2":{}}}],["scope",{"_index":367,"title":{},"description":{"66":{},"67":{}}}],["scope=hpe-ten",{"_index":148,"title":{},"description":{"2":{}}}],["secret",{"_index":131,"title":{},"description":{"2":{}}}],["select",{"_index":245,"title":{},"description":{"23":{},"41":{}}}],["separ",{"_index":294,"title":{},"description":{"36":{}}}],["server",{"_index":205,"title":{"8":{},"66":{}},"description":{"7":{},"21":{},"23":{},"65":{},"66":{},"67":{}}}],["servic",{"_index":12,"title":{},"description":{"0":{},"2":{},"3":{},"54":{},"66":{},"67":{}}}],["set",{"_index":220,"title":{"31":{},"32":{}},"description":{"10":{},"11":{},"23":{},"31":{},"32":{},"33":{},"58":{}}}],["singl",{"_index":44,"title":{},"description":{"0":{},"3":{},"12":{},"18":{},"24":{},"28":{},"29":{},"30":{},"31":{},"32":{},"37":{},"45":{},"50":{},"61":{},"62":{}}}],["site",{"_index":350,"title":{},"description":{"54":{},"66":{},"67":{}}}],["siteid",{"_index":372,"title":{},"description":{"66":{},"67":{}}}],["size",{"_index":65,"title":{},"description":{"0":{},"53":{},"54":{},"58":{}}}],["sn",{"_index":86,"title":{},"description":{"0":{}}}],["solid",{"_index":171,"title":{},"description":{"2":{}}}],["sometim",{"_index":13,"title":{},"description":{"0":{}}}],["space",{"_index":119,"title":{"5":{}},"description":{"2":{},"5":{},"9":{},"10":{},"11":{},"58":{}}}],["spaceid",{"_index":197,"title":{},"description":{"5":{},"10":{},"11":{},"58":{}}}],["spec",{"_index":87,"title":{},"description":{"0":{}}}],["specif",{"_index":70,"title":{},"description":{"0":{},"3":{},"11":{},"54":{},"66":{},"67":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/circle-information.svg",{"_index":180,"title":{},"description":{"2":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/clipboard.svg",{"_index":176,"title":{},"description":{"2":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/share.svg",{"_index":123,"title":{},"description":{"2":{},"5":{}}}],["src=\"https://raw.githubusercontent.com/grommet/grommet-icons/stable/img/user.svg",{"_index":157,"title":{},"description":{"2":{},"5":{}}}],["ssh",{"_index":234,"title":{"17":{},"18":{},"19":{},"20":{}},"description":{"15":{},"17":{},"18":{},"20":{}}}],["sshkey",{"_index":233,"title":{"15":{},"16":{}},"description":{"16":{},"17":{}}}],["sshkeyid",{"_index":249,"title":{},"description":{"23":{}}}],["sshkeys/{sshkeyid",{"_index":236,"title":{},"description":{"18":{},"19":{},"20":{}}}],["state",{"_index":255,"title":{},"description":{"25":{},"26":{},"27":{},"33":{},"38":{},"54":{}}}],["storag",{"_index":51,"title":{"67":{}},"description":{"0":{},"34":{},"53":{},"54":{},"65":{}}}],["storageinventori",{"_index":349,"title":{},"description":{"54":{}}}],["style=\"color",{"_index":165,"title":{},"description":{"2":{}}}],["such",{"_index":328,"title":{},"description":{"53":{}}}],["support",{"_index":103,"title":{},"description":{"2":{}}}],["sure",{"_index":127,"title":{},"description":{"2":{}}}],["svcflavor",{"_index":246,"title":{},"description":{"23":{}}}],["svcversion",{"_index":247,"title":{},"description":{"23":{}}}],["symbol",{"_index":201,"title":{},"description":{"5":{}}}],["system",{"_index":346,"title":{},"description":{"54":{}}}],["tabl",{"_index":79,"title":{},"description":{"0":{}}}],["target=\"_blank",{"_index":121,"title":{},"description":{"2":{},"5":{}}}],["team",{"_index":225,"title":{},"description":{"11":{}}}],["tenant/host",{"_index":369,"title":{},"description":{"66":{},"67":{}}}],["those",{"_index":355,"title":{},"description":{"58":{}}}],["through",{"_index":58,"title":{},"description":{"0":{}}}],["token",{"_index":100,"title":{},"description":{"2":{},"3":{},"4":{},"10":{},"11":{},"58":{},"66":{},"67":{}}}],["top",{"_index":159,"title":{},"description":{"2":{},"5":{}}}],["two",{"_index":104,"title":{},"description":{"2":{}}}],["type",{"_index":94,"title":{},"description":{"0":{},"2":{},"53":{},"66":{},"67":{}}}],["type'",{"_index":364,"title":{},"description":{"66":{},"67":{}}}],["type=\"button",{"_index":163,"title":{},"description":{"2":{}}}],["ubuntu",{"_index":333,"title":{},"description":{"54":{}}}],["ui",{"_index":78,"title":{},"description":{"0":{}}}],["ui</h2",{"_index":152,"title":{},"description":{"2":{}}}],["understood",{"_index":314,"title":{},"description":{"41":{}}}],["updat",{"_index":231,"title":{"13":{},"19":{},"25":{},"38":{},"51":{},"62":{}},"description":{"13":{},"25":{},"38":{},"40":{},"41":{},"62":{}}}],["url",{"_index":26,"title":{},"description":{"0":{},"2":{},"5":{}}}],["us",{"_index":35,"title":{},"description":{"0":{},"2":{},"3":{},"4":{},"10":{},"11":{},"44":{},"54":{},"58":{},"66":{},"67":{}}}],["usag",{"_index":339,"title":{"56":{}},"description":{"54":{},"55":{},"56":{}}}],["usage-report",{"_index":352,"title":{"55":{}},"description":{"56":{}}}],["user",{"_index":99,"title":{"58":{}},"description":{"2":{},"58":{}}}],["valu",{"_index":191,"title":{},"description":{"5":{},"23":{},"38":{},"66":{},"67":{}}}],["value=\"api",{"_index":164,"title":{},"description":{"2":{}}}],["version",{"_index":202,"title":{"7":{},"8":{}},"description":{"7":{},"8":{},"54":{}}}],["via",{"_index":325,"title":{},"description":{"44":{}}}],["view",{"_index":240,"title":{},"description":{"21":{}}}],["visibl",{"_index":297,"title":{},"description":{"38":{}}}],["volum",{"_index":52,"title":{"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"43":{},"45":{},"54":{}},"description":{"0":{},"9":{},"10":{},"11":{},"12":{},"25":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"44":{},"45":{},"53":{},"54":{},"58":{}}}],["volume-attach",{"_index":319,"title":{"42":{}},"description":{"43":{},"44":{}}}],["volume-attachments/{attachmentid",{"_index":323,"title":{},"description":{"44":{},"45":{},"46":{}}}],["volumeattach",{"_index":303,"title":{"44":{},"46":{}},"description":{"40":{},"41":{},"42":{},"43":{},"44":{},"46":{}}}],["volumeflavor",{"_index":351,"title":{},"description":{"54":{},"58":{}}}],["volumes/{volumeid",{"_index":295,"title":{},"description":{"37":{},"38":{},"39":{}}}],["volumes/{volumeid}/attach",{"_index":307,"title":{},"description":{"40":{},"44":{}}}],["volumes/{volumeid}/detach",{"_index":318,"title":{},"description":{"41":{}}}],["way",{"_index":110,"title":{},"description":{"2":{}}}],["welcom",{"_index":1,"title":{},"description":{"0":{}}}],["well",{"_index":313,"title":{},"description":{"41":{}}}],["within",{"_index":43,"title":{"10":{},"58":{}},"description":{"0":{},"3":{},"11":{},"16":{},"22":{},"35":{},"36":{},"43":{},"48":{},"55":{},"60":{}}}],["workflow",{"_index":269,"title":{},"description":{"27":{},"33":{}}}],["wrong",{"_index":317,"title":{},"description":{"41":{}}}],["x",{"_index":138,"title":{},"description":{"2":{}}}]],"pipeline":[]}},"options":{}};
 
     var container = document.getElementById('redoc');
     Redoc.hydrate(__redoc_state, container);
diff --git a/v1/pkg/client/api/openapi.yaml b/v1/pkg/client/api/openapi.yaml
index f1050a20..cf14c41f 100644
--- a/v1/pkg/client/api/openapi.yaml
+++ b/v1/pkg/client/api/openapi.yaml
@@ -3112,16 +3112,16 @@ components:
           type: array
       type: object
     AllocationStorage:
-      description: allocation of storage for each PCE service.
+      description: Allocation of storage for each PCE service.
       example:
         InstanceFamily: Performance Optimized Block
         AllocationInfo:
         - AllocatedCount: 1
           ServiceType: BMaaS
-          AllocatedCapacity: 5
+          AllocatedCapacity: 0.5962134
         - AllocatedCount: 1
           ServiceType: BMaaS
-          AllocatedCapacity: 5
+          AllocatedCapacity: 0.5962134
         Total: 0.8008282
         ResourceType: ResourceType
         Available: 0.6027456
@@ -4196,7 +4196,7 @@ components:
       example:
         AllocatedCount: 1
         ServiceType: BMaaS
-        AllocatedCapacity: 5
+        AllocatedCapacity: 0.5962134
       properties:
         ServiceType:
           description: Service type consuming the resource
@@ -4208,7 +4208,9 @@ components:
         AllocatedCapacity:
           description: Total capacity of all allocated volumes in TB for a service
             type.
-          type: integer
+          format: float
+          minimum: 0.0
+          type: number
       type: object
     HostServerPort:
       properties:
diff --git a/v1/pkg/client/docs/ServiceStorageInfo.md b/v1/pkg/client/docs/ServiceStorageInfo.md
index 39c09c20..28dc4877 100644
--- a/v1/pkg/client/docs/ServiceStorageInfo.md
+++ b/v1/pkg/client/docs/ServiceStorageInfo.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ServiceType** | **string** | Service type consuming the resource | [optional] 
 **AllocatedCount** | **int32** | Allocated number of volumes. | [optional] 
-**AllocatedCapacity** | **int32** | Total capacity of all allocated volumes in TB for a service type. | [optional] 
+**AllocatedCapacity** | **float32** | Total capacity of all allocated volumes in TB for a service type. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/v1/pkg/client/model_allocation_storage.go b/v1/pkg/client/model_allocation_storage.go
index 7d9ddd42..131d8efa 100644
--- a/v1/pkg/client/model_allocation_storage.go
+++ b/v1/pkg/client/model_allocation_storage.go
@@ -10,7 +10,7 @@
  */
 
 package client
-// AllocationStorage allocation of storage for each PCE service.
+// AllocationStorage Allocation of storage for each PCE service.
 type AllocationStorage struct {
 	// Type of the resource the allocation information is listed for.
 	ResourceType string `json:"ResourceType,omitempty"`
diff --git a/v1/pkg/client/model_service_storage_info.go b/v1/pkg/client/model_service_storage_info.go
index 09c818bb..9566c758 100644
--- a/v1/pkg/client/model_service_storage_info.go
+++ b/v1/pkg/client/model_service_storage_info.go
@@ -17,5 +17,5 @@ type ServiceStorageInfo struct {
 	// Allocated number of volumes.
 	AllocatedCount int32 `json:"AllocatedCount,omitempty"`
 	// Total capacity of all allocated volumes in TB for a service type.
-	AllocatedCapacity int32 `json:"AllocatedCapacity,omitempty"`
+	AllocatedCapacity float32 `json:"AllocatedCapacity,omitempty"`
 }