{ "openapi": "3.1.0", "info": { "description": "HPE Greenlake For Block Storage REST APIs", "license": { "name": "HPE End User License Agreement", "url": "https://www.hpe.com/us/en/software/licensing.html" }, "title": "HPE Greenlake For Block Storage REST APIs", "version": "1.0.0" }, "servers": [ { "url": "https://eu1.data.cloud.hpe.com" }, { "url": "https://us1.data.cloud.hpe.com" }, { "url": "https://jp1.data.cloud.hpe.com" } ], "tags": [ { "description": "The Host service API allows the management of Host Group", "name": "host-initiator-groups" }, { "description": "The Host service API allows the management of Host, initiators", "name": "host-initiators" }, { "description": "The ports API allows the management of host-paths", "name": "host-paths" }, { "description": "The ports API allows the management of host-sets", "name": "host-sets" }, { "description": "The ports API allows the management of hosts", "name": "hosts" }, { "description": "The pools API allows the management of storage pools", "name": "storage-pools" }, { "description": "The storage-systems API allows the management of storage device.", "name": "storage-systems" }, { "description": "The Volume-sets API allows the management of volume sets", "name": "volume-sets" }, { "description": "The volumes API allows the management of volumes", "name": "volumes" } ], "paths": { "/block-storage/v1/devtype4-storage-systems/{systemId}/application-summary": { "get": { "description": "Get Application Summary for an HPE Alletra Storage MP B10000 storage system", "operationId": "DeviceType4ApplicationSummaryGet", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ApplicationSummary" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get Application Summary for an HPE Alletra Storage MP B10000 storage system", "tags": [ "storage-systems" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets": { "get": { "description": "Get all applicationset details for HPE Alletra Storage MP B10000", "operationId": "DeviceType4VolumeSetsList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/DeviceType4AppSetFilterParam" }, { "$ref": "#/components/parameters/DeviceType4AppSetSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ApplicationSetsList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all applicationset details for HPE Alletra Storage MP B10000", "tags": [ "volume-sets" ] }, "post": { "description": "Create Application Set for an HPE Alletra Storage MP B10000 storage system", "operationId": "DeviceType4VolumeSetsCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CreateAppSetInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create Application Set for an HPE Alletra Storage MP B10000 storage system", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{appsetId}/export": { "post": { "description": "Export applicationset identified by {appsetId} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VolumeSetExport", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/appsetUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ExportAppSetPost" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Export applicationset identified by {appsetId} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{appsetId}/replication-partners": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 replication partners identified by {systemId} and {appsetId}", "operationId": "DeviceType4GetReplicationPartnersByAppSetId", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/appsetUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ReplicationPartnersSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 replication partners identified by {systemId} and {appsetId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{appsetId}/replication-partners/{replicationPartnerId}/volumes": { "get": { "description": "Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4GetReplicationPartnerVolumesByAppSetId", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/appsetUid" }, { "$ref": "#/components/parameters/replicationPartnerId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ReplicationPartnerVolumesSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for HPE Alletra Storage MP B10000", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{appsetId}/snapsets/{snapsetId}": { "delete": { "description": "Remove HPE Alletra Storage MP B10000 snapset in system identified by {snapsetId}", "operationId": "DeviceType4VolumeSetSnapshotGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/appsetUid" }, { "$ref": "#/components/parameters/DeviceType4SnapsetID" }, { "$ref": "#/components/parameters/forceDeleteSnapset" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Remove HPE Alletra Storage MP B10000 snapset in system identified by {snapsetId}", "tags": [ "volume-sets" ] }, "get": { "description": "Get details of snapset identified by {snapsetId} for Applicationset identified by {appsetId} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4SnapsetsGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/appsetUid" }, { "$ref": "#/components/parameters/DeviceType4SnapsetID" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4SnapshotsetListSingle" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of snapsets identified by {snapsetId} for Applicationset identified by {appsetId} for HPE Alletra Storage MP B10000", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{appsetId}/un-export": { "post": { "description": "Unexport applicationset identified by {appsetId} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VolumeSetUnexport", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/appsetUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4UnExportAppSetPost" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Unexport applicationset identified by {appsetId} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{appsetId}/volumes": { "get": { "description": "Get volumes for an applicationset identified by appsetUid", "operationId": "DeviceType4VolumeSetVolumesList", "parameters": [ { "$ref": "#/components/parameters/appsetUid" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumesList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get volumes for an applicationset identified by appsetUid", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}": { "delete": { "description": "Remove applicationset identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VolumeSetsDeleteById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uidAppset" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Remove applicationset identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volume-sets" ] }, "get": { "description": "Get applicationset details for an applicationset identified by appsetUid", "operationId": "DeviceType4VolumeSetsGetById", "parameters": [ { "$ref": "#/components/parameters/uidAppset" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ApplicationSetDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get applicationset details for an applicationset identified by appsetUid", "tags": [ "volume-sets" ] }, "put": { "description": "Edit applicationset identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VolumeSetsEditById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uidAppset" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumeSetPut" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Edit applicationset identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/capacity-statistics": { "get": { "description": "Get capacity details for an applicationset identified by appsetUid", "operationId": "DeviceType4VolumeSetCapacityStatisticsGetById", "parameters": [ { "$ref": "#/components/parameters/uidAppset" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ApplicationSetCapacityStatsList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get capacity details for an applicationset identified by appsetUid", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/performance": { "get": { "description": "Get the performance history data for the HPE Alletra Storage MP B10000 volume set identified by {id}, including the QOS configuration history and the top/bottom 5-10 volumes based on a metric or up to 10 selected volume's performance history on a storage system identified by {systemid}.", "operationId": "DeviceType4GetAppSetVolumesPerformanceHistory", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/reportType" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" }, { "$ref": "#/components/parameters/compareByVolumeSetPerf" }, { "$ref": "#/components/parameters/filterVolumeSetVolumePerf" }, { "$ref": "#/components/parameters/perfMetricTypeVolumeSetPerf" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeSetPerformanceHistoryDataList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the performance history data for the HPE Alletra Storage MP B10000 volume set identified by {id}, including the QOS configuration history and the top/bottom 5-10 volumes based on a metric or up to 10 selected volume's performance history on a storage system identified by {systemid}.", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/protection-policies": { "get": { "description": "Get details of protection policies configured on application set identified by {id} created on HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4GetProtectionPolicies", "parameters": [ { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/DeviceType4AppSetFilterParam" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ProtectionPoliciesList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of protection policies configured on application set identified by {id} created on HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volume-sets" ] }, "post": { "description": "Add protection policy on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4CreateProtectionPolicy", "parameters": [ { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CreateProtectionPolicyInputSchema" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Add protection policy on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volume-sets" ] }, "put": { "description": "Edit protection policy on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4EditProtectionPolicies", "parameters": [ { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4EditProtectionPolicyInputSchema" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Edit protection policy on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/protection-policies/fix": { "post": { "description": "Remedies issues caused in protection policy configuration on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4FixProtectionPolicy", "parameters": [ { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CreateProtectionPolicyInputSchema" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Fix protection policy configuration on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/protection-policies/remove": { "post": { "description": "Remove protection policy on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4removeProtectionPolicies", "parameters": [ { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4RemoveProtectionPoliciesInputSchema" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Remove protection policy on application set identified by {id} for an HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/proximity-settings": { "get": { "description": "Get hosts and proximity details identified by application set {id} for HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4GetProximitySettings", "parameters": [ { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/storageSystemUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumeSetProximitySettings" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get hosts and proximity details identified by application set {id} for HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volume-sets" ] }, "put": { "description": "Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from HPE Alletra Storage MP B10000", "operationId": "DeviceType4EditProximitySettings", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uidAppset" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ChangeProximitySettingsInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from HPE Alletra Storage MP B10000", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/remote-protection/actions": { "post": { "description": "Actions on volume set identified by {id} and {systemId} from HPE Alletra Storage MP B10000", "operationId": "DeviceType4actionOnVolumeSets", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/idAppset" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4RemoteProtectionActionsInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Actions on volume set identified by {id} and {systemId} from HPE Alletra Storage MP B10000", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/snapsets": { "get": { "description": "Get snapshot details of volume sets identified by {id} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4VolumeSetSnapshotsList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/uidAppset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4SnapshotSetsSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get snapshot details of volume sets identified by {id} for HPE Alletra Storage MP B10000", "tags": [ "volume-sets" ] }, "post": { "description": "Create snapshot for application set identified by {id}", "operationId": "DeviceType4VolumeSetsSnapshotCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uidAppset" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4AppsetPost" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create snapshot for application set identified by {id}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/applicationsets/{id}/supported-protection": { "get": { "description": "Get supported protection types for application set identified by {id} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4getSupportedProtectionTypes", "parameters": [ { "$ref": "#/components/parameters/idAppset" }, { "$ref": "#/components/parameters/storageSystemUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4SupportedProtectionTypesList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get supported protection types for application set identified by {id} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volume-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/capacity-forecast": { "get": { "description": "Get latest capacity trend data and forecasted data", "operationId": "DeviceType4SystemCapacityForecastGet", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/startTime" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CapacityForecastList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get latest capacity trend data and forecasted data", "tags": [ "storage-systems" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/capacity-timeuntilfull": { "get": { "description": "Get capacity time until full data for an HPE HPE Alletra Storage MP B10000 storage system", "operationId": "DeviceType4SystemCapacityTimeUntilFull", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CapacityTimeUntilFullList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get capacity time until full data for an HPE Alletra Storage MP B10000 storage system", "tags": [ "storage-systems" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/headroom-contribution": { "get": { "description": "Get Top headroom contribution by volumes/Apps for device-type4", "operationId": "DeviceType4GetHeadroomContribution", "parameters": [ { "$ref": "#/components/parameters/DeviceType4SystemId" }, { "$ref": "#/components/parameters/resourceTypeHeadroom" }, { "$ref": "#/components/parameters/timeIntervalMinutes" }, { "$ref": "#/components/parameters/timeRange" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/headroomContributionList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get Top headroom contribution by volumes/Apps for device-type4", "tags": [ "storage-systems" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/host-paths": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 Host Paths", "operationId": "DeviceType4GetAllHostPaths", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/DeviceType4hostPathFilterParam" }, { "$ref": "#/components/parameters/DeviceType4hostPathSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4HostPathList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 Host Paths", "tags": [ "host-paths" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/host-paths/{hostPathId}": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 Host Path identified by {HostPathId}", "operationId": "DeviceType4GetHostPathsById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/DeviceType4hostPathId" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4HostPaths" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 Host Path identified by {HostPathId}", "tags": [ "host-paths" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/host-sets": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 Host Sets", "operationId": "DeviceType4GetAllHostSets", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/DeviceType4HostSetFilterParam" }, { "$ref": "#/components/parameters/DeviceType4hostSetSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4HostSetList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 Host Sets", "tags": [ "host-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/host-sets/{hostSetId}": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 Host Set identified by {HostSetId}", "operationId": "DeviceType4GetHostSetsById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/DeviceType4hostSetId" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4HostSets" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 Host Set identified by {HostSetId}", "tags": [ "host-sets" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/hosts": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 Hosts", "operationId": "DeviceType4GetAllHosts", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/DeviceType4hostFilterParam" }, { "$ref": "#/components/parameters/DeviceType4hostSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4HostList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 Hosts", "tags": [ "hosts" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/hosts/{hostId}": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 Host identified by {HostId}", "operationId": "DeviceType4GetHostById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/DeviceType4hostId" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4Hosts" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 Host identified by {HostId}", "tags": [ "hosts" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/hotspots": { "get": { "description": "Get the top hotspots segregated into read and write categories", "operationId": "DeviceType4GetHotspots", "parameters": [ { "$ref": "#/components/parameters/DeviceType4SystemId" }, { "$ref": "#/components/parameters/timeIntervalMinutes" }, { "$ref": "#/components/parameters/timeRange" }, { "$ref": "#/components/parameters/operationType" }, { "$ref": "#/components/parameters/resourceType" }, { "$ref": "#/components/parameters/DeviceType4MetricType" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hotspotsList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get hotspots for HPE Alletra Storage MP B10000 storage system based on resourceType `VOLUMES or VOLUME-SET` and metricType `LATENCY`", "tags": [ "storage-systems" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/latency-factors": { "get": { "description": "Get system level latency factors of system identified by {systemId}", "operationId": "Device4LatencyFactorsGet", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMinutes" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4SystemLatencyFactorsList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get system level latency factors", "tags": [ "storage-systems" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/resource-contention": { "get": { "description": "Get the top volume contributors and timeseries data for disk and cpu resource contention", "operationId": "DeviceType4GetResourceContentionData", "parameters": [ { "$ref": "#/components/parameters/DeviceType4SystemId" }, { "$ref": "#/components/parameters/timeIntervalMinutes" }, { "$ref": "#/components/parameters/timeRange" }, { "$ref": "#/components/parameters/resourceContentionType" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourceContentionList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get resource contention data for resources `DISK and CPU` for device-type4", "tags": [ "storage-systems" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{childSnapshotId}/restore-options": { "get": { "description": "Get the details of all read-write parent snapshots and base volume to which the child snapshot identified by {childSnapshotId} can be restored on HPE Alletra Storage MP B10000 system identified by {systemId}.", "operationId": "DeviceType4GetSnapshotRestoreOptions", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/childSnapshotUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4SnapshotsSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the details of all read-write parent snapshots and base volume to which the child snapshot identified by {childSnapshotId} can be restored on HPE Alletra Storage MP B10000 system identified by {systemId}.", "tags": [ "snapshots" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{parentSnapshotId}/snapshots/{childSnapshotId}/restore": { "post": { "description": "Restore a child snapshot identified by {childSnapshotId} to a read-write parent snapshot identified by {parentSnapshotId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4RestoreSnapshotOfSnapshot", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/parentSnapshotUid" }, { "$ref": "#/components/parameters/childSnapshotUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4RestoreSnapshotOfSnapshotInput" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Restore a child snapshot identified by {childSnapshotId} to a read-write parent snapshot identified by {parentSnapshotId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "snapshots" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{snapshotId}/clone": { "post": { "description": "Create a clone of a snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000 systems.", "operationId": "DeviceType4SnapshotCloneCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/snapshotUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CreateCloneSnapshotInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create a clone of a snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000 systems.", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{snapshotId}/export": { "post": { "description": "Export vlun for snapshot identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VlunExportForSnapshot", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/snapshotUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VlunsCreateInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Export vlun for snapshot identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{snapshotId}/snapshots": { "post": { "description": "Create snapshot of snapshot identified by {snapshotId} on a HPE Alletra storage MP system identified by {systemId}", "operationId": "DeviceType4SnapshotOfSnapshotCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/snapshotUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumePost" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create snapshot of snapshot identified by {snapshotId} on a HPE Alletra storage MP system identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{snapshotId}/un-export": { "post": { "description": "Unexport vlun for snapshot identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VlunUnexportForSnapshot", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/snapshotUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4UnExportVlun" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Unexport vlun for snapshot identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{snapshotId}/vluns": { "get": { "description": "Get details of vluns for Snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4GetSnapshotVlunsList", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/snapshotUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/orderby" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VlunsSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of vluns for Snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/snapshots/{snapshotId}/vluns/{id}": { "get": { "description": "Get details of vlun identified by {id} for Snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4GetsnapshotVlunsById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/snapshotUid" }, { "$ref": "#/components/parameters/vlunUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VlunsListSingle" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of vlun identified by {id} for Snapshot identified by {snapshotId} for HPE Alletra Storage MP B10000", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/storage-pools": { "get": { "description": "Get all storage-pools details by HPE Alletra Storage MP B10000", "operationId": "DeviceType4StoragePoolList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/DeviceType4PoolFilter" }, { "$ref": "#/components/parameters/DeviceType4PoolSort" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4PoolsSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all storage-pools details by HPE Alletra Storage MP B10000", "tags": [ "storage-pools" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/storage-pools/{id}": { "get": { "description": "Get details of HPE Alletra Storage MP B10000 storage-pool identified by {id}", "operationId": "DeviceType4StoragePoolGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/DeviceType4PoolID" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4PoolDetails" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 storage-pool identified by {id}", "tags": [ "storage-pools" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/storage-pools/{id}/volumes": { "get": { "description": "Get all volumes for storage-pool identified by {uuid} of HPE Alletra Storage MP B10000", "operationId": "DeviceType4StoragePoolVolumeGetById", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/DeviceType4PoolID" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumesList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all volumes for storage-pool identified by {uuid} of HPE Alletra Storage MP B10000", "tags": [ "storage-pools" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes": { "get": { "description": "Get all volumes details for HPE Alletra Storage MP B10000", "operationId": "DeviceType4VolumesList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumesList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all volumes details for HPE Alletra Storage MP B10000", "tags": [ "volumes" ] }, "post": { "description": "Create a new volume for an HPE Alletra Storage MP B10000 storage system", "operationId": "DeviceType4VolumeCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CreateVolumeInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create a new volume for an HPE Alletra Storage MP B10000 storage system", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes-performance": { "get": { "description": "Get performance history of Volumes on storage system identified by {systemid}", "operationId": "DeviceType4GetVolumesPerformanceHistory", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/reportType" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" }, { "$ref": "#/components/parameters/compareBy" }, { "$ref": "#/components/parameters/groupByVolumeDT4" }, { "$ref": "#/components/parameters/filterVolumeDT4" }, { "$ref": "#/components/parameters/component" }, { "$ref": "#/components/parameters/perfMetricType" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4PerformanceHistoryDataList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get performance history of Volumes on storage system identified by {systemid}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}": { "delete": { "description": "Remove volume identified by {volumeId} from HPE Alletra Storage MP B10000", "operationId": "DeviceType4VolumeDelete", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/UnExportDelVol" }, { "$ref": "#/components/parameters/CascadeDelVol" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Remove volume identified by {volumeId} from HPE Alletra Storage MP B10000", "tags": [ "volumes" ] }, "get": { "description": "Get details for a single HPE Alletra Storage MP B10000 volume identified by {id}", "operationId": "DeviceType4VolumeGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumeDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of HPE Alletra Storage MP B10000 Volume identified by {id}", "tags": [ "volumes" ] }, "put": { "description": "Edit volume identified by {volumeId} from HPE Alletra Storage MP B10000", "operationId": "DeviceType4VolumeEdit", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumePut" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Edit volume identified by {volumeId} from HPE Alletra Storage MP B10000", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/capacity-history": { "get": { "description": "Get volume capacity trend data of HPE Alletra Storage MP B10000 Volume identified by {id}", "operationId": "DeviceType4VolumeCapacityHistoryGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMinForVvCapacity" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumeCapacityHistoryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get volume capacity trend data of HPE Alletra Storage MP B10000 Volume identified by {id}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/clone": { "post": { "description": "Create a clone volume identified by {id} for HPE Alletra Storage MP B10000 systems.", "operationId": "DeviceType4VolumeCloneCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4CreateCloneVolumeInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create a clone volume identified by {id} for HPE Alletra Storage MP B10000 systems.", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/export": { "post": { "description": "Export vlun for volume identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VlunExport", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VlunsCreateInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Export vlun for volume identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/performance-histogram": { "get": { "description": "Get the I/O size histogram for a volume over the specified duration. The buckets query parameter must contain one or more of: Size512B, Size1k, Size2k, Size4k, Size8k, Size16k, Size32k, Size64k, Size128k, Size256k, Size512k, Size1m, Size2m", "operationId": "DeviceType4GetPerformanceHistogram", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" }, { "$ref": "#/components/parameters/ioType" }, { "$ref": "#/components/parameters/buckets" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumePerformanceHistogramList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get histogram buckets distribution of I/Os of a volume for a given duration.", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/performance-history": { "get": { "description": "Get performance trend data of HPE Alletra Storage MP B10000 Volume identified by {id}", "operationId": "DeviceType4VolumePerformanceHistoryGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/timeIntervalMin" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumePerformanceHistoryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get performance trend data of HPE Alletra Storage MP B10000 Volume identified by {id}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/performance-statistics": { "get": { "description": "Get performance statistics of HPE Alletra Storage MP B10000 Volume identified by {id}", "operationId": "DeviceType4VolumePerformanceStatisticsGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumePerformanceList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get performance statistics of HPE Alletra Storage MP B10000 Volume identified by {id}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/snapshots": { "get": { "description": "Get snapshot details of volume identified by {id} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4VolumeSnapshotsList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/uuidVolume" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4SnapshotsSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get snapshot details of volume identified by {id} for HPE Alletra Storage MP B10000", "tags": [ "volumes" ] }, "post": { "description": "Create snapshot for volumes identified by {id}", "operationId": "DeviceType4VolumeSnapshotCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumePost" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create snapshot for volumes identified by {id}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/un-export": { "post": { "description": "Unexport vlun for volume identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "operationId": "DeviceType4VlunUnexport", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4UnExportVlun" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Unexport vlun for volume identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{id}/vluns": { "get": { "description": "Get details of vluns for Volume identified by {volumeId} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4VlunsList", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/orderby" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VlunsSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of vluns for Volume identified by {volumeId} for HPE Alletra Storage MP B10000", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/clones": { "get": { "description": "Get the details of the clone volumes associated with a base volume identified by {volumeId} for HPE Alletra Storage MP B10000 systems.", "operationId": "DeviceType4GetClones", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VolumesList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the details of the clone volumes associated with a base volume identified by {volumeId} for HPE Alletra Storage MP B10000 systems.", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/clones/{cloneId}/promote": { "post": { "description": "Promote a clone volume identified by {cloneId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4PromoteCloneVolume", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/cloneUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4PromoteCloneInput" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Promote a clone volume identified by {cloneId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/clones/{cloneId}/resync": { "post": { "description": "Resynchronize a clone volume identified by {cloneId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4ResyncCloneVolume", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/cloneUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ResyncCloneVolumeInput" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Resynchronize a clone volume identified by {cloneId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/latency-annotations": { "get": { "description": "Get the high latency points to be annotated segregated into read and write categories", "operationId": "DeviceType4GetVolumeLatencyAnnotations", "parameters": [ { "$ref": "#/components/parameters/DeviceType4SystemId" }, { "$ref": "#/components/parameters/volumeId" }, { "$ref": "#/components/parameters/timeIntervalMinutes" }, { "$ref": "#/components/parameters/timeRange" }, { "$ref": "#/components/parameters/operationType" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumeLatencyAnnotationsList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get volume latency annotations for device-type4", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/performance-drifts": { "get": { "description": "Get latency drifts of a volume for a give duration.The minimum duration supported is 8 hours and a maximum duration of 2 days. Drifts are detected in both read and write latency metrics", "operationId": "DeviceType4GetPerformanceDrifts", "parameters": [ { "$ref": "#/components/parameters/DeviceType4SystemId" }, { "$ref": "#/components/parameters/volumeId" }, { "$ref": "#/components/parameters/timeIntervalMinutes" }, { "$ref": "#/components/parameters/timeRange" }, { "$ref": "#/components/parameters/operationType" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumePerformanceDriftsList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get latency drifts of a volume for a give duration", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/schedules": { "get": { "description": "Get snapshot schedules of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4VolumeSnapshotSchedulesList", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ScheduleList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get snapshot schedules of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] }, "post": { "description": "Create snapshot schedule for a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4VolumeSnapshotScheduleCreate", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4ScheduleInputSchema" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create snapshot schedule for a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/schedules/{scheduleId}": { "delete": { "description": "Delete snapshot Schedule identified by {scheduleId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4VolumeSnapshotScheduleDelete", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/scheduleUid" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Delete snapshot Schedule identified by {scheduleId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] }, "get": { "description": "Get details of snapshot schedule identified by {scheduleId} for a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4VolumeSnapshotScheduleGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/scheduleUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4Schedule" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of snapshot schedule identified by {scheduleId} for a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] }, "put": { "description": "Edit Snapshot Schedule identified by {scheduleId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "arcusEditVolumeSnapshotSchedule", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/scheduleUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4EditVolumeSnapshotScheduleInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Edit Snapshot Schedule identified by {scheduleId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/snapshots/{snapshotId}": { "delete": { "description": "Remove HPE Alletra Storage MP B10000 snapshot in system identified by {snapshotId}", "operationId": "DeviceType4VolumeSnapshotGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/DeviceType4SnapshotID" }, { "$ref": "#/components/parameters/forceDeleteSnapshot" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Remove HPE Alletra Storage MP B10000 snapshot in system identified by {snapshotId}", "tags": [ "volumes" ] }, "get": { "description": "Get details of vlun identified by {id} for Volume identified by {volumeId} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4SnapshotsGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/snapshotUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4SnapshotsListSingle" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of snapshot identified by {snapshotId} for Volume identified by {volumeId} for HPE Alletra Storage MP B10000", "tags": [ "volumes" ] }, "post": { "description": "Promote a snapshot identified by {snapshotId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "operationId": "DeviceType4PromoteSnapshot", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/snapshotUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4PromoteSnapshotInput" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Promote a snapshot identified by {snapshotId} of a volume identified by {volumeId} on HPE Alletra Storage MP B10000 storage system identified by {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-storage-systems/{systemId}/volumes/{volumeId}/vluns/{id}": { "delete": { "description": "Remove vlun idenfied by {id} form volume identified by {volumeId} from HPE Alletra Storage MP B10000", "operationId": "DeviceType4VlunsDelete", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/vlunUid" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Remove vlun idenfied by {id} form volume identified by {volumeId} from HPE Alletra Storage MP B10000", "tags": [ "volumes" ] }, "get": { "description": "Get details of vlun identified by {id} for Volume identified by {volumeId} for HPE Alletra Storage MP B10000", "operationId": "DeviceType4VlunsGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/volumeUid" }, { "$ref": "#/components/parameters/vlunUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceType4VlunsListSingle" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of vlun identified by {id} for Volume identified by {volumeId} for HPE Alletra Storage MP B10000", "tags": [ "volumes" ] } }, "/block-storage/v1/devtype4-system-insights": { "get": { "description": "List all insights.", "operationId": "DeviceType4Insights", "parameters": [ { "allowReserved": true, "description": "GET /block-storage/v1/devtype4-system-insights?filter=type eq 'TIME_UNTIL_FULL':\nGET /block-storage/v1/devtype4-system-insights?filter=score lt 3:\nGET /block-storage/v1/devtype4-system-insights?filter=value gt 60:\nGET /block-storage/v1/devtype4-system-insights?filter=date eq '2024-05-12':\n", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsightsResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all insights.", "tags": [ "storage-systems" ] } }, "/block-storage/v1/host-initiator-groups": { "get": { "description": "Get the list of host groups", "operationId": "HostGroupList", "parameters": [ { "$ref": "#/components/parameters/hsFilterParam" }, { "$ref": "#/components/parameters/hsSortParam" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroupsList" } } }, "description": "Success", "headers": { "ETag": { "description": "List of Host groups", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the list of host groups", "tags": [ "host-initiator-groups" ] }, "post": { "description": "Create a host group with hosts having same protocol initiators", "operationId": "HostGroupCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHostGroupInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroupObjectDetails" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create a host group", "tags": [ "host-initiator-groups" ] } }, "/block-storage/v1/host-initiator-groups/{hostGroupId}": { "delete": { "description": "Delete a host group by {hostGroupId}", "operationId": "HostGroupDelete", "parameters": [ { "$ref": "#/components/parameters/hostGroupUid" }, { "$ref": "#/components/parameters/ForceDelete" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Delete a host group by {hostGroupId}", "tags": [ "host-initiator-groups" ] }, "get": { "description": "Get the host group details by {hostGroupId}", "operationId": "HostGroupGetById", "parameters": [ { "$ref": "#/components/parameters/hostGroupUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroupDetails" } } }, "description": "Success", "headers": { "ETag": { "description": "Host group details", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the host group details by {hostGroupId}", "tags": [ "host-initiator-groups" ] }, "put": { "description": "Update host group details by {hostGroupId}. Hostgroup can be updated with hosts containing same protocol initiators", "operationId": "HostGroupUpdateById", "parameters": [ { "$ref": "#/components/parameters/hostGroupUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHostGroupInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Update host group by {hostGroupId}", "tags": [ "host-initiator-groups" ] } }, "/block-storage/v1/host-initiator-groups/{hostGroupId}/mapped-devices": { "get": { "description": "Get details of a host group identified by {hostGroupId} across its associated systems", "operationId": "HostGroupMappedDevice", "parameters": [ { "$ref": "#/components/parameters/hostGroupUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappedDeviceList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of a host group identified by {hostGroupId} across its associated systems", "tags": [ "host-initiator-groups" ] } }, "/block-storage/v1/host-initiators": { "get": { "description": "Get the list of hosts", "operationId": "HostList", "parameters": [ { "$ref": "#/components/parameters/hsFilterParam" }, { "$ref": "#/components/parameters/hsSortParam" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostsList" } } }, "description": "Success", "headers": { "ETag": { "description": "List of Hosts", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the list of hosts", "tags": [ "host-initiators" ] }, "post": { "description": "Create a host with same protocol initiators", "operationId": "HostCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHostInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostObjectDetails" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create a host", "tags": [ "host-initiators" ] } }, "/block-storage/v1/host-initiators/{hostId}": { "delete": { "description": "Delete a host by {hostId}", "operationId": "HostDelete", "parameters": [ { "$ref": "#/components/parameters/hostUid" }, { "$ref": "#/components/parameters/ForceDelete" }, { "$ref": "#/components/parameters/DeleteAssociatedEmptyHostGroup" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Delete a host by {hostId}", "tags": [ "host-initiators" ] }, "get": { "description": "Get the host details by {hostId}", "operationId": "HostGetById", "parameters": [ { "$ref": "#/components/parameters/hostUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostDetails" } } }, "description": "Success", "headers": { "ETag": { "description": "Host details", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the host details by {hostId}", "tags": [ "host-initiators" ] }, "put": { "description": "Update host details by {hostId}. Host can only be updated with the same protocol initiators", "operationId": "HostUpdateById", "parameters": [ { "$ref": "#/components/parameters/hostUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHostInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Update Host by {hostId}", "tags": [ "host-initiators" ] } }, "/block-storage/v1/host-initiators/{hostId}/chap": { "get": { "description": "Get Host CHAP details by {hostId}", "operationId": "GetHostChapById", "parameters": [ { "$ref": "#/components/parameters/hostUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostChapDetails" } } }, "description": "Success", "headers": { "ETag": { "description": "Host Chap details", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get Host CHAP details by {hostId}", "tags": [ "host-initiators" ] }, "put": { "description": "CHAP can be updated only on iSCSI host on HPE GreenLake for Block Storage 10.4.0 or later and NVMe/TCP host on HPE GreenLake for Block Storage 10.5.0 or later.", "operationId": "UpdateHostChapById", "parameters": [ { "$ref": "#/components/parameters/hostUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHostChapInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskResponse" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Update Host CHAP by {hostId}", "tags": [ "host-initiators" ] } }, "/block-storage/v1/host-initiators/{hostId}/chapkey": { "post": { "description": "CHAP key can be generated only on NVMe/TCP host on HPE GreenLake for Block Storage 10.5.0 and later system OS versions.", "operationId": "GenerateChapKeyById", "parameters": [ { "$ref": "#/components/parameters/hostUid" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateChapKeyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateChapKeyResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Generate a DH-HMAC-CHAP host key usable for NVMe In-Band Authentication for Host by {hostId}", "tags": [ "host-initiators" ] } }, "/block-storage/v1/host-initiators/{hostId}/mapped-devices": { "get": { "description": "Get details of a host identified by {hostId} across its associated systems", "operationId": "HostMappedDevice", "parameters": [ { "$ref": "#/components/parameters/hostUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappedDeviceList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of a host identified by {hostId} across its associated systems", "tags": [ "host-initiators" ] } }, "/block-storage/v1/host-initiators/{hostId}/storage-performance-history": { "get": { "description": "Get the volume performance history data associated with a host identified by {uid}", "operationId": "HostVolumePerformanceHistoryGet", "parameters": [ { "$ref": "#/components/parameters/hostUid" }, { "$ref": "#/components/parameters/selectStoragePerf" }, { "$ref": "#/components/parameters/range" }, { "$ref": "#/components/parameters/storagePerfTimeMin" }, { "$ref": "#/components/parameters/topVolumesCount" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hostStoragePerformanceHistoryList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the volume performance history data associated with a host identified by {uid}", "tags": [ "host-initiators" ] } }, "/block-storage/v1/host-initiators/{hostId}/volumes": { "get": { "description": "Get details of volumes associated with a host identified by {uid}", "operationId": "HostVolumesGet", "parameters": [ { "$ref": "#/components/parameters/hostUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hostStorageVolumes" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of volumes associated with a host identified by {uid}", "tags": [ "host-initiators" ] } }, "/block-storage/v1/initiators": { "get": { "description": "Get the list of initiators", "operationId": "HostInitiatorList", "parameters": [ { "$ref": "#/components/parameters/hsFilterParam" }, { "$ref": "#/components/parameters/hsSortParam" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiatorList" } } }, "description": "Success", "headers": { "ETag": { "description": "List of Host initiators", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the list of initiators", "tags": [ "host-initiators" ] }, "post": { "description": "Create initiator", "operationId": "HostInitiatorCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiatorInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiatorForPost" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Create initiator", "tags": [ "host-initiators" ] } }, "/block-storage/v1/initiators/{initiatorId}": { "delete": { "description": "Delete initiator by {initiatorId}", "operationId": "HostInitiatorDelete", "parameters": [ { "$ref": "#/components/parameters/initiatorUid" } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteInitiator" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Delete initiator by {initiatorId}", "tags": [ "host-initiators" ] }, "get": { "description": "Get the initiator details by {initiatorId}", "operationId": "HostInitiatorGetById", "parameters": [ { "$ref": "#/components/parameters/initiatorUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiatorDetails" } } }, "description": "Success", "headers": { "ETag": { "description": "Host initiator details", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get the initiator details by {initiatorId}", "tags": [ "host-initiators" ] } }, "/block-storage/v1/storage-systems/{systemId}/storage-pools": { "get": { "description": "Get all storage pools for a device {systemId}", "operationId": "StoragePoolsList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/poolFilter" }, { "$ref": "#/components/parameters/poolSort" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storagePoolsFleetSummaryList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all storage pools for a device {systemId}", "tags": [ "storage-pools" ] } }, "/block-storage/v1/storage-systems/{systemId}/storage-pools/{id}": { "get": { "description": "Get details of storage pools identified by {id}", "operationId": "StoragePoolsGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/primeraPoolID" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetPoolDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of storage pools identified by {id}", "tags": [ "storage-pools" ] } }, "/block-storage/v1/storage-systems/{systemId}/storage-pools/{id}/volumes": { "get": { "description": "Get all volumes for storage-pool identified by {id}", "operationId": "StoragePoolVolumesList", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/primeraPoolID" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumesListWithoutRansomware" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all volumes for storage-pool identified by {id}", "tags": [ "storage-pools" ] } }, "/block-storage/v1/storage-systems/{systemId}/volume-sets": { "get": { "description": "Get all volume sets for a systemId", "operationId": "VolumesetListForSystemBySystemId", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeSetFilterParam" }, { "$ref": "#/components/parameters/volumeSetSortParam" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/storageSystemUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumeSetListWithoutRansomware" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all volume-sets for a systemId", "tags": [ "volume-sets" ] } }, "/block-storage/v1/storage-systems/{systemId}/volume-sets/{id}": { "get": { "description": "Get volume-set identified by id", "operationId": "VolumesetSystemGetById", "parameters": [ { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/volumeSetUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetSystemVolumeset" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get volume-set identified by id", "tags": [ "volume-sets" ] } }, "/block-storage/v1/storage-systems/{systemId}/volumes": { "get": { "description": "Get details of volumes identified with {systemId}", "operationId": "VolumeListForSystemBySystemId", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/storageSystemUid" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumesList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of volumes identified with {systemId}", "tags": [ "volumes" ] } }, "/block-storage/v1/storage-systems/provisioning-recommendations": { "post": { "description": "Produce a set of provisioning recommendations based on the provided input parameters.", "operationId": "ProvisioningRecommendations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommendationInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageSystemRecommendationList" } } }, "description": "Accepted", "headers": { "Location": { "description": "This contains the URI of the task used to monitor the request", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Produce a set of provisioning recommendations based on the provided input parameters.", "tags": [ "volumes" ] } }, "/block-storage/v1/volume-sets": { "get": { "description": "Get all volume sets", "operationId": "VolumesetList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeSetFilterParam" }, { "$ref": "#/components/parameters/volumeSetSortParam" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumeSetListWithoutRansomware" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all volume-sets", "tags": [ "volume-sets" ] } }, "/block-storage/v1/volume-sets/{id}": { "get": { "description": "Get volume-set identified by id", "operationId": "VolumesetGetById", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/volumeSetUid" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumeSetDetailsWithoutRansomware" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get volume-set identified by id", "tags": [ "volume-sets" ] } }, "/block-storage/v1/volume-sets/{id}/volumes": { "get": { "description": "Get volumes identified by volume set id", "operationId": "VolumesetGetByvolumesetId", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/volumeSetUid" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumeSetList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Pool object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get volumes identified by volume set id", "tags": [ "volume-sets" ] } }, "/block-storage/v1/volumes": { "get": { "description": "Get all volumes", "operationId": "VolumesList", "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/volumeFilterParam" }, { "$ref": "#/components/parameters/volumeSortParam" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumesList" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get all volumes", "tags": [ "volumes" ] } }, "/block-storage/v1/volumes/{id}": { "get": { "description": "Get details of Volume identified by {id}", "operationId": "VolumeGetById", "parameters": [ { "$ref": "#/components/parameters/uuidVolume" }, { "$ref": "#/components/parameters/select" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fleetVolumeDetails" } } }, "description": "Success" }, "304": { "description": "Not Modified" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Storage system object not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal / unexpected error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "unexpected error" } }, "summary": "Get details of Volume identified by {id}", "tags": [ "volumes" ] } } }, "components": { "parameters": { "CascadeDelVol": { "allowReserved": true, "description": "Delete snapshot and volume", "example": true, "in": "query", "name": "cascade", "required": false, "schema": { "type": "boolean" } }, "DeleteAssociatedEmptyHostGroup": { "allowReserved": true, "description": "Delete the resulting empty host group associated to this host option", "example": true, "in": "query", "name": "delete-associated-empty-hg", "required": false, "schema": { "type": "boolean" } }, "DeviceType4AppSetFilterParam": { "allowReserved": true, "description": "Lucene query to filter application-sets by Key.", "example": "uid eq 2a0df0fe6f7dc7bb16000000000000000000004817", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "DeviceType4AppSetSortParam": { "allowReserved": true, "description": "Lucene query to sort application-sets by Key.", "example": "name desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "DeviceType4HostSetFilterParam": { "allowReserved": true, "description": "Lucene query to filter host set by Key.", "example": "id eq 2a0df0fe6f7dc7bb16000000000000000000004817", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "DeviceType4MetricType": { "allowReserved": true, "description": "Query to select metric for which hotspot is to calculated", "example": "LATENCY", "in": "query", "name": "metric-type", "schema": { "default": "LATENCY", "enum": [ "LATENCY" ], "type": "string" } }, "DeviceType4PoolFilter": { "allowReserved": true, "description": "oData query to filter pools by Key.", "example": "name eq CPG_1", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "DeviceType4PoolID": { "description": "Identifier of pool. A 32 digit number.", "example": "147c439db3ecb34d1ccccc932d14fd60", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, "DeviceType4PoolSort": { "allowReserved": true, "description": "oData query to sort pools by Key.", "example": "name desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "DeviceType4SnapsetID": { "description": "Identifier of snapset.", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "snapsetId", "required": true, "schema": { "type": "string" } }, "DeviceType4SnapshotID": { "description": "Identifier of snapshot.", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "snapshotId", "required": true, "schema": { "type": "string" } }, "DeviceType4SystemId": { "description": "SystemId of the HPE Alletra Storage MP B10000 storage system", "example": "ABC239XFZ9", "in": "path", "name": "systemId", "required": true, "schema": { "type": "string" } }, "DeviceType4hostFilterParam": { "allowReserved": true, "description": "Lucene query to filter host by Key.", "example": "id eq 2a0df0fe6f7dc7bb16000000000000000000004817", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "DeviceType4hostId": { "description": "ID of the HPE Alletra Storage MP B10000 Host Set. A 42 digit hexadecimal number.", "example": "2a0df0fe6f7dc7bb16000000000000000000004817", "in": "path", "name": "hostId", "required": true, "schema": { "type": "string" } }, "DeviceType4hostPathFilterParam": { "allowReserved": true, "description": "Lucene query to filter host path by Key.", "example": "id eq 2a0df0fe6f7dc7bb16000000000000000000004817", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "DeviceType4hostPathId": { "description": "ID of the HPE Alletra Storage MP B10000 Host Path. A 42 digit hexadecimal number.", "example": "2a0df0fe6f7dc7bb16000000000000000000004817", "in": "path", "name": "hostPathId", "required": true, "schema": { "type": "string" } }, "DeviceType4hostPathSortParam": { "allowReserved": true, "description": "oData query to sort host path resource by Key.", "example": "HostSpeed desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "DeviceType4hostSetId": { "description": "ID of the HPE Alletra Storage MP B10000 Host Set. A 42 digit hexadecimal number.", "example": "2a0df0fe6f7dc7bb16000000000000000000004817", "in": "path", "name": "hostSetId", "required": true, "schema": { "type": "string" } }, "DeviceType4hostSetSortParam": { "allowReserved": true, "description": "oData query to sort host set resource by Key.", "example": "HostSpeed desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "DeviceType4hostSortParam": { "allowReserved": true, "description": "oData query to sort host resource by Key.", "example": "HostSpeed desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "ForceDelete": { "allowReserved": true, "description": "Forceful delete option", "example": true, "in": "query", "name": "force", "required": false, "schema": { "type": "boolean" } }, "UnExportDelVol": { "allowReserved": true, "description": "UnExport Host,HostSet and delete volume", "example": true, "in": "query", "name": "un-export", "required": false, "schema": { "type": "boolean" } }, "appsetUid": { "description": "UID of the applicationset", "example": "e9d353bf98fc1a6bdb90b824e3ca14b5", "in": "path", "name": "appsetId", "required": true, "schema": { "type": "string" } }, "buckets": { "description": "Comma separated buckets list. Following values are supported: Size512B, Size1k, Size2k, Size4k, Size8k, Size16k, Size32k, Size64k, Size128k, Size256k, Size512k, Size1m, Size2m", "in": "query", "name": "buckets", "required": false, "schema": { "type": "string" } }, "childSnapshotUid": { "description": "UID of the child snapshot to be restored", "example": "c7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "childSnapshotId", "required": true, "schema": { "type": "string" } }, "cloneUid": { "description": "UID of the clone", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "cloneId", "required": true, "schema": { "type": "string" } }, "compareBy": { "allowReserved": true, "description": "compareBy will define top and compare metrics for which query has to be made. Allowed values: `readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy`", "example": "top eq 5 and metrics eq readIops", "in": "query", "name": "compare-by", "schema": { "type": "string" } }, "compareByVolumeSetPerf": { "allowReserved": true, "description": "compareBy will define top or bottom N count", "example": "top eq 5", "in": "query", "name": "compare-by", "schema": { "type": "string" } }, "component": { "allowReserved": true, "description": "component will give information about resource to be queried", "example": "VLUN", "in": "query", "name": "component", "schema": { "enum": [ "VLUN" ], "type": "string" } }, "filterVolumeDT4": { "description": "filter will define objects to be filtered. Filterable columns are:\n* `hostIds` - id of the host\n* `appsetId` - id of the application set\n* `vvId` - id of the volume\n* `targetName` - name of the replication partner\n", "in": "query", "name": "filter", "schema": { "type": "string" } }, "filterVolumeSetVolumePerf": { "allowReserved": true, "description": "filter will define objects to be filtered. Filterable columns are:\n* `vvId` - id of the volume\n", "example": "vvId in (5df1fc8108e1c74b7041625a2f94d098,cd6c28c563b60f391fcd6dee8b92360c)", "in": "query", "name": "filter", "schema": { "type": "string" } }, "forceDeleteSnapset": { "allowReserved": true, "description": "Make snapset offline and remove.", "example": true, "in": "query", "name": "force", "required": false, "schema": { "type": "boolean" } }, "forceDeleteSnapshot": { "allowReserved": true, "description": "Make snapshot offline and remove.", "example": true, "in": "query", "name": "force", "required": false, "schema": { "type": "boolean" } }, "groupByVolumeDT4": { "allowReserved": true, "description": "groupBy will define comma separated groupBy parameters. Allowed values are: `vvName, hostName, appsetType, appsetName, portNsp, targetName`. By default, groupBy will be set to `vvName`. If groupBy is used along with filter query parameter, only following combinations are allowed:\n* `filter: vvId eq 179fa4a77c8497aacdee87d0fb67066b` then groupBy should be `vvName`\n* `filter: appsetId eq 4765171ee6d74340fca5996b90875d45` then groupBy should be `appsetName`\n* `filter: hostIds eq 61e2d16fb28d5e6e75198039fcb4f068` then groupBy should be `hostName`\n* `filter: targetName eq 08BM_s0B8X` then groupBy should be `targetName`\n", "example": "vvName", "in": "query", "name": "group-by", "schema": { "type": "string" } }, "hostGroupUid": { "description": "Id of the host Group.", "example": "e789e756496246859fde6c132b2091d3", "in": "path", "name": "hostGroupId", "required": true, "schema": { "type": "string" } }, "hostUid": { "description": "Id of the Host.", "example": "2b09e744496246859fde6c132b2091d3", "in": "path", "name": "hostId", "required": true, "schema": { "type": "string" } }, "hsFilterParam": { "allowReserved": true, "description": "oData query to filter hostservice by Key.", "example": "id eq 2a0df0fe6f7dc7bb16000000000000000000004817", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "hsSortParam": { "allowReserved": true, "description": "oData query to sort hostservice by Key.", "example": "name desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "idAppset": { "description": "ID of the applicationset", "example": "e9d353bf98fc1a6bdb90b824e3ca14b5", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, "initiatorUid": { "description": "UID of Initiator.", "example": "e789e756496246859fde6c132b2091d3", "in": "path", "name": "initiatorId", "required": true, "schema": { "type": "string" } }, "ioType": { "description": "Indicates if histogram metrics to be calculated for read or write.", "in": "query", "name": "io-type", "required": false, "schema": { "enum": [ "read", "write" ], "type": "string" } }, "limit": { "description": "Number of items to return at a time", "example": 10, "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 5000, "minimum": 0, "type": "integer" } }, "offset": { "description": "The offset of the first item in the collection to return", "example": 5, "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "maximum": 100000, "minimum": 0, "type": "integer" } }, "operationType": { "description": "Indicates if hotspots metrics to be calculated for read, write or both operations. If this field is not provided, hotspots are calculated for both operations", "example": "READ", "in": "query", "name": "operation-type", "required": false, "schema": { "enum": [ "READ", "WRITE", "ALL" ], "type": "string" } }, "orderby": { "allowReserved": true, "description": "Query to sort the response with specified key and order", "example": "id asc,name desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "parentSnapshotUid": { "description": "UID of the read-write parent snapshot", "example": "b7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "parentSnapshotId", "required": true, "schema": { "type": "string" } }, "perfMetricType": { "allowReserved": true, "description": "metricType will define comma separated metrics", "example": "IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY", "in": "query", "name": "metric-type", "schema": { "type": "string" } }, "perfMetricTypeVolumeSetPerf": { "allowReserved": true, "description": "metricType will define comma separated metrics", "example": "IOPS,LATENCY,THROUGHPUT", "in": "query", "name": "metric-type", "schema": { "type": "string" } }, "poolFilter": { "allowReserved": true, "description": "oData query to filter pools by Key.", "example": "name eq CPG_1", "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, "poolSort": { "allowReserved": true, "description": "oData query to sort pools by Key.", "example": "name desc", "in": "query", "name": "sort", "required": false, "schema": { "type": "string" } }, "primeraPoolID": { "description": "Identifier of pool. A 32 digit number.", "example": "147c439db3ecb34d1ccccc932d14fd60", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, "range": { "allowReserved": true, "description": "range will define start and end time in which query has to be made.", "example": "startTime eq 1605063600 and endTime eq 1605186000", "in": "query", "name": "range", "schema": { "type": "string" } }, "replicationPartnerId": { "description": "ID of device-type4 replication partner", "example": "aedec7d11d02f73611a6ff992c256bdb", "in": "path", "name": "replicationPartnerId", "required": true, "schema": { "type": "string" } }, "reportType": { "allowReserved": true, "description": "parameter will be set to report type requested. For api users, set parameter as ApiUser", "example": "Canned,Custom,Def,ApiUser", "in": "query", "name": "report-type", "schema": { "type": "string" } }, "resourceContentionType": { "description": "Indicates if resource contention has to be calculated for disk, cpu or both resources. If this field is not provided, resource contention is calculated for both resources", "example": "DISK", "in": "query", "name": "resource-contention-type", "required": false, "schema": { "enum": [ "DISK", "CPU", "ALL" ], "type": "string" } }, "resourceType": { "allowReserved": true, "description": "Query to select resource (volumes, volume-set) for analytics", "example": "VOLUMES", "in": "query", "name": "resource-type", "schema": { "default": "VOLUMES", "enum": [ "VOLUMES", "VOLUME-SET" ], "type": "string" } }, "resourceTypeHeadroom": { "allowReserved": true, "description": "Query to select resource (volumes, volume-set) for getting Headroom Contributors", "example": "VOLUMES", "in": "query", "name": "resource-type", "schema": { "default": "VOLUMES", "enum": [ "VOLUMES", "VOLUME-SET" ], "type": "string" } }, "scheduleUid": { "description": "Schedule ID of the volume", "example": "2e2af4b093bee71e1e38549ca2aa5f9f", "in": "path", "name": "scheduleId", "required": true, "schema": { "type": "string" } }, "select": { "allowReserved": true, "description": "Query to select only the required parameters, separated by . if nested", "example": "id", "in": "query", "name": "select", "required": false, "schema": { "type": "string" } }, "selectStoragePerf": { "allowReserved": true, "description": "Query to select only the required parameters, separated by . if nested", "example": "latencyMetricsDataMs", "in": "query", "name": "select", "required": false, "schema": { "type": "string" } }, "snapshotUid": { "description": "UID of the snapshots", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "snapshotId", "required": true, "schema": { "type": "string" } }, "startTime": { "description": "Start time from which forecasted data is needed", "example": 1591601529000, "in": "query", "name": "start-time", "required": false, "schema": { "type": "integer" } }, "storagePerfTimeMin": { "allowReserved": true, "description": "It defines granularity in minutes.", "example": 1440, "in": "query", "name": "time-interval-min", "schema": { "enum": [ 5, 60, 1440, 10080 ], "type": "integer" } }, "storageSystemUid": { "description": "systemId of the storage system", "example": "7CE751P312", "in": "path", "name": "systemId", "required": true, "schema": { "type": "string" } }, "timeIntervalMin": { "allowReserved": true, "description": "It defines granularity in minutes.", "example": 60, "in": "query", "name": "time-interval-min", "schema": { "enum": [ 5, 60, 1440, 10080 ], "type": "integer" } }, "timeIntervalMinForVvCapacity": { "allowReserved": true, "description": "It defines granularity in minutes.", "example": 1440, "in": "query", "name": "time-interval-min", "schema": { "enum": [ 1440, 10080 ], "type": "integer" } }, "timeIntervalMinutes": { "description": "Time interval granularity in minutes", "in": "query", "name": "time-interval-min", "required": true, "schema": { "enum": [ 5, 60, 1440 ], "type": "integer" } }, "timeRange": { "allowReserved": true, "description": "Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified", "example": "startTime eq 1605063600 and endTime eq 1605186000", "in": "query", "name": "range", "required": true, "schema": { "type": "string" } }, "topVolumesCount": { "allowReserved": true, "description": "The number of top volumes to return. Defaults to 5.", "example": 5, "in": "query", "name": "top-volumes-count", "schema": { "type": "integer" } }, "uidAppset": { "description": "UID of the applicationset", "example": "e9d353bf98fc1a6bdb90b824e3ca14b5", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, "uuidVolume": { "description": "UID(volumeuid) of the storage system", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, "vlunUid": { "description": "UID of the vlun", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, "volumeFilterParam": { "allowReserved": true, "description": "oData query to filter by Key.", "example": "name eq array1 and wwn eq 2FF70002AC018D94", "in": "query", "name": "filter", "schema": { "type": "string" } }, "volumeId": { "description": "VolumeId of the device-type4 storage system", "example": "60002AC000000000000005B200029834", "in": "path", "name": "volumeId", "required": true, "schema": { "type": "string" } }, "volumeSetFilterParam": { "allowReserved": true, "description": "oData query to filter by Key.", "example": "name eq volset and systemId eq 7CE751P312", "in": "query", "name": "filter", "schema": { "type": "string" } }, "volumeSetSortParam": { "allowReserved": true, "description": "oData query to sort by Key.", "example": "systemId desc", "in": "query", "name": "sort", "schema": { "type": "string" } }, "volumeSetUid": { "description": "UID of Volume Set", "example": "fd3244ef7f1ab8bd16500c7a41bdf8f8", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, "volumeSortParam": { "allowReserved": true, "description": "oData query to sort by Key.", "example": "systemWWN desc", "in": "query", "name": "sort", "schema": { "type": "string" } }, "volumeUid": { "description": "UID(volumeuid) of the storage system", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "in": "path", "name": "volumeId", "required": true, "schema": { "type": "string" } } }, "schemas": { "ArcusScriptInfo": { "description": "Script information for application consistency operations", "properties": { "params": { "description": "Parameters to pass to the script", "example": "--mode backup --timeout 300", "type": [ "string", "null" ] }, "path": { "description": "Path to the script file", "example": "/scripts/backup/pre-backup.sh", "type": [ "string", "null" ] }, "timeoutSecs": { "description": "Timeout in seconds for script execution", "example": 300, "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "CommonListResponse": { "properties": { "count": { "description": "Number of items in this response.", "type": "integer" }, "offset": { "description": "The offset query parameter from the request.", "type": "integer" }, "total": { "description": "Total number of items matching the filter parameter in the request.", "type": "integer" } }, "required": [ "count", "offset" ] }, "CreateHostGroupInput": { "properties": { "comment": { "description": "Comment", "example": "host-group-comment", "type": [ "string", "null" ] }, "hostIds": { "description": "List of host ids of existing hosts", "items": { "type": "string" }, "type": [ "array", "null" ] }, "hostsToCreate": { "description": "List of hosts to be created and added to this hostGroup", "items": { "$ref": "#/components/schemas/CreateHostInput" }, "type": [ "array", "null" ] }, "name": { "description": "Name of the host group. The maximum supported length is 251 characters. Host Group name length greater than 27 characters is supported only for HPE Alletra Storage MP B10000 systems with OS version 10.4.2 and later.", "example": "host-group1", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "CreateHostInput": { "properties": { "comment": { "description": "Comment", "example": "comment1", "type": [ "string", "null" ] }, "contact": { "description": "Contact information", "example": "sanjay@hpe.com", "type": [ "string", "null" ] }, "fqdn": { "description": "Fully qualified domain name of the host.", "example": "host1.hpe.com", "type": [ "string", "null" ] }, "hostGroupIds": { "description": "List of hostgroup IDs", "items": { "type": "string" }, "type": [ "array", "null" ] }, "initiatorIds": { "description": "List of ids of existing initiators", "items": { "type": "string" }, "type": [ "array", "null" ] }, "initiatorsToCreate": { "description": "List of initiators to be created and added to this host", "items": { "$ref": "#/components/schemas/InitiatorInput" }, "type": "array" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "location": { "description": "location.", "example": "India", "type": [ "string", "null" ] }, "model": { "description": "Model", "example": "model1", "type": [ "string", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "operatingSystem": { "description": "Host operating system. Possible Values are: - AIX - Apple - Citrix Hypervisor(XenServer) - HP-UX - IBM VIO Server - InForm - NetApp/ONTAP - OE Linux UEK - OpenVMS - Oracle VM x86 - RHE Linux - RHE Virtualization - Solaris - SuSE Linux - SuSE Virtualization - Ubuntu - VMware (ESXi) - Windows Server", "enum": [ "AIX", "Apple", "Citrix Hypervisor(XenServer)", "HP-UX", "IBM VIO Server", "InForm", "NetApp/ONTAP", "OE Linux UEK", "OpenVMS", "Oracle VM x86", "RHE Linux", "RHE Virtualization", "Solaris", "SuSE Linux", "SuSE Virtualization", "Ubuntu", "VMware (ESXi)", "Windows Server" ], "example": "Windows Server", "type": [ "string", "null" ] }, "persona": { "description": "Host persona details.", "example": "AIX-Legacy", "type": [ "string", "null" ] }, "subnet": { "description": "subnet.", "example": "255.255.255.0", "type": [ "string", "null" ] } }, "required": [ "name", "operatingSystem" ], "type": "object" }, "DeleteInitiator": { "properties": { "deleteInitiator": { "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4AppSetQoSConfig": { "properties": { "bandwidthMaxLimit": { "description": "Bandwidth Maximum Limit in KB/s", "example": 500, "format": "int64", "type": [ "number", "null" ] }, "bwGuaranteeTb": { "description": "Bandwidth Guarantee Limit per Tb in KB/s", "example": 500, "format": "int64", "type": [ "number", "null" ] }, "bwLimitTb": { "description": "Bandwidth Maximum Limit per Tb in KB/s", "example": 500, "format": "int64", "type": [ "number", "null" ] }, "displayname": { "description": "QoS Config Display name", "type": [ "string", "null" ] }, "domain": { "description": "Domain Name", "type": [ "string", "null" ] }, "enable": { "description": "Enable of QoS Configuration", "example": true, "type": "boolean" }, "enableSrAlert": { "description": "Sets the SR alert with the criterion name as the vvset name based on the max limits being set on the QoS parameters. If provided true, the SR alert criterion will be created or updated based on updated parameters. If provided false, the SR Alert criterion will be deleted if present. If enableSrAlert is not specified and the SR Alert criterion is already present for the volume set, the SR Alert criterion will be retained based on the updated QoS parameters.", "example": true, "type": "boolean" }, "generation": { "description": "generation", "example": 1666788678, "type": [ "integer", "null" ] }, "id": { "description": "id of the QoS Configuration", "example": "59978", "type": "string" }, "ioGuaranteeTb": { "description": "iops Maximum Guarantee per Tb", "example": 500, "format": "int64", "type": [ "number", "null" ] }, "ioLimitTb": { "description": "iops Maximum Limit per Tb", "example": 500, "format": "int64", "type": [ "number", "null" ] }, "iopsMaxLimit": { "description": "iops Maxmium Limit", "example": 500, "format": "int64", "type": [ "number", "null" ] }, "lastModifiedEpoch": { "description": "last modified Epoch", "example": 1666788678, "format": "int64", "type": [ "number", "null" ] }, "perTb": { "description": "Enable of perTb QoS Configuration (Applicable for storage systems with OS versions that are 10.4.0 or higher but below 10.5.0)", "example": true, "type": "boolean" }, "systemUid": { "description": "System Id", "example": "756XNSKA", "type": "string" }, "systemWwn": { "description": "System WWN", "example": "2FWWN2004134", "type": "string" }, "targetName": { "description": "Target Name of the QoS Config", "example": "volumeset", "type": "string" }, "targetType": { "description": "Target Type of the QoS Config", "example": "QOS_TGT_APPSET", "type": "string" }, "uid": { "description": "UID of the QoS Config resource", "example": "12335546bgbgnbgnaq12", "type": "string" }, "volumes": { "description": "List of volumes", "example": [ "vol1", "vol2" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": [ "object", "null" ] }, "DeviceType4ApplicationConsistentSettings": { "description": "Application-consistent snapshot settings. Applicable only for arrays running OS version 10.6.0 and above; null otherwise.", "properties": { "applicationServerUid": { "description": "Unique identifier of the application server", "example": "app-server-12345", "type": [ "string", "null" ] }, "postScriptInfo": { "allOf": [ { "$ref": "#/components/schemas/ArcusScriptInfo" } ], "description": "Post-script information for application consistency", "type": [ "object", "null" ] }, "preScriptInfo": { "allOf": [ { "$ref": "#/components/schemas/ArcusScriptInfo" } ], "description": "Pre-script information for application consistency", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4ApplicationSetCapacityStats": { "properties": { "associatedLinks": { "description": "Associated Links Details", "example": [ { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/7CE751P312", "type": "systems" }, { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/7CE751P312/applicationsets/8f4e84da31ae80b362786a15b290f1eb/volumes", "type": "volumes" } ], "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "capacitySummary": { "description": "Capacity of the applicationSet", "properties": { "freeSizeMiB": { "description": "Free Size in MiB", "example": 1233920, "format": "float64", "type": [ "number", "null" ] }, "sizeMiB": { "description": "Total size in MiB", "example": 595968, "format": "float64", "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Used Size in MiB.", "example": 595968, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "The customer application identifier", "type": "string" }, "id": { "description": "Uid of the applicationset", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "members": { "description": "Volume Names", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "name": { "description": "Name of the application set", "example": "KA_VEGA_APPSET2_186", "maxLength": 255, "type": [ "string", "null" ] }, "systemId": { "description": "SystemId/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4ApplicationSetCapacityStatsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4ApplicationSetCapacityStats" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4ApplicationSetDetails": { "properties": { "appSetBusinessUnit": { "description": "Appset BusinessUnit", "example": "cssl", "type": [ "string", "null" ] }, "appSetComments": { "description": "Application set comments", "example": "app set comments", "type": [ "string", "null" ] }, "appSetExcludeAiQoS": { "description": "Exclusion from AI QoS", "example": "no", "type": [ "string", "null" ] }, "appSetId": { "description": "ID", "example": 5, "type": [ "integer", "null" ] }, "appSetImportance": { "description": "Importance Level", "example": "NORMAL", "type": [ "string", "null" ] }, "appSetName": { "description": "Application set name", "example": "KA_VEGA_APPSET1_186", "maxLength": 255, "type": [ "string", "null" ] }, "appSetQosConfig": { "$ref": "#/components/schemas/DeviceType4AppSetQoSConfig" }, "appSetType": { "description": "Type of the application set", "example": "Oracle Database", "type": [ "string", "null" ] }, "appSetTypeEnum": { "description": "Enum value of type of the application set", "example": "ORACLE_DATA", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "example": [ { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/2FF70002AC01F0FF", "type": "systems" }, { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/2FF70002AC01F0FF/volumes", "type": "volumes" } ], "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "comment": { "description": "Comments if any", "example": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "displayName": { "description": "Display Name", "example": "Application Set KA_VEGA_APPSET1_186 ", "maxLength": 255, "type": [ "string", "null" ] }, "domain": { "description": "Domain name", "example": "Domain", "maxLength": 255, "type": [ "string", "null" ] }, "drState": { "description": "Specifies replication disaster recovery state of a protected volume set. Possible values: Normal, Failover, Recover, Unknown The disaster recovery state is Unknown for any intermediate state.", "example": "Normal", "type": [ "string", "null" ] }, "exportStatus": { "description": "Export status", "example": "PARTIALLY_EXPORTED", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "uid of the applicationset", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "initiators": { "description": "Initiator details", "items": { "properties": { "deviceDiscoveredName": { "description": "Host/HostGroup name on device.", "example": "TEST11", "type": [ "string", "null" ] }, "id": { "description": "Resource id", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "resourceUri": { "description": "Resource URI", "example": "/v1/host-initiators/6848ef683c27403e96caa51816ddc72c", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "example": "host-initiators", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "isPrimary": { "description": "States if the Application set is Primary or not", "example": true, "type": [ "boolean", "null" ] }, "kvPairsPresent": { "description": "Represents KV pairs present or not", "example": true, "type": "boolean" }, "members": { "description": "Volume Names", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "name": { "description": "Name of the application set", "example": "KA_VEGA_APPSET2_186", "maxLength": 255, "type": [ "string", "null" ] }, "nonZeroRtoConfig": { "description": "Non-Zero RTO configuration. Supported config is Active-Sync", "example": "ActiveSync", "type": [ "string", "null" ] }, "ransomware": { "description": "Indicates Whether ransomware detection has been enabled on this volume set (Applicable for the HPE Alletra Storage MP B10000 systems with version 10.5.0 OS and later).", "type": [ "boolean", "null" ] }, "remoteRecoveryPoint": { "$ref": "#/components/schemas/DeviceType4RecoveryPoint" }, "replicationPartner": { "description": "Shows the Replication Partner Systems and Replication Partners", "example": [ { "partnerSystem": "cs2-C630-2939-141", "replicationPartner": "cs2-C630-2939_s1511" }, { "partnerSystem": "s2940_208", "replicationPartner": "s2940_1" } ], "items": { "properties": { "partnerSystem": { "description": "Replication Partner System", "type": [ "string", "null" ] }, "replicationPartner": { "description": "Replication Partner", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "replicationState": { "description": "Shows the replication state of the application set. This is not applicable in case of a 3DC/SLD configuration.", "example": "Started", "type": [ "string", "null" ] }, "replicationTraffic": { "description": "Shows the direction of flow of data. This is not applicable in case of a 3DC/SLD configuration.", "example": "Sending", "type": [ "string", "null" ] }, "replicationType": { "description": "Mode of replication. Can be sync or periodic. This is not applicable in case of a 3DC/SLD configuration.", "example": "periodic", "type": [ "string", "null" ] }, "role": { "description": "Specifies remote copy role for a protected volume set. Possible values: Primary, Secondary, Primary-Rev, Secondary-Rev, Unknown The role status is Unknown for any intermediate remote copy role of a protected volume set.", "example": "Primary", "type": [ "string", "null" ] }, "serialNumber": { "description": "Serial number.", "example": "7CE738P06J", "type": [ "string", "null" ] }, "shortName": { "description": "Short name of the application set", "example": "VegaApplications~886", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MB of appset", "example": 153600, "format": "float64", "type": [ "number", "null" ] }, "snapSetParentId": { "description": "ParentId of the snapSet", "example": 5, "format": "int64", "type": [ "integer", "null" ] }, "snapSetParentName": { "description": "Parent name of the snapSet", "example": "HPE", "maxLength": 255, "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "vvSetType": { "description": "Type of the volume-set", "example": "VVSET", "maxLength": 255, "type": [ "string", "null" ] }, "zeroRtoConfig": { "description": "Zero RTO configuration. Supported config is Active Peer Persistence. Classic Peer Persistence is not supported for HPE Alletra Storage MP B10000.", "example": "PP", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4ApplicationSets": { "properties": { "appSetBusinessUnit": { "description": "Appset BusinessUnit", "example": "cssl", "type": [ "string", "null" ] }, "appSetComments": { "description": "Application set comments", "example": "app set comments", "type": [ "string", "null" ] }, "appSetExcludeAiQoS": { "description": "Exclusion from AI QoS", "example": "no", "type": [ "string", "null" ] }, "appSetId": { "description": "ID", "example": 5, "type": [ "integer", "null" ] }, "appSetImportance": { "description": "Importance Level", "example": "MEDIUM", "type": [ "string", "null" ] }, "appSetName": { "description": "Application set name. `Filter`", "example": "KA_VEGA_APPSET1_186", "maxLength": 255, "type": [ "string", "null" ] }, "appSetType": { "description": "Name of the resource. `Filter`", "example": "Oracle Database", "type": [ "string", "null" ] }, "appSetTypeEnum": { "description": "Enum value of type of the application set", "example": "ORACLE_DATA", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "example": [ { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/2FF70002AC01F0FF", "type": "systems" }, { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/2FF70002AC01F0FF/volumes", "type": "volumes" } ], "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "comment": { "description": "Comments if any", "example": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "displayName": { "description": "Display Name", "example": "Application Set KA_VEGA_APPSET1_186 ", "maxLength": 255, "type": [ "string", "null" ] }, "domain": { "description": "Domain name. `Filter`", "example": "Domain", "maxLength": 255, "type": [ "string", "null" ] }, "drState": { "description": "Specifies replication disaster recovery state of a protected volume set. Possible values: Normal, Failover, Recover, Unknown The disaster recovery state is Unknown for any intermediate state.", "example": "Normal", "type": [ "string", "null" ] }, "exportStatus": { "description": "Export status", "example": "PARTIALLY_EXPORTED", "type": [ "string", "null" ] }, "generation": { "description": "generation. `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "uid of the applicationset `Filter`", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "initiators": { "description": "Initiator details", "items": { "properties": { "deviceDiscoveredName": { "description": "Host/HostGroup name on device.", "example": "TEST11", "type": [ "string", "null" ] }, "id": { "description": "Resource id", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "resourceUri": { "description": "Resource URI", "example": "/v1/host-initiators/6848ef683c27403e96caa51816ddc72c", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "example": "host-initiators", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "isPrimary": { "description": "States if the Application set is Primary or not", "example": true, "type": [ "boolean", "null" ] }, "kvPairsPresent": { "description": "Represents KV pairs present or not", "example": true, "type": "boolean" }, "members": { "description": "Volume Names. `Filter, Sort`", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "name": { "description": "Name of the resource. `Filter, Sort`", "example": "volset_name", "maxLength": 255, "type": [ "string", "null" ] }, "nonZeroRtoConfig": { "description": "Non-Zero RTO configuration. Supported config is Active-Sync", "example": "ActiveSync", "type": [ "string", "null" ] }, "ransomware": { "description": "Indicates Whether ransomware detection has been enabled on this volume set (Applicable for the HPE Alletra Storage MP B10000 systems with version 10.5.0 OS and later).", "type": [ "boolean", "null" ] }, "remoteRecoveryPoint": { "$ref": "#/components/schemas/DeviceType4RecoveryPoint" }, "replicationPartner": { "description": "Shows the Replication Partner Systems and Replication Partners", "example": [ { "partnerSystem": "cs2-C630-2939-141", "replicationPartner": "cs2-C630-2939_s1511" }, { "partnerSystem": "s2940_208", "replicationPartner": "s2940_1" } ], "items": { "properties": { "partnerSystem": { "description": "Replication Partner System", "type": [ "string", "null" ] }, "replicationPartner": { "description": "Replication Partner", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "replicationState": { "description": "Shows the replication state of the application set. This is not applicable in case of a 3DC/SLD configuration.", "example": "Started", "type": [ "string", "null" ] }, "replicationTraffic": { "description": "Shows the direction of flow of data. This is not applicable in case of a 3DC/SLD configuration.", "example": "Sending", "type": [ "string", "null" ] }, "replicationType": { "description": "Mode of replication. Can be sync or periodic. This is not applicable in case of a 3DC/SLD configuration.", "example": "periodic", "type": [ "string", "null" ] }, "role": { "description": "Specifies remote copy role for a protected volume set. Possible values: Primary, Secondary, Primary-Rev, Secondary-Rev, Unknown The role status is Unknown for any intermediate remote copy role of a protected volume set.", "example": "Primary", "type": [ "string", "null" ] }, "shortName": { "description": "Short name of the application set", "example": "VegaApplications~886", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MB of appset", "example": 153600, "format": "float64", "type": [ "number", "null" ] }, "snapSetParentId": { "description": "ParentId of the snapSet. `Filter`", "example": 5, "format": "int64", "type": [ "integer", "null" ] }, "snapSetParentName": { "description": "Parent name of the snapSet. `Filter`", "example": "HPE", "maxLength": 255, "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/serialNumber of the array. `Filter, Sort`", "example": "7CE751P312", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "vvSetType": { "description": "Type of the volume-set. `Filter`", "example": "VVSET", "maxLength": 255, "type": [ "string", "null" ] }, "zeroRtoConfig": { "description": "Zero RTO configuration. Supported config is Active Peer Persistence. Classic Peer Persistence is not supported for HPE Alletra Storage MP B10000.", "example": "PP", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4ApplicationSetsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4ApplicationSets" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4ApplicationSummary": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4applications" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4AppsetPost": { "properties": { "comment": { "description": "Comment if any", "example": "", "type": [ "string", "null" ] }, "expireSecs": { "description": "Expiration time in seconds", "example": 100, "type": [ "integer", "null" ] }, "readOnly": { "description": "Read only or Read/Write", "example": false, "type": [ "boolean", "null" ] }, "retainSecs": { "description": "Reatain time in seconds", "example": 86400, "format": "int64", "type": [ "integer", "null" ] }, "snapshotName": { "description": "Name for snapshot. For the HPE Alletra Storage MP B10000 systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 248 characters.", "example": "snapshot_oracle_1611807822", "type": [ "string", "null" ] }, "vvNamePattern": { "$ref": "#/components/schemas/DeviceType4vvNamePattern" } }, "required": [ "vvNamePattern", "snapshotName" ], "type": [ "object", "null" ] }, "DeviceType4CapacityForecast": { "description": "Capacity forecast data for HPE Alletra Storage MP B10000 system", "properties": { "confidenceLevel": { "description": "Confidence level represents the level of certainity or probability of a forecast made by a model", "example": 90, "format": "float64", "type": [ "number", "null" ] }, "customerId": { "description": "CustomerId of the user", "example": "string", "type": [ "string", "null" ] }, "forecasted": { "items": { "$ref": "#/components/schemas/DeviceType4capacitySeriesForecastData" }, "type": [ "array", "null" ] }, "historic": { "items": { "$ref": "#/components/schemas/DeviceType4capacitySeriesHistoricData" }, "type": [ "array", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "message": { "description": "A message to describe why forecast data is not available", "example": "No data available", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4CapacityForecastList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4CapacityForecast" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4CapacityTimeUntilFull": { "description": "capacity time until full for a given systemId", "properties": { "customerId": { "description": "input customer id", "example": null, "type": [ "string", "null" ] }, "deviceType": { "description": "device type of the system", "example": "deviceType4", "type": [ "string", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "systemId": { "description": "input system id", "example": "4UW0004226", "type": [ "string", "null" ] }, "timeUntilFull": { "description": "epoch timestamp in millisecond denoting the estimated tuf of the system", "example": 1605063600000, "format": "int64", "type": [ "integer", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4CapacityTimeUntilFullList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4CapacityTimeUntilFull" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4ChangeProximitySettingsInput": { "description": "Request body to change proximity settings", "properties": { "hostGroups": { "items": { "$ref": "#/components/schemas/DeviceType4HostGroupProximityInput" }, "type": "array" }, "hosts": { "items": { "$ref": "#/components/schemas/DeviceType4HostProximityInput" }, "type": "array" } }, "type": "object" }, "DeviceType4ClonePriority": { "description": "Priority of the task for promoting/resynchronizing the clone volume. Defaults to MEDIUM.", "enum": [ "PRIORITYTYPE_HIGH", "PRIORITYTYPE_MED", "PRIORITYTYPE_LOW" ], "example": "PRIORITYTYPE_MED", "type": [ "string", "null" ] }, "DeviceType4CpgState": { "description": "State of the resource", "properties": { "detailed": { "description": "Array of the detailed states of the resource.", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "overall": { "description": "Overall state of the resource. `Filter, Sort`", "enum": [ "STATE_UNKNOWN", "STATE_NORMAL", "STATE_DEGRADED", "STATE_FAILED", "STATE_NOT_APPLICABLE", "STATE_NEW", null ], "example": "STATE_NORMAL", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4CreateAppSetInput": { "description": "Request body for creating Application Sets", "properties": { "appSetBusinessUnit": { "description": "App set business unit", "example": "HPE", "type": [ "string", "null" ] }, "appSetComments": { "description": "App set comments", "example": "Edit appset", "type": [ "string", "null" ] }, "appSetName": { "description": "App set name", "example": "Appset_134", "type": "string" }, "appSetType": { "$ref": "#/components/schemas/DeviceType4VolumeSetApplicationType" }, "createAppSetQosConfigInput": { "$ref": "#/components/schemas/DeviceType4CreateAppSetQosConfigInput" }, "customAppType": { "description": "App set name for Custom workloads when appSetType=CUSTOM", "example": "CustomWorkload_123", "type": [ "string", "null" ] }, "members": { "description": "volumes list", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "ransomware": { "description": "This attribute enables/disables ransomware detection on the volume set. Both the existing volumes in the volume set as well as the volumes which get added in future in to this volume set will have this ransomware setting. By Default, it is set to false. This applies to the HPE Alletra Storage MP B10000 systems running OS version 10.5.0 and later.", "type": [ "boolean", "null" ] } }, "required": [ "appSetName", "appSetType" ], "type": [ "object", "null" ] }, "DeviceType4CreateAppSetQosConfigInput": { "description": "Create QoS Configuration Input (Applicable for OS version 10.4.0 and later)", "properties": { "bandwidthMaxLimit": { "description": "The maximum bandwidth limit permitted for the volume set associated with this policy. The bandwidth maximum limit must be between 0 and 9,007,199,254,740,991 KB/s. Pass -1 to unset the parameter", "example": 100, "format": "int64", "type": [ "number", "null" ] }, "enable": { "description": "Enabling of QoS Configuration", "example": true, "type": [ "boolean", "null" ] }, "enableSrAlert": { "description": "Sets the SR alert with the criterion name as the vvset name based on the max limits being set on the QoS parameters. If provided true, the SR alert criterion will be created or updated based on updated parameters. If provided false, the SR Alert criterion will be deleted if present. If enableSrAlert is not specified and the SR Alert criterion is already present for the volume set, the SR Alert criterion will be retained based on the updated QoS parameters.", "type": [ "boolean", "null" ] }, "iopsMaxLimit": { "description": "The maximum IOPS limit permitted for the volume set associated with this policy. The IOPS maximum limit must be between 0 and 2,147,483,647 IO/s. Pass -1 to unset the parameter", "example": 1, "format": "int64", "type": [ "number", "null" ] }, "perTb": { "description": "Sets the maximum IOPS limit or/and bandwidth limit for QoS throttling based on the number of terabytes configured for the volumes in the volume set on which QoS rule is configured. By default, this option is off. Once per_tb is set, it cannot be unset (Applicable for storage systems with OS versions that are 10.4.0 or higher but below 10.5.0).", "example": true, "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4CreateCloneSnapshotInput": { "description": "Request body for creating physical copy of a snapshot.", "properties": { "autoLun": { "description": "Secify to use auto lun number.", "example": true, "type": [ "boolean", "null" ] }, "destinationCpg": { "description": "Name of the User CPG", "example": "SSD_r6", "type": [ "string", "null" ] }, "destinationVolume": { "description": "Name of the destination volume.", "example": "destinationVol1", "type": "string" }, "hostGroupId": { "description": "Unique identifier of host group.", "example": "fd3244ef7f1ab8bd16500c7a41bdf8f8", "type": [ "string", "null" ] }, "lun": { "description": "LUN of volume.", "example": 0, "format": "int64", "type": [ "integer", "null" ] }, "priority": { "description": "Priority of the task for clone of a snashot. Defualts to MEDIUM.", "enum": [ "PRIORITYTYPE_HIGH", "PRIORITYTYPE_MED", "PRIORITYTYPE_LOW" ], "example": "PRIORITYTYPE_MED", "type": [ "string", "null" ] } }, "required": [ "destinationVolume" ], "type": "object" }, "DeviceType4CreateCloneVolumeInput": { "description": "Request body for creating physical copy of a volume.", "properties": { "destinationVolume": { "description": "Name of the destination volume.", "example": "destinationVol1", "type": "string" }, "offlineClone": { "$ref": "#/components/schemas/DeviceType4offlineClone" }, "online": { "description": "Create an online or offline clone of a volume.", "example": true, "type": [ "boolean", "null" ] }, "onlineClone": { "$ref": "#/components/schemas/DeviceType4onlineClone" }, "priority": { "description": "Priority of the task for clone volume. Defualts to MEDIUM.", "enum": [ "PRIORITYTYPE_HIGH", "PRIORITYTYPE_MED", "PRIORITYTYPE_LOW" ], "example": "PRIORITYTYPE_MED", "type": [ "string", "null" ] } }, "required": [ "destinationVolume" ], "type": "object" }, "DeviceType4CreateProtectionPolicyInputSchema": { "description": "Request body to create protection policy", "properties": { "policy": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4ProtectionPolicyInputSchema" } ], "type": "object" }, "protectionPolicyType": { "description": "Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.", "enum": [ "schedule", "sync", "async" ], "type": "string" }, "schedules": { "items": { "$ref": "#/components/schemas/DeviceType4ProtectionScheduleInputSchema" }, "type": "array" } }, "required": [ "protectionPolicyType" ], "type": "object" }, "DeviceType4CreateVolumeInput": { "description": "Request body for creating volumes", "properties": { "comments": { "description": "test", "example": "test", "type": [ "string", "null" ] }, "count": { "description": "Volumes count", "example": 2, "type": [ "integer", "null" ] }, "dataReduction": { "description": "Data Reduction", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the volume. For the HPE Alletra Storage MP B10000 systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 255 characters.", "example": "", "type": "string" }, "ransomware": { "description": "This attribute enables/disables ransomware detection on the volume. By Default, it is set to false. This applies to the HPE Alletra Storage MP B10000 systems running OS version 10.5.0 and later.", "type": [ "boolean", "null" ] }, "sizeMib": { "description": "Size of the volume to be created.", "example": 16384, "type": "integer" }, "snapshotAllocWarning": { "description": "Snapshot Alloc Warning", "example": 5, "type": [ "integer", "null" ] }, "userAllocWarning": { "description": "User Alloc Warning", "example": 5, "type": [ "integer", "null" ] }, "userCpg": { "description": "User CPG", "example": "SSD_r6", "type": "string" } }, "required": [ "name", "userCpg", "sizeMib" ], "type": [ "object", "null" ] }, "DeviceType4EditAppSetQosConfigInput": { "description": "Edit QoS Configuration Input (Applicable for OS version 10.4.0 and later)", "properties": { "action": { "description": "QoS Action", "enum": [ "ADD_QOS", "EDIT_QOS", "REMOVE_QOS" ], "type": "string" }, "bandwidthMaxLimit": { "description": "The maximum bandwidth limit permitted for the volume set associated with this policy. The bandwidth maximum limit must be between 0 and 9,007,199,254,740,991 KB/s. Pass -1 to unset the parameter", "example": 100, "format": "int64", "type": [ "number", "null" ] }, "enable": { "description": "Enabling of QoS Configuration", "example": true, "type": [ "boolean", "null" ] }, "enableSrAlert": { "description": "Sets the SR alert with the criterion name as the vvset name based on the max limits being set on the QoS parameters. If provided true, the SR alert criterion will be created or updated based on updated parameters. If provided false, the SR Alert criterion will be deleted if present. If enableSrAlert is not specified and the SR Alert criterion is already present for the volume set, the SR Alert criterion will be retained based on the updated QoS parameters.", "type": [ "boolean", "null" ] }, "iopsMaxLimit": { "description": "The maximum IOPS limit permitted for the volume set associated with this policy. The IOPS maximum limit must be between 0 and 2,147,483,647 IO/s. Pass -1 to unset the parameter", "example": 1, "format": "int64", "type": [ "number", "null" ] }, "perTb": { "description": "Sets the maximum IOPS limit or/and bandwidth limit for QoS throttling based on the number of terabytes configured for the volumes in the volume set on which QoS rule is configured. By default, this option is off. Once per_tb is set, it cannot be unset (Applicable for storage systems with OS versions that are 10.4.0 or higher but below 10.5.0).", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "action" ], "type": [ "object", "null" ] }, "DeviceType4EditProtectionPolicyInputSchema": { "description": "Request body for edit protection policy", "properties": { "createSchedules": { "items": { "$ref": "#/components/schemas/DeviceType4ProtectionScheduleInputSchema" }, "type": "array" }, "modifySchedules": { "items": { "$ref": "#/components/schemas/DeviceType4ModifyProtectionScheduleInputSchema" }, "type": "array" }, "policy": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4ProtectionPolicyInputSchema" } ], "type": "object" }, "protectionPolicyType": { "description": "Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.", "enum": [ "schedule", "sync", "async" ], "type": "string" }, "removeSchedules": { "items": { "$ref": "#/components/schemas/DeviceType4RemoveProtectionScheduleInputSchema" }, "type": "array" } }, "required": [ "protectionPolicyType" ], "type": "object" }, "DeviceType4EditVolumeSnapshotScheduleInput": { "description": "Edit schedule of a volume Input", "properties": { "atTime": { "description": "Time of the day when snapshot should be taken. Possible values: 0-23 If more than one snapshots in a day then untilTime specifies until what time snapshots should be taken.", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "dayOfMonth": { "description": "Day of month on which snapshot has to be taken for Monthly schedule. Possible values: 1-28", "example": 10, "format": "int64", "type": [ "integer", "null" ] }, "days": { "description": "Days on which snapshots should be taken. comma separated. Possible values: sunday,monday,tuesday,wednesday,thursday,friday,saturday", "example": "sunday,monday", "type": [ "string", "null" ] }, "name": { "description": "Name of the Schedule", "example": "Every_1_hour_on_sunday_monday", "type": [ "string", "null" ] }, "period": { "description": "Time interval for snapshots. Possible values:\n - hours: 1,2,3,4,6,8,12\n - minutes: 15,20,30\n - days & months: 1", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "periodUnit": { "description": "Unit of time for the interval specified in period.", "enum": [ "minutes", "hours", "days", "months" ], "example": "hours", "type": [ "string", "null" ] }, "untilTime": { "description": "Time of the day to stop taking snapshots. Must be an incremental value by the factor specified in Period, starting from atTime. Applicable only when more than one snapshots should be taken in a day.", "example": 7, "format": "int64", "type": [ "integer", "null" ] } }, "type": "object" }, "DeviceType4ExportAppSetPost": { "properties": { "hostGroupDataMap": { "description": "Host Group IDs and the corresponding attributes for each host group ID. NVMe transport type for each host Group ID is defined in this map and it is applicable if all the hosts of this host group are associated with the NVMe protocol.", "items": { "properties": { "hostGroupId": { "description": "Host group Id", "example": "cb17544e9347145d22a0fac608831053", "type": "string" }, "nvmeTransportType": { "description": "Transport type of the protocol. Configuration of the transport type is only supported for NVMe protocol starting from the system OS version 10.3.0 and the default transport type value is FC.", "example": "TCP", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "hostGroupIds": { "description": "HostGroups", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "proximity": { "description": "Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.", "enum": [ "PRIMARY", "SECONDARY", "ALL" ], "example": "PRIMARY", "type": "string" } }, "required": [ "hostGroupIds" ], "type": [ "object", "null" ] }, "DeviceType4FactorData": { "description": "Timestamp based latency values", "properties": { "cpuBusy": { "description": "CPU busy percentage", "example": 2.47, "format": "float64", "type": "number" }, "dackSsd": { "description": "Delayed ack percentage", "example": 2.47, "format": "float64", "type": "number" }, "pdSsdAvgBusy": { "description": "PD average busy percentage", "example": 2.47, "format": "float64", "type": "number" }, "readCacheMiss": { "description": "Read cache miss percentage", "example": 2.47, "format": "float64", "type": "number" }, "timestamp": { "description": "Timestamp", "example": 1669880791, "format": "int64", "type": "integer" }, "writeCacheMiss": { "description": "Write cache miss percentage", "example": 2.47, "format": "float64", "type": "number" } }, "type": [ "object", "null" ] }, "DeviceType4FailoverParams": { "properties": { "forcePpFailover": { "description": "Specifies that the Peer Persistence failover operation is forced overriding data inconsistency warnings. All I/O to the existing primary volumes should be quiesced when using this option.", "example": true, "type": [ "boolean", "null" ] }, "noSnapshot": { "description": "Specifies that snapshots are not taken of application sets that are switched from secondary to primary. Additionally, existing snapshots are deleted if application sets are switched from primary to secondary. The use of this option may result in a full synchronization of the secondary volumes.", "example": true, "type": [ "boolean", "null" ] }, "skipPromote": { "description": "Specifies that the synchronized snapshots of the protected volume set that are switched from primary to secondary should not be promoted to the base volume. The incorrect use of this option can lead to the primary and secondary volumes not being consistent.", "example": true, "type": [ "boolean", "null" ] }, "targetName": { "description": "Replication partner name on which to failover.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4HostAgent": { "description": "HPE Alletra Storage MP B10000 Host Agent", "properties": { "architecture": { "description": "Architecture Name", "example": "SAN", "type": [ "string", "null" ] }, "bootFromSan": { "description": "Boot from SAN", "example": "yes", "type": [ "string", "null" ] }, "clusterName": { "description": "Cluster Cluster", "example": "SAN-cluster", "type": [ "string", "null" ] }, "clusterSoftware": { "description": "Cluster OS", "example": "Linux", "type": [ "string", "null" ] }, "clusterVersion": { "description": "Cluster Version ", "example": "v1.0.0", "type": [ "string", "null" ] }, "hostApps": { "description": "Host Applications", "example": "mysql", "type": [ "string", "null" ] }, "ipAddr": { "description": "Ip Address", "example": "10.15.12.136", "type": [ "string", "null" ] }, "lastUpdated": { "description": "HPE Alletra Storage MP B10000 Host Agent", "properties": { "ms": { "description": "Epoch Time", "example": 101780, "format": "Uint64", "type": [ "integer", "null" ] }, "tz": { "description": "String Time", "example": "123545", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "multiPathSoftware": { "description": "Multipath Software", "example": "OS", "type": [ "string", "null" ] }, "multiPathSoftwareVersion": { "description": "MultiPath Software Version", "example": "v1.0.0", "type": [ "string", "null" ] }, "os": { "description": "Operating System Name", "example": "Linux", "type": [ "string", "null" ] }, "osPatch": { "description": "Os patch", "example": "v1.0.0", "type": [ "string", "null" ] }, "osVersion": { "description": "Os version", "example": "v1.0.0", "type": [ "string", "null" ] }, "reportedName": { "description": "Reported Name", "example": "slvs", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4HostDescriptors": { "description": "Host Descriptors", "properties": { "comment": { "description": "Comment", "example": "Comments", "type": [ "string", "null" ] }, "contact": { "description": "Contact", "example": "1234567788e", "type": [ "string", "null" ] }, "ipAddr": { "description": "Ip Address", "example": "1.1.1.1", "type": [ "string", "null" ] }, "location": { "description": "Location", "example": "US", "type": [ "string", "null" ] }, "model": { "description": "Model", "example": "AIX", "type": [ "string", "null" ] }, "os": { "description": "Operating System Name", "example": "Linux", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4HostGroupProximityInput": { "properties": { "hostGroupName": { "description": "Name of the host group for which proximity setting is getting changed. This is the host group which is present in device.", "example": "tstHostGroup", "type": "string" }, "proximity": { "description": "Host group proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. This is applicable when all the systems in the replication configuration has the OS version 10.5.0 or later", "enum": [ "PRIMARY", "SECONDARY", "ALL" ], "example": "PRIMARY", "type": "string" } }, "required": [ "hostGroupName", "proximity" ], "type": "object" }, "DeviceType4HostList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4HostListObj" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4HostListObj": { "description": "HPE Alletra Storage MP B10000 Host details", "properties": { "agent": { "$ref": "#/components/schemas/DeviceType4HostAgent" }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesDeviceType4Host" }, "descriptors": { "$ref": "#/components/schemas/DeviceType4HostDescriptors" }, "displayname": { "description": "Name to be used for display purposes", "example": "Drive 0.SIDE_NONE.2.0", "type": [ "string", "null" ] }, "domain": { "description": "Domain name of the Host", "example": "slt", "type": [ "string", "null" ] }, "generation": { "description": "Generation Time of the Resource `Filter, Sort`", "example": 1652172502, "format": "Uint64", "type": "integer" }, "hostId": { "description": "Numeric ID of the resource", "example": 101780, "format": "Uint64", "type": [ "integer", "null" ] }, "id": { "description": "Host Resource UID `Filter`", "example": "132b493352ca3141456333edf403be0c", "type": "string" }, "initiatorChapEnabled": { "description": "Indicates if the Initiator Chap is enabled or not", "type": [ "boolean", "null" ] }, "initiatorChapName": { "description": "Initiator Chap Name", "example": "chapName", "type": [ "string", "null" ] }, "initiatorEncryptedChapSecret": { "description": "Initiator Encrypted Chap Secret", "example": "secret", "type": [ "string", "null" ] }, "isNvmfStretched": { "description": "Indicates if this host is NVMe stretched.", "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is used to export VASA vVol over NVMe Protocol.", "type": [ "boolean", "null" ] }, "minLunId": { "description": "LUN Id of the host", "example": 10, "format": "Uint64", "type": [ "integer", "null" ] }, "name": { "description": "Host Name `Filter, Sort`", "example": "test-host", "type": [ "string", "null" ] }, "persona": { "$ref": "#/components/schemas/DeviceType4Persona" }, "resourceUri": { "description": "Resoure Uri of the Host ", "example": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a", "type": [ "string", "null" ] }, "scHostId": { "description": "Host Service Host Id `Filter`", "example": "132b493352ca3141456333edf403be0c", "type": [ "string", "null" ] }, "state": { "$ref": "#/components/schemas/DeviceType4HostState" }, "stateDescription": { "items": { "description": "State Description of the host", "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "stateVal": { "description": "Health Status of the Host", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] }, "systemUid": { "description": "Serial Number of the system `Filter` ", "example": "swK21", "type": "string" }, "systemWwn": { "description": "System wwn `Filter, Sort`", "example": "swK21", "type": "string" }, "targetChapEnabled": { "description": "Indicates if the Target Chap is enabled or not", "type": [ "boolean", "null" ] }, "targetChapName": { "description": "Target Chap Name", "example": "sltest1", "type": [ "string", "null" ] }, "targetEncryptedChapSecret": { "description": "Target Encrypted Chap Secret", "example": "Target Encrypted Chap Secret", "type": [ "string", "null" ] }, "type": { "description": "type of the resource", "type": "string" }, "uaRepLun": { "description": "Indicates if the UaRepLun is enabled or not", "type": [ "boolean", "null" ] }, "uri": { "description": "Resoure Uri of the Host", "example": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4HostPathList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4HostPathListObj" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4HostPathListObj": { "properties": { "address": { "description": "WWN Address of the Host Path `Filter`", "example": "810009440c9ce5824", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesDeviceType4HostPath" }, "displayname": { "description": "Name to be used for display purposes", "example": "Drive 0.SIDE_NONE.2.0", "type": [ "string", "null" ] }, "domain": { "description": "Domain name of the Host", "example": "-", "type": [ "string", "null" ] }, "driverVersion": { "description": "Driver version ", "example": "v1.0.0", "type": [ "string", "null" ] }, "firmwareVersion": { "description": "Firmware version", "example": "v1.0.0", "type": [ "string", "null" ] }, "generation": { "description": "Generation Time of the Resource `Filter, Sort`", "example": 1652172206, "format": "Uint64", "type": "integer" }, "hostId": { "description": "ID of the Host resource", "example": 101780, "format": "Uint64", "type": [ "integer", "null" ] }, "hostName": { "description": "Host Name `Filter, Sort`", "example": "test-host", "type": [ "string", "null" ] }, "hostSpeed": { "description": "ID of the Host resource", "example": 100, "format": "Any", "type": [ "integer", "null" ] }, "id": { "description": "HostPath Resource UID `Filter`", "example": "1223f5s", "type": "string" }, "ipAddr": { "description": "Ip Address", "example": "1.1.1.1", "type": [ "string", "null" ] }, "model": { "description": "Host Model", "example": "model_1", "type": [ "string", "null" ] }, "nvmeSubsystemNqn": { "description": "Subsystem NQN of NVMe/TCP hostpath", "example": "nqn.2020-07.com.hpe:8ee43ce5-8264-4fcf-9990-a894f56386c7", "type": [ "string", "null" ] }, "pathType": { "description": "Path Type `Filter`", "example": "FC", "type": [ "string", "null" ] }, "portPos": { "properties": { "node": { "description": "Node Port", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] }, "port": { "description": "Port", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] }, "slot": { "description": "Slot", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "resourceUri": { "description": "resourceUri for detailed hostpath object", "example": "/v1/storage-systems/host-paths/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "scHostInitiatorId": { "description": "Host Service Initiator Id `Filter`", "example": "1223f5s", "type": [ "string", "null" ] }, "switchPortWwn": { "description": "Switch Port WWN", "example": "5001438026e98a60", "type": [ "string", "null" ] }, "systemUid": { "description": "System Uid `Filter`", "example": "7CE727P35M", "type": "string" }, "systemWwn": { "description": "System serial Number `Filter, Sort`", "example": "swK21", "type": "string" }, "type": { "description": "type", "type": "string" }, "uri": { "description": "Uri ", "example": "/api/v3/hostpaths/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "vendor": { "description": "Vendor", "example": "-", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4HostPaths": { "properties": { "address": { "description": "WWN Address of the Host Path", "example": "810009440c9ce5824", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesDeviceType4HostPath" }, "displayname": { "description": "Name to be used for display purposes", "example": "Drive 0.SIDE_NONE.2.0", "type": [ "string", "null" ] }, "domain": { "description": "Domain name of the Host", "example": "-", "type": [ "string", "null" ] }, "driverVersion": { "description": "Driver version ", "example": "v1.0.0", "type": [ "string", "null" ] }, "firmwareVersion": { "description": "Firmware version", "example": "v1.0.0", "type": [ "string", "null" ] }, "generation": { "description": "Generation Time of the Resource", "example": 1652172206, "format": "Uint64", "type": "integer" }, "hostId": { "description": "ID of the Host resource", "example": 101780, "format": "Uint64", "type": [ "integer", "null" ] }, "hostName": { "description": "Host Name", "example": "test-host", "type": [ "string", "null" ] }, "hostSpeed": { "description": "ID of the Host resource", "example": 100, "format": "Any", "type": [ "integer", "null" ] }, "id": { "description": "HostPath Resource UID", "example": "1223f5s", "type": "string" }, "ipAddr": { "description": "Ip Address", "example": "1.1.1.1", "type": [ "string", "null" ] }, "model": { "description": "Host Model", "example": "model_1", "type": [ "string", "null" ] }, "nvmeSubsystemNqn": { "description": "Subsystem NQN of NVMe/TCP hostpath", "example": "nqn.2020-07.com.hpe:8ee43ce5-8264-4fcf-9990-a894f56386c7", "type": [ "string", "null" ] }, "pathType": { "description": "Path Type", "example": "FC", "type": [ "string", "null" ] }, "portPos": { "properties": { "node": { "description": "Node Port", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] }, "port": { "description": "Port", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] }, "slot": { "description": "Slot", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "resourceUri": { "description": "resourceUri for detailed hostpath object", "example": "/v1/storage-systems/host-paths/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "scHostInitiatorId": { "description": "Host Service Initiator Id", "example": "1223f5s", "type": [ "string", "null" ] }, "switchPortWwn": { "description": "Switch Port WWN", "example": "5001438026e98a60", "type": [ "string", "null" ] }, "systemUid": { "description": "System Uid", "example": "7CE727P35M", "type": "string" }, "systemWwn": { "description": "System serial Number ", "example": "swK21", "type": "string" }, "type": { "description": "type of the resource", "type": "string" }, "uri": { "description": "Uri ", "example": "/api/v3/hostpaths/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "vendor": { "description": "Vendor", "example": "-", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4HostProximityInput": { "properties": { "hostName": { "description": "Name of the host for which proximity setting is getting changed. This is the host which is present in device.", "example": "tstHost", "type": "string" }, "proximity": { "description": "Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL", "enum": [ "PRIMARY", "SECONDARY", "ALL" ], "example": "PRIMARY", "type": "string" } }, "required": [ "hostName", "proximity" ], "type": "object" }, "DeviceType4HostSetList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4HostSetListObj" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4HostSetListObj": { "description": "Host Sets details", "properties": { "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "comment": { "description": "Comment on the Host Set", "example": "hostset comment", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesDeviceType4HostSet" }, "displayname": { "description": "Name to be used for display purposes", "example": "Drive 0.SIDE_NONE.2.0", "type": [ "string", "null" ] }, "domain": { "description": "Domain name of the Host Set", "example": "slt", "type": [ "string", "null" ] }, "generation": { "description": "Generation Time of the Resource `Filter, Sort`", "example": 101780, "format": "Uint64", "type": "integer" }, "hostSetId": { "description": "Numeric ID of the resource", "example": 101780, "format": "Uint64", "type": [ "integer", "null" ] }, "id": { "description": "HostSet Resource UID `Filter`", "example": "1223f5s", "type": "string" }, "members": { "description": "system ntp addresses `Filter, Sort`", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "name": { "description": "Host Set Name `Filter, Sort`", "example": "test-host-set", "type": [ "string", "null" ] }, "resourceUri": { "description": "resourceUri for detailed hostset object", "example": "/v1/storage-systems/host-setss/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "scHostGroupId": { "description": "Host Service HostGroup Id `Filter`", "example": "1223f5s", "type": [ "string", "null" ] }, "systemUid": { "description": "Serail Number of the system `Filter`", "example": "swK21", "type": "string" }, "systemWwn": { "description": "System wwn `Filter, Sort`", "example": "swK21", "type": "string" }, "type": { "description": "Type of the resource", "type": "string" }, "uri": { "description": "Uri", "example": "/api/v3/hostsets/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "uuid": { "description": "HostSet Resource UUID", "example": "1223f5s", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4HostSets": { "description": "Host Sets details", "properties": { "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "comment": { "description": "Comment on the Host Set", "example": "hostset comment", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesDeviceType4HostSet" }, "displayname": { "description": "Name to be used for display purposes", "example": "Drive 0.SIDE_NONE.2.0", "type": [ "string", "null" ] }, "domain": { "description": "Domain name of the Host Set", "example": "slt", "type": [ "string", "null" ] }, "generation": { "description": "Generation Time of the Resource", "example": 101780, "format": "Uint64", "type": "integer" }, "hostSetId": { "description": "Numeric ID of the resource", "example": 101780, "format": "Uint64", "type": [ "integer", "null" ] }, "id": { "description": "HostSet Resource UID", "example": "1223f5s", "type": "string" }, "members": { "description": "system ntp addresses", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "name": { "description": "Host Set Name", "example": "test-host-set", "type": [ "string", "null" ] }, "resourceUri": { "description": "resourceUri for detailed hostset object", "example": "/v1/storage-systems/host-setss/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "scHostGroupId": { "description": "Host Service HostGroup Id", "example": "1223f5s", "type": [ "string", "null" ] }, "systemUid": { "description": "Serail Number of the system", "example": "swK21", "type": "string" }, "systemWwn": { "description": "System wwn", "example": "swK21", "type": "string" }, "type": { "description": "Type of the resource", "type": "string" }, "uri": { "description": "Uri", "example": "/api/v3/hostsets/dbce79b2612cde02a6e0be8934c330ec", "type": [ "string", "null" ] }, "uuid": { "description": "HostSet Resource UUID", "example": "1223f5s", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4HostState": { "description": "Host State", "properties": { "detailed": { "properties": { "args": { "description": "system ntp addresses", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "default": { "description": "Default Name", "example": "Host sltestish", "type": [ "string", "null" ] }, "key": { "description": "Key of the Host Name", "example": "HOST_NAME", "type": [ "string", "null" ] }, "localizedText": { "description": "Localized Text ", "example": "Localized text of the resource capabilities", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "overall": { "description": "Host State ", "example": "NORMAL", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4Hosts": { "description": "HPE Alletra Storage MP B10000 Host details", "properties": { "agent": { "$ref": "#/components/schemas/DeviceType4HostAgent" }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesDeviceType4Host" }, "descriptors": { "$ref": "#/components/schemas/DeviceType4HostDescriptors" }, "displayname": { "description": "Name to be used for display purposes", "example": "Drive 0.SIDE_NONE.2.0", "type": [ "string", "null" ] }, "domain": { "description": "Domain name of the Host", "example": "slt", "type": [ "string", "null" ] }, "generation": { "description": "Generation Time of the Resource", "example": 1652172502, "format": "Uint64", "type": "integer" }, "hostId": { "description": "Numeric ID of the resource", "example": 101780, "format": "Uint64", "type": [ "integer", "null" ] }, "id": { "description": "Host Resource UID", "example": "132b493352ca3141456333edf403be0c", "type": "string" }, "initiatorChapEnabled": { "description": "Indicates if the Initiator Chap is enabled or not", "type": [ "boolean", "null" ] }, "initiatorChapName": { "description": "Initiator Chap Name", "example": "chapName", "type": [ "string", "null" ] }, "initiatorEncryptedChapSecret": { "description": "Initiator Encrypted Chap Secret", "example": "secret", "type": [ "string", "null" ] }, "isNvmfStretched": { "description": "Indicates if this host is NVMe stretched.", "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is used to export VASA vVol over NVMe Protocol.", "type": [ "boolean", "null" ] }, "minLunId": { "description": "LUN Id of the host", "example": 10, "format": "Uint64", "type": [ "integer", "null" ] }, "name": { "description": "Host Name", "example": "test-host", "type": [ "string", "null" ] }, "persona": { "$ref": "#/components/schemas/DeviceType4Persona" }, "resourceUri": { "description": "Resoure Uri of the Host ", "example": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a", "type": [ "string", "null" ] }, "scHostId": { "description": "Host Service Host Id", "example": "132b493352ca3141456333edf403be0c", "type": [ "string", "null" ] }, "state": { "$ref": "#/components/schemas/DeviceType4HostState" }, "stateDescription": { "items": { "description": "State Description of the host", "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "stateVal": { "description": "Health Status of the Host", "example": 1, "format": "Uint64", "type": [ "integer", "null" ] }, "systemUid": { "description": "Serial Number of the system", "example": "swK21", "type": "string" }, "systemWwn": { "description": "System wwn ", "example": "swK21", "type": "string" }, "targetChapEnabled": { "description": "Indicates if the Target Chap is enabled or not", "type": [ "boolean", "null" ] }, "targetChapName": { "description": "Target Chap Name", "example": "sltest1", "type": [ "string", "null" ] }, "targetEncryptedChapSecret": { "description": "Target Encrypted Chap Secret", "example": "Target Encrypted Chap Secret", "type": [ "string", "null" ] }, "type": { "description": "Type of the resource", "type": "string" }, "uaRepLun": { "description": "Indicates if the UaRepLun is enabled or not", "type": [ "boolean", "null" ] }, "uri": { "description": "Resoure Uri of the Host", "example": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4KpiMetrics": { "description": "kpi metrics with read, write and total average values", "properties": { "read": { "$ref": "#/components/schemas/DeviceType4pmPerfData" }, "total": { "$ref": "#/components/schemas/DeviceType4pmPerfData" }, "write": { "$ref": "#/components/schemas/DeviceType4pmPerfData" } }, "type": [ "object", "null" ] }, "DeviceType4ModifyProtectionScheduleInputSchema": { "description": "Protection schedule details", "properties": { "atTime": { "description": "Time of the day when snapshot should be taken. Possible values: 0-23 If more than one snapshots in a day then untilTime specifies until what time snapshots should be taken.", "example": 2, "format": "int64", "type": "integer" }, "dayOfMonth": { "description": "Day of month on which snapshot has to be taken for Monthly schedule. Possible values: 1-28", "example": 10, "format": "int64", "type": "integer" }, "days": { "description": "Days on which snapshots should be taken. comma separated. Possible values: sunday,monday,tuesday,wednesday,thursday,friday,saturday", "example": "sunday,monday", "type": "string" }, "id": { "description": "schedule id", "example": "c1a96e09142935b7f0513a852610dccc", "type": "string" }, "isRemote": { "description": "Specifies that this schedule is remote protection schedule", "example": true, "type": "boolean" }, "name": { "description": "Name of the Schedule", "example": "Every_1_hour_on_sunday_monday", "type": "string" }, "period": { "description": "Time interval for snapshots. Possible values:\n - hours: 1,2,3,4,6,8,12\n - minutes: 15,20,30\n - days & months: 1", "example": 1, "format": "int64", "type": "integer" }, "periodUnit": { "description": "Unit of time for the interval specified in period.", "enum": [ "minutes", "hours", "days", "months" ], "example": "hours", "type": "string" }, "untilTime": { "description": "Time of the day to stop taking snapshots. Must be an incremental value by the factor specified in Period, starting from atTime. Applicable only when more than one snapshots should be taken in a day.", "example": 7, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "isRemote" ], "type": "object" }, "DeviceType4NamePattern": { "description": "name pattern", "enum": [ "PARENT_TIMESTAMP", "PARENT_SEC_SINCE_EPOCH", "CUSTOM" ], "example": "PARENT_TIMESTAMP", "type": [ "string", "null" ] }, "DeviceType4OverrideParams": { "properties": { "targetName": { "description": "Replication partner name (target name) on which the override action is to be performed.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4PerformanceHistoryData": { "description": "performance trends for given granularity and time range for a component", "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesPerf" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "endTime": { "description": "end time of history data", "example": 162564271, "type": [ "integer", "null" ] }, "historyData": { "description": "performance history data", "properties": { "avgbusyMetricsDataPerct": { "items": { "$ref": "#/components/schemas/DeviceType4metricHistoryDataSingleValue" }, "type": [ "array", "null" ] }, "iopsMetricsData": { "items": { "$ref": "#/components/schemas/DeviceType4metricHistoryData" }, "type": [ "array", "null" ] }, "ioszMetricsDataKbs": { "items": { "$ref": "#/components/schemas/DeviceType4metricHistoryData" }, "type": [ "array", "null" ] }, "latencyMetricsDataMs": { "items": { "$ref": "#/components/schemas/DeviceType4metricHistoryData" }, "type": [ "array", "null" ] }, "qlenMetricsData": { "items": { "$ref": "#/components/schemas/DeviceType4metricHistoryDataSingleValue" }, "type": [ "array", "null" ] }, "throughputMetricsDataKbps": { "items": { "$ref": "#/components/schemas/DeviceType4metricHistoryData" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "startTime": { "description": "start time of history data", "example": 1625556314, "type": [ "integer", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4PerformanceHistoryDataList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4PerformanceHistoryData" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4Persona": { "description": "Host Persona", "properties": { "capabilities": { "items": { "description": "Capabilities of the Host", "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "id": { "description": "ID of the resource", "type": "string" }, "name": { "description": "Host Name", "example": "test-host", "type": [ "string", "null" ] } }, "required": [ "id" ], "type": [ "object", "null" ] }, "DeviceType4PoolDetails": { "properties": { "alert": { "$ref": "#/components/schemas/DeviceType4cpgAlert" }, "allocationSettings": { "$ref": "#/components/schemas/DeviceType4allocation" }, "associatedLinks": { "$ref": "#/components/schemas/DeviceType4poolsDeviceType4AssociatedLinks" }, "baseSizeMiB": { "description": "Number of LD MiB used in base virtual volumes", "example": 67584, "type": "integer" }, "baseSizePrivateMiB": { "description": "Number of LD MiB private to individual base virtual volumes, not shared by deduplication", "example": 1215872, "format": "Uint64", "type": "number" }, "baseSizeRawMiB": { "description": "Number of physical (raw) MiB used in base virtual volumes", "example": 90111, "format": "Uint64", "type": "number" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "compactRatio": { "description": "Ratio between the virtual sizes of all volumes in the CPG and the amount of disk space they are currently using. Updated in Cloud Data Store at most once per 30 minutes.", "example": 5.722643930878938, "format": "float64", "type": [ "number", "null" ] }, "compressRatio": { "description": "Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated. Updated in Cloud Data Store at most once per 30 minutes.", "example": 4.233684210526316, "format": "float64", "type": "number" }, "compressSavings": { "description": "The space savings in MiB by compressing data", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "dataReduceRatio": { "description": "Ratio between the amount written to all volumes in the CPG and the amount of disk space used after compression and deduplication", "example": 2.25, "format": "float64", "type": "number" }, "dedupCapable": { "description": "Indicates whether the CPG supports dedup", "example": true, "type": "boolean" }, "dedupRatio": { "description": "Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated. Updated in Cloud Data Store at most once per 30 minutes.", "example": 2.2464644143676713, "format": "float64", "type": "number" }, "dedupSavings": { "description": "Savings from dedup in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "dedupVersion": { "description": "Version of Dedup that is being used by volumes in the CPG", "properties": { "default": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "displayname": { "description": "Name to be used for display purposes", "example": "CPG Vega_7_test", "type": [ "string", "null" ] }, "domain": { "description": "Name of the domain that the CPG belongs to", "example": "testdomain", "type": "string" }, "freeForAllocationMiB": { "description": "Estimated free space for volume allocation (MiB)", "example": 4141056, "format": "Uint64", "type": "number" }, "freeSizeMiB": { "description": "Number of LD MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes.", "example": 44672, "format": "Uint64", "type": "number" }, "freeSizeRawMiB": { "description": "Number of physical (raw) MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes.", "example": 16896, "format": "Uint64", "type": "number" }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "hostWrt": { "description": "Host writes in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "id": { "description": "Unique Identifier of the resource ", "example": "e9d353bf98fc1a6bdb90b824e3ca14b5", "type": "string" }, "name": { "description": "Name of the resource", "example": "Vega_7_test", "maxLength": 255, "type": "string" }, "nonReducibleData": { "description": "Amount of data that could not be reduced", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "numberOfSnapRc": { "description": "Number of VVs used for Remote copy snapshot CPG usage", "example": 5, "format": "Uint32", "type": [ "number", "null" ] }, "numberOfTdVv": { "description": "Number of TDVVs using the CPG", "example": 14, "format": "Uint32", "type": "number" }, "numberOfTpVv": { "description": "Number of TPVVs using the CPG", "example": 1062, "format": "Uint32", "type": "number" }, "numberOfUserRc": { "description": "Number of VVs used for Remote copy user CPG usage", "example": 5, "format": "Uint32", "type": "number" }, "overProvRatio": { "description": "Ratio between the virtual sizes of all volumes and the amount of used and free disk spaces. Updated in Cloud Data Store at most once per 30 minutes.", "example": 0.58, "format": "float64", "type": "number" }, "reduceSavings": { "description": "Savings from data reduction in MiB and this is the combination of compression and dedup savings", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "reducibleReduceSavings": { "description": "Data reduction savings in MiB using the reducible data. This savings is the combination of compression and dedup savings.", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "reducibleReduceSavingsRatio": { "description": "Data reduction savings ratio using the reducible data. This savings ratio is the combination of compression and dedup savings.", "example": 0.08, "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed storage-pool object", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178", "type": "string" }, "saGrow": { "$ref": "#/components/schemas/DeviceType4cpgGrow" }, "sdGrow": { "$ref": "#/components/schemas/DeviceType4cpgGrow" }, "sharedSizeMiB": { "description": "Number of LD MiB shared between volumes via deduplication", "example": 512, "format": "Uint64", "type": "number" }, "snapSizePrivateMiB": { "description": "Number of LD MiB private to individual snapshot virtual volumes, not shared by deduplication. Updated in Cloud Data Store at most once per 30 minutes.", "example": 526848, "format": "Uint64", "type": "number" }, "snapSizeRawMiB": { "description": "Number of physical (raw) MiB used in snapshot virtual volumes. Updated in Cloud Data Store at most once per 30 minutes.", "example": 56831, "format": "Uint64", "type": "number" }, "snapSpaceAdmin": { "$ref": "#/components/schemas/DeviceType4snapSpace" }, "snapSpaceData": { "$ref": "#/components/schemas/DeviceType4snapSpace" }, "state": { "$ref": "#/components/schemas/DeviceType4State" }, "storagePoolId": { "description": "Numeric ID of the resource", "example": 4, "format": "int64", "type": "number" }, "systemId": { "description": "SystemID of the array", "example": "7CE809P009", "type": "string" }, "thinSavings": { "description": "The space savings from a fully allocated virtual volume (CPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "thinSavingsRatio": { "description": "The space savings ratio from a fully allocated virtual volume (FPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.", "example": 0.08, "format": "float64", "type": [ "number", "null" ] }, "totalReservedMiB": { "description": "Total amount of space reserved by CPG (MiB)", "example": 1806336, "format": "Uint64", "type": "number" }, "totalSavings": { "description": "Total space savings including thin, compression, dedup, clone, zero packing, and snaps, in MiB", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "totalSavingsRatio": { "description": "Total space savings ratio including thin, compression, dedup, clone, zero packing, and snaps", "example": 0.08, "format": "float64", "type": [ "number", "null" ] }, "totalSizeMiB": { "description": "Total logical capacity in the user/snapshot space (MiB)", "example": 122880, "type": "integer" }, "totalSizeRawMiB": { "description": "Total physical (raw) MiB in the user/snapshot space", "example": 163839, "format": "Uint64", "type": "number" }, "type": { "description": "type", "example": "string", "type": "string" }, "userSpace": { "$ref": "#/components/schemas/DeviceType4snapSpace" }, "volumesCount": { "description": "Number of volumes in the CPG.", "example": 5, "type": [ "integer", "null" ] }, "warnPercent": { "description": "Allocation warning percentage", "example": 5, "format": "Uint32", "type": "number" } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4PoolList": { "properties": { "alert": { "$ref": "#/components/schemas/DeviceType4cpgAlert" }, "allocationSettings": { "$ref": "#/components/schemas/DeviceType4allocation" }, "associatedLinks": { "$ref": "#/components/schemas/DeviceType4poolsDeviceType4AssociatedLinks" }, "baseSizeMiB": { "description": "Number of LD MiB used in base virtual volumes.", "example": 67584, "type": "integer" }, "baseSizePrivateMiB": { "description": "Number of LD MiB private to individual base virtual volumes, not shared by deduplication", "example": 1215872, "format": "Uint64", "type": "number" }, "baseSizeRawMiB": { "description": "Number of physical (raw) MiB used in base virtual volumes", "example": 90111, "format": "Uint64", "type": "number" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "compactRatio": { "description": "Ratio between the virtual sizes of all volumes in the CPG and the amount of disk space they are currently using. Updated in Cloud Data Store at most once per 30 minutes.", "example": 5.722643930878938, "format": "float64", "type": [ "number", "null" ] }, "compressRatio": { "description": "Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated. Updated in Cloud Data Store at most once per 30 minutes.", "example": 4.233684210526316, "format": "float64", "type": "number" }, "compressSavings": { "description": "The space savings in MiB by compressing data", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "dataReduceRatio": { "description": "Ratio between the amount written to all volumes in the CPG and the amount of disk space used after compression and deduplication", "example": 2.25, "format": "float64", "type": "number" }, "dedupCapable": { "description": "Indicates whether the CPG supports dedup", "example": true, "type": "boolean" }, "dedupRatio": { "description": "Ratio between the amount of data written to Dedup Volumes and the amount that is not duplicated", "example": 2.2464644143676713, "format": "float64", "type": "number" }, "dedupSavings": { "description": "Savings from dedup in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "dedupVersion": { "description": "Version of Dedup that is being used by volumes in the CPG", "properties": { "default": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "displayname": { "description": "Name to be used for display purposes", "example": "CPG Vega_7_test", "type": [ "string", "null" ] }, "domain": { "description": "Name of the domain that the CPG belongs to. `Filter, Sort`", "example": "testdomain", "type": "string" }, "freeForAllocationMiB": { "description": "Estimated free space for volume allocation (MiB)", "example": 4141056, "format": "Uint64", "type": "number" }, "freeSizeMiB": { "description": "Number of LD MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes. `Filter, Sort`", "example": 44672, "format": "Uint64", "type": "number" }, "freeSizeRawMiB": { "description": "Number of physical (raw) MiB allocated and available in the CPG. Updated in Cloud Data Store at most once per 30 minutes.", "example": 16896, "format": "Uint64", "type": "number" }, "generation": { "description": "generation `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "hostWrt": { "description": "Host writes in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "id": { "description": "Unique Identifier of the resource. `Filter`", "example": "e9d353bf98fc1a6bdb90b824e3ca14b5", "type": "string" }, "name": { "description": "Name of the resource. `Filter, Sort`", "example": "Vega_7_test", "maxLength": 255, "type": "string" }, "nonReducibleData": { "description": "Amount of data that could not be reduced", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "numberOfSnapRc": { "description": "Number of VVs used for Remote copy snapshot CPG usage", "example": 5, "format": "Uint32", "type": [ "number", "null" ] }, "numberOfTdVv": { "description": "Number of TDVVs using the CPG", "example": 14, "format": "Uint32", "type": "number" }, "numberOfTpVv": { "description": "Number of TPVVs using the CPG", "example": 1062, "format": "Uint32", "type": "number" }, "numberOfUserRc": { "description": "Number of VVs used for Remote copy user CPG usage", "example": 5, "format": "Uint32", "type": "number" }, "overProvRatio": { "description": "Ratio between the virtual sizes of all volumes and the amount of used and free disk spaces. Updated in Cloud Data Store at most once per 30 minutes.", "example": 0.58, "format": "float64", "type": "number" }, "reduceSavings": { "description": "Savings from data reduction in MiB and this is the combination of compression and dedup savings", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "reducibleReduceSavings": { "description": "Data reduction savings in MiB using the reducible data. This savings is the combination of compression and dedup savings.", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "reducibleReduceSavingsRatio": { "description": "Data reduction savings using the reducible data. This savings is the combination of compression and dedup savings.", "example": 0.08, "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed storage-pool object", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178", "type": "string" }, "saGrow": { "$ref": "#/components/schemas/DeviceType4cpgGrow" }, "sdGrow": { "$ref": "#/components/schemas/DeviceType4cpgGrow" }, "sharedSizeMiB": { "description": "Number of LD MiB shared between volumes via deduplication", "example": 512, "format": "Uint64", "type": "number" }, "snapSizePrivateMiB": { "description": "Number of LD MiB private to individual snapshot virtual volumes, not shared by deduplication. Updated in Cloud Data Store at most once per 30 minutes.", "example": 526848, "format": "Uint64", "type": "number" }, "snapSizeRawMiB": { "description": "Number of physical (raw) MiB used in snapshot virtual volumes. Updated in Cloud Data Store at most once per 30 minutes.", "example": 56831, "format": "Uint64", "type": "number" }, "snapSpaceAdmin": { "$ref": "#/components/schemas/DeviceType4snapSpace" }, "snapSpaceData": { "$ref": "#/components/schemas/DeviceType4snapSpace" }, "state": { "$ref": "#/components/schemas/DeviceType4CpgState" }, "storagePoolId": { "description": "Numeric ID of the resource. `Filter, Sort`", "example": 4, "format": "int64", "type": "number" }, "systemId": { "description": "SystemID of the array. `Filter, Sort`", "example": "7CE809P009", "type": "string" }, "thinSavings": { "description": "The space savings from a fully allocated virtual volume (CPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "thinSavingsRatio": { "description": "The space savings ratio from a fully allocated virtual volume (FPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.", "example": 0.08, "format": "float64", "type": [ "number", "null" ] }, "totalReservedMiB": { "description": "Total amount of space reserved by CPG (MiB)", "example": 1806336, "format": "Uint64", "type": "number" }, "totalSavings": { "description": "Total space savings including thin, compression, dedup, clone, zero packing, and snaps, in MiB", "example": 2, "format": "int64", "type": [ "integer", "null" ] }, "totalSavingsRatio": { "description": "Total space savings ratio including thin, compression, dedup, clone, zero packing, and snaps", "example": 0.08, "format": "float64", "type": [ "number", "null" ] }, "totalSizeMiB": { "description": "Total logical capacity in the user/snapshot space (MiB).", "example": 122880, "type": "integer" }, "totalSizeRawMiB": { "description": "Total physical (raw) MiB in the user/snapshot space", "example": 163839, "format": "Uint64", "type": "number" }, "type": { "description": "type", "example": "string", "type": "string" }, "userSpace": { "$ref": "#/components/schemas/DeviceType4snapSpace" }, "volumesCount": { "description": "Number of volumes in the CPG.", "example": 5, "type": [ "integer", "null" ] }, "warnPercent": { "description": "Allocation warning percentage", "example": 5, "format": "Uint32", "type": "number" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4PoolsSummaryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4PoolList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4Priority": { "description": "Priority of the task for promoting the snapshot. Defualts to PRIORITYTYPE_MED.", "enum": [ "PRIORITYTYPE_HIGH", "PRIORITYTYPE_MED", "PRIORITYTYPE_LOW" ], "example": "PRIORITYTYPE_HIGH", "type": [ "string", "null" ] }, "DeviceType4PromoteCloneInput": { "description": "Promote clone input. Promote a clone volume with given priority.", "properties": { "priority": { "$ref": "#/components/schemas/DeviceType4ClonePriority" } }, "type": "object" }, "DeviceType4PromoteSnapshotInput": { "description": "Promote snapshot input. Promote a snapshot to the target with given priority.", "properties": { "priority": { "$ref": "#/components/schemas/DeviceType4Priority" }, "target": { "description": "Target volume name to which the snapshot need to be promoted. If not specified it will be promoted to its base volume.", "example": "volume1", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4ProtectionPoliciesList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4ProtectionPolicy" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4ProtectionPolicy": { "properties": { "associatedBackupDevice": { "description": "Contains protection store id and StoreOnce device id used to create backup.", "properties": { "protectionStoreId": { "description": "Unique identifier of the protection store used to create backup of the application set.", "example": "fa43500317062d6f025ec9ca54bab123", "type": [ "string", "null" ] }, "storeOnceId": { "description": "Unique identifier of the StoreOnce device used to create backup of the application set.", "example": "fa43500317062d6f025ec9ca54bab123", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "associatedPolicy": { "description": "Policy created in Data Services Cloud Console that is associated with this application set.", "properties": { "policyId": { "description": "Unique identifier of the policy created in Data Services Cloud Console.", "example": "fa43500317062d6f025ec9ca54bab123", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "Protection Policy ID", "example": "12ab132316dc4b05a4805dba13e495xy", "type": "string" }, "policy": { "properties": { "autoRecover": { "description": "If the Remote Copy is stopped as a result of links going down, the Remote Copy group can be automatically restarted after the links come back up.", "example": true, "type": "boolean" }, "autoSynchronize": { "description": "Auto synchronization ensure that remote copy system automatically recovers and synchronizes all volumes in the group after automatic or manual failover scenarios. In addition, this policy allows failover even when remote copy synchronous groups are started and online", "example": true, "type": "boolean" }, "isProtectionPolicyConfigured": { "description": "Boolean value to indicate if protection policy is properly configured on the volume set. If it is set to false, user needs to either delete the policy or fix the policy configuration. All other operations will be blocked in this scenario.", "example": true, "type": "boolean" }, "noAutomaticSynchronization": { "description": "Specifies if the no-automatic-synchronization option is enabled in case of Asynchronous/Periodic replication. If this property is true, then no synchronization happens. Not applicable for Synchronous replication.", "example": false, "type": [ "boolean", "null" ] }, "nonZeroRtoConfig": { "description": "Non Zero RTO configuration. Supported configuration is Active Sync.", "example": "ActiveSync", "type": [ "string", "null" ] }, "overPeriodAlert": { "description": "If synchronization of an asynchronous periodic Remote Copy group takes longer to complete than its synchronization period, an alert is generated. This property is not valid and hence cannot be enabled in case of synchronous replication.", "example": true, "type": [ "boolean", "null" ] }, "remote": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4RemoteInfo" } ], "description": "Replication partner details", "type": "object" }, "rpoSecs": { "description": "Specifies recovery point objective in seconds for Asynchronous periodic protection. This is not applicable for Synchronous replication, and in case of Asynchronous replication, rpoSecs will not contain any value if the no-automatic-synchronization option is enabled.", "example": 600, "format": "int64", "type": [ "integer", "null" ] }, "secondaryRemote": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4SecondaryRemoteInfo" } ], "description": "Second replication partner details from Synchronous Long Distance configuration and for 3DC Peer Persistence mode", "type": [ "object", "null" ] }, "zeroRtoConfig": { "description": "Zero RTO configuration. Supported config is Active Peer Persistence. Classic Peer Persistence is not supported for HPE Alletra Storage MP. This property is nil in case of Plain Synchronous Replication, which is of non-zero-RTO type.", "example": "APP", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "protectionPolicyType": { "description": "Protection policy type: schedule, sync or async", "example": "sync", "type": "string" }, "schedules": { "description": "Schedules on application set", "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4Schedule" }, "type": "array" }, "total": { "description": "Number of schedules on application set", "example": 1, "format": "int64", "type": "integer" } }, "type": [ "object", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4ProtectionPolicyInputSchema": { "description": "Protection policy details", "properties": { "autoRecover": { "description": "Specifies that if the protected volume set is stopped as a result of the Remote Copy links going down, the protected volume set is restarted automatically after the links come back up. If this policy is enabled for a volume set while the volume set is stopped after link failures, it will only be started when the links come up for the failed target. If the links are already up at the time the policy is set, then the protected volume set will not be restarted at that time.", "example": false, "type": "boolean" }, "autoSynchronize": { "description": "This property ensures that the Remote Copy system automatically recovers and synchronizes all volumes in the protected volume set after a system failover, for either automatic or manual failover scenarios. Synchronization occurs after system recovery completes and the Remote Copy links recover. This policy also allows the failover command to be used when synchronous volume sets are started and are online. It is no longer necessary to stop the synchronous volume sets before initiating a failover command to the secondary system.", "example": false, "type": "boolean" }, "noAutomaticSynchronization": { "description": "Enabling this option results in no synchronization happening between the source and target application sets. This is applicable only in case of periodic replication, and is disabled by default.", "example": false, "type": [ "boolean", "null" ] }, "overPeriodAlert": { "description": "If synchronization of an asynchronous periodic protection takes longer to complete than its synchronization period, an alert is generated. This property is not valid and hence cannot be enabled in case of synchronous replication.", "example": false, "type": "boolean" }, "remote": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4ProtectionPolicyRemoteInputSchema" } ], "description": "Replication partner details for remote protection", "type": "object" }, "rpoSecs": { "description": "Specifies recovery point objective in seconds for asynchronous periodic protection. Range: 30 - 63072000, and should be an even number. For Synchronous replication, the value defaults to zero even if it is specified. For Asynchronous replication, if rpoSecs is not specified then it would be considered under the no-automatic-synchronization option, and no synchronization happens.", "example": 600, "format": "int64", "type": "integer" }, "secondaryRemote": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4ProtectionPolicySecondaryRemoteInputSchema" } ], "description": "Replication partner details for Async partner in Synchronous Long Distance mode and for 3DC Peer Persistence mode", "type": "object" }, "zeroRtoConfig": { "description": "Zero RTO configuration to be used. Supported config is Active Peer Persistence. Classic Peer Persistence is not supported by HPE Alletra Storage MP B10000. If this is not specified, the configuration will be Plain Synchronous Configuration. ", "enum": [ "APP" ], "example": "APP", "type": "string" } }, "required": [ "remote" ], "type": "object" }, "DeviceType4ProtectionPolicyRemoteInputSchema": { "properties": { "partnerId": { "description": "Remote partner ID", "example": "afb4961e47212e5bc88dd35db5be5c83", "type": "string" }, "partnerName": { "description": "Remote partner name", "example": "IP_target", "type": "string" }, "replicationPartnerSnapshotCpg": { "description": "Replication Partner Snapshot CPG. Applicable only if the target system is Primera or Alletra 9K. Currently, not supported due to OS limitation. This field will be supported in future release.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationPartnerUserCpg": { "description": "User CPG in which the target volumes would get created in the replication partner system.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationType": { "description": "Replication type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Periodic replication (Asynchronous protection policy) provides protection from array or site failure with the user defined RPO.", "enum": [ "sync", "periodic" ], "example": "sync", "type": "string" } }, "required": [ "partnerName", "partnerId", "replicationType" ], "type": "object" }, "DeviceType4ProtectionPolicySecondaryRemoteInputSchema": { "properties": { "partnerId": { "description": "Remote partner ID", "example": "afb4961e47212e5bc88dd35db5be5c83", "type": "string" }, "partnerName": { "description": "Remote partner name", "example": "IP_target", "type": "string" }, "replicationPartnerSnapshotCpg": { "description": "Replication Partner Snapshot CPG. Applicable only if the target system is Primera or Alletra 9K. Currently, not supported due to OS limitation. This field will be supported in future release.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationPartnerUserCpg": { "description": "User CPG in which the target volumes would get created in the replication partner system.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationType": { "description": "Replication type. Supported type is periodic only. Periodic replication (Asynchronous protection policy) provides protection from array or site failure with the user defined RPO.", "enum": [ "periodic" ], "example": "periodic", "type": "string" } }, "required": [ "partnerName", "partnerId", "replicationType" ], "type": "object" }, "DeviceType4ProtectionScheduleInputSchema": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4ScheduleInputSchema" } ], "description": "Protection schedule details", "properties": { "isRemote": { "description": "Specifies that this schedule is remote protection schedule", "example": true, "type": "boolean" } }, "required": [ "name", "period", "periodUnit", "expireSecs", "isRemote" ], "type": "object" }, "DeviceType4QlenMetricDataValue": { "description": "Timeseries data for particular metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4QlenMetricSeriesDataValue" }, "type": [ "array", "null" ] }, "total": { "description": "total number of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4QlenMetricSeriesDataValue": { "properties": { "timestampms": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] }, "value": { "description": "value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4RecoverParams": { "properties": { "skipStart": { "description": "Specifies that protection is not started after recover action is completed.", "example": true, "type": [ "boolean", "null" ] }, "skipSync": { "description": "Specifies that protection is not synced after recover action is completed.", "example": true, "type": [ "boolean", "null" ] }, "targetName": { "description": "Replication partner name (target name) on which the recover action to be performed.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4RecoveryPoint": { "description": "Shows last data sync time", "properties": { "ms": { "description": "Epoch time in milliseconds", "example": 1591601529000, "format": "Uint64", "type": [ "integer", "null" ] }, "tz": { "description": "Time zone name", "example": "Local", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4RemoteInfo": { "properties": { "customerId": { "description": "TenantId of resource", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "isRemoteArraySupportReplication": { "description": "Boolean value to indicate if remote array OS version supports replication", "example": true, "type": "boolean" }, "overPeriodAlert": { "description": "This field is valid only for 3DC remote replication. If synchronization of an asynchronous periodic Remote Copy group takes longer to complete than its synchronization period, an alert is generated. This property is not valid in case of synchronous policy and will always be false in that case.", "example": true, "type": [ "boolean", "null" ] }, "partnerId": { "description": "Id of replication partner", "example": "29ee132316dc4b05a4805dba13e495ab", "type": "string" }, "partnerName": { "description": "Name of replication partner", "example": "s2930", "type": "string" }, "replicationPartnerSnapshotCpg": { "description": "Replication Partner Snapshot CPG. Applicable only if the target system is Primera or Alletra 9K. Currently, not supported due to OS limitation. This field will be supported in future release.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationPartnerUserCpg": { "description": "User CPG in which the target volumes would get created in the replication partner system.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationType": { "description": "Mode of replication. Can be sync or periodic", "example": "periodic", "type": "string" }, "resourceUri": { "description": "resource Uri of replication partner object", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE815P2BH/replicationpartners/7810cbb0e03490bcd608eda2b59fcc81\"", "type": "string" } }, "type": [ "object", "null" ] }, "DeviceType4RemoteProtectionActionsInput": { "properties": { "action": { "description": "Actions on the volume set where remote protection is enabled.", "enum": [ "FAILOVER", "SYNC", "OVERRIDE", "START", "STOP", "RECOVER", "RESTORE", "SWITCHOVER", "REVERSE" ], "example": "SYNC", "type": "string" }, "parameters": { "$ref": "#/components/schemas/DeviceType4RemoteProtectionActionsInputParams" } }, "type": "object" }, "DeviceType4RemoteProtectionActionsInputParams": { "properties": { "failoverActionParams": { "$ref": "#/components/schemas/DeviceType4FailoverParams" }, "overrideActionParams": { "$ref": "#/components/schemas/DeviceType4OverrideParams" }, "recoverActionParams": { "$ref": "#/components/schemas/DeviceType4RecoverParams" }, "restoreActionParams": { "$ref": "#/components/schemas/DeviceType4RestoreParams" }, "reverseActionParams": { "$ref": "#/components/schemas/DeviceType4ReverseParams" }, "startActionParams": { "$ref": "#/components/schemas/DeviceType4StartParams" }, "stopActionParams": { "$ref": "#/components/schemas/DeviceType4StopParams" }, "switchoverActionParams": { "$ref": "#/components/schemas/DeviceType4SwitchOverParams" }, "syncActionParams": { "$ref": "#/components/schemas/DeviceType4SyncParams" } }, "type": "object" }, "DeviceType4RemoveProtectionPoliciesInputSchema": { "description": "Request body to remove protection policies", "properties": { "policies": { "description": "List of protection policies to be removed", "items": { "$ref": "#/components/schemas/DeviceType4RemoveProtectionPolicyInputSchema" }, "type": "array" } }, "required": [ "policies" ], "type": "object" }, "DeviceType4RemoveProtectionPolicyInputSchema": { "description": "Protection policy to be removed", "properties": { "remote": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4RemoveRemoteProtectionInputSchema" } ], "description": "Remote protection to be removed", "type": "object" }, "removeOnlySchedules": { "description": "Remove only schedules and retain remote protection", "example": true, "type": "boolean" }, "removeSchedules": { "description": "List of protection schedules to be removed", "items": { "$ref": "#/components/schemas/DeviceType4RemoveProtectionScheduleInputSchema" }, "type": "array" }, "secondaryRemote": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4RemoveRemoteProtectionInputSchema" } ], "description": "Secondary remote protection to be removed", "type": "object" } }, "type": "object" }, "DeviceType4RemoveProtectionScheduleInputSchema": { "properties": { "id": { "description": "Protection schedule ID", "example": "12ab132316dc4b05a4805dba13e495xy", "type": "string" } }, "required": [ "id" ], "type": "object" }, "DeviceType4RemoveRemoteProtectionInputSchema": { "properties": { "partnerId": { "description": "Replication partner ID where remote protection is created", "example": "29ee132316dc4b05a4805dba13e495ab", "type": "string" } }, "required": [ "partnerId" ], "type": "object" }, "DeviceType4ReplicationPartner": { "properties": { "asyncPartner": { "description": "Shows asynchronous replication partner associated with SLD configuration. This is applicable only if the parent partner is of sync type.", "example": "CS2-A630-SVQ8", "type": [ "string", "null" ] }, "id": { "description": "Id of replication partner", "example": "5a5ce66d4814a5e5156de428abb0a589", "type": "string" }, "isActiveSyncSupported": { "description": "States if Active-Sync is supported or not", "example": true, "type": [ "boolean", "null" ] }, "isPeerPersistanceSupported": { "description": "States if Peer Persistance is supported or not", "example": true, "type": [ "boolean", "null" ] }, "minAsyncRpo": { "description": "Minimum async RPO value in seconds for asynchronous data replication.", "example": 30, "type": [ "integer", "null" ] }, "name": { "description": "Name of replication partner", "example": "s2930", "type": "string" }, "resourceUri": { "description": "Resource URI for replication partner", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE815P2BH/replicationpartners/5a5ce66d4814a5e5156de428abb0a589", "type": "string" }, "syncPartner": { "description": "Shows synchronous replication partner associated with SLD configuration. This is applicable only if the parent partner is of async type.", "example": "CS2-A630-SVQ8_1", "type": [ "string", "null" ] } }, "required": [ "id" ], "type": [ "object", "null" ] }, "DeviceType4ReplicationPartnerList": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customer ID", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "displayName": { "description": "Replication partner display name.", "example": "RCPartner1", "type": [ "string", "null" ] }, "domain": { "description": "Domain that the resource belongs to.", "example": "Domain1", "type": [ "string", "null" ] }, "drState": { "description": "Specifies replication disaster recovery state of a protected volume set. Possible values: Normal, Failover, Recover, Unknown The disaster recovery state is Unknown for any intermediate state.", "example": "Normal", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "groupId": { "description": "Unique id of replication partner remote group", "example": "0af26e4430948dd5c37bea1757107caf", "type": [ "string", "null" ] }, "groupLastSyncTime": { "$ref": "#/components/schemas/DeviceType4SyncTime" }, "groupName": { "description": "Replication partner remote group name.", "example": "testGroup", "type": [ "string", "null" ] }, "groupObjectId": { "description": "Replication partner group ID.", "example": 11, "format": "int64", "type": [ "integer", "null" ] }, "id": { "description": "Unique Identifier of the replication partner.", "example": "0af26e4430548dd5c37bea1757107caf", "type": "string" }, "isProtectionPolicyConfigured": { "description": "Boolean value to indicate if protection policy is properly configured on the volume set. If it is set to false, user needs to either delete the policy or fix the policy configuration. All other operations will be blocked in this scenario.", "example": true, "type": "boolean" }, "isRemoteArraySupportReplication": { "description": "Boolean value to indicate if remote array OS version supports replication", "example": true, "type": "boolean" }, "isSourceArraySupportReplication": { "description": "Boolean value to indicate if source array OS version supports replication", "example": true, "type": "boolean" }, "mode": { "description": "Replication partner group mode.", "example": "Periodic", "type": [ "string", "null" ] }, "policies": { "description": "The policy assigned to the replication partner remote group.", "properties": { "activeActive": { "description": "Specifies active active policy of the group.", "example": true, "type": [ "boolean", "null" ] }, "autoFailover": { "description": "Automatic failover on a group.", "example": true, "type": [ "boolean", "null" ] }, "autoRecover": { "description": "If the group is stopped as a result of links going down, the group can be automatically restarted after the links come back up.", "example": true, "type": [ "boolean", "null" ] }, "autoSynchronize": { "description": "Specifies auto synchronization of the group.", "example": true, "type": [ "boolean", "null" ] }, "multiTargetPeerPersistence": { "description": "Specifies that the group is participating in a Multi-target Peer Persistence configuration. The group must have two targets, one of which must be synchronous.The synchronous group target also requires pathManagement and auto Fail over policy settings.", "example": true, "type": [ "boolean", "null" ] }, "overPeriodAlert": { "description": "If synchronization of an asynchronous periodic group takes longer to complete than its synchronization period, an alert is generated.", "example": true, "type": [ "boolean", "null" ] }, "pathManagement": { "description": "Path management on a group.", "example": true, "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "protectionType": { "description": "Type of protection", "example": "Remote", "type": [ "string", "null" ] }, "remoteProductFamily": { "description": "Target volume set product family where remote protection is enabled", "example": "deviceType4", "type": [ "string", "null" ] }, "remoteRole": { "description": "Specifies remote copy role for a restore point of a protected volume set. In case of synchronous and asynchronous protection polices, restore point is the volume set on the replication partner/target array. Possible values: Primary, Secondary, Primary-Rev, Secondary-Rev, Unknown The role status is Unknown for any intermediate remote copy role for a restore point of a protected volume set.", "example": "Primary", "type": [ "string", "null" ] }, "remoteSystemId": { "description": "Target volume set system ID where remote protection is enabled", "example": "systemID", "type": [ "string", "null" ] }, "remoteUsrCpg": { "description": "Name for which the user space is allocated on the remote target.", "example": "FC_r1", "type": [ "string", "null" ] }, "remoteVolumeSetId": { "description": "Target volume set ID where remote protection is enabled", "example": "volumeSetID", "type": [ "string", "null" ] }, "remoteVolumeSetName": { "description": "Target volume set name where remote protection is enabled", "example": "volumeSet2", "type": [ "string", "null" ] }, "replicationTraffic": { "description": "Specifies the direction of data replication for the current target.", "example": "Sending", "type": [ "string", "null" ] }, "resourceUri": { "description": "resourceUri for replication partner list where volume set is remote protected", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE751P312/applicationsets/9c3c4f29a82fd8d632ff379116fa0b8f/replication-partners/0af26e4430548dd5c37bea1757107caf", "type": "string" }, "role": { "description": "Specifies remote copy role for a protected volume set. Possible values: Primary, Secondary, Primary-Rev, Secondary-Rev, Unknown The role status is Unknown for any intermediate remote copy role of a protected volume set.", "example": "Primary", "type": [ "string", "null" ] }, "roleReversed": { "description": "Remote group role switched due to a fail over.", "example": true, "type": [ "boolean", "null" ] }, "snapFrequencySecs": { "description": "Specifies the interval in seconds at which remote group takes coordinated snapshots. This field applies only to Async mode: it is set to -1 otherwise.", "example": -1, "format": "int64", "type": [ "integer", "null" ] }, "state": { "description": "Status of the Remote group for the replication partner. Can be New, Starting, Started, Restart, Stopped, Backup, Failsafe or Logging. Null if unset.", "example": "Started", "type": [ "string", "null" ] }, "syncPeriod": { "description": "Time period in seconds for automatic resynchronization. The value must be at least five minutes and not more than one year. Defaults to 0.", "example": 0, "format": "int64", "type": "integer" }, "systemId": { "description": "Unique ID or serial number of the system.", "example": "7CE816P0SR", "type": [ "string", "null" ] }, "systemName": { "description": "Name of the system.", "example": "sp2bh", "type": [ "string", "null" ] }, "systemWwn": { "description": "WWN of the system.", "example": "2FF70002AC020DA1", "type": [ "string", "null" ] }, "targetName": { "description": "Target to which the volume group is mirrored. This is the same as replication partner.", "example": "sp2bh", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "replication-partner", "type": "string" }, "volumeCount": { "description": "Number of volumes in the group for a replication partner.", "example": 1, "type": [ "integer", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4ReplicationPartnerVolumeList": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "displayName": { "description": "Volume display name", "example": "testVol624_1", "type": [ "string", "null" ] }, "domain": { "description": "Domain that the resource belongs to.", "example": "Domain2", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "groupId": { "description": "Unique id of replication partner remote group.", "example": "0af26e4430948dd5c37bea1757107caf", "type": [ "string", "null" ] }, "groupName": { "description": "Replication partner remote group name.", "example": "testGroup", "type": [ "string", "null" ] }, "groupObjectId": { "description": "Replication partner group ID.", "example": 11, "format": "int64", "type": [ "integer", "null" ] }, "id": { "description": "Unique Identifier of the volume.", "example": "b23a03cf79a0830f507eebb90c30410c", "type": "string" }, "isRemoteArraySupportReplication": { "description": "Boolean value to indicate if remote array OS version supports replication", "example": true, "type": "boolean" }, "localVolumeId": { "description": "Volume ID.", "example": 21, "format": "int64", "type": [ "integer", "null" ] }, "localVolumeName": { "description": "Volume name.", "example": "testVol624_1", "type": [ "string", "null" ] }, "remoteVolume": { "description": "remote volume properties associated with replication partner", "properties": { "asyncOutstanding": { "description": "Total outstanding data to be synchronized in MB. You can calculate backlog data for the Remote Copy Async group by summing up the asyncOutsstanding value for all the volumes in the group. Defaults to -1.", "example": -1, "format": "int64", "type": [ "integer", "null" ] }, "remoteVolumeId": { "description": "Volume ID on the target system.", "example": 31, "format": "int64", "type": [ "integer", "null" ] }, "remoteVolumeName": { "description": "Volume name on the target system.", "example": "testVol624_1.r", "type": [ "string", "null" ] }, "resyncIteration": { "description": "A correlator used to determine the data consistency point of the resynchroniztion snapshot relative to the remote volume and/or snapshots. Returns 'NA' if not set.", "example": "134383/1", "type": [ "string", "null" ] }, "resyncSnapshotName": { "description": "Snapshot indicating the starting point of the remote volume. The primary array uses this snapshot to determine which changes to synchronize to the secondary volume. The target array uses this snapshot as a recovery point if there is a resynchronization failure.", "example": "rcpy.41.88.134", "type": [ "string", "null" ] }, "syncIteration": { "description": "A correlator used to determine the data consistency point of the synchronization snapshot relative to the remote volume and/or snapshots. Returns 'NA' if not set.", "example": "NA", "type": [ "string", "null" ] }, "syncPercentage": { "description": "Synchronization percentage of the volume.", "example": 36, "type": [ "integer", "null" ] }, "syncSnapshotName": { "description": "Snapshot indicating the destination point of the Remote Copy volume on successful completion of resynchronization. Upon completion of a resynchronization, the remote base volume mirrors this synchronization snapshot. This snapshot becomes the resync snapshot when resynchronization completes.", "example": "none", "type": [ "string", "null" ] }, "syncStatus": { "description": "Synchronization status of the volume. Can be New, Syncing, Synced, Not Synced, Stale, New Pre Synced, New Sync from Snap, Failsafe, Logging, New Pending, Pending Dismiss or Remote Pending Dismiss. Null if unset.", "example": "Synced", "type": [ "string", "null" ] }, "targetName": { "description": "Target to which the volume group is mirrored.", "example": "sp2bh", "type": [ "string", "null" ] }, "volumeIteration": { "description": "A correlator used to determine the data consistency point of the volume relative to the remote volume and/or snapshots. Returns 'NA' if not set.", "example": "134383/1", "type": [ "string", "null" ] }, "volumeLastSyncTime": { "$ref": "#/components/schemas/DeviceType4SyncTime" }, "volumeSyncLength": { "description": "Volume synchronization total length. Returns -1 if unset", "example": -1, "format": "int64", "type": [ "integer", "null" ] }, "volumeSyncOffset": { "description": "Volume synchronization offset. Returns -1 if unset.", "example": -1, "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE751P312/volumes/b23a03cf79a0830f507eebb90c30410c", "type": "string" }, "systemId": { "description": "Unique ID or serial number of the system.", "example": "7CE816P0SR", "type": [ "string", "null" ] }, "systemWwn": { "description": "WWN of the system.", "example": "2FF70002AC020DA1", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "volume", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4ReplicationPartnerVolumesSummaryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4ReplicationPartnerVolumeList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4ReplicationPartnersSummaryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4ReplicationPartnerList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4RestoreParams": { "properties": { "noSnapshot": { "description": "Specifies that snapshots are not taken of application sets that are switched from secondary to primary. Additionally, existing snapshots are deleted if application sets are switched from primary to secondary. The use of this option may result in a full synchronization of the secondary volumes.", "example": true, "type": [ "boolean", "null" ] }, "skipStart": { "description": "Specifies that protection is not started after restore action is completed.", "example": true, "type": [ "boolean", "null" ] }, "skipSync": { "description": "Specifies that protection is not synced after restore action is completed.", "example": true, "type": [ "boolean", "null" ] }, "targetName": { "description": "Replication partner name (target name) on which the restore action to be performed.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4RestoreSnapshotOfSnapshotInput": { "description": "Restore snapshot of snapshot input. Restore a snapshot to the target with given priority.", "properties": { "priority": { "$ref": "#/components/schemas/DeviceType4Priority" }, "target": { "description": "Target read-write parent snapshot name to which the child snapshot need to be promoted.", "example": "snapshot-rw", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4ResyncCloneVolumeInput": { "description": "Resynchronize clone input. Resynchronize a clone volume with given priority.", "properties": { "priority": { "$ref": "#/components/schemas/DeviceType4ClonePriority" } }, "type": "object" }, "DeviceType4ReverseParams": { "properties": { "current": { "description": "Changes both the role and the direction of data flow between the protected volume sets. For example, if the roles of the protected volume sets are \"primary\" and \"secondary\", issuing the -current option to the reverse operation will result in the roles of the protected volume set becoming \"secondary-rev\" and \"primary-rev\" respectively, and the direction data flows between the groups is reversed. Since the -current option actually reverses the direction of data replication, it requires the protected volume set be stopped.This option must be used with care to ensure the protected volume sets do not end up in a non-deterministic state (like \"secondary\", \"secondary-rev\" for example) and to ensure data loss does not occur by inadvertently changing the direction of data flow and resyncing old data on top of newer data.", "example": true, "type": [ "boolean", "null" ] }, "localGroupDirection": { "description": "This option only applies to the reverse operation, and only when the -natural or -current options to the reverse operation are specified. Specifying this option with the reverse operation and an associated -natural or -current option will only affect the system where the reverse command is issued, and will not be mirrored to any other arrays in the Remote Copy configuration.", "example": true, "type": [ "boolean", "null" ] }, "natural": { "description": "Changes the role of the protected volume sets but not the direction of data flow between the groups on the arrays. For example, if the role of the protected volume sets are \"primary\" and \"secondary\", issuing the -natural option with the reverse operation will result in the role of the groups becoming \"primary-rev\" and \"secondary-rev\" respectively. The direction of data flow between the protected volume sets is not affected, only the roles. Since the -natural option does not change the direction of data flow between the protected volume sets, it does not require the protected volume sets be stopped. This option must be used with care to ensure the protected volume sets do not end up in a non-deterministic state (like \"secondary\", \"secondary-rev\" for example) and to ensure data loss does not occur by inadvertently changing the direction of data flow and resyncing old data on top of newer data.", "example": true, "type": [ "boolean", "null" ] }, "noSnapshot": { "description": "Specifies that snapshots are not taken of the protected volume sets that are switched from secondary to primary. Additionally, existing snapshots are deleted if the protected volume sets are switched from primary to secondary. The use of this option may result in a full synchronization of the secondary volumes.", "example": true, "type": [ "boolean", "null" ] }, "skipPromote": { "description": "Specifies that the synchronized snapshots of the protected volume set that are switched from primary to secondary should not be promoted to the base volume. The incorrect use of this option can lead to the primary and secondary volumes not being consistent.", "example": true, "type": [ "boolean", "null" ] }, "stopGroups": { "description": "Specifies that the system stops the replication before performing the reverse action.", "example": true, "type": [ "boolean", "null" ] }, "targetName": { "description": "Replication partner name (target name) on which the reverse action to be performed.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4Schedule": { "description": "Schedule created on application set", "properties": { "allowSysOffsetMinute": { "description": "This option enables the system to automatically balance existing schedules by applying an offset to the start time, relative to other active schedules. This helps distribute snapshot schedules of the workloads more evenly, ensuring optimal resource utilization. The allowSysOffsetMinute mode is supported and can be enabled in HPE Alletra Storage MP B10000 systems from 10.5.0 and later OS versions.", "example": false, "type": [ "boolean", "null" ] }, "applicationConsistentSettings": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4ApplicationConsistentSettings" } ], "description": "Application-consistent snapshot settings. Populated only for arrays running OS version 10.6.0 and above; null otherwise.", "type": [ "object", "null" ] }, "atTime": { "description": "Time of the day when snapshot should be taken. If more than one snapshots in a day then untilTime specifies until what time snapshots should be taken", "example": 8, "format": "int64", "type": [ "integer", "null" ] }, "customerId": { "description": "tenantId of resource", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "dayOfMonth": { "description": "Day of month that a scheduled task will execute. Allowed values are 1-28", "example": 4, "format": "int64", "type": [ "integer", "null" ] }, "days": { "description": "Days on which schedule task will run. Possible values: sunday,monday,tuesday,wednesday,thursday,friday,saturday", "example": "sunday,monday", "type": "string" }, "expireSecs": { "description": "Expiration time in seconds", "example": 86400, "format": "int64", "type": [ "integer", "null" ] }, "generation": { "description": "Generation value", "example": 123, "format": "int64", "type": "integer" }, "id": { "description": "Unique Identifier of the resource", "example": "fa43500317062d6f025ec9ca54bab123", "type": "string" }, "interval": { "description": "Time interval", "type": [ "string", "null" ] }, "isAlertEnabled": { "description": "Whether the schedule will generate an alert if it could not run.", "example": true, "type": "boolean" }, "isPaused": { "description": "Whether the schedule has been paused.", "example": true, "type": "boolean" }, "isSystemTask": { "description": "Whether the schedule is a system created one.", "example": false, "type": "boolean" }, "name": { "description": "Name of the resource", "example": "Every_1_hour_on_sunday_monday", "type": "string" }, "period": { "description": "Time interval for schedule task to run. Possible values:\n - hours: 1,2,3,4,6,8,12\n - minutes: 15,20,30\n - days & months: 1", "example": 1, "format": "int64", "type": "integer" }, "periodUnit": { "description": "Unit of time in which period is defined. Possible values: minutes, hours, days, months", "example": "hours", "type": "string" }, "readOnly": { "description": "Specifies that the snapshots created by schedule are read-only ", "example": true, "type": "boolean" }, "retainSecs": { "description": "Retention time in seconds.", "example": 3600, "format": "int64", "type": [ "integer", "null" ] }, "status": { "description": "Whether the schedule task is active or has been suspended", "example": "Active", "type": "string" }, "systemWwn": { "description": "WWN of the array", "example": "2FF70002AC020CEF", "type": "string" }, "type": { "description": "Type of object", "example": "schedules", "type": "string" }, "untilTime": { "description": "Time of the day to stop taking snapshots. Applicable only when more than one snapshots should be taken in a day.", "example": 15, "format": "int64", "type": [ "integer", "null" ] }, "user": { "description": "The user that created the schedule.", "example": "3paradm", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4ScheduleInputSchema": { "description": "Snapshot schedule details", "properties": { "atTime": { "description": "Time of the day when snapshot should be taken. Possible values: 0-23 If more than one snapshots in a day then untilTime specifies until what time snapshots should be taken.", "example": 2, "format": "int64", "type": "integer" }, "dayOfMonth": { "description": "Day of month on which snapshot has to be taken for Monthly schedule. Possible values: 1-28", "example": 10, "format": "int64", "type": "integer" }, "days": { "description": "Days on which snapshots should be taken. comma separated. Possible values: sunday,monday,tuesday,wednesday,thursday,friday,saturday", "example": "sunday,monday", "type": "string" }, "expireSecs": { "description": "Number of seconds the snapshot has to be retained.", "example": 3600, "format": "int64", "type": "integer" }, "name": { "description": "Name of the Schedule", "example": "Every_1_hour_on_sunday_monday", "type": "string" }, "period": { "description": "Time interval for snapshots. Possible values:\n - hours: 1,2,3,4,6,8,12\n - minutes: 15,20,30\n - days & months: 1", "example": 1, "format": "int64", "type": "integer" }, "periodUnit": { "description": "Unit of time for the interval specified in period.", "enum": [ "minutes", "hours", "days", "months" ], "example": "hours", "type": "string" }, "readOnly": { "description": "Specifies that the snapshots created by schedule are read-only. Defaults to false in case of local schedules. Defaults to true in case of remote schedules. When local schedules are converted to remote schedules, ReadOnly mode will be considered by default.", "example": true, "type": [ "boolean", "null" ] }, "retainSecs": { "description": "Specifies the amount of time in seconds, relative to the current time, that the snapshot will be retained. It is a positive integer value and in the range of 1 hour - 1825 days. If both expiration time and retention time are specified, then the retention time cannot be longer than the expiration time.", "example": 3600, "format": "int64", "type": [ "integer", "null" ] }, "untilTime": { "description": "Time of the day to stop taking snapshots. Must be an incremental value by the factor specified in Period, starting from atTime. Applicable only when more than one snapshots should be taken in a day.", "example": 7, "format": "int64", "type": "integer" } }, "required": [ "name", "period", "periodUnit", "expireSecs" ], "type": "object" }, "DeviceType4ScheduleList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4Schedule" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4SecondaryRemoteInfo": { "properties": { "customerId": { "description": "TenantId of resource", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "isRemoteArraySupportReplication": { "description": "Boolean value to indicate if remote array OS version supports replication", "example": true, "type": "boolean" }, "overPeriodAlert": { "description": "This field is valid only for 3DC remote replication. If synchronization of an asynchronous periodic Remote Copy group takes longer to complete than its synchronization period, an alert is generated. This property is not valid in case of synchronous policy and will always be false in that case.", "example": true, "type": [ "boolean", "null" ] }, "partnerId": { "description": "Id of replication partner", "example": "29ee132316dc4b05a4805dba13e495ab", "type": "string" }, "partnerName": { "description": "Name of replication partner", "example": "s2930", "type": "string" }, "replicationPartnerSnapshotCpg": { "description": "Replication Partner Snapshot CPG. Applicable only if the target system is Primera or Alletra 9K. Currently, not supported due to OS limitation. This field will be supported in future release.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationPartnerUserCpg": { "description": "User CPG in which the target volumes would get created in the replication partner system.", "example": "SSD_r6", "type": [ "string", "null" ] }, "replicationType": { "description": "Mode of replication. Can be periodic only", "example": "periodic", "type": "string" }, "resourceUri": { "description": "resource Uri of replication partner object", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE815P2BH/replicationpartners/7810cbb0e03490bcd608eda2b59fcc81\"", "type": "string" } }, "type": [ "object", "null" ] }, "DeviceType4SnapshotCapacity": { "properties": { "adminSpace": { "$ref": "#/components/schemas/DeviceType4space" }, "branchUsedBlocksMiB": { "description": "Branch used blocks size in MiB. This attribute contains the used space of the base volume and its Read-Only snapshots. This field is relevant for the system OS version 10.3.0 and above.", "format": "float64", "type": [ "number", "null" ] }, "branchVirtualSizeMiB": { "description": "Branch virtual size in MiB. This attribute contains the provisioned or virtual size of the base volume and its Read-Only snapshots.", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "compactEfficiency": { "description": "Compact Efficiency", "format": "float64", "type": [ "number", "null" ] }, "compressionEfficiency": { "description": "Compression Efficiency", "format": "float64", "type": [ "number", "null" ] }, "copiedMb": { "description": "Copied MB", "format": "float64", "type": [ "number", "null" ] }, "copiedPerc": { "description": "Copied Perecentage", "type": [ "integer", "null" ] }, "ddcSize": { "format": "float64", "type": [ "number", "null" ] }, "ddsSize": { "format": "float64", "type": [ "number", "null" ] }, "dedupSavingsSize": { "format": "float64", "type": [ "number", "null" ] }, "dedupWrittenSize": { "format": "float64", "type": [ "number", "null" ] }, "hostWrittenMiB": { "description": "Host written data size in MiB.", "format": "float64", "type": [ "number", "null" ] }, "hostWrittenToVirtualPercent": { "description": "Host written to virtual percent", "format": "float64", "type": [ "number", "null" ] }, "sizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "snapshotTdvvSize": { "$ref": "#/components/schemas/DeviceType4snapshotTdvvsize" }, "snapshotUsedToVirtualPercent": { "description": "Snapshot used to virtual percent", "format": "float64", "type": [ "number", "null" ] }, "totalRawReservedMiB": { "description": "Total Raw Reserved Space in MiB", "format": "float64", "type": [ "number", "null" ] }, "totalReservedMiB": { "description": "Description", "format": "float64", "type": [ "number", "null" ] }, "totalSpaceMiB": { "description": "Total Space in MiB", "format": "float64", "type": [ "number", "null" ] }, "usedBlocksMiB": { "description": "Used Blocks Size in MiB. This attribute contains the used space of the base volume and its Read-Only snapshots. This field is relevant for the system OS versions equal and below 10.2.x. For the system OS version 10.3.0 and above, please refer the field branchUsedBlocksMiB.", "format": "float64", "type": [ "number", "null" ] }, "usedCapacity": { "description": "Used volume capacity.", "format": "float64", "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Used Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "userReservedToVirtualPercent": { "description": "User reseved to virtual percent", "format": "float64", "type": [ "number", "null" ] }, "userSpace": { "$ref": "#/components/schemas/DeviceType4space" }, "userUsedToVirtualPercent": { "description": "User used to virtual percent", "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4SnapshotSetsSummaryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4snapshotsetsList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4SnapshotsListSingle": { "properties": { "adminAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettingsSingle" }, "baseId": { "description": "snapshot Tdvv Size", "format": "int64", "type": [ "integer", "null" ] }, "comment": { "description": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "compressionPolicy": { "description": "compression policy", "type": [ "string", "null" ] }, "conversionType": { "description": "Conversion Type of Volume", "enum": [ "CONVERSIONTYPE_THIN", "CONVERSIONTYPE_DDS", "CONVERSIONTYPE_V1", "CONVERSIONTYPE_V2", null ], "type": [ "string", "null" ] }, "copyOfId": { "description": "Copy of ID", "format": "int64", "type": [ "integer", "null" ] }, "creationTime": { "description": "Creation Time ", "properties": { "ms": { "type": [ "integer", "null" ] }, "tz": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "dataReduction": { "description": "Data Reduction type", "type": [ "string", "null" ] }, "dedup": { "type": [ "string", "null" ] }, "devType": { "description": "Device Type", "type": [ "string", "null" ] }, "displayname": { "description": "Display name of the volume", "type": [ "string", "null" ] }, "domain": { "description": "Domain of the volume", "type": [ "string", "null" ] }, "fullyProvisioned": { "type": [ "boolean", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "headsPerCylinder": { "description": "Heads per Cylinder", "type": [ "integer", "null" ] }, "healthState": { "description": "Health status of the Volume.", "format": "int64", "type": [ "integer", "null" ] }, "hidden": { "description": "Flag to know if the Volume is hidden or not", "type": [ "boolean", "null" ] }, "id": { "description": "UID of the snapshot. `Filter`", "example": "b7107a30-260a-41c1-a47f-e50770c414c9", "type": "string" }, "initiators": { "description": "Initiator details", "items": { "properties": { "deviceDiscoveredName": { "description": "Host/HostGroup name on device.", "example": "TEST11", "type": [ "string", "null" ] }, "id": { "description": "Resource id", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "resourceUri": { "description": "Resource URI", "example": "/v1/host-initiators/6848ef683c27403e96caa51816ddc72c", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "example": "host-initiators", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "name": { "description": "A user friendly name to identify the storage system volume (resourceName).", "example": "Finance", "type": [ "string", "null" ] }, "parentId": { "description": "Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "physParentId": { "description": "physical Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "physicalCopy": { "type": [ "boolean", "null" ] }, "policy": { "$ref": "#/components/schemas/DeviceType4policy" }, "provType": { "description": "Provisioning type", "type": [ "string", "null" ] }, "raid": { "description": "Raid", "type": [ "string", "null" ] }, "rcopyStatus": { "description": "RemoteCopy Status", "type": [ "string", "null" ] }, "readOnly": { "type": [ "boolean", "null" ] }, "roChildId": { "description": "RO child id", "format": "int64", "type": [ "integer", "null" ] }, "rwChildId": { "format": "int64", "type": [ "integer", "null" ] }, "rwareAlert": { "description": "Indicates whether this snapshot acts as an alert snapshot for the base volume. Alert snapshot is generated when the OS detects a possible ransomware attack on the base volume (Applicable for the HPE Alletra Storage MP B10000 systems with version 10.5.0 OS and above).", "type": [ "boolean", "null" ] }, "sectorsPerTrack": { "description": "Sector per Track", "type": [ "integer", "null" ] }, "sharedParentId": { "description": "Shared Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "snapshotCapacity": { "$ref": "#/components/schemas/DeviceType4SnapshotCapacity" }, "snapshotId": { "description": "Numeric ID of the resource", "format": "int64", "type": [ "integer", "null" ] }, "snapshotType": { "type": [ "string", "null" ] }, "started": { "type": [ "boolean", "null" ] }, "state": { "$ref": "#/components/schemas/DeviceType4State" }, "systemId": { "description": "SystemUid/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinProvisioned": { "description": "Thin provisioning details", "type": [ "boolean", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "userAllocLimit": { "description": "User alloc limit", "format": "int64", "type": [ "integer", "null" ] }, "userAllocWarning": { "description": "User alloc space limit warning", "format": "int64", "type": [ "integer", "null" ] }, "userAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettingsSingle" }, "userCpgId": { "description": "User CPG Id", "format": "int64", "type": [ "integer", "null" ] }, "userCpgName": { "description": "User CPG Name", "type": [ "string", "null" ] }, "vlunSectorSize": { "description": "VLUN sector size", "type": [ "integer", "null" ] }, "wwn": { "description": "Volume wwn.", "example": "60002AC0000000000000006B0001FFEB", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4SnapshotsSummaryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4snapshotsList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4SnapshotsetListSingle": { "properties": { "appSetBusinessUnit": { "description": "Appset BusinessUnit", "example": "cssl", "type": [ "string", "null" ] }, "appSetComments": { "description": "Application set comments", "example": "app set comments", "type": [ "string", "null" ] }, "appSetImportance": { "description": "Importance Level", "example": "NORMAL", "type": [ "string", "null" ] }, "appSetName": { "description": "Application set name", "example": "KA_VEGA_APPSET1_186", "maxLength": 255, "type": [ "string", "null" ] }, "appSetType": { "description": "Type of the snapshotset", "example": "Oracle Database", "type": [ "string", "null" ] }, "comment": { "description": "Comments if any", "example": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "creationTime": { "description": "Creation Time", "properties": { "ms": { "type": [ "integer", "null" ] }, "tz": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "displayName": { "description": "Display Name", "example": "Application Set KA_VEGA_APPSET1_186 ", "maxLength": 255, "type": [ "string", "null" ] }, "domain": { "description": "Domain name", "example": "Domain", "maxLength": 255, "type": [ "string", "null" ] }, "exportStatus": { "description": "Export status", "example": "PARTIALLY_EXPORTED", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "uid of the snapshotset.", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "kvPairsPresent": { "description": "Represents KV pairs present or not", "example": true, "type": "boolean" }, "members": { "description": "Volume Names", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "mode": { "description": "Mode of the snapset.", "example": "RO", "type": [ "string", "null" ] }, "name": { "description": "Name of the snapshotset.", "example": "KA_VEGA_APPSET2_186", "type": [ "string", "null" ] }, "shortName": { "description": "Short name of the snapshotset", "example": "VegaSnapshotSets~92775", "type": [ "string", "null" ] }, "snapSetId": { "description": "ID", "example": 5, "type": [ "integer", "null" ] }, "snapSetParentId": { "description": "ParentId of the snapSet", "example": 5, "format": "int64", "type": [ "integer", "null" ] }, "snapSetParentName": { "description": "Parent name of the snapSet", "example": "HPE", "maxLength": 255, "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "vvSetType": { "description": "Type of the volume-set", "example": "VVSET", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4StartParams": { "properties": { "targetName": { "description": "Target name on which the protection has to be started.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4State": { "description": "State of the resource", "properties": { "detailed": { "description": "Array of the detailed states of the resource", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "overall": { "description": "Overall state of the resource", "enum": [ "STATE_UNKNOWN", "STATE_NORMAL", "STATE_DEGRADED", "STATE_FAILED", "STATE_NOT_APPLICABLE", "STATE_NEW", null ], "example": "STATE_NORMAL", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4StopParams": { "properties": { "targetName": { "description": "Target name on which the protection has to be stopped.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4SupportedProtectionTypes": { "description": "Response body for supported protection types on an application set", "properties": { "asyncPartners": { "description": "List of potential replication partners that can be part of asynchronous protection policy", "items": { "$ref": "#/components/schemas/DeviceType4ReplicationPartner" }, "type": [ "array", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "isSldSupported": { "description": "Shows if SLD is supported or not", "example": true, "type": "boolean" }, "protectionTypes": { "description": "List of protection policies types that can be configured on the application set Possible values: schedule, async, sync", "example": [ "schedule", "async", "sync" ], "items": { "type": "string" }, "type": [ "array", "null" ] }, "syncPartners": { "description": "List of potential replication partners that can be part of synchronous protection policy", "items": { "$ref": "#/components/schemas/DeviceType4ReplicationPartner" }, "type": [ "array", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4SupportedProtectionTypesList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4SupportedProtectionTypes" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4SwitchOverParams": { "properties": { "noSnapshot": { "description": "Specifies that snapshots are not taken of application sets that are switched from secondary to primary. Additionally, existing snapshots are deleted if application sets are switched from primary to secondary. The use of this option may result in a full synchronization of the secondary volumes.", "example": false, "type": [ "boolean", "null" ] }, "targetName": { "description": "Replication partner name (target name) on which the switchover action is to be performed.", "example": "s1511", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4SyncParams": { "properties": { "forceFullSync": { "description": "Forces full synchronization, even if volumes are already synchronized. This option is only applicable for volume sets with synchronous replication.", "example": false, "type": [ "boolean", "null" ] } }, "type": "object" }, "DeviceType4SyncTime": { "description": "Last synchronization time in milliseconds since epoch.", "properties": { "ms": { "description": "Epoch time in milliseconds.", "example": 1552301131100, "format": "int64", "type": [ "integer", "null" ] }, "tz": { "description": "Time zone name", "example": "UTC", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4SystemLatencyFactors": { "description": "system latency factors response structure", "properties": { "customerId": { "description": "Customer identifier", "type": "string" }, "endTime": { "description": "End time of the interval for which latency factors are determined", "example": 1669880791, "format": "int64", "type": "integer" }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "latencyBands": { "properties": { "read": { "items": { "description": "Timestamp based top latency factors", "properties": { "endTime": { "description": "Timestamp", "example": 1669880791, "format": "float64", "type": "number" }, "startTime": { "description": "Timestamp", "example": 1669880791, "format": "float64", "type": "number" }, "topFactors": { "description": "Top latency factors", "items": { "description": "latency factor", "type": "string" }, "type": "array" } }, "type": [ "object", "null" ] }, "type": "array" }, "write": { "items": { "description": "Timestamp based top latency factors", "properties": { "endTime": { "description": "Timestamp", "example": 1669880791, "format": "float64", "type": "number" }, "startTime": { "description": "Timestamp", "example": 1669880791, "format": "float64", "type": "number" }, "topFactors": { "description": "Top latency factors", "items": { "description": "latency factor", "type": "string" }, "type": "array" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "startTime": { "description": "Start time of the interval for which latency factors are determined", "example": 1669794391, "format": "int64", "type": "integer" }, "systemFactorsMetrics": { "items": { "$ref": "#/components/schemas/DeviceType4FactorData" }, "type": [ "array", "null" ] }, "systemId": { "description": "System identifier", "type": "string" }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4SystemLatencyFactorsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4SystemLatencyFactors" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4UnExportAppSetPost": { "properties": { "hostGroupIds": { "description": "HostGroups", "example": [ "host Group1", "Host Group2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] } }, "required": [ "hostGroupIds" ], "type": [ "object", "null" ] }, "DeviceType4UnExportVlun": { "properties": { "hostGroupIds": { "description": "HostGroups", "example": [ "host Group1", "Host Group2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] } }, "required": [ "hostGroupIds" ], "type": [ "object", "null" ] }, "DeviceType4VlunsCreateInput": { "properties": { "autoLun": { "description": "Auto Lun", "example": true, "type": [ "boolean", "null" ] }, "hostGroupIds": { "description": "HostGroups", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "lun": { "description": "Custom LUN Id for multiple host groups", "items": { "properties": { "hostGroupId": { "description": "Host group Id", "example": "cb17544e9347145d22a0fac608831053", "type": "string" }, "lun": { "description": "Logical Unit Number", "example": 34, "type": "integer" }, "nvmeTransportType": { "description": "Transport type of the protocol. Configuration of the transport type is only supported for NVMe protocol starting from the system OS version 10.3.0 and the default transport type value is FC.", "example": "TCP", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "maxAutoLun": { "description": "Number of volumes.", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "noVcn": { "description": "No VCN", "example": true, "type": [ "boolean", "null" ] }, "override": { "description": "Override", "example": true, "type": [ "boolean", "null" ] }, "proximity": { "description": "Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.", "enum": [ "PRIMARY", "SECONDARY", "ALL" ], "example": "PRIMARY", "type": "string" } }, "required": [ "hostGroupIds" ], "type": "object" }, "DeviceType4VlunsListSingle": { "properties": { "active": { "description": "Indicates if this is an active VLUN or a template", "example": true, "type": [ "boolean", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "type": [ "string", "null" ] }, "deviceWwns": { "description": "Device WWNs", "example": "", "type": [ "string", "null" ] }, "diskPartition": { "description": "Disk partition of host", "example": "", "type": [ "string", "null" ] }, "displayname": { "description": "SED state", "example": "", "type": [ "string", "null" ] }, "domain": { "description": "SED state", "example": "", "type": [ "string", "null" ] }, "failedPathInterval": { "description": "Monitoring interval in seconds after which the host checks for failed paths", "example": 1, "type": [ "integer", "null" ] }, "failedPathPolicy": { "description": "Failed path monitoring method", "example": "", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "uid of the vlun", "example": "", "type": "string" }, "initiators": { "description": "Initiator details", "properties": { "deviceDiscoveredName": { "description": "Host/HostGroup name on device.", "example": "TEST11", "type": [ "string", "null" ] }, "id": { "description": "Resource id", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "resourceUri": { "description": "Resource URI", "example": "/v1/host-initiators/6848ef683c27403e96caa51816ddc72c", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "example": "host-initiators", "type": "string" } }, "type": [ "object", "null" ] }, "lun": { "description": "Exported LUN ID", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "mountPoint": { "description": "Mount points of devices", "example": "", "type": [ "string", "null" ] }, "mountPointFsau": { "description": "File system allocation unit in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "multiPathType": { "description": "Multi-path method in use", "example": "", "type": [ "string", "null" ] }, "portPos": { "description": "System port VLUN is exported through. It includes node number, slot number, and port number", "properties": { "node": { "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "port": { "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "slot": { "example": 1, "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "rawVolume": { "description": "Volume that has not been formatted. Yes if it supports", "example": "", "type": [ "string", "null" ] }, "remoteName": { "description": "Host WWN, iSCSI name, or SAS address; depending on port type", "example": "", "type": [ "string", "null" ] }, "resourceUri": { "description": "resourceUri for detailed vlun object", "example": "- TO BE IMPLEMENTED", "type": [ "string", "null" ] }, "state": { "description": "State of the resource", "properties": { "detailed": { "description": "Array of the detailed states of the resource", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "overall": { "description": "Overall state of the resource", "enum": [ "STATE_UNKNOWN", "STATE_NORMAL", "STATE_DEGRADED", "STATE_FAILED", "STATE_NOT_APPLICABLE", "STATE_NEW", null ], "example": "STATE_NORMAL", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "status": { "description": "SED state", "example": "", "type": [ "string", "null" ] }, "systemId": { "description": "SED state", "example": "", "type": [ "string", "null" ] }, "targetNqn": { "description": "\"Subsystem NQN id for the NVMe host to which the volumes are exported\"", "example": "nqn.2020-09.com.hpe:b0eb957f-cb5c-4b31-a97a-80f9be7d77de", "type": [ "string", "null" ] }, "tpgId": { "description": "SED state", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "type": { "description": "VLUN type", "example": "", "type": "string" }, "usedSpace": { "description": "Host devices used space in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "vlunType": { "description": "VLUN type", "example": "", "type": [ "string", "null" ] }, "volumeGroup": { "description": "Volume group info", "example": "", "type": [ "string", "null" ] }, "volumeManager": { "description": "Volume Manager tool used", "example": "", "type": [ "string", "null" ] }, "volumeName": { "description": "Name of exported virtual volume or volume set name", "example": "", "type": [ "string", "null" ] }, "volumeWwn": { "description": "WWN of exported volume.If a volume set is exported, then this value is null.", "example": "", "type": [ "string", "null" ] }, "vvReservedUserSpace": { "description": "Volume user reserved space in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "vvSize": { "description": "Size of volume in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4VlunsSummaryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4vlunsList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4VolumeCapacity": { "properties": { "adminSpace": { "$ref": "#/components/schemas/DeviceType4space" }, "branchUsedBlocksMiB": { "description": "Branch used blocks size in MiB. This attribute contains the used space of the base volume and its Read-Only snapshots. This field is relevant for the system OS version 10.3.0 and above.", "format": "float64", "type": [ "number", "null" ] }, "branchVirtualSizeMiB": { "description": "Branch virtual size in MiB. This attribute contains the provisioned or virtual size of the base volume and its Read-Only snapshots.", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "compactEfficiency": { "description": "Compact Efficiency", "format": "float64", "type": [ "number", "null" ] }, "compressSavings": { "description": "The space savings in MiB by compressing data", "format": "int64", "type": [ "integer", "null" ] }, "compressionEfficiency": { "description": "Compression Efficiency", "format": "float64", "type": [ "number", "null" ] }, "copiedMb": { "description": "Copied MB", "format": "float64", "type": [ "number", "null" ] }, "copiedPerc": { "description": "Copied Perecentage", "type": [ "integer", "null" ] }, "ddcSize": { "format": "float64", "type": [ "number", "null" ] }, "ddsSize": { "format": "float64", "type": [ "number", "null" ] }, "dedupSavingsSize": { "format": "float64", "type": [ "number", "null" ] }, "dedupWrittenSize": { "format": "float64", "type": [ "number", "null" ] }, "hostWrittenMiB": { "description": "Host written data size in MiB.", "format": "float64", "type": [ "number", "null" ] }, "hostWrittenToVirtualPercent": { "description": "Host written to virtual percent", "format": "float64", "type": [ "number", "null" ] }, "nonReducibleData": { "description": "Amount of data that could not be reduced", "format": "int64", "type": [ "integer", "null" ] }, "reduceSavings": { "description": "Savings from data reduction in MiB and this is the combination of compression and dedup savings", "format": "int64", "type": [ "integer", "null" ] }, "reduceSavingsRatio": { "description": "Reduce ratio", "format": "float64", "type": [ "number", "null" ] }, "reducibleReduceSavings": { "description": "Data reduction savings in MiB using the reducible data. This savings is the combination of compression and dedup savings", "format": "int64", "type": [ "integer", "null" ] }, "reducibleReduceSavingsRatio": { "description": "Data reduction savings ratio using the reducible data. This savings is the combination of compression and dedup savings.", "format": "float64", "type": [ "number", "null" ] }, "sizeMiB": { "description": "Size in MiB `Filter, Sort`", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "snapshotTdvvSize": { "$ref": "#/components/schemas/DeviceType4snapshotTdvvsize" }, "snapshotUsedToVirtualPercent": { "description": "Snapshot used to virtual percent", "format": "float64", "type": [ "number", "null" ] }, "thinSaving": { "description": "The space savings from a fully allocated virtual volume (CPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space.", "format": "int64", "type": [ "integer", "null" ] }, "thinSavings": { "description": "Thin savings for the detailed volume object", "type": [ "string", "null" ] }, "thinSavingsRatio": { "description": "The space savings ratio from a fully allocated virtual volume (CPVV) to a thinly allocated VV (TPVV). This ratio is got by dividing the Provisioned size by host written space", "format": "float64", "type": [ "number", "null" ] }, "totalRawReservedMiB": { "description": "Total Raw Reserved Space in MiB", "format": "float64", "type": [ "number", "null" ] }, "totalReservedMiB": { "description": "Description", "format": "float64", "type": [ "number", "null" ] }, "totalSavings": { "description": "Total space savings including thin, compression, dedup, clone, zero packing, and snaps in MiB", "format": "int64", "type": [ "integer", "null" ] }, "totalSavingsRatio": { "description": "Total space savings ratio including thin, compression, dedup, clone, zero packing, and snaps", "format": "float64", "type": [ "number", "null" ] }, "totalSpaceMiB": { "description": "Total Space in MiB", "format": "float64", "type": [ "number", "null" ] }, "treeVirtualSize": { "description": "Virtual size of volume tree", "format": "float64", "type": [ "number", "null" ] }, "usedBlocksMiB": { "description": "Used Blocks Size in MiB. This attribute contains the used space of the base volume and its Read-Only snapshots. This field is relevant for the system OS versions equal and below 10.2.x. For the system OS version 10.3.0 and above, please refer the field branchUsedBlocksMiB.", "format": "float64", "type": [ "number", "null" ] }, "usedCapacity": { "description": "Used volume capacity. `Filter, Sort`", "format": "float64", "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Used Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "userReservedToVirtualPercent": { "description": "User reseved to virtual percent", "format": "float64", "type": [ "number", "null" ] }, "userSpace": { "$ref": "#/components/schemas/DeviceType4space" }, "userUsedToVirtualPercent": { "description": "User used to virtual percent", "format": "float64", "type": [ "number", "null" ] }, "vvtreeHostWrt": { "description": "Total data written to volume family tree by the host", "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4VolumeCapacityHistory": { "description": "volume capacity trends for given granularity", "properties": { "capacityData": { "properties": { "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "items": { "items": { "$ref": "#/components/schemas/DeviceType4volumeCapacitySeriesData" }, "type": [ "array", "null" ] }, "total": { "description": "count of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "endTime": { "description": "end time of the capacity history", "example": 1625209133, "type": [ "integer", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "startTime": { "description": "start time of the capacity history", "example": 1625122733, "type": [ "integer", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4VolumeCapacityHistoryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4VolumeCapacityHistory" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4VolumeDetails": { "properties": { "adminAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettingsSingle" }, "associatedLinks": { "description": "Associated Links", "example": [ { "resourceUri": "v1/storage-systems/{systemUid}/contollers", "type": "controllers" }, { "resourceUri": "v1/storage-systems/{systemUid}/shelves", "type": "shelves" }, { "resourceUri": "v1/storage-systems/{systemUid}/disks", "type": "disks" }, { "resourceUri": "v1/storage-systems/{systemUid}/storage-ports", "type": "storage-ports" }, { "resourceUri": "v1/storage-systems/{systemUid}/storage-devices-settings", "type": "storage-devices-settings" }, { "resourceUri": "v1/storage-systems/{systemUid}/storage-pools", "type": "storage-pools" }, { "resourceUri": "v1/storage-systems/{systemUid}/volume-sets", "type": "volume-sets" }, { "resourceUri": "v1/storage-systems/{systemUid}/host-groups", "type": "host-groups" } ], "items": { "properties": { "resourceUri": { "description": "Resource URI", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "baseId": { "description": "snapshot Tdvv Size", "format": "int64", "type": [ "integer", "null" ] }, "bulkvv": { "description": "Volume is bulk volume or not", "type": [ "boolean", "null" ] }, "comment": { "description": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "compressionPolicy": { "description": "Compression Policy", "type": [ "string", "null" ] }, "conversionType": { "description": "Conversion Type of Volume", "enum": [ "CONVERSIONTYPE_THIN", "CONVERSIONTYPE_DDS", "CONVERSIONTYPE_V1", "CONVERSIONTYPE_V2", null ], "type": [ "string", "null" ] }, "copyOfId": { "description": "Copy of Id", "format": "int64", "type": [ "integer", "null" ] }, "copyOfShortName": { "description": "Short name of volume parent, if a copy", "example": "VegaCopyOfShortNames~66", "type": [ "string", "null" ] }, "creationTime": { "$ref": "#/components/schemas/DeviceType4calendar" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "dataReduction": { "description": "Data Reduction type. Possible values:\n - DATA_REDUCTION_ON\n - DATA_REDUCTION_OFF\n - DATA_REDUCTION_DISABLED", "type": [ "string", "null" ] }, "dedup": { "description": "Dedup", "type": [ "string", "null" ] }, "devType": { "description": "Device Type", "type": [ "string", "null" ] }, "displayname": { "description": "Display name of the volume", "type": [ "string", "null" ] }, "domain": { "description": "Domain of the volume", "type": [ "string", "null" ] }, "fullyProvisioned": { "type": [ "boolean", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "headsPerCylinder": { "description": "Heads per Cylinder", "type": [ "integer", "null" ] }, "healthState": { "description": "Health status of the Volume.", "format": "int64", "type": [ "integer", "null" ] }, "hidden": { "description": "Flag to know if the Volume is hidden or not", "type": [ "boolean", "null" ] }, "id": { "description": "UUID string uniquely identifying the storage system object.", "type": "string" }, "initiators": { "description": "Initiator details", "items": { "properties": { "deviceDiscoveredName": { "description": "Host/HostGroup name on device.", "example": "TEST11", "type": [ "string", "null" ] }, "id": { "description": "Resource id", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "resourceUri": { "description": "Resource URI", "example": "/v1/host-initiators/6848ef683c27403e96caa51816ddc72c", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "example": "host-initiators", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "name": { "description": "A user friendly name to identify the storage system volume (resourceName).", "example": "Finance", "type": [ "string", "null" ] }, "nguid": { "description": "Namespace Globally Unique Identifier. This data is available only for NVMe enabled storage system.", "example": "60002AC0000800660002AC130007EEFD", "type": [ "string", "null" ] }, "parentId": { "description": "Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "pevv": { "description": "Volume is pe volume or not", "type": [ "boolean", "null" ] }, "physParentId": { "description": "physical Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "physicalCopy": { "type": [ "boolean", "null" ] }, "policy": { "$ref": "#/components/schemas/DeviceType4policy" }, "provType": { "description": "Description", "type": [ "string", "null" ] }, "raid": { "description": "Raid", "type": [ "string", "null" ] }, "rcopyStatus": { "description": "RemoteCopy Status", "type": [ "string", "null" ] }, "readOnly": { "type": [ "boolean", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/storage-fleet/v1/devtype4-storage-systems/2FF70002AC018D94/volumes/{uid}", "type": [ "string", "null" ] }, "sectorsPerTrack": { "description": "Sector per Track", "type": [ "integer", "null" ] }, "sharedParentId": { "description": "Shared Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "shortName": { "description": "Short name of the storage system volume", "example": "VegaVolumesShortName~67245", "type": [ "string", "null" ] }, "snapShotTier": { "description": "Snapshot Tier", "type": [ "string", "null" ] }, "started": { "type": [ "boolean", "null" ] }, "state": { "$ref": "#/components/schemas/DeviceType4State" }, "storageTier": { "description": "Storage Tier", "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinProvisioned": { "description": "Description", "type": [ "boolean", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "userAllocLimit": { "description": "User alloc limit", "format": "int64", "type": [ "integer", "null" ] }, "userAllocWarning": { "description": "User alloc space limit warning", "format": "int64", "type": [ "integer", "null" ] }, "userAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettingsSingle" }, "userCpgId": { "description": "User CPG Id", "format": "int64", "type": [ "integer", "null" ] }, "userCpgName": { "description": "User CPG Name", "type": [ "string", "null" ] }, "usrCpgShortName": { "description": "Short name of volume user CPG", "example": "VegaUserCpgShortName~97", "type": [ "string", "null" ] }, "vlunSectorSize": { "description": "VLUN sector size", "type": [ "integer", "null" ] }, "volumeCapacity": { "$ref": "#/components/schemas/DeviceType4VolumeCapacity" }, "volumeId": { "description": "Numeric ID of the resource", "format": "int64", "type": [ "integer", "null" ] }, "volumePerformance": { "$ref": "#/components/schemas/DeviceType4VolumePerformance" }, "volumeType": { "description": "VV Type", "example": "VVTYPE_BASE", "type": [ "string", "null" ] }, "wwn": { "description": "Volume wwn.", "example": "60002AC0000000000000006B0001FFEB", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4VolumeDetailsList": { "properties": { "adminAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettings" }, "associatedLinks": { "description": "Associated Links", "example": [ { "resourceUri": "v1/storage-systems/{systemUid}/contollers", "type": "controllers" }, { "resourceUri": "v1/storage-systems/{systemUid}/shelves", "type": "shelves" }, { "resourceUri": "v1/storage-systems/{systemUid}/disks", "type": "disks" }, { "resourceUri": "v1/storage-systems/{systemUid}/storage-ports", "type": "storage-ports" }, { "resourceUri": "v1/storage-systems/{systemUid}/storage-devices-settings", "type": "storage-devices-settings" }, { "resourceUri": "v1/storage-systems/{systemUid}/storage-pools", "type": "storage-pools" }, { "resourceUri": "v1/storage-systems/{systemUid}/volume-sets", "type": "volume-sets" }, { "resourceUri": "v1/storage-systems/{systemUid}/host-groups", "type": "host-groups" } ], "items": { "properties": { "resourceUri": { "description": "Resource URI", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "baseId": { "description": "snapshot Tdvv Size", "format": "int64", "type": [ "integer", "null" ] }, "bulkvv": { "description": "Volume is bulk volume or not", "type": [ "boolean", "null" ] }, "comment": { "description": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "compressionPolicy": { "description": "Compression Policy", "type": [ "string", "null" ] }, "conversionType": { "description": "Conversion Type of Volume", "enum": [ "CONVERSIONTYPE_THIN", "CONVERSIONTYPE_DDS", "CONVERSIONTYPE_V1", "CONVERSIONTYPE_V2", null ], "type": [ "string", "null" ] }, "copyOfId": { "description": "Copy of Id", "format": "int64", "type": [ "integer", "null" ] }, "copyOfShortName": { "description": "Short name of volume parent, if a copy", "example": "VegaCopyOfShortNames~66", "type": [ "string", "null" ] }, "creationTime": { "description": "Creation Time. `Sort`", "properties": { "ms": { "type": [ "integer", "null" ] }, "tz": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "dataReduction": { "description": "Data Reduction type. Possible values:\n - DATA_REDUCTION_ON\n - DATA_REDUCTION_OFF\n - DATA_REDUCTION_DISABLED", "type": [ "string", "null" ] }, "dedup": { "description": "Field to indicate Dedup status", "type": [ "string", "null" ] }, "devType": { "description": "Device Type `Filter`", "type": [ "string", "null" ] }, "displayname": { "description": "Display name of the volume", "type": [ "string", "null" ] }, "domain": { "description": "Domain of the volume", "type": [ "string", "null" ] }, "fullyProvisioned": { "type": [ "boolean", "null" ] }, "generation": { "description": "generation `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "headsPerCylinder": { "description": "Heads per Cylinder", "type": [ "integer", "null" ] }, "healthState": { "description": "Health status of the Volume. `Filter, Sort`", "format": "int64", "type": [ "integer", "null" ] }, "hidden": { "description": "Flag to know if the Volume is hidden or not", "type": [ "boolean", "null" ] }, "id": { "description": "UUID string uniquely identifying the storage system object. `Filter`", "type": "string" }, "name": { "description": "A user friendly name to identify the storage system volume (resourceName). `Filter, Sort`", "example": "Finance", "type": [ "string", "null" ] }, "nguid": { "description": "Namespace Globally Unique Identifier. This data is available only for NVMe enabled storage system. `Filter`", "example": "60002AC0000800660002AC130007EEFD", "type": [ "string", "null" ] }, "parentId": { "description": "Parent Id `Filter`", "format": "int64", "type": [ "integer", "null" ] }, "pevv": { "description": "Volume is pe volume or not", "type": [ "boolean", "null" ] }, "physParentId": { "description": "physical Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "physicalCopy": { "type": [ "boolean", "null" ] }, "policy": { "$ref": "#/components/schemas/DeviceType4policy" }, "provType": { "description": "Description", "type": [ "string", "null" ] }, "raid": { "description": "Raid", "type": [ "string", "null" ] }, "rcopyStatus": { "description": "RemoteCopy Status", "type": [ "string", "null" ] }, "readOnly": { "type": [ "boolean", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/v1/storage-systems/primea/2FF70002AC018D94/volumes/{uid}", "type": [ "string", "null" ] }, "sectorsPerTrack": { "description": "Sector per Track", "type": [ "integer", "null" ] }, "sharedParentId": { "description": "Shared Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "shortName": { "description": "Short name of the storage system volume", "example": "VegaVolumesShortName~67245", "type": [ "string", "null" ] }, "snapShotTier": { "description": "Snapshot Tier", "type": [ "string", "null" ] }, "started": { "type": [ "boolean", "null" ] }, "state": { "$ref": "#/components/schemas/DeviceType4State" }, "storageTier": { "description": "Storage Tier", "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinProvisioned": { "description": "Description", "type": [ "boolean", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "userAllocLimit": { "description": "User alloc limit", "format": "int64", "type": [ "integer", "null" ] }, "userAllocWarning": { "description": "User alloc space limit warning", "format": "int64", "type": [ "integer", "null" ] }, "userAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettings" }, "userCpgId": { "description": "User CPG Id `Filter`", "format": "int64", "type": [ "integer", "null" ] }, "userCpgName": { "description": "User CPG Name `Filter`", "type": [ "string", "null" ] }, "usrCpgShortName": { "description": "Short name of volume user CPG", "example": "VegaUserCpgShortName~97", "type": [ "string", "null" ] }, "vlunSectorSize": { "description": "VLUN sector size", "type": [ "integer", "null" ] }, "volumeCapacity": { "$ref": "#/components/schemas/DeviceType4VolumeCapacity" }, "volumeId": { "description": "Numeric ID of the resource", "format": "int64", "type": [ "integer", "null" ] }, "volumePerformance": { "$ref": "#/components/schemas/DeviceType4volumePerformanceDetails" }, "volumeType": { "description": "VV Type", "example": "VVTYPE_BASE", "type": [ "string", "null" ] }, "wwn": { "description": "Volume wwn. `Filter`", "example": "60002AC0000000000000006B0001FFEB", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4VolumePerformance": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "iops": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" }, "latencyMs": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/storage-fleet/v1/devtype4-storage-systems/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-statistics", "type": [ "string", "null" ] }, "throughputKbps": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" } }, "type": [ "object", "null" ] }, "DeviceType4VolumePerformanceDetails": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "iops": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" }, "latencyMs": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/storage-fleet/v1/devtype4-storage-systems/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-statistics", "type": [ "string", "null" ] }, "throughputKbps": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4VolumePerformanceHistogram": { "description": "Response structure of performance histogram", "properties": { "customerId": { "description": "Id specific to the customer", "type": "string" }, "deviceType": { "description": "device type", "enum": [ "devicetype1", "devicetype2", "devicetype4", "devicetype7" ], "type": [ "string", "null" ] }, "endTime": { "description": "End time for volume histogram data", "example": 1669880791, "type": "number" }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "sizeHistogramData": { "$ref": "#/components/schemas/sizeHistogramData" }, "startTime": { "description": "Start time for volume histogram data", "example": 1669794391, "type": "number" }, "systemId": { "description": "system ID", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" }, "volumeId": { "description": "volume ID", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4VolumePerformanceHistogramList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4VolumePerformanceHistogram" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4VolumePerformanceHistory": { "description": "volume performance trends for given granularity and time range", "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "endTime": { "description": "end time of history data", "example": 162564271, "type": [ "integer", "null" ] }, "historyData": { "description": "performance history data", "properties": { "iopsMetricsData": { "$ref": "#/components/schemas/DeviceType4historicalMetricData" }, "ioszMetricsData": { "$ref": "#/components/schemas/DeviceType4historicalMetricData" }, "latencyMetricsDataMs": { "$ref": "#/components/schemas/DeviceType4historicalMetricData" }, "qlenMetricsData": { "$ref": "#/components/schemas/DeviceType4QlenMetricDataValue" }, "throughputMetricsDataKbps": { "$ref": "#/components/schemas/DeviceType4historicalMetricData" } }, "type": [ "object", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "startTime": { "description": "start time of history data", "example": 1625556314, "type": [ "integer", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4VolumePerformanceHistoryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4VolumePerformanceHistory" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4VolumePerformanceList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4VolumePerformanceDetails" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4VolumePost": { "properties": { "comment": { "description": "Comment if any", "example": "", "type": [ "string", "null" ] }, "customName": { "description": "Name for snapshot. For the HPE Alletra Storage MP B10000 systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 255 characters.", "example": "snap1", "type": [ "string", "null" ] }, "expireSecs": { "description": "Expiration time in seconds", "example": 86400, "type": [ "integer", "null" ] }, "namePattern": { "$ref": "#/components/schemas/DeviceType4NamePattern" }, "readOnly": { "description": "Read only or Read/Write", "example": false, "type": [ "boolean", "null" ] }, "retainSecs": { "description": "Reatain time in seconds", "example": 86400, "format": "int64", "type": [ "integer", "null" ] } }, "required": [ "namePattern" ], "type": [ "object", "null" ] }, "DeviceType4VolumePut": { "properties": { "dataReduction": { "description": "Data Reduction on Volume.", "type": [ "boolean", "null" ] }, "name": { "description": "volume name. For the HPE Alletra Storage MP B10000 systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 255 characters.", "example": "volume_Name", "type": [ "string", "null" ] }, "ransomware": { "description": "This attribute enables/disables ransomware detection on the volume. If no input is provided, the existing ransomware setting on the volume set would stay. This applies to the HPE Alletra Storage MP B10000 systems running OS version 10.5.0 and later.", "type": [ "boolean", "null" ] }, "sizeMib": { "description": "Size of the volume to be edited.", "example": 1, "format": "float64", "type": [ "number", "null" ] }, "snapshotAllocWarning": { "description": "snapshot alloc space allocation warning", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "userAllocWarning": { "description": "User alloc space limit warning", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "userCpgName": { "description": "user cpg name", "example": "cpg_1", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4VolumeSetApplicationType": { "description": "application type", "enum": [ "ORACLE_DATA", "ORACLE_LOG", "MICROSOFT_EXCHANGE", "MICROSOFT_EXCHANGE_LOG", "MICROSOFT_SQL_SERVER", "MICROSOFT_SQL_SERVER_LOG", "VIRTUAL_SERVER_VMWARE_ESXI_STORAGE", "VIRTUAL_SERVER_HYPER_V_STORAGE", "VIRTUAL_DESKTOP_VMWARE_ESXI_STORAGE", "VIRTUAL_DESKTOP_HYPER_V_STORAGE", "SHAREPOINT", "FILE_SERVER", "VME", "SAP_HANA", "VEEAM_BACKUP_REPOSITORY", "OTHER", "CUSTOM" ], "example": "ORACLE_LOG", "type": [ "string", "null" ] }, "DeviceType4VolumeSetHostGroupList": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "generation": { "description": "generation", "type": [ "integer", "null" ] }, "hostGroupName": { "description": "Host group name", "example": "hostset1", "type": [ "string", "null" ] }, "hosts": { "items": { "$ref": "#/components/schemas/DeviceType4VolumeSetHostProximityInfo" }, "type": [ "array", "null" ] }, "id": { "description": "Id of the resource", "type": "string" }, "proximity": { "properties": { "localSystem": { "description": "This is the system where the host group proximity is set to Primary for the associated protected volume set. If this host group proximity is set to ALL for the associated protected volume set, it will contain both the replicated system names.", "example": "s4300", "type": [ "string", "null" ] }, "proximityValue": { "description": "Host Group Proximity with which Host Group was already admitted to the protected volume set. Supported values are - PRIMARY, SECONDARY and ALL.", "example": "PRIMARY", "type": [ "string", "null" ] }, "remoteSystem": { "description": "This is the system where the host group proximity is set to Secondary for the associated protected volume set and it will be empty if the host group proximity is set to ALL for the associated protected volume set.", "example": "s4300", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "systemId": { "description": "Unique ID or serial number of the system.", "example": "7CE816P0SR", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4VolumeSetHostProximityInfo": { "properties": { "dsccHostName": { "description": "Name of host in Data Services Cloud Console", "example": "host1", "type": [ "string", "null" ] }, "hostId": { "description": "Unique ID of host", "example": "0af26e4430948dd5c37bea1757107caf", "type": [ "string", "null" ] }, "hostNqn": { "description": "Host NQN information", "example": [ "nqn.2014-08.net.hpecorp.storage.mip:nvme:ESX173" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "name": { "description": "Host name", "example": "host1", "type": [ "string", "null" ] }, "os": { "description": "OS of host", "example": "Windows Server", "type": [ "string", "null" ] }, "proximity": { "$ref": "#/components/schemas/DeviceType4hostProximityDetail" }, "targetNqn": { "description": "\"Subsystem NQN id for the NVMe host to which the volumes are exported\"", "example": "nqn.2020-09.com.hpe:b0eb957f-cb5c-4b31-a97a-80f9be7d77de", "type": [ "string", "null" ] } }, "type": "object" }, "DeviceType4VolumeSetProximitySettings": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4VolumeSetHostGroupList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4VolumeSetPut": { "properties": { "addMembers": { "description": "Members to add to application set", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "appSetBusinessUnit": { "description": "App set business unit", "example": "HPE", "type": [ "string", "null" ] }, "appSetComments": { "description": "App set comments", "example": "Edit appset", "type": [ "string", "null" ] }, "appSetName": { "description": "App set name", "example": "Appset_134", "type": [ "string", "null" ] }, "appSetType": { "$ref": "#/components/schemas/DeviceType4volumeSetApplicationTypePut" }, "customAppType": { "description": "App set name for Custom workloads when appSetType=CUSTOM", "example": "CustomWorkload_123", "type": [ "string", "null" ] }, "editAppSetQosConfigInput": { "$ref": "#/components/schemas/DeviceType4EditAppSetQosConfigInput" }, "ransomware": { "description": "This attribute enables/disables ransomware detection on the volume set. Both the existing volumes in the volume set as well as the volumes which get added in future in to this volume set will have this ransomware setting. If no input is provided, the existing ransomware setting on the volume set would stay. This applies to the HPE Alletra Storage MP B10000 systems running OS version 10.5.0 and later.", "example": true, "type": [ "boolean", "null" ] }, "removeMembers": { "description": "Members to remove from application set", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4VolumesList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4VolumeDetailsList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "DeviceType4allocation": { "description": "Device allocation settings such as RAID and device type information", "properties": { "chunkletPosPref": { "description": "Chunklets position", "example": "Position1", "type": [ "string", "null" ] }, "deviceSpeed": { "description": "Device speed", "properties": { "text": { "type": [ "string", "null" ] }, "value": { "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "deviceType": { "description": "Device type", "example": "DEVICE_TYPE_SSD", "type": [ "string", "null" ] }, "diskFilter": { "description": "Disk filter", "example": "test", "type": [ "string", "null" ] }, "ha": { "description": "Requested High Availability setting", "properties": { "default": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "raidType": { "description": "RAID type", "example": "RAID_SIX", "type": [ "string", "null" ] }, "requestedHa": { "description": "Requested High Availability setting", "properties": { "default": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "setSize": { "description": "Set size", "example": "6 data, 2 parity", "type": [ "string", "null" ] }, "stepSize": { "description": "Step size", "example": -1, "format": "int64", "type": "number" } }, "type": [ "object", "null" ] }, "DeviceType4applications": { "properties": { "applicationSetType": { "description": "Name of the application", "example": "Microsoft Exchange", "type": "string" }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "totalSizeMiB": { "description": "The total volume size in MiB of the application", "example": 307200, "format": "float64", "type": [ "number", "null" ] }, "totalUsedSizeMiB": { "description": "The total used size in Mib of the application", "example": 7200, "format": "float64", "type": [ "number", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" }, "volumesCount": { "description": "The number of volumes in an application", "example": 5, "type": [ "integer", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4calendar": { "description": "", "properties": { "ms": { "format": "int64", "type": [ "integer", "null" ] }, "tz": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4capacitySeriesForecastData": { "properties": { "maxUsedMiB": { "description": "Forecasted maximum used capacity in MiB", "example": 4, "format": "float64", "type": [ "number", "null" ] }, "minUsedMiB": { "description": "Forecasted minimum used capacity in MiB", "example": 4, "format": "float64", "type": [ "number", "null" ] }, "timestampMs": { "description": "Epoch timestamp in milliseconds", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] }, "totalMiB": { "description": "Forecasted total capacity in MiB.", "example": 4, "format": "float64", "type": [ "number", "null" ] }, "usedMiB": { "description": "Forecasted used capacity in MiB", "example": 4, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4capacitySeriesHistoricData": { "properties": { "timestampMs": { "description": "Epoch timestamp in milliseconds", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] }, "totalMiB": { "description": "Total capacity in MiB", "example": 4, "format": "float64", "type": [ "number", "null" ] }, "usedMiB": { "description": "Used capacity in MiB", "example": 4, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4cpgAlert": { "description": "Information for posted alerts", "properties": { "fail": { "description": "Alert when there is a growth failure for admin/data space", "example": "--", "type": "string" }, "limit": { "description": "Alert corresponding to limit for admin/data space", "example": "--", "type": "string" }, "warn": { "description": "Alert corresponding to warning for admin/data space", "example": "--", "type": "string" }, "warnPercent": { "description": "Alert corresponding to warning percentage for admin/data space", "example": 2, "format": "Uint32", "type": "number" } }, "type": [ "object", "null" ] }, "DeviceType4cpgGrow": { "description": "CPG grow information", "properties": { "args": { "description": "The admin/data LD creation arguments used by the CPG when growing new LDs", "example": "-p -devtype SSD", "type": "string" }, "limitMiB": { "description": "Limit size in MiB beyond which the admin/data space will not grow", "example": 10, "format": "Uint64", "type": "number" }, "sizeMiB": { "description": "Amount of admin/data LD storage in MiB created on each auto-grow", "example": 12, "format": "Uint64", "type": "number" }, "warnMiB": { "description": "Size in MiB of the admin/data space at which a warning alert is generated", "example": 10, "format": "Uint64", "type": "number" } }, "type": [ "object", "null" ] }, "DeviceType4createVolume": { "description": "Create a new volume for clone.", "properties": { "destinationCpg": { "description": "Name of the User CPG", "example": "SSD_r6", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4deviceSpeed": { "description": "device speed", "properties": { "text": { "type": [ "string", "null" ] }, "value": { "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4deviceSpeedSingle": { "description": "device speed", "properties": { "text": { "type": [ "string", "null" ] }, "value": { "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4historicalMetricData": { "description": "Timeseries data for particular metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4metricSeriesData" }, "type": [ "array", "null" ] }, "total": { "description": "count of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4hostProximityDetail": { "properties": { "isRemoteArraySupportReplication": { "description": "Boolean value to indicate if remote array OS version supports replication", "example": true, "type": "boolean" }, "isSourceArraySupportReplication": { "description": "Boolean value to indicate if source array OS version supports replication", "example": true, "type": "boolean" }, "localSystem": { "description": "Local system where host I/O path is Active optimized", "example": "CS2-A630-SVQ8", "type": [ "string", "null" ] }, "proximityValue": { "description": "Host proximity to determine the Asymmetric Logical path access state", "example": "PRIMARY", "type": [ "string", "null" ] }, "remoteSystem": { "description": "Remote system where host I/O path is Active Non-optimized", "example": "s2937", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4metricData": { "description": "Timeseries data for particular metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4metricSeriesRdWrData" }, "type": [ "array", "null" ] }, "total": { "description": "total number of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4metricDataValue": { "description": "Timeseries data for particular metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4metricSeriesDataValue" }, "type": [ "array", "null" ] }, "total": { "description": "total number of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4metricHistoryData": { "properties": { "chartLegendId": { "description": "Id to display chart legend, gives information about groupby and filtered objects", "example": "VV_NAME-vvname1:HOST_NAME-host:LUN-lun", "type": [ "string", "null" ] }, "timeseriesData": { "$ref": "#/components/schemas/DeviceType4metricData" } }, "type": [ "object", "null" ] }, "DeviceType4metricHistoryDataSingleValue": { "properties": { "chartLegendId": { "description": "Id to display chart legend, gives information about groupby and filtered objects", "example": "VV_NAME-vvname1:HOST_NAME-host:LUN-lun", "type": [ "string", "null" ] }, "timeseriesData": { "$ref": "#/components/schemas/DeviceType4metricDataValue" } }, "type": [ "object", "null" ] }, "DeviceType4metricRdWrTotData": { "description": "Timeseries data for particular metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/DeviceType4metricSeriesRdWrTotData" }, "type": [ "array", "null" ] }, "total": { "description": "total number of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4metricRdWrTotHistoryData": { "properties": { "chartLegendId": { "description": "Id to display chart legend, gives information about groupby and filtered objects", "example": "VV_NAME-vvname1:HOST_NAME-host:LUN-lun", "type": [ "string", "null" ] }, "timeseriesData": { "$ref": "#/components/schemas/DeviceType4metricRdWrTotData" } }, "type": [ "object", "null" ] }, "DeviceType4metricSeriesData": { "properties": { "readValue": { "description": "average read metric value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] }, "timestampms": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] }, "totalValue": { "description": "total metric value at particular timestamp", "example": 89.76, "format": "float64", "type": [ "number", "null" ] }, "writeValue": { "description": "average write metric value at particular timestamp", "example": 23.76, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4metricSeriesDataValue": { "properties": { "name": { "description": "name of the object at particular timestamp", "example": "appset1", "type": [ "string", "null" ] }, "timestampms": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] }, "value": { "description": "value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4metricSeriesRdWrData": { "properties": { "name": { "description": "name of the object at particular timestamp", "example": "appset1", "type": [ "string", "null" ] }, "readValue": { "description": "average read metric value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] }, "timestampms": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] }, "writeValue": { "description": "average write metric value at particular timestamp", "example": 23.76, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4metricSeriesRdWrTotData": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4metricSeriesRdWrData" } ], "description": "Timeseries data for particular metric type", "properties": { "totalValue": { "description": "average total metric value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4offlineClone": { "description": "Offline clone of a volume.", "properties": { "createVolume": { "$ref": "#/components/schemas/DeviceType4createVolume" }, "enableResync": { "description": "Specify to save a snapshot for fast resynchronization.", "example": true, "type": [ "boolean", "null" ] }, "useExistingVolume": { "description": "Specify to use existing volume or create a new volume for clone.", "example": true, "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4onlineClone": { "description": "Online clone of a volume.", "properties": { "autoLun": { "description": "Specify to use auto lun number.", "example": true, "type": [ "boolean", "null" ] }, "destinationCpg": { "description": "Name of the User CPG", "example": "SSD_r6", "type": [ "string", "null" ] }, "hostGroupId": { "description": "Unique identifier of host group.", "example": "fd3244ef7f1ab8bd16500c7a41bdf8f8", "type": [ "string", "null" ] }, "lun": { "description": "LUN of volume.", "example": 0, "format": "int64", "type": [ "integer", "null" ] }, "nvmeTransportType": { "description": "Transport type of the protocol. Configuration of the transport type is only supported for NVMe protocol starting from the system OS version 10.3.0 and the default transport type value is FC.", "example": "TCP", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4pmPerfData": { "description": "Performance metrics average values", "properties": { "avgOf1day": { "description": "last one day avg data", "example": 33.65, "format": "float64", "type": [ "number", "null" ] }, "avgOf1hour": { "description": "last one hour avg data", "example": 40.4, "format": "float64", "type": [ "number", "null" ] }, "avgOf8hours": { "description": "last 8 hours avg data", "example": 50.98, "format": "float64", "type": [ "number", "null" ] }, "avgOfLatest": { "description": "latest perf data", "example": 3.4, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4policy": { "properties": { "fileService": { "type": [ "boolean", "null" ] }, "noCache": { "type": [ "boolean", "null" ] }, "oneHost": { "type": [ "boolean", "null" ] }, "ransomware": { "description": "Indicates Whether ransomware detection has been enabled on this volume (Applicable for the HPE Alletra Storage MP B10000 systems with version 10.5.0 OS and above).", "type": [ "boolean", "null" ] }, "staleSnapshot": { "type": [ "boolean", "null" ] }, "system": { "type": [ "boolean", "null" ] }, "zeroDetect": { "type": [ "boolean", "null" ] }, "zeroFill": { "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4poolsDeviceType4AssociatedLinks": { "description": "Associated Links Details", "example": [ { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/7CE809P009", "type": "storage-systems" }, { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178/volumes", "type": "volumes" } ], "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "DeviceType4snapSpace": { "description": "snapSpace information", "properties": { "ldCount": { "description": "Number of Logical Disks", "example": 4, "format": "Uint64", "type": "number" }, "totalMiB": { "description": "Total logical capacity (MiB)", "example": 83968, "format": "Uint64", "type": "number" }, "totalRawMiB": { "description": "Total physical (raw) capacity (MiB)", "example": 251904, "format": "Uint64", "type": "number" }, "usedMiB": { "description": "Used logical capacity (MiB)", "example": 75008, "format": "Uint64", "type": "number" }, "usedRawMiB": { "description": "Used physical (raw) capacity (MiB)", "example": 225024, "format": "Uint64", "type": "number" } }, "type": [ "object", "null" ] }, "DeviceType4snapshotTdvvsize": { "properties": { "ddcSizeMiB": { "format": "float64", "type": [ "number", "null" ] }, "ddsSizeMiB": { "format": "float64", "type": [ "number", "null" ] }, "virtualSizeMiB": { "format": "float64", "type": [ "number", "null" ] }, "writtenSizeMiB": { "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4snapshotsList": { "properties": { "adminAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettingsSingle" }, "baseId": { "description": "snapshot Tdvv Size", "format": "int64", "type": [ "integer", "null" ] }, "comment": { "description": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "compressionPolicy": { "description": "compression policy", "type": [ "string", "null" ] }, "conversionType": { "description": "Conversion Type of Volume", "enum": [ "CONVERSIONTYPE_THIN", "CONVERSIONTYPE_DDS", "CONVERSIONTYPE_V1", "CONVERSIONTYPE_V2", null ], "type": [ "string", "null" ] }, "copyOfId": { "description": "Copy of ID", "format": "int64", "type": [ "integer", "null" ] }, "creationTime": { "description": "Creation Time `Sort`", "properties": { "ms": { "type": [ "integer", "null" ] }, "tz": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "dataReduction": { "description": "Data Reduction type", "type": [ "string", "null" ] }, "dedup": { "type": [ "string", "null" ] }, "devType": { "description": "Device Type", "type": [ "string", "null" ] }, "displayname": { "description": "Display name of the volume", "type": [ "string", "null" ] }, "domain": { "description": "Domain of the volume", "type": [ "string", "null" ] }, "fullyProvisioned": { "type": [ "boolean", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "headsPerCylinder": { "description": "Heads per Cylinder", "type": [ "integer", "null" ] }, "healthState": { "description": "Health status of the Volume.", "format": "int64", "type": [ "integer", "null" ] }, "hidden": { "description": "Flag to know if the Volume is hidden or not", "type": [ "boolean", "null" ] }, "id": { "description": "UID of the snapshot. `Filter`", "example": "b7107a30-260a-41c1-a47f-e50770c414c9", "type": "string" }, "initiators": { "description": "Initiator details", "items": { "properties": { "deviceDiscoveredName": { "description": "Host/HostGroup name on device.", "example": "TEST11", "type": [ "string", "null" ] }, "id": { "description": "Resource id", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "resourceUri": { "description": "Resource URI", "example": "/v1/host-initiators/6848ef683c27403e96caa51816ddc72c", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "example": "host-initiators", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "name": { "description": "A user friendly name to identify the storage system volume (resourceName).", "example": "Finance", "type": [ "string", "null" ] }, "parentId": { "description": "Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "physParentId": { "description": "physical Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "physicalCopy": { "type": [ "boolean", "null" ] }, "policy": { "$ref": "#/components/schemas/DeviceType4policy" }, "provType": { "description": "Provisioning type", "type": [ "string", "null" ] }, "raid": { "description": "Raid", "type": [ "string", "null" ] }, "rcopyStatus": { "description": "RemoteCopy Status", "type": [ "string", "null" ] }, "readOnly": { "type": [ "boolean", "null" ] }, "roChildId": { "description": "RO child id", "format": "int64", "type": [ "integer", "null" ] }, "rwChildId": { "format": "int64", "type": [ "integer", "null" ] }, "rwareAlert": { "description": "Indicates whether this snapshot acts as an alert snapshot for the base volume. Alert snapshot is generated when the OS detects a possible ransomware attack on the base volume (Applicable for the HPE Alletra Storage MP B10000 systems with version 10.5.0 OS and above).", "type": [ "boolean", "null" ] }, "sectorsPerTrack": { "description": "Sector per Track", "type": [ "integer", "null" ] }, "sharedParentId": { "description": "Shared Parent Id", "format": "int64", "type": [ "integer", "null" ] }, "snapshotCapacity": { "$ref": "#/components/schemas/DeviceType4SnapshotCapacity" }, "snapshotId": { "description": "Numeric ID of the resource", "format": "int64", "type": [ "integer", "null" ] }, "snapshotType": { "type": [ "string", "null" ] }, "started": { "type": [ "boolean", "null" ] }, "state": { "$ref": "#/components/schemas/DeviceType4State" }, "systemId": { "description": "SystemUid/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinProvisioned": { "description": "Thin provisioning details", "type": [ "boolean", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "userAllocLimit": { "description": "User alloc limit", "format": "int64", "type": [ "integer", "null" ] }, "userAllocWarning": { "description": "User alloc space limit warning", "format": "int64", "type": [ "integer", "null" ] }, "userAllocationSettings": { "$ref": "#/components/schemas/DeviceType4userAllocationSettingsSingle" }, "userCpgId": { "description": "User CPG Id", "format": "int64", "type": [ "integer", "null" ] }, "userCpgName": { "description": "User CPG Name", "type": [ "string", "null" ] }, "vlunSectorSize": { "description": "VLUN sector size", "type": [ "integer", "null" ] }, "wwn": { "description": "Volume wwn.", "example": "60002AC0000000000000006B0001FFEB", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4snapshotsetsList": { "properties": { "appSetBusinessUnit": { "description": "Appset BusinessUnit", "example": "cssl", "type": [ "string", "null" ] }, "appSetComments": { "description": "Application set comments", "example": "app set comments", "type": [ "string", "null" ] }, "appSetImportance": { "description": "Importance Level", "example": "MEDIUM", "type": [ "string", "null" ] }, "appSetName": { "description": "Application set name", "example": "KA_VEGA_APPSET1_186", "maxLength": 255, "type": [ "string", "null" ] }, "appSetType": { "description": "Type of the snapshotset", "example": "Oracle Database", "type": [ "string", "null" ] }, "comment": { "description": "Comments if any", "example": "Comments", "type": [ "string", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "creationTime": { "description": "Creation Time", "properties": { "ms": { "type": [ "integer", "null" ] }, "tz": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "displayName": { "description": "Display Name", "example": "Application Set KA_VEGA_APPSET1_186 ", "maxLength": 255, "type": [ "string", "null" ] }, "domain": { "description": "Domain name", "example": "Domain", "maxLength": 255, "type": [ "string", "null" ] }, "exportStatus": { "description": "Export status", "example": "PARTIALLY_EXPORTED", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "uid of the snapshotset. `Filter`", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "kvPairsPresent": { "description": "Represents KV pairs present or not", "example": true, "type": "boolean" }, "members": { "description": "Volume Names", "example": [ "vol1", "vol2" ], "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "mode": { "description": "Mode of the snapshotset", "example": "RO", "type": [ "string", "null" ] }, "name": { "description": "Name of the snapshotset. `Filter, Sort`", "example": "KA_VEGA_APPSET2_186", "type": [ "string", "null" ] }, "shortName": { "description": "Short name of the snapshotset", "example": "VegaSnapshotSets~92775", "type": [ "string", "null" ] }, "snapSetId": { "description": "ID", "example": 5, "type": [ "integer", "null" ] }, "snapSetParentId": { "description": "ParentId of the snapSet", "example": 5, "format": "int64", "type": [ "integer", "null" ] }, "snapSetParentName": { "description": "Parent name of the snapSet", "example": "HPE", "maxLength": 255, "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/serialNumber of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "vvSetType": { "description": "Type of the volume-set", "example": "VVSET", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "DeviceType4space": { "properties": { "freeMiB": { "format": "float64", "type": [ "number", "null" ] }, "grownMiB": { "format": "float64", "type": [ "number", "null" ] }, "rawReservedMiB": { "format": "float64", "type": [ "number", "null" ] }, "reclaimedMiB": { "format": "float64", "type": [ "number", "null" ] }, "reservedMiB": { "format": "float64", "type": [ "number", "null" ] }, "totalMiB": { "format": "float64", "type": [ "number", "null" ] }, "usedMiB": { "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4sysAssociatedLinks": { "description": "Associated Links Details", "example": [ { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/{uid}", "type": "systems" } ], "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "DeviceType4userAllocationSettings": { "properties": { "deviceSpeed": { "$ref": "#/components/schemas/DeviceType4deviceSpeed" }, "deviceType": { "type": [ "string", "null" ] }, "diskFilter": { "type": [ "string", "null" ] }, "ha": { "properties": { "default": { "example": "Magazine", "type": [ "string", "null" ] }, "key": { "example": "hajbod-10", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "raidType": { "description": "", "type": [ "string", "null" ] }, "requestedHa": { "properties": { "default": { "example": "Magazine", "type": [ "string", "null" ] }, "key": { "example": "hajbod-10", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "setSize": { "type": [ "string", "null" ] }, "stepSize": { "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4userAllocationSettingsSingle": { "properties": { "deviceSpeed": { "$ref": "#/components/schemas/DeviceType4deviceSpeedSingle" }, "deviceType": { "type": [ "string", "null" ] }, "diskFilter": { "type": [ "string", "null" ] }, "ha": { "properties": { "default": { "example": "Magazine", "type": [ "string", "null" ] }, "key": { "example": "hajbod-10", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "raidType": { "description": "", "type": [ "string", "null" ] }, "requestedHa": { "properties": { "default": { "example": "Magazine", "type": [ "string", "null" ] }, "key": { "example": "hajbod-10", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "setSize": { "type": [ "string", "null" ] }, "stepSize": { "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4vlunsList": { "properties": { "active": { "description": "Indicates if this is an active VLUN or a template", "example": true, "type": [ "boolean", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "deviceWwns": { "description": "Device WWNs", "example": "wwn", "type": [ "string", "null" ] }, "diskPartition": { "description": "Disk partition of host", "example": "", "type": [ "string", "null" ] }, "displayname": { "description": "SED state", "example": "", "type": [ "string", "null" ] }, "domain": { "description": "SED state", "example": "", "type": [ "string", "null" ] }, "failedPathInterval": { "description": "Monitoring interval in seconds after which the host checks for failed paths", "example": 1, "type": [ "integer", "null" ] }, "failedPathPolicy": { "description": "Failed path monitoring method", "example": "", "type": [ "string", "null" ] }, "generation": { "description": "generation `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "uid of the vlun `Filter`", "example": "", "type": "string" }, "initiators": { "description": "Initiator details", "properties": { "deviceDiscoveredName": { "description": "Host/HostGroup name on device.", "example": "TEST11", "type": [ "string", "null" ] }, "id": { "description": "Resource id", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "resourceUri": { "description": "Resource URI", "example": "/v1/host-initiators/6848ef683c27403e96caa51816ddc72c", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "example": "host-initiators", "type": "string" } }, "type": [ "object", "null" ] }, "lun": { "description": "Exported LUN ID `Filter, Sort`", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "mountPoint": { "description": "Mount points of devices", "example": "", "type": [ "string", "null" ] }, "mountPointFsau": { "description": "File system allocation unit in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "multiPathType": { "description": "Multi-path method in use", "example": "", "type": [ "string", "null" ] }, "portPos": { "description": "System port VLUN is exported through. It includes node number, slot number, and port number", "properties": { "node": { "description": "`Filter, Sort`", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "port": { "description": "`Filter, Sort`", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "slot": { "description": "`Filter, Sort`", "example": 1, "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "rawVolume": { "description": "Volume that has not been formatted. Yes if it supports", "example": "", "type": [ "string", "null" ] }, "remoteName": { "description": "Host WWN, iSCSI name, or SAS address; depending on port type", "example": "", "type": [ "string", "null" ] }, "resourceUri": { "description": "resourceUri for detailed vlun object", "example": "- TO BE IMPLEMENTED", "type": [ "string", "null" ] }, "state": { "description": "State of the resource", "properties": { "detailed": { "description": "Array of the detailed states of the resource", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "overall": { "description": "Overall state of the resource", "enum": [ "STATE_UNKNOWN", "STATE_NORMAL", "STATE_DEGRADED", "STATE_FAILED", "STATE_NOT_APPLICABLE", "STATE_NEW", null ], "example": "STATE_NORMAL", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "status": { "description": "SED state", "example": "", "type": [ "string", "null" ] }, "systemId": { "description": "System Uid `Filter`", "example": "", "type": [ "string", "null" ] }, "targetNqn": { "description": "\"Subsystem NQN id for the NVMe host to which the volumes are exported\"", "example": "nqn.2020-09.com.hpe:b0eb957f-cb5c-4b31-a97a-80f9be7d77de", "type": [ "string", "null" ] }, "tpgId": { "description": "SED state", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "usedSpace": { "description": "Host devices used space in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "vlunType": { "description": "VLUN type", "example": "", "type": [ "string", "null" ] }, "volumeGroup": { "description": "Volume group info", "example": "", "type": [ "string", "null" ] }, "volumeManager": { "description": "Volume Manager tool used", "example": "", "type": [ "string", "null" ] }, "volumeName": { "description": "Name of exported virtual volume or volume set name `Filter`", "example": "", "type": [ "string", "null" ] }, "volumeWwn": { "description": "WWN of exported volume.If a volume set is exported, then this value is null. `Filter`", "example": "", "type": [ "string", "null" ] }, "vvReservedUserSpace": { "description": "Volume user reserved space in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] }, "vvSize": { "description": "Size of volume in MiB", "example": 1, "format": "int64", "type": [ "integer", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "DeviceType4volAssociatedLinks": { "description": "Associated Links Details", "example": [ { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/ABC239XFZ9/volumes/60002AC000000000000005B200029834", "type": "volumes" }, { "resourceUri": "/storage-fleet/v1/devtype4-storage-systems/ABC239XFZ9/volumes/60002AC000000000000005B200029834/performace-history", "type": "performance-history" } ], "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "DeviceType4volumeCapacitySeriesData": { "properties": { "actualUsageMiB": { "description": "Actual usage value in MiB", "example": 25, "format": "float64", "type": [ "number", "null" ] }, "hostWrittenCapacityMiB": { "description": "Host written capacity in MiB", "example": 20, "format": "float64", "type": [ "number", "null" ] }, "timestampMs": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "DeviceType4volumePerformanceDetails": { "properties": { "iops": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" }, "latencyMs": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" }, "throughputKbps": { "$ref": "#/components/schemas/DeviceType4KpiMetrics" } }, "type": [ "object", "null" ] }, "DeviceType4volumeSetApplicationTypePut": { "description": "Application set type. Not applicable for OS Version 10.4.0 and above.", "enum": [ "ORACLE_DATA", "ORACLE_LOG", "MICROSOFT_EXCHANGE", "MICROSOFT_EXCHANGE_LOG", "MICROSOFT_SQL_SERVER", "MICROSOFT_SQL_SERVER_LOG", "VIRTUAL_SERVER_VMWARE_ESXI_STORAGE", "VIRTUAL_SERVER_HYPER_V_STORAGE", "VIRTUAL_DESKTOP_VMWARE_ESXI_STORAGE", "VIRTUAL_DESKTOP_HYPER_V_STORAGE", "SHAREPOINT", "FILE_SERVER", "VME", "SAP_HANA", "VEEAM_BACKUP_REPOSITORY", "OTHER", "CUSTOM" ], "example": "ORACLE_LOG", "type": [ "string", "null" ] }, "DeviceType4vvNamePattern": { "description": "name pattern", "enum": [ "PARENT_TIMESTAMP", "PARENT_SEC_SINCE_EPOCH" ], "example": "PARENT_TIMESTAMP", "type": [ "string", "null" ] }, "ErrorResponse": { "properties": { "debugId": { "description": "A unique identifier for the request", "example": "f57dcca3345820eb579c9317ce36dd92", "type": "string" }, "errorCode": { "description": "A machine friendly identifier for the error response", "type": "string" }, "httpStatusCode": { "description": "The HTTP status code of the response", "type": "integer" }, "message": { "description": "A user-friendly error message", "example": "An example error message", "type": "string" } }, "required": [ "httpStatusCode", "message", "errorCode", "debugId" ] }, "FleetPoolDetails": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/fleetAssociatedLinks" }, "capacityUsed": { "description": "Capacity Used", "example": 56446, "type": "integer" }, "customerId": { "description": "The customer application identifier", "type": "string" }, "domain": { "description": "Domain of the storage pool.", "example": "domain", "type": "string" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "format": "int64", "type": "integer" }, "id": { "description": "Unique Identifier of the resource ", "example": "e9d353bf98fc1a6bdb90b824e3ca14b5", "type": "string" }, "name": { "description": "Name of the resource", "example": "Vega_7_test", "maxLength": 255, "type": "string" }, "resourceUri": { "description": "resourceUri for detailed storage-pool object ", "example": "/block-storage/v1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178", "type": "string" }, "systemId": { "description": "SystemID of the array", "example": "7CE809P009", "type": "string" }, "type": { "description": "The type of resource.", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "FleetPoolList": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/fleetAssociatedLinks" }, "capacityUsed": { "description": "Capacity Used", "example": 56446, "type": "integer" }, "customerId": { "description": "The customer application identifier", "type": "string" }, "domain": { "description": "Domain of the storage pool.`Filter`", "example": "domain", "type": "string" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "format": "int64", "type": "integer" }, "id": { "description": "Unique Identifier of the resource ", "example": "e9d353bf98fc1a6bdb90b824e3ca14b5", "type": "string" }, "name": { "description": "Name of the resource", "example": "Vega_7_test", "maxLength": 255, "type": "string" }, "resourceUri": { "description": "resourceUri for detailed storage-pool object ", "example": "/block-storage/v1/devtype4-storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178", "type": "string" }, "systemId": { "description": "SystemID of the array", "example": "7CE809P009", "type": "string" }, "type": { "description": "The type of resource.", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "GenerateChapKeyInput": { "properties": { "hmacNum": { "description": "HMAC function to use for key transformation. Expected values are NONE | SHA256 | SHA384 | SHA512. Default value is NONE.", "enum": [ "NONE", "SHA256", "SHA384", "SHA512" ], "example": "SHA512", "type": [ "string", "null" ] }, "secret": { "description": "secret (in hexadecimal characters) to be used to initialize the key. Length of secret should be one of 64 | 96 | 128 based on hmacNum. (hmacNum, Length of secret): (NONE, 64) | (SHA256, 64) | (SHA384, 96) | (SHA512, 128)", "example": "DB174528097951E0CCF41D92476FCA228E77717F1AE82AB380FCA07A2A91ABCD", "type": "string" }, "system": { "description": "system to which NVMe/TCP initiator has connectivity", "example": "15.212.100.100", "type": "string" }, "type": { "description": "type for generate CHAP key. Allowed values are INITIATOR | TARGET.", "enum": [ "INITIATOR", "TARGET" ], "example": "INITIATOR", "type": "string" } }, "required": [ "system", "type", "secret" ], "type": [ "object", "null" ] }, "GenerateChapKeyResponse": { "properties": { "chapkey": { "description": "Generated CHAP key for NVMe/TCP initiator", "example": "DHHC-1:00:2xdFKAl5UeDM9B2SR2/KIo53cX8a6CqzgPygeiqRq83MSNuW:", "type": "string" } }, "type": [ "object", "null" ] }, "HostChapDetails": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/HostChapObject" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "HostChapInputObject": { "properties": { "initiatorChapEnabled": { "description": "Initiator CHAP enabled or disabled", "example": true, "type": [ "boolean", "null" ] }, "initiatorChapKey": { "description": "Initiator CHAP key for NVMe/TCP host", "example": "DHHC-1:01:xvNDJvVLNeOi/fC808nmnw3JTYFxRcGMkEewhdzia2P9LM6Z:", "type": "string" }, "initiatorChapName": { "description": "Name of initiator CHAP", "example": "chapnameSetDSCC", "type": [ "string", "null" ] }, "initiatorEncryptedChapSecret": { "description": "Base64 encoded Initiator CHAP Secret", "example": "dGVzdGNoYXBzZWNyZXQ", "format": "string", "type": "string" }, "system": { "description": "Host CHAP details for a given system", "example": "SGH014XGSP", "type": "string" }, "targetChapEnabled": { "description": "Target CHAP enabled or disabled", "example": true, "type": [ "boolean", "null" ] }, "targetChapKey": { "description": "Target CHAP key for NVMe/TCP host", "example": "DHHC-1:01:xvNDJvVLNeOi/fC808nmnw3JTYFxRcGMkEewhdzia2P9LM6Z:", "type": "string" }, "targetChapName": { "description": "Name of target CHAP", "example": "chapnameSetDSCC", "type": [ "string", "null" ] }, "targetEncryptedChapSecret": { "description": "Base64 encoded Target CHAP Secret", "example": "dGVzdGNoYXBzZWNyZXQ", "format": "string", "type": "string" } }, "type": [ "object", "null" ] }, "HostChapObject": { "properties": { "id": { "description": "Identifier for duplicate host group.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "initiatorChapEnabled": { "description": "Initiator CHAP enabled or disabled", "example": true, "type": [ "boolean", "null" ] }, "initiatorChapKey": { "description": "Initiator CHAP key for NVMe/TCP host", "example": "DHHC-1:01:xvNDJvVLNeOi/fC808nmnw3JTYFxRcGMkEewhdzia2P9LM6Z:", "type": [ "string", "null" ] }, "initiatorChapName": { "description": "Name of initiator CHAP set on iSCSI host", "example": "chapnameSetDSCC", "type": [ "string", "null" ] }, "initiatorEncryptedChapSecret": { "description": "Encrypted Initiator CHAP secret set on iSCSI host", "example": "aa7164fee47c0723", "format": "string", "type": [ "string", "null" ] }, "system": { "description": "Host CHAP details for a given system", "example": "SGH014XGSP", "type": [ "string", "null" ] }, "targetChapEnabled": { "description": "Target CHAP enabled or disabled", "example": true, "type": [ "boolean", "null" ] }, "targetChapKey": { "description": "Target CHAP key for NVMe/TCP host", "example": "DHHC-1:01:xvNDJvVLNeOi/fC808nmnw3JTYFxRcGMkEewhdzia2P9LM6Z:", "format": "string", "type": [ "string", "null" ] }, "targetChapName": { "description": "Name of target CHAP set on iSCSI host", "example": "chapnameSetDSCC", "type": [ "string", "null" ] }, "targetEncryptedChapSecret": { "description": "Encrypted Target CHAP secret set on iSCSI host", "example": "aa7164fee47c0723", "format": "string", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "HostDetails": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "associatedSystems": { "description": "system IDs to which the host belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "comment": { "description": "Comment", "example": "comment1", "type": [ "string", "null" ] }, "contact": { "description": "Contact information", "example": "sanjay@hpe.com", "type": [ "string", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "editStatus": { "description": "Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success.", "example": "Delete_Failed", "type": [ "string", "null" ] }, "fqdn": { "description": "Fully qualified domain name of the host.", "example": "host1.hpe.com", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hostGroups": { "description": "Host group to which the host belongs to", "items": { "$ref": "#/components/schemas/HostGroupSummaryObject" }, "type": "array" }, "id": { "description": "Identifier for host.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "initiators": { "description": "Host initiator list this host is associated with.", "items": { "$ref": "#/components/schemas/InitiatorSummary" }, "type": "array" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is created with NVMe initiator to be used by VASA vvol or not", "example": true, "type": [ "boolean", "null" ] }, "location": { "description": "location.", "example": "India", "type": [ "string", "null" ] }, "markedForDelete": { "description": "Indicates whether host group is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "model": { "description": "Model", "example": "model1", "type": [ "string", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "operatingSystem": { "description": "Host operating system.", "example": "Windows", "type": [ "string", "null" ] }, "persona": { "description": "Host persona details.", "example": "AIX-Legacy", "type": [ "string", "null" ] }, "subnet": { "description": "subnet.", "example": "255.255.255.0", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host belongs to", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator", "type": "string" }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "HostGroupDetails": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "associatedSystems": { "description": "system IDs to which the host group belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "comment": { "description": "Comment", "example": "host-group-comment", "type": [ "string", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "editStatus": { "description": "Host group Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success.", "example": "Delete_Failed", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hosts": { "description": "List of hosts.", "items": { "$ref": "#/components/schemas/HostSummaryForHSObjectDetail" }, "type": [ "array", "null" ] }, "id": { "description": "Identifier for host group.", "example": "e987ef683c27403e96caa51816ddc72c", "type": "string" }, "isMergable": { "description": "Indicates whether host has a duplicate. This field is applicable only when isMergable filter is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host group is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host group", "example": "host-group1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host group belongs to", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator-groups", "type": "string" }, "userCreated": { "description": "Idicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "HostGroupObject": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "associatedSystems": { "description": "system IDs to which the host group belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "comment": { "description": "Comment", "example": "host-group-comment", "type": [ "string", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "editStatus": { "description": "Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success. `Filter`", "example": "Delete_Failed", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hosts": { "description": "List of hosts. `Filter` by hostId. `Sort` by count.", "items": { "$ref": "#/components/schemas/HostSummaryForHSObject" }, "type": [ "array", "null" ] }, "id": { "description": "Identifier for host group. `Filter`", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "isMergable": { "description": "Indicates whether host group has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.`Sort`", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host group is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host group. `Filter, Sort`", "example": "host-group1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host group belongs to. `Filter`. `Sort` by count.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator-group", "type": "string" }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "HostGroupObjectDetails": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "associatedSystems": { "description": "system IDs to which the host group belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "comment": { "description": "Comment", "example": "host-group-comment", "type": [ "string", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "editStatus": { "description": "Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success.", "example": "Delete_Failed", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hosts": { "description": "List of hosts.", "items": { "$ref": "#/components/schemas/HostSummaryForHSObjectDetails" }, "type": "array" }, "id": { "description": "Identifier for host group.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "isMergable": { "description": "Indicates whether host group has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host group is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host group.", "example": "host-group1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host group belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator-group", "type": "string" }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "HostGroupSummaryObject": { "properties": { "id": { "description": "Identifier for host group.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "isMergable": { "description": "Indicates whether host group has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host group is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host group", "example": "host-group1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host group belongs to", "items": { "type": "string" }, "type": [ "array", "null" ] }, "userCreated": { "description": "Idicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": [ "object", "null" ] }, "HostGroupSummaryObjectDetails": { "properties": { "associatedSystems": { "description": "system IDs to which the host group belongs to.", "items": { "type": [ "string", "null" ] }, "type": [ "array", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "id": { "description": "Identifier for host group.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "isMergable": { "description": "Indicates whether host has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host group is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host group", "example": "host-group1", "type": [ "string", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator-group", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "HostGroupsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/HostGroupObject" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "HostObject": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "associatedSystems": { "description": "The system IDs the host is associated with. `Filter`", "items": { "type": "string" }, "type": [ "array", "null" ] }, "comment": { "description": "Comment", "example": "a sample host comment", "type": [ "string", "null" ] }, "contact": { "description": "Contact information", "example": "sanjay@hpe.com", "type": [ "string", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "editStatus": { "description": "Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success. `Filter`", "example": "Delete_Failed", "type": [ "string", "null" ] }, "fqdn": { "description": "Fully qualified domain name of the host.", "example": "host1.hpe.com", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hostGroups": { "description": "Host group to which the host belongs to. `Filter` by hostGroupId. `Sort` by count.", "items": { "$ref": "#/components/schemas/HostGroupSummaryObject" }, "type": "array" }, "id": { "description": "Identifier for host. `Filter`", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "initiators": { "description": "Host initiator list this host is associated with. `Filter` by initiatorId. `Sort` by count.", "items": { "$ref": "#/components/schemas/InitiatorSummary" }, "type": "array" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always. `Sort`", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is created with NVMe initiator to be used by VASA vvol or not", "example": true, "type": [ "boolean", "null" ] }, "location": { "description": "location.", "example": "India", "type": [ "string", "null" ] }, "markedForDelete": { "description": "Indicates whether host is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "model": { "description": "Model", "example": "model1", "type": [ "string", "null" ] }, "name": { "description": "Name of the host. `Filter, Sort`", "example": "host1", "type": [ "string", "null" ] }, "operatingSystem": { "description": "Host operating system. `Filter`", "example": "Windows", "type": [ "string", "null" ] }, "persona": { "description": "Host persona details.", "example": "AIX-Legacy", "type": [ "string", "null" ] }, "subnet": { "description": "subnet.", "example": "255.255.255.0", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host belongs to. `Filter`. `Sort` by count.To filter hosts based on domain, \"domain\" as a filter can be used along with \"system\" as a filter. When using this domain filter, only single system id in the request is allowed.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator", "type": "string" }, "userCreated": { "description": "Indicates whether user created host or discovered host. `Filter`", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "HostObjectDetails": { "properties": { "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "associatedSystems": { "description": "system IDs to which the host belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "comment": { "description": "Comment", "example": "a sample host comment", "type": [ "string", "null" ] }, "contact": { "description": "Contact information", "example": "sanjay@hpe.com", "type": [ "string", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "editStatus": { "description": "Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success.", "example": "Delete_Failed", "type": [ "string", "null" ] }, "fqdn": { "description": "Fully qualified domain name of the host.", "example": "host1.hpe.com", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hostGroups": { "description": "Host group to which the host belongs to.", "items": { "$ref": "#/components/schemas/HostGroupSummaryObjectDetails" }, "type": "array" }, "id": { "description": "Identifier for host.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "initiators": { "description": "Host initiator list this host is associated with.", "items": { "$ref": "#/components/schemas/InitiatorObjectDetails" }, "type": "array" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is created with NVMe initiator to be used by VASA vvol or not", "example": true, "type": [ "boolean", "null" ] }, "location": { "description": "location.", "example": "India", "type": [ "string", "null" ] }, "markedForDelete": { "description": "Indicates whether host is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "model": { "description": "Model", "example": "model1", "type": [ "string", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "operatingSystem": { "description": "Host operating system.", "example": "Windows", "type": [ "string", "null" ] }, "persona": { "description": "Host persona details.", "example": "AIX-Legacy", "type": [ "string", "null" ] }, "subnet": { "description": "subnet.", "example": "255.255.255.0", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator", "type": "string" }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "HostProximityValue": { "properties": { "groupName": { "description": "Replication Group Name", "example": "RCGName", "type": [ "string", "null" ] }, "groupUid": { "description": "Replication Group ID", "example": "rcg1", "type": [ "string", "null" ] }, "hostId": { "description": "Host ID", "example": "12345", "type": [ "string", "null" ] }, "hostName": { "description": "Host name", "example": "host1", "type": [ "string", "null" ] }, "proximitySystemName": { "description": "Host proximity value", "example": "primary", "type": [ "string", "null" ] }, "systemName": { "description": "Source system name", "example": "system1", "type": [ "string", "null" ] }, "systemUid": { "description": "Source system serial number", "example": "SGH014XGSP", "type": [ "string", "null" ] }, "targetName": { "description": "Target system name", "example": "system2", "type": [ "string", "null" ] }, "targetSystemId": { "description": "Target system serial number", "example": "7CE751P312", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "HostSummaryForHSObject": { "properties": { "id": { "description": "Identifier for host.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "initiators": { "description": "Initiator to which the host belongs to. `Sort` by count.", "items": { "$ref": "#/components/schemas/InitiatorSummary" }, "type": "array" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host group has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is created with NVMe initiator to be used by VASA vvol or not", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host belongs to", "items": { "type": "string" }, "type": [ "array", "null" ] }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" }, "HostSummaryForHSObjectDetail": { "properties": { "id": { "description": "Identifier for host.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "initiators": { "description": "Initiator to which the host belongs to.", "items": { "$ref": "#/components/schemas/InitiatorSummary" }, "type": "array" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host group has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is created with NVMe initiator to be used by VASA vvol or not", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host belongs to", "items": { "type": "string" }, "type": [ "array", "null" ] }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" }, "HostSummaryForHSObjectDetails": { "properties": { "associatedSystems": { "description": "system IDs to which the host belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "id": { "description": "Identifier for host.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "initiators": { "description": "Initiator to which the host belongs to.", "items": { "$ref": "#/components/schemas/InitiatorObjectDetails" }, "type": [ "array", "null" ] }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host group has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is used to export VASA vVol over NVMe Protocol.", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "type": { "description": "The type of resource.", "example": "host-initiator", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "HostSummaryForInitiatorObject": { "properties": { "editStatus": { "description": "Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success. `Filter`", "example": "Update_Success", "type": [ "string", "null" ] }, "hostGroups": { "description": "Host group to which the host belongs to. `Sort` by count.", "items": { "$ref": "#/components/schemas/HostGroupSummaryObject" }, "type": [ "array", "null" ] }, "id": { "description": "Identifier for host.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is created with NVMe initiator to be used by VASA vvol or not", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host belongs to", "items": { "type": "string" }, "type": [ "array", "null" ] }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": [ "object", "null" ] }, "HostSummaryForInitiatorObjectDetails": { "properties": { "hostGroups": { "description": "Host group to which the host belongs to.", "items": { "$ref": "#/components/schemas/HostGroupSummaryObject" }, "type": [ "array", "null" ] }, "id": { "description": "Identifier for host.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "ipAddress": { "description": "IP address of the host.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "isMergable": { "description": "Indicates whether host has a duplicate. This field is applicable only when isMergable `Filter` is set to true on the GET All else will be set to false always.", "example": true, "type": [ "boolean", "null" ] }, "isVvolHost": { "description": "Indicates if this host is created with NVMe initiator to be used by VASA vvol or not", "example": true, "type": [ "boolean", "null" ] }, "markedForDelete": { "description": "Indicates whether host is marked for deletion or not", "example": true, "type": [ "boolean", "null" ] }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the host belongs to", "items": { "type": "string" }, "type": [ "array", "null" ] }, "userCreated": { "description": "Indicates whether user created host or discovered host", "example": true, "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": [ "object", "null" ] }, "HostsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/HostObject" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "Initiator": { "properties": { "address": { "description": "Address of the initiator. `Filter`", "example": "100008F1EABFE61C", "type": [ "string", "null" ] }, "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "driverVersion": { "description": "Driver version of the host initiator.", "example": "4.1", "type": [ "string", "null" ] }, "firmwareVersion": { "description": "Firmware version of the host initiator.", "example": "10.0", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hbaModel": { "description": "Host bus adaptor model of the host initiator", "example": "myobject-5", "type": [ "string", "null" ] }, "hostSpeed": { "description": "Host speed", "example": 1000, "format": "int64", "type": [ "integer", "null" ] }, "hosts": { "description": "List of hosts.", "items": { "$ref": "#/components/schemas/HostSummaryForInitiatorObject" }, "type": "array" }, "id": { "description": "Identifier for an initiator.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "ipAddress": { "description": "IP address of the initiator.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "name": { "description": "Name of the initiator.", "example": "init1", "type": [ "string", "null" ] }, "pathType": { "description": "Transport type of the protocol. Valid values are FC, iSCSI ,NVMe/FC and NVMe/TCP.", "type": [ "string", "null" ] }, "protocol": { "description": "protocol supported are : FC ,iSCSI or NVMe", "example": "FC", "type": [ "string", "null" ] }, "systems": { "description": "System IDs associated with the host initiator", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "initiator", "type": "string" }, "vendor": { "description": "Vendor of the host initiator", "example": "hpe", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "InitiatorDetails": { "properties": { "address": { "description": "Address of the initiator. ", "example": "100008F1EABFE61C", "type": [ "string", "null" ] }, "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "driverVersion": { "description": "Driver version of the host initiator.", "example": "4.1", "type": [ "string", "null" ] }, "firmwareVersion": { "description": "Firmware version of the host initiator.", "example": "10.0", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hbaModel": { "description": "Host bus adaptor model of the host initiator", "example": "myobject-5", "type": [ "string", "null" ] }, "hostSpeed": { "description": "Host speed", "example": 1000, "format": "int64", "type": [ "integer", "null" ] }, "hosts": { "description": "List of hosts. `Filter` by hostId.", "items": { "$ref": "#/components/schemas/HostSummaryForInitiatorObjectDetails" }, "type": "array" }, "id": { "description": "Identifier for an initiator.", "example": "e748ef683c27403e96caa51816ddc72c", "type": "string" }, "ipAddress": { "description": "IP address of the initiator.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "name": { "description": "Name of the initiator.", "example": "init1", "type": [ "string", "null" ] }, "pathType": { "description": "Transport type of the protocol. Valid values are FC, iSCSI, NVMe/FC and NVMe/TCP.", "example": "FC", "type": [ "string", "null" ] }, "protocol": { "description": "protocol supported are : FC ,iSCSI or NVMe", "example": "FC", "type": [ "string", "null" ] }, "systems": { "description": "System IDs associated with the host initiator", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "initiator", "type": "string" }, "vendor": { "description": "Vendor of the host initiator", "example": "hpe", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "InitiatorForPost": { "properties": { "address": { "description": "Address of the initiator.", "example": "100008F1EABFE61C", "type": [ "string", "null" ] }, "associatedLinks": { "$ref": "#/components/schemas/scAssociatedLinks" }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "driverVersion": { "description": "Driver version of the host initiator.", "example": "4.1", "type": [ "string", "null" ] }, "firmwareVersion": { "description": "Firmware version of the host initiator.", "example": "10.0", "type": [ "string", "null" ] }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "hbaModel": { "description": "Host bus adaptor model of the host initiator", "example": "myobject-5", "type": [ "string", "null" ] }, "hostSpeed": { "description": "Host speed", "example": 1000, "format": "int64", "type": [ "integer", "null" ] }, "hosts": { "description": "List of hosts.", "items": { "$ref": "#/components/schemas/HostSummaryForInitiatorObjectDetails" }, "type": "array" }, "id": { "description": "Identifier for an initiator.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "ipAddress": { "description": "IP address of the initiator.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "name": { "description": "Name of the initiator.", "example": "init1", "type": [ "string", "null" ] }, "protocol": { "description": "protocol supported are : FC ,iSCSI or NVMe", "example": "FC", "type": [ "string", "null" ] }, "systems": { "description": "System IDs associated with the host initiator", "items": { "type": "string" }, "type": [ "array", "null" ] }, "type": { "description": "The type of resource.", "example": "initiator", "type": "string" }, "vendor": { "description": "Vendor of the host initiator", "example": "hpe", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "InitiatorInput": { "properties": { "address": { "description": "Address of the initiator.", "example": "iqn.1998-01.com.vmware:61f7c688-3e93-d360-8043-70106f7a7e18-0cba0054", "type": [ "string", "null" ] }, "driverVersion": { "description": "Driver version of the host initiator.", "example": "4.1", "type": [ "string", "null" ] }, "firmwareVersion": { "description": "Firmware version of the host initiator.", "example": "10.0", "type": [ "string", "null" ] }, "hbaModel": { "description": "Host bus adaptor model of the host initiator", "example": "model-5", "type": [ "string", "null" ] }, "hostSpeed": { "description": "Host speed", "example": 1000, "format": "int64", "type": [ "integer", "null" ] }, "ipAddress": { "description": "IP address of the initiator. Supported only for iSCSI and NVMe protocols", "example": "15.212.100.100", "type": [ "string", "null" ] }, "name": { "description": "Name of the initiator.", "example": "init1", "type": [ "string", "null" ] }, "protocol": { "description": "protocol supported are : FC, iSCSI or NVMe", "example": "iSCSI", "type": [ "string", "null" ] }, "vendor": { "description": "Vendor of the host initiator", "example": "hpe", "type": [ "string", "null" ] } }, "required": [ "address", "protocol" ], "type": [ "object", "null" ] }, "InitiatorList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/Initiator" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "InitiatorObjectDetails": { "properties": { "address": { "description": "Address of the initiator. ", "example": "100008F1EABFE61C", "type": [ "string", "null" ] }, "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "generation": { "description": "A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.", "example": 1627534116, "format": "int64", "type": "integer" }, "id": { "description": "Identifier for an initiator.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "ipAddress": { "description": "IP address of the initiator.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "name": { "description": "Name of the initiator.", "example": "init1", "type": [ "string", "null" ] }, "protocol": { "description": "protocol supported are : FC ,iSCSI or NVMe", "example": "FC", "type": [ "string", "null" ] }, "type": { "description": "The type of resource.", "example": "initiator", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "InitiatorSummary": { "properties": { "address": { "description": "Address of the initiator. ", "example": "100008F1EABFE61C", "type": [ "string", "null" ] }, "id": { "description": "Identifier for an initiator.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "ipAddress": { "description": "IP address of the initiator.", "example": "15.212.100.100", "type": [ "string", "null" ] }, "name": { "description": "Name of the initiator.", "type": [ "string", "null" ] }, "pathType": { "description": "Transport type of the protocol. Valid values are FC, iSCSI NVMe/FC and NVMe/TCP.", "example": "FC", "type": [ "string", "null" ] }, "systems": { "description": "system IDs to which the initiator belongs to.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "id" ], "type": [ "object", "null" ] }, "InsightDetails": { "properties": { "additionalDetails": { "type": [ "string", "null" ] }, "endTime": { "format": "int64", "type": "integer" }, "startTime": { "format": "int64", "type": "integer" } }, "type": "object" }, "InsightsData": { "properties": { "category": { "description": "Category of the insight", "enum": [ "CAPACITY", "PERFORMANCE" ], "type": "string" }, "cause": { "type": [ "string", "null" ] }, "createTime": { "description": "Timestamp for the insight.", "format": "int64", "type": "integer" }, "customerId": { "description": "Primary identifier for the customer (UUID) associated with the insight", "type": "string" }, "date": { "description": "Date in string format corresponding to the timestamp field.", "format": "date", "type": "string" }, "details": { "$ref": "#/components/schemas/InsightDetails" }, "id": { "description": "Primary identifier for the insight.", "type": "string" }, "insightDetailsUri": { "description": "URI of the insight details page", "type": "string" }, "insightUri": { "description": "URI of the insight", "type": "string" }, "lastUpdatedTime": { "format": "int64", "type": "integer" }, "remediation": { "type": [ "string", "null" ] }, "resourceDetails": { "$ref": "#/components/schemas/ResourceDetail" }, "score": { "description": "Score of the insight - 0,1,2...10", "format": "int64", "type": "integer" }, "severity": { "description": "Severity of the insight - CRITICAL, INFO, WARNING", "enum": [ "CRITICAL", "INFO", "WARNING" ], "type": "string" }, "state": { "type": "string" }, "subType": { "description": "Sub-type of the insight (eg. DISK/CPU)", "type": [ "string", "null" ] }, "symptom": { "type": [ "string", "null" ] }, "systemDetails": { "$ref": "#/components/schemas/SystemDetails" }, "systemId": { "description": "Identifier of the system", "type": "string" }, "title": { "description": "One line description of the insight", "type": "string" }, "type": { "description": "Type of the insight", "enum": [ "TIME_UNTIL_FULL", "RESOURCE_CONTENTION", "LATENCY_ANOMALIES", "HEADROOM_UTILIZATION" ], "type": "string" }, "value": { "description": "insight values - No. of annotations, saturation value", "format": "float64", "type": "number" } }, "required": [ "id", "type" ], "type": "object" }, "InsightsResponse": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/InsightsData" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "MappedDevice": { "properties": { "customerId": { "description": "The customer application identifier", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "id": { "description": "Identifier for an host/hostgroup.", "example": "d548ef683c27403e96caa51816ddc72c", "type": "string" }, "mappedDevices": { "items": { "$ref": "#/components/schemas/MappedDeviceDetails" }, "type": "array" }, "name": { "description": "Name of the host/hostgroup.", "example": "init1", "type": "string" }, "type": { "description": "The type of resource.", "example": "initiator", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "MappedDeviceDetails": { "properties": { "nameOnDevice": { "description": "Name of associated host/hostgroup on the array.", "example": "host1", "type": "string" }, "systemId": { "description": "System serial number", "example": "7CE751P312", "type": "string" }, "volumeNames": { "description": "Volume names exported to the host/hostgroup on particular array.", "items": { "$ref": "#/components/schemas/MappedVolSnap" }, "type": "array" } }, "type": [ "object", "null" ] }, "MappedDeviceList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/MappedDevice" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "MappedVolSnap": { "properties": { "name": { "description": "Name of exported volume/snapshot.", "example": "Vol1", "type": "string" }, "type": { "description": "Virtual volume type.", "example": "Volume", "type": "string" } }, "type": [ "object", "null" ] }, "RecommendationList": { "properties": { "capacityInfo": { "$ref": "#/components/schemas/capacityInfoSolo" }, "id": { "description": "uid of the array", "example": "RTYTY123", "type": "string" }, "mgmtIp": { "description": "management Ip of the array", "example": "1.2.3.4", "type": "string" }, "name": { "description": "name of the array", "example": "system_Name", "type": "string" }, "productFamily": { "description": "Storage device type. Possible values: deviceType1 and deviceType2", "example": "deviceType1", "type": "string" }, "state": { "description": "For deviceType1 State derived from ports, enclosure, disk and node state for deviceType2 state is state reported by deviceType2 array", "enum": [ "NORMAL", "DEGRADED", null ], "type": [ "string", "null" ] }, "systemWwn": { "description": "WWN of the array", "example": "2FF70002AC018D94", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ResourceDetail": { "description": "System and Resource Details", "properties": { "resourceType": { "type": "string" }, "resourceUid": { "type": "string" }, "resourceUri": { "type": "string" } }, "type": "object" }, "SystemDetails": { "description": "System and Resource Details", "properties": { "systemId": { "type": "string" }, "systemUri": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "UpdateHostChapInput": { "properties": { "items": { "items": { "$ref": "#/components/schemas/HostChapInputObject" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "UpdateHostGroupInput": { "properties": { "hostProximityValues": { "description": "Change Proximity for list of hosts", "items": { "$ref": "#/components/schemas/HostProximityValue" }, "type": "array" }, "hostsToCreate": { "description": "List of hosts to be replaced to the group", "items": { "$ref": "#/components/schemas/CreateHostInput" }, "type": [ "array", "null" ] }, "name": { "description": "Name of the host group. The maximum supported length is 251 characters. Host Group name length greater than 27 characters is supported only for HPE Alletra Storage MP B10000 systems with OS version 10.4.2 and later.", "example": "host-group1", "type": [ "string", "null" ] }, "removedHosts": { "description": "List of host IDs to be removed from the group", "items": { "type": [ "string", "null" ] }, "type": "array" }, "updatedHosts": { "description": "List of host IDs to be added to the group", "items": { "type": [ "string", "null" ] }, "type": "array" } }, "type": [ "object", "null" ] }, "UpdateHostInput": { "properties": { "initiatorsToCreate": { "description": "List of initiators to be created and added to this host", "items": { "$ref": "#/components/schemas/InitiatorInput" }, "type": "array" }, "name": { "description": "Name of the host.", "example": "host1", "type": [ "string", "null" ] }, "updatedInitiators": { "description": "List of existing initiator IDs to be replaced to the host", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "VolumeSetPerformanceHistoryData": { "description": "performance trends for given granularity and time range for a component", "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesPerf" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "endTime": { "description": "end time of history data", "example": 162564271, "type": [ "integer", "null" ] }, "historyData": { "description": "performance history data", "properties": { "volume": { "properties": { "iopsMetricsData": { "items": { "$ref": "#/components/schemas/DeviceType4metricRdWrTotHistoryData" }, "type": [ "array", "null" ] }, "latencyMetricsDataMs": { "items": { "$ref": "#/components/schemas/DeviceType4metricHistoryData" }, "type": [ "array", "null" ] }, "throughputMetricsDataKbps": { "items": { "$ref": "#/components/schemas/DeviceType4metricRdWrTotHistoryData" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "volumeSet": { "properties": { "iopsMetricsData": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4metricRdWrTotHistoryData" } ], "type": [ "object", "null" ] }, "latencyMetricsDataMs": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4metricHistoryData" } ], "type": [ "object", "null" ] }, "qosMetricsData": { "description": "Timeseries data for QoS metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/qosMetricsSeriesData" }, "type": [ "array", "null" ] }, "total": { "description": "total number of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "throughputMetricsDataKbps": { "allOf": [ { "$ref": "#/components/schemas/DeviceType4metricRdWrTotHistoryData" } ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "startTime": { "description": "start time of history data", "example": 1625556314, "type": [ "integer", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "VolumeSetPerformanceHistoryDataList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/VolumeSetPerformanceHistoryData" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "aggregateData": { "properties": { "system": { "$ref": "#/components/schemas/systemData" } }, "type": [ "object", "null" ] }, "aggregations": { "description": "Aggregated results of histogram size bucktes", "properties": { "avgPercentages": { "$ref": "#/components/schemas/avgPercentages" } }, "type": [ "object", "null" ] }, "avgPercentages": { "description": "Average percentage of performance histogram", "properties": { "read": { "$ref": "#/components/schemas/percentageBucketSet" }, "write": { "$ref": "#/components/schemas/percentageBucketSet" } }, "type": [ "object", "null" ] }, "capacityInfoSolo": { "description": "Device capacity details", "properties": { "capacitySummary": { "$ref": "#/components/schemas/capacitySummary" } }, "type": [ "object", "null" ] }, "capacitySummary": { "properties": { "free": { "description": "Total free capacity", "format": "int64", "type": [ "integer", "null" ] }, "total": { "description": "Total used capacity", "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributes": { "properties": { "cloudState": { "description": "The cloud connectivity status of the system associated with this resource", "example": "CONNECTED", "type": "string" }, "errCode": { "description": "Error code of the blocked status of the system where the resource belongs", "example": "E01", "type": [ "string", "null" ] }, "errMessage": { "description": "Reason why the system associated with the resource is blocked", "example": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributesDeviceType4Host": { "properties": { "cloudState": { "description": "Cloud connectivity status of the system where the host resource belongs", "example": "CONNECTED", "type": [ "string", "null" ] }, "errCode": { "description": "Error code of the blocked status of the system where the resource belongs", "example": "E01", "type": [ "string", "null" ] }, "errMessage": { "description": "Reason why the system associated with the resource is blocked", "example": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributesDeviceType4HostPath": { "properties": { "cloudState": { "description": "Cloud connectivity status of the system where the host-path resource belongs", "example": "CONNECTED", "type": [ "string", "null" ] }, "errCode": { "description": "Error code of the blocked status of the system where the resource belongs", "example": "E01", "type": [ "string", "null" ] }, "errMessage": { "description": "Reason why the system associated with the resource is blocked", "example": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributesDeviceType4HostSet": { "properties": { "cloudState": { "description": "Cloud connectivity status of the system where the host-set resource belongs", "example": "CONNECTED", "type": [ "string", "null" ] }, "errCode": { "description": "Error code of the blocked status of the system where the resource belongs", "example": "E01", "type": [ "string", "null" ] }, "errMessage": { "description": "Reason why the system associated with the resource is blocked", "example": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributesPerf": { "properties": { "cloudState": { "description": "Cloud connectivity status of the system to which the resource belongs.", "example": "CONNECTED", "type": [ "string", "null" ] }, "errCode": { "description": "Error code of the blocked status of the system where the resource belongs", "example": "E01", "type": [ "string", "null" ] }, "errMessage": { "description": "Reason why the system associated with the resource is blocked", "example": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "commonResourceAttributesfleet": { "properties": { "cloudState": { "description": "Cloud connectivity status of the system where the volume resource belongs", "example": "CONNECTED", "type": [ "string", "null" ] }, "errCode": { "description": "Error code of the blocked status of the system where the resource belongs", "example": "E01", "type": [ "string", "null" ] }, "errMessage": { "description": "Reason why the system associated with the resource is blocked", "example": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "driftBuckets": { "description": "IO size buckets in which drifts are observed", "items": { "properties": { "bucketName": { "description": "Bucket name in which drifts are detected", "example": 128, "type": "number" }, "bucketUnit": { "description": "Metric of the bucket in which drift is detected", "example": "KiB", "type": "string" } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "driftsDetected": { "description": "Drifts detected in the selected duration", "items": { "properties": { "actualEndTime": { "description": "Actual end time of the Drift.", "example": 1669880791, "type": "number" }, "actualStartTime": { "description": "Actual start time of the Drift.", "example": 1669880791, "type": "number" }, "avg90thPercentile": { "description": "90th quantile of latency", "example": 0.98, "format": "float64", "type": "number" }, "driftBuckets": { "$ref": "#/components/schemas/driftBuckets" }, "endTime": { "description": "End time of the Drift", "example": 1669880791, "type": "number" }, "iotype": { "description": "Drift detected in operation type", "example": "read", "type": "string" }, "latencyRangeUnit": { "description": "Metric of the latency range", "example": "ms", "type": "string" }, "maxLatencyLowerRange": { "description": "Floor of the latency bucket", "example": 6, "type": "number" }, "maxLatencyUpperRange": { "description": "Ceiling of the latency bucket", "example": 8, "type": "number" }, "startTime": { "description": "Start time of the Drift", "example": 1669880791, "type": "number" }, "updated": { "description": "Specifies if the values are changed.", "type": "boolean" } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "fleetAssociatedLinks": { "description": "Associated Links Details", "example": [ { "resourceUri": "/storage-fleet/v1/storage-systems", "type": "storage-systems" }, { "resourceUri": "/block-storage/v1/storage-systems/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178/volumes", "type": "volumes" } ], "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Type", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "fleetSystemVolumeset": { "properties": { "appType": { "description": "Application name `Filter`", "example": "Oracle Database", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesfleet" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "generation": { "description": "generation `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "id": { "description": "id of the volume set", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "name": { "description": "name of volume-set", "example": "snap11", "type": [ "string", "null" ] }, "productFamily": { "description": "Product Family", "example": "deviceType1", "type": [ "string", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/block-storage/v1/storage-systems/volume-sets", "type": [ "string", "null" ] }, "systemId": { "description": "system ID.", "example": "7CE751P312", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "volumesCount": { "description": "The number of volumes in an application", "example": 5, "type": [ "integer", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "fleetVolumeDetails": { "properties": { "associatedLinks": { "description": "Associated Links", "example": [ { "resourceUri": "/block-storage/v1/storage-systems/storage-pools/{uid}", "type": "storage-pools" }, { "resourceUri": "/block-storage/v1/storage-systems/volume-sets/{uid}", "type": "volume-sets" }, { "resourceUri": "/block-storage/v1/storage-systems/{uid}", "type": "systems" } ], "items": { "properties": { "resourceUri": { "description": "Resource URI", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesfleet" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "healthState": { "description": "Health State of volume.`", "example": "NORMAL", "type": [ "string", "null" ] }, "hostWrittenCapacityMiB": { "description": "Host written data size in MiB.", "format": "float64", "type": [ "number", "null" ] }, "id": { "description": "UUID string uniquely identifying the storage system object.", "type": "string" }, "intrinsicResource": { "description": "Type of volume", "example": "volume", "type": [ "string", "null" ] }, "isInternal": { "description": "boolean value which specifies if it is a systemVolume or not `Filter`", "example": false, "type": [ "boolean", "null" ] }, "isRansomwareDegraded": { "description": "A boolean value that specifies if the volume is in degraded state due to ransomware.", "example": false, "type": [ "boolean", "null" ] }, "name": { "description": "A user friendly name to identify the storage system volume (resourceName).", "example": "Finance", "type": [ "string", "null" ] }, "productFamily": { "description": "Product Family", "example": "deviceType1", "type": [ "string", "null" ] }, "provisionedSizeMiB": { "description": "Provisioned Size in MiB", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/block-storage/v1/storage-systems/2FF70002AC01F0FF/volumes/{uid}", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "spaceWarning": { "$ref": "#/components/schemas/spaceWarning" }, "subType": { "description": "subType of the volume", "example": "PROVTYPE_DDS", "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/Serial Number of the array.", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinSavings": { "description": "Thin savings", "example": "1:1", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "usedCapacityPercent": { "description": "Used capacity percentage of volume. `Filter, Sort`", "example": 1.2345, "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "volumeSetId": { "description": "SystemUid/serialNumber of the volumeSet.", "example": "7CE751P312", "type": [ "string", "null" ] }, "volumeType": { "description": "VV Type", "example": "VVTYPE_BASE", "type": [ "string", "null" ] }, "wwn": { "description": "Volume wwn.", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "fleetVolumeDetailsList": { "properties": { "associatedLinks": { "description": "Associated Links", "example": [ { "resourceUri": "/block-storage/v1/storage-systems/storage-pools/{uid}", "type": "storage-pools" }, { "resourceUri": "/block-storage/v1/storage-systems/volume-sets/{uid}", "type": "volume-sets" }, { "resourceUri": "/block-storage/v1/storage-systems/{uid}", "type": "systems" } ], "items": { "properties": { "resourceUri": { "description": "Resource URI", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesfleet" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "healthState": { "description": "Health State of volume. `Filter, Sort`", "example": "NORMAL", "type": [ "string", "null" ] }, "hostWrittenCapacityMiB": { "description": "Host written data size in MiB. `Filter, Sort`", "example": 0, "format": "float64", "type": [ "number", "null" ] }, "id": { "description": "UUID string uniquely identifying the storage system object. `Filter`", "example": "e66ed5ce8d35961481a48b4f78bb06b4", "type": "string" }, "intrinsicResource": { "description": "type of volume", "example": "volume", "type": [ "string", "null" ] }, "isInternal": { "description": "boolean value which specifies if it is a systemVolume or not", "example": false, "type": [ "boolean", "null" ] }, "isRansomwareDegraded": { "description": "A boolean value that specifies if the volume is in degraded state due to ransomware.", "example": false, "type": [ "boolean", "null" ] }, "name": { "description": "A user friendly name to identify the storage system volume (resourceName). `Filter, Sort`", "example": "Finance", "type": [ "string", "null" ] }, "productFamily": { "description": "Product Family", "example": "deviceType1", "type": [ "string", "null" ] }, "provisionedSizeMiB": { "description": "Provisioned Size in MiB", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/block-storage/v1/storage-systems/volumes", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MiB `Filter, Sort`", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "spaceWarning": { "$ref": "#/components/schemas/spaceWarning" }, "subType": { "description": "subType of the volume", "example": "PROVTYPE_DDS", "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/Serial Number of the array. `Filter, Sort`", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinSavings": { "description": "Thin savings", "example": "1:1", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "volume", "type": "string" }, "usedCapacityPercent": { "description": "Used capacity percentage of volume.", "example": 1.2345, "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "volumeSetId": { "description": "SystemUid/serialNumber of the volumeSet.", "example": "7CE751P312", "type": [ "string", "null" ] }, "volumeType": { "description": "VV Type", "example": "VVTYPE_BASE", "type": [ "string", "null" ] }, "wwn": { "description": "Volume wwn.", "example": "60002AC0000000000000006B0001FFEB", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "fleetVolumeDetailsListWithoutRansomware": { "properties": { "associatedLinks": { "description": "Associated Links", "example": [ { "resourceUri": "/block-storage/v1/storage-systems/storage-pools/{uid}", "type": "storage-pools" }, { "resourceUri": "/block-storage/v1/storage-systems/volume-sets/{uid}", "type": "volume-sets" }, { "resourceUri": "/block-storage/v1/storage-systems/{uid}", "type": "systems" } ], "items": { "properties": { "resourceUri": { "description": "Resource URI", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesfleet" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": [ "string", "null" ] }, "generation": { "description": "generation", "example": 0, "type": [ "integer", "null" ] }, "healthState": { "description": "Health State of volume. `Filter, Sort`", "example": "NORMAL", "type": [ "string", "null" ] }, "hostWrittenCapacityMiB": { "description": "Host written data size in MiB. `Filter, Sort`", "example": 0, "format": "float64", "type": [ "number", "null" ] }, "id": { "description": "UUID string uniquely identifying the storage system object. `Filter`", "example": "e66ed5ce8d35961481a48b4f78bb06b4", "type": "string" }, "intrinsicResource": { "description": "type of volume", "example": "volume", "type": [ "string", "null" ] }, "isInternal": { "description": "boolean value which specifies if it is a systemVolume or not", "example": false, "type": [ "boolean", "null" ] }, "name": { "description": "A user friendly name to identify the storage system volume (resourceName). `Filter, Sort`", "example": "Finance", "type": [ "string", "null" ] }, "productFamily": { "description": "Product Family", "example": "deviceType1", "type": [ "string", "null" ] }, "provisionedSizeMiB": { "description": "Provisioned Size in MiB", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/block-storage/v1/storage-systems/volumes", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MiB `Filter, Sort`", "example": 2048, "format": "float64", "type": [ "number", "null" ] }, "spaceWarning": { "$ref": "#/components/schemas/spaceWarning" }, "subType": { "description": "subType of the volume", "example": "PROVTYPE_DDS", "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid/Serial Number of the array. `Filter, Sort`", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinSavings": { "description": "Thin savings", "example": "1:1", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "volume", "type": "string" }, "usedCapacityPercent": { "description": "Used capacity percentage of volume.", "example": 1.2345, "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "volumeSetId": { "description": "SystemUid/serialNumber of the volumeSet.", "example": "7CE751P312", "type": [ "string", "null" ] }, "volumeType": { "description": "VV Type", "example": "VVTYPE_BASE", "type": [ "string", "null" ] }, "wwn": { "description": "Volume wwn.", "example": "60002AC0000000000000006B0001FFEB", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "fleetVolumeSetDetailsWithoutRansomware": { "properties": { "appType": { "description": "Application name `Filter`", "example": "Oracle Database", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesfleet" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "exportStatus": { "description": "Export status", "example": "PARTIALLY_EXPORTED", "type": [ "string", "null" ] }, "generation": { "description": "generation `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "healthState": { "description": "health state", "type": [ "string", "null" ] }, "hostWrittenCapacityMiB": { "description": "Host written capacity in MiB", "format": "float64", "type": [ "number", "null" ] }, "id": { "description": "id of the volume set `Filter`", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "intrinsicResource": { "description": "Intrinsic resource type", "type": [ "string", "null" ] }, "iops": { "description": "IOPS", "format": "float64", "type": [ "number", "null" ] }, "isInternal": { "description": "Is an internal resource", "type": [ "boolean", "null" ] }, "latency": { "description": "Latency", "format": "float64", "type": [ "number", "null" ] }, "location": { "description": "location", "type": [ "string", "null" ] }, "name": { "description": "name of volume-set `Filter, Sort`", "example": "snap11", "type": [ "string", "null" ] }, "productFamily": { "description": "Product Family", "example": "deviceType1", "type": [ "string", "null" ] }, "provisionedSizeMiB": { "description": "Provisioned size in MiB", "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/block-storage/v1/storage-systems/volume-sets", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "spaceWarning": { "description": "Space warning set for the resource", "format": "float64", "type": [ "number", "null" ] }, "subType": { "description": "subType", "type": [ "string", "null" ] }, "systemId": { "description": "system ID. `Filter, Sort`", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinSavings": { "description": "ThinSavings", "type": [ "string", "null" ] }, "throughPut": { "description": "ThroughPut for the resource", "format": "float64", "type": [ "number", "null" ] }, "totalReservedMiB": { "description": "Total reserved MiB for the resource", "format": "float64", "type": [ "number", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "usedCapacityPercent": { "description": "Used capacity percentage", "format": "float64", "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Used size in MiB", "format": "float64", "type": [ "number", "null" ] }, "volumeSetId": { "description": "UID of the volume set Id", "type": [ "string", "null" ] }, "volumeType": { "description": "Type of volume", "type": [ "string", "null" ] }, "volumesCount": { "description": "The number of volumes in an application", "example": 5, "type": [ "integer", "null" ] }, "vvSetType": { "description": "Type of the volume-set", "example": "VVSET", "maxLength": 255, "type": [ "string", "null" ] }, "wwn": { "description": "wwn of the volume", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "fleetVolumeSetList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/fleetVolumeset" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "fleetVolumeSetListWithoutRansomware": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/fleetVolumesetWithoutRansomware" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "fleetVolumesList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/fleetVolumeDetailsList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "fleetVolumesListWithoutRansomware": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/fleetVolumeDetailsListWithoutRansomware" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "fleetVolumeset": { "properties": { "appType": { "description": "Application name `Filter`", "example": "Oracle Database", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesfleet" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "generation": { "description": "generation `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "healthState": { "description": "health state", "type": [ "string", "null" ] }, "hostWrittenCapacityMiB": { "description": "Host written capacity in MiB", "format": "float64", "type": [ "number", "null" ] }, "id": { "description": "id of the volume set `Filter`", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "intrinsicResource": { "description": "Intrinsic resource type", "type": [ "string", "null" ] }, "iops": { "description": "IOPS", "format": "float64", "type": [ "number", "null" ] }, "isInternal": { "description": "Is an internal resource", "type": [ "boolean", "null" ] }, "isRansomwareDegraded": { "description": "A boolean value that specifies if the volume is in degraded state due to ransomware.", "example": false, "type": [ "boolean", "null" ] }, "latency": { "description": "Latency", "format": "float64", "type": [ "number", "null" ] }, "location": { "description": "location", "type": [ "string", "null" ] }, "name": { "description": "name of volume-set `Filter, Sort`", "example": "snap11", "type": [ "string", "null" ] }, "productFamily": { "description": "Product Family", "example": "deviceType1", "type": [ "string", "null" ] }, "provisionedSizeMiB": { "description": "Provisioned size in MiB", "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/block-storage/v1/storage-systems/volume-sets", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "spaceWarning": { "description": "Space warning set for the resource", "format": "float64", "type": [ "number", "null" ] }, "subType": { "description": "subType", "type": [ "string", "null" ] }, "systemId": { "description": "system ID. `Filter, Sort`", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinSavings": { "description": "ThinSavings", "type": [ "string", "null" ] }, "throughPut": { "description": "ThroughPut for the resource", "format": "float64", "type": [ "number", "null" ] }, "totalReservedMiB": { "description": "Total reserved MiB for the resource", "format": "float64", "type": [ "number", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "usedCapacityPercent": { "description": "Used capacity percentage", "format": "float64", "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Used size in MiB", "format": "float64", "type": [ "number", "null" ] }, "volumeSetId": { "description": "UID of the volume set Id", "type": [ "string", "null" ] }, "volumeType": { "description": "Type of volume", "type": [ "string", "null" ] }, "volumesCount": { "description": "The number of volumes in an application", "example": 5, "type": [ "integer", "null" ] }, "wwn": { "description": "wwn of the volume", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "fleetVolumesetWithoutRansomware": { "properties": { "appType": { "description": "Application name `Filter`", "example": "Oracle Database", "type": [ "string", "null" ] }, "associatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource Uri", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": [ "object", "null" ] }, "type": "array" }, "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributesfleet" }, "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "generation": { "description": "generation `Filter, Sort`", "example": 0, "type": [ "integer", "null" ] }, "healthState": { "description": "health state", "type": [ "string", "null" ] }, "hostWrittenCapacityMiB": { "description": "Host written capacity in MiB", "format": "float64", "type": [ "number", "null" ] }, "id": { "description": "id of the volume set `Filter`", "example": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0", "type": "string" }, "intrinsicResource": { "description": "Intrinsic resource type", "type": [ "string", "null" ] }, "iops": { "description": "IOPS", "format": "float64", "type": [ "number", "null" ] }, "isInternal": { "description": "Is an internal resource", "type": [ "boolean", "null" ] }, "latency": { "description": "Latency", "format": "float64", "type": [ "number", "null" ] }, "location": { "description": "location", "type": [ "string", "null" ] }, "name": { "description": "name of volume-set `Filter, Sort`", "example": "snap11", "type": [ "string", "null" ] }, "productFamily": { "description": "Product Family", "example": "deviceType1", "type": [ "string", "null" ] }, "provisionedSizeMiB": { "description": "Provisioned size in MiB", "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri for detailed volume object", "example": "/block-storage/v1/storage-systems/volume-sets", "type": [ "string", "null" ] }, "sizeMiB": { "description": "Size in MiB", "format": "float64", "type": [ "number", "null" ] }, "spaceWarning": { "description": "Space warning set for the resource", "format": "float64", "type": [ "number", "null" ] }, "subType": { "description": "subType", "type": [ "string", "null" ] }, "systemId": { "description": "system ID. `Filter, Sort`", "example": "7CE751P312", "type": [ "string", "null" ] }, "thinSavings": { "description": "ThinSavings", "type": [ "string", "null" ] }, "throughPut": { "description": "ThroughPut for the resource", "format": "float64", "type": [ "number", "null" ] }, "totalReservedMiB": { "description": "Total reserved MiB for the resource", "format": "float64", "type": [ "number", "null" ] }, "type": { "description": "type", "example": "string", "type": "string" }, "usedCapacityPercent": { "description": "Used capacity percentage", "format": "float64", "type": [ "number", "null" ] }, "usedSizeMiB": { "description": "Used size in MiB", "format": "float64", "type": [ "number", "null" ] }, "volumeSetId": { "description": "UID of the volume set Id", "type": [ "string", "null" ] }, "volumeType": { "description": "Type of volume", "type": [ "string", "null" ] }, "volumesCount": { "description": "The number of volumes in an application", "example": 5, "type": [ "integer", "null" ] }, "wwn": { "description": "wwn of the volume", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "headroomContribution": { "description": "system headroom contribution by volumes", "properties": { "associatedLinks": { "$ref": "#/components/schemas/DeviceType4sysAssociatedLinks" }, "averageHeadroomUtilization": { "$ref": "#/components/schemas/aggregateData" }, "customerId": { "description": "id specific to the customer", "type": "string" }, "endTime": { "description": "endTime refers to last/ending period of the interval for which contributors are fetched", "example": 1669880791, "type": "number" }, "headroomContribution": { "$ref": "#/components/schemas/headroomResponse" }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "remaining": { "$ref": "#/components/schemas/resourcesResponse" }, "resourceType": { "description": "Resource type - volumes", "type": "string" }, "startTime": { "description": "startTime refers to starting period of the interval for which contributors are fetched", "example": 1669794391, "type": "number" }, "system": { "$ref": "#/components/schemas/resourcesResponse" }, "systemId": { "description": "Serial Number of the array", "example": "7CEFVC12", "type": [ "string", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "headroomContributionList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/headroomContribution" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "headroomResources": { "properties": { "resourceName": { "description": "Name of the resource", "example": "test-volume", "type": [ "string", "null" ] }, "seriesData": { "items": { "$ref": "#/components/schemas/timeSeriesData" }, "type": [ "array", "null" ] } }, "type": "object" }, "headroomResponse": { "properties": { "resources": { "items": { "$ref": "#/components/schemas/headroomResources" }, "type": [ "array", "null" ] } }, "type": "object" }, "histogramBucket": { "description": "Histogram data of io buckets", "items": { "properties": { "name": { "description": "Name of the histogram bucket", "example": "2K", "type": "string" }, "percentage": { "description": "Percentage of I/O in respective histogram bucket", "example": 20, "format": "float64", "type": "number" }, "value": { "description": "Number of I/Os in respective histogram bucket", "example": 1151, "type": "number" } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "historicalData": { "description": "List of DISK/CPU metric per timestamp", "properties": { "timestampMs": { "description": "Timestamp in epoch milliseconds for which the metrics are listed", "example": 1669794420000, "type": "number" }, "value": { "description": "metric value for disk/cpu", "example": 0.47, "format": "float64", "type": "number" } }, "type": "object" }, "hostHistoricalMetricData": { "description": "Timeseries data for particular metric type", "properties": { "items": { "items": { "$ref": "#/components/schemas/hostMetricSeriesData" }, "type": [ "array", "null" ] }, "total": { "description": "count of series data", "example": 1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "hostHistoryData": { "description": "Performance history data for given time range and granularily for a volume", "properties": { "iopsMetricsData": { "items": { "$ref": "#/components/schemas/hostPerfHistory" }, "type": [ "array", "null" ] }, "latencyMetricsDataMs": { "items": { "$ref": "#/components/schemas/hostPerfHistory" }, "type": [ "array", "null" ] }, "throughputMetricsDataKbps": { "items": { "$ref": "#/components/schemas/hostPerfHistory" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "hostMetricSeriesData": { "properties": { "read": { "description": "read metric value at particular timestamp", "example": 0.0005, "format": "float64", "type": [ "number", "null" ] }, "timestampMs": { "description": "epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] }, "value": { "description": "average metric value at particular timestamp", "example": 46, "format": "float64", "type": [ "number", "null" ] }, "write": { "description": "write metric value at particular timestamp", "example": 0.3, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "hostPerfHistory": { "properties": { "historicalData": { "$ref": "#/components/schemas/hostHistoricalMetricData" }, "id": { "description": "The id of the volume", "example": "60002AC0000000000000001B00025BB2", "type": "string" }, "systemId": { "description": "The id of the system", "example": "SGH014XGSP", "type": [ "string", "null" ] }, "volumeName": { "description": "The name of the volume", "example": "test-vv", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "hostStoragePerformanceHistory": { "properties": { "customerId": { "description": "customerId", "example": "string", "type": [ "string", "null" ] }, "hostVolumePerfTrendData": { "$ref": "#/components/schemas/hostHistoryData" }, "id": { "description": "ID of the resource", "example": "e66ed5ce8d35961481a48b4f78bb06b4", "type": "string" }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "hostStoragePerformanceHistoryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/hostStoragePerformanceHistory" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "hostStorageVolumes": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/hostVolumes" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "hostVolumes": { "properties": { "commonResourceAttributes": { "$ref": "#/components/schemas/commonResourceAttributes" }, "customerId": { "description": "customerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "id": { "description": "ID of the resource", "example": "e66ed5ce8d35961481a48b4f78bb06b4", "type": "string" }, "intrinsicResource": { "description": "type of volume", "example": "vvol", "type": [ "string", "null" ] }, "iops": { "description": "IOPS", "example": 4702, "format": "float64", "type": [ "number", "null" ] }, "latencyMs": { "description": "Latency in ms", "example": 1.2, "format": "float64", "type": [ "number", "null" ] }, "lunId": { "description": "lunid", "example": 0, "format": "int64", "type": [ "integer", "null" ] }, "pathCount": { "description": "The number of connections from that volume", "example": 2, "type": [ "integer", "null" ] }, "readLatency": { "description": "Latency in ms", "example": 1.2, "format": "float64", "type": [ "number", "null" ] }, "resourceUri": { "description": "resourceUri of the volume", "example": "/storage-fleet/v1/devtype4-storage-systems/7CE738P06J/volumes/e1839c72fef8784f2c77194efb8b2620", "type": [ "string", "null" ] }, "systemId": { "description": "SystemUid of the system associated with the volume", "example": "7CE751P312", "type": [ "string", "null" ] }, "targetNqn": { "description": "Subsystem NQN id for the NVMe host to which the volume is exported", "example": "nqn.2021-04.com.hpe:volume-1", "type": [ "string", "null" ] }, "throughputKbps": { "description": "The throughput in kbps", "example": 477219.2, "format": "float64", "type": [ "number", "null" ] }, "type": { "description": "type", "example": "Type of the resource", "type": "string" }, "volumeName": { "description": "The name of the volume", "example": "test-vv", "type": [ "string", "null" ] }, "writeLatency": { "description": "Latency in ms", "example": 1.2, "format": "float64", "type": [ "number", "null" ] }, "wwn": { "description": "Volume wwn.", "example": "60002AC0000000000000006B0001FFEB", "type": [ "string", "null" ] } }, "required": [ "id", "type" ], "type": "object" }, "hotspots": { "description": "Hotspots response structure", "properties": { "associatedLinks": { "$ref": "#/components/schemas/DeviceType4sysAssociatedLinks" }, "customerId": { "description": "CustomerId", "type": "string" }, "endTime": { "description": "End time of the interval for which hotspots are calculated", "example": 1669880791, "type": "number" }, "hotspots": { "$ref": "#/components/schemas/hotspotsDataPerCategory" }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "metricType": { "description": "Metric which is used to calculate hotspots", "example": "latency", "type": "string" }, "resourceType": { "description": "Resource for which hotspots is calculated", "example": "volumes", "type": "string" }, "startTime": { "description": "Start time of the interval for which hotspots are calculated", "example": 1669794391, "type": "number" }, "systemId": { "description": "Serial number of the array", "example": "ABC239XFZ9", "type": "string" }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "hotspotsDataPerCategory": { "description": "Contains the hotspots metrics per operation i.e., read and write", "properties": { "readHotspots": { "description": "Contains the list of hotspots metrics for read based on metricType", "items": { "$ref": "#/components/schemas/hotspotsDataPerOperation" }, "type": [ "array", "null" ] }, "writeHotspots": { "description": "Contains the list of hotspots metrics for write based on metricType", "items": { "$ref": "#/components/schemas/hotspotsDataPerOperation" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "hotspotsDataPerOperation": { "description": "Conatins the resource name along with the hotspots metrics per timestamp", "properties": { "maxValue": { "description": "The max value for metricType and resourceType", "example": 7.88, "format": "float64", "type": "number" }, "resourceId": { "description": "Id of the resource for which the metrics are listed", "example": "34d6c72ba337757dde27e4a31971a46f", "type": "string" }, "resourceName": { "description": "Name of the resource for which the metrics are listed", "example": "VV0081", "type": "string" }, "seriesData": { "items": { "$ref": "#/components/schemas/hotspotsDataPerTimestamp" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "hotspotsDataPerTimestamp": { "description": "List of hotspots metrics per timestamp", "properties": { "timestampMs": { "description": "Timestamp in epoch milliseconds for which the metrics are listed", "example": 1669794420000, "type": "number" }, "value": { "description": "metric value for example latency value", "example": 0.47, "format": "float64", "type": "number" } }, "type": [ "object", "null" ] }, "hotspotsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/hotspots" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "latencyAnnotationMetrics": { "description": "Volume latency annotations response structure", "properties": { "latencyQtl90": { "description": "Value of 90th quantile of time histogram", "example": 6.21, "format": "float64", "type": "number" }, "maxRange": { "description": "Maximum range of values in time histogram", "example": "6ms-8ms", "type": "string" }, "timestampMs": { "description": "Timestamp in milliseconds", "example": 1669880791, "type": "number" } }, "type": "object" }, "latencyAnnotations": { "description": "Volume latency annotations response structure", "properties": { "read": { "items": { "$ref": "#/components/schemas/latencyAnnotationMetrics" }, "type": [ "array", "null" ] }, "write": { "items": { "$ref": "#/components/schemas/latencyAnnotationMetrics" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "percentageBucketSet": { "description": "List of histogram size buckets and respective average percentage of I/O throughout the interval", "items": { "properties": { "name": { "description": "Name of the histogram bucket", "example": "2K", "type": "string" }, "percentage": { "description": "Average Percentage of I/O happened in size bucket throughout the interval", "example": 20, "format": "float64", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "qosMetricsSeriesData": { "description": "QOS configuration time series data of volume set", "properties": { "bwLimitKbps": { "description": "Time series data of QoS throughput threshold limit", "example": 10, "format": "int64", "type": [ "number", "null" ] }, "iopsLimit": { "description": "Time series data of QoS IOPS threshold limit", "example": 1000, "format": "int64", "type": [ "number", "null" ] }, "timestampms": { "description": "Epoch timestamp", "example": 1605063600, "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "recommendationInput": { "description": "Request body for creating provisioning Workflow", "properties": { "hostGroupId": { "description": "host group id", "example": "a7c4e6593f51d0b98f0e40d7e6df04fd", "type": [ "string", "null" ] }, "productFamily": { "description": "Storage device type", "type": [ "string", "null" ] }, "sizeMib": { "description": "volume size requirement", "example": 16384, "type": "integer" } }, "required": [ "sizeMib" ], "type": [ "object", "null" ] }, "resourceContention": { "description": "Resource contention response structure", "properties": { "associatedLinks": { "$ref": "#/components/schemas/DeviceType4sysAssociatedLinks" }, "cpuContention": { "$ref": "#/components/schemas/resourceContentionData" }, "customerId": { "description": "CustomerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "diskContention": { "$ref": "#/components/schemas/resourceContentionData" }, "endTime": { "description": "End time of the interval for which resource contention is computed", "example": 1669880791, "type": "number" }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "iomRecommended": { "description": "Indicates if resource-contention is IOM based Storage CPU Contention", "example": true, "type": "boolean" }, "startTime": { "description": "Start time of the interval for which resource contention is computed", "example": 1669794391, "type": "number" }, "systemId": { "description": "Serial number of the array", "example": "ABC239XFZ9", "type": "string" }, "type": { "description": "type", "example": "Type of the resource", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "resourceContentionContributors": { "description": "Top volume contributors for resource contention response structure", "properties": { "appsetType": { "description": "Appset Type", "example": "Oracle", "type": "string" }, "provType": { "description": "Provisioning Type", "example": "tpvv", "type": "string" }, "readLatency": { "description": "Read Latency", "example": 40.25, "format": "float64", "type": "number" }, "readThroughput": { "description": "Read Throughput", "example": 17.25, "format": "float64", "type": "number" }, "totalIops": { "description": "Total Iops", "example": 22.36, "format": "float64", "type": "number" }, "volumeName": { "description": "VolumeName", "example": "VV-S2444-IOPS-1.0", "type": "string" }, "volumeStatus": { "description": "Volume Status", "example": "Normal", "type": "string" }, "volumeUid": { "description": "VolumeId", "example": "bdce8ba359c68370085e66bf2615c30d", "type": "string" }, "writeLatency": { "description": "Write Latency", "example": 85.25, "format": "float64", "type": "number" }, "writeThroughput": { "description": "Write Throughput", "example": 20.75, "format": "float64", "type": "number" } }, "type": "object" }, "resourceContentionData": { "description": "Resource contention per resource response structure", "properties": { "resourceMetricData": { "items": { "$ref": "#/components/schemas/historicalData" }, "type": [ "array", "null" ] }, "topContributors": { "items": { "$ref": "#/components/schemas/resourceContentionContributors" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "resourceContentionList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/resourceContention" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "resourcesResponse": { "items": { "$ref": "#/components/schemas/timeSeriesData" }, "type": [ "array", "null" ] }, "scAssociatedLinks": { "description": "Associated Links Details", "items": { "properties": { "resourceUri": { "description": "Resource URI", "type": [ "string", "null" ] }, "type": { "description": "Resource Name", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "seriesData": { "description": "Size histogram data structure", "items": { "properties": { "readBuckets": { "$ref": "#/components/schemas/histogramBucket" }, "timestamp": { "description": "Timestamp in epoch milliseconds for which the metrics are listed", "example": 1669794420000, "type": "number" }, "writeBuckets": { "$ref": "#/components/schemas/histogramBucket" } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "sizeHistogramData": { "description": "Size histogram data structure", "properties": { "aggs": { "$ref": "#/components/schemas/aggregations" }, "seriesData": { "$ref": "#/components/schemas/seriesData" } }, "type": [ "object", "null" ] }, "spaceWarning": { "description": "User alloc space warning", "format": "float64", "type": [ "number", "null" ] }, "storagePoolsFleetSummaryList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/FleetPoolList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "storageSystemRecommendationList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/RecommendationList" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "systemData": { "properties": { "headroom": { "description": "headroom utilized on system", "example": 12.29, "format": "float64", "type": "number" }, "headroomUtilised": { "description": "headroom utilized in terms of Low/Medium/High", "example": "High", "type": "string" } }, "type": [ "object", "null" ] }, "taskResponse": { "properties": { "message": { "description": "Task Message.", "example": "Successfully submitted", "type": "string" }, "status": { "description": "Status of the task.", "example": "SUBMITTED", "type": "string" }, "taskUri": { "description": "Task URI which can be used to monitor the status of the operation.", "example": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c", "type": "string" } }, "required": [ "taskUri" ], "type": "object" }, "timeSeriesData": { "properties": { "headroom": { "description": "headroom utilized on resource", "example": 12.29, "format": "float64", "type": "number" }, "headroomPct": { "description": "headroom percentage contribution from resource on system", "example": 20, "format": "float64", "type": [ "number", "null" ] }, "headroomUtilized": { "description": "headroom utilized in terms of Low/Medium/High", "example": "High", "type": "string" }, "timestampMs": { "description": "timestamp for which the metrics are present", "example": 1669794420000, "type": "number" } }, "type": "object" }, "volumeLatencyAnnotations": { "description": "Volume latency annotations response structure", "properties": { "associatedLinks": { "$ref": "#/components/schemas/DeviceType4volAssociatedLinks" }, "customerId": { "description": "CustomerId", "example": "fc5f41652a53497e88cdcebc715cc1cf", "type": "string" }, "endTime": { "description": "End time of the interval for which annotated points are returned", "example": 1669880791, "type": "number" }, "id": { "description": "ID of the resource", "type": "string" }, "latencyAnnotations": { "$ref": "#/components/schemas/latencyAnnotations" }, "startTime": { "description": "Start time of the interval for which annotated points are selected", "example": 1669794391, "type": "number" }, "systemId": { "description": "Serial number of the array", "example": "ABC239XFZ9", "type": "string" }, "type": { "description": "Type of the resource", "type": "string" }, "volumeId": { "description": "VolumeId", "example": "60002AC000000000000005B200029834", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "volumeLatencyAnnotationsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/volumeLatencyAnnotations" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] }, "volumePerformanceDrifts": { "description": "Response structure of read and write latency drifts", "properties": { "associatedLinks": { "$ref": "#/components/schemas/DeviceType4volAssociatedLinks" }, "customerId": { "description": "Customer identification attribute", "example": "fc5f41652a53497e88cdcebc715xxxxx", "type": "string" }, "driftsDetected": { "$ref": "#/components/schemas/driftsDetected" }, "endTime": { "description": "End time of the drift detection interval", "example": 1669880791, "type": "number" }, "id": { "description": "Identifier for the resource.", "example": "6848ef683c27403e96caa51816ddc72c", "type": "string" }, "startTime": { "description": "Start time of the drift detection interval", "example": 1669794391, "type": "number" }, "systemId": { "description": "Serial number of the array", "example": "ABC239XFZ9", "type": "string" }, "timeZone": { "description": "timezone", "example": "Asia/Calcutta", "type": "string" }, "type": { "description": "type", "example": "Type of the resource", "type": "string" }, "volumeId": { "description": "This attributes represents volume identification", "example": "60002AC000000000000005B200029834", "type": "string" } }, "required": [ "id", "type" ], "type": [ "object", "null" ] }, "volumePerformanceDriftsList": { "allOf": [ { "$ref": "#/components/schemas/CommonListResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/volumePerformanceDrifts" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] } }, "securitySchemes": { "bearer": { "bearerFormat": "JWT", "description": "Storage Fleet API uses a JWT bearer token for authentication.\nAn authentication token can be obtained from the HPE GreenLake console.\n", "scheme": "bearer", "type": "http" } } }, "security": [ { "bearer": [] } ] }