Hypervisor Storage Controller Resource

The API allows you to view, list, create and edit hypervisor storages.

GET /hypervisor-storages

Returns list of hypervisor storages filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
backupFileGuid query   no
cluster query   no
cluster-uuid query   no
direction query   no
filter query   no
hvm-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor query   no
hypervisor-manager query   no
nameLike query   no
nfs-storage query boolean no
orderBy query   no
page query   no
project-uuid query   no
size query   no
storage-pool-name query   no
uuid query   no
Response Body
media type data type description
application/json array of HypervisorStorageListRecord (JSON) list of hypervisor storages filtered by specified query parameters

Example

Request
GET /hypervisor-storages
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "uuid" : "...",
  "name" : "...",
  "storagePoolName" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "LOCAL",
  "storagePool" : {
    "guid" : "...",
    "uuid" : "...",
    "name" : "...",
    "storageProvider" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "size" : 12345,
    "usedSpace" : 12345
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

POST /hypervisor-storages

Create a hypervisor storage.

Request Body
media type data type description
application/json HypervisorStorageRequest (JSON) specify details for new hypervisor storage
Response Body
media type data type description
application/json HypervisorStorageRecordExtendedDetail (JSON) details of newly created hypervisor storage

Example

Request
POST /hypervisor-storages
Content-Type: application/json
Accept: application/json

                
{
  "uuid" : "...",
  "name" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "type" : "OPENNEBULA_SYSTEM_DS",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "guid" : "...",
  "uuid" : "...",
  "hvmType" : "AZURE",
  "name" : "...",
  "hvmStrategy" : "INHERIT",
  "storagePoolName" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "GCP_DISK_TYPE",
  "storagePool" : {
    "guid" : "...",
    "uuid" : "...",
    "name" : "...",
    "storageProvider" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "size" : 12345,
    "usedSpace" : 12345
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

GET /hypervisor-storages/detailed

Returns detailed list of hypervisor storages filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
backupFileGuid query   no
cluster query   no
cluster-uuid query   no
direction query   no
filter query   no
hvm-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor query   no
hypervisor-manager query   no
nameLike query   no
nfs-storage query boolean no
orderBy query   no
page query   no
project-uuid query   no
size query   no
storage-pool-name query   no
uuid query   no
Response Body
media type data type description
application/json array of HypervisorStorageRecordExtendedDetail (JSON) detailed list of hypervisor storages filtered by specified query parameters

Example

Request
GET /hypervisor-storages/detailed
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "guid" : "...",
  "uuid" : "...",
  "hvmType" : "GCP",
  "name" : "...",
  "hvmStrategy" : "VM_IMAGE_PLUS_INCREMENTAL_DISKS",
  "storagePoolName" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "STORAGEOS",
  "storagePool" : {
    "guid" : "...",
    "uuid" : "...",
    "name" : "...",
    "storageProvider" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "size" : 12345,
    "usedSpace" : 12345
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

GET /hypervisor-storages/for-restore

Returns list of hypervisor storage for restore infos filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
backupFileGuid query   no
cluster query   no
cluster-uuid query   no
direction query   no
filter query   no
hvm-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor query   no
hypervisor-manager query   no
nameLike query   no
nfs-storage query boolean no
orderBy query   no
page query   no
project-uuid query   no
size query   no
storage-pool-name query   no
uuid query   no
Response Body
media type data type description
application/json array of HypervisorStorageForRestoreListRecord (JSON) list of list of hypervisor storage for restore infos filtered by specified query parameters

Example

Request
GET /hypervisor-storages/for-restore
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "uuid" : "...",
  "name" : "...",
  "storagePoolName" : "...",
  "type" : "OPENNEBULA_IMAGE_DS",
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true
} ]
                
              

GET /hypervisor-storages/query

Returns list of hypervisor storages filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
backupFileGuid query   no
cluster query   no
cluster-uuid query   no
direction query   no
filter query   no
hvm-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor query   no
hypervisor-manager query   no
nameLike query   no
nfs-storage query boolean no
orderBy query   no
page query   no
project-uuid query   no
size query   no
storage-pool-name query   no
uuid query   no
Response Body
media type data type description
application/json array of HypervisorStorageListRecord (JSON) list of hypervisor storages filtered by specified query parameters

Example

Request
GET /hypervisor-storages/query
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "uuid" : "...",
  "name" : "...",
  "storagePoolName" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "STORAGEOS",
  "storagePool" : {
    "guid" : "...",
    "uuid" : "...",
    "name" : "...",
    "storageProvider" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "size" : 12345,
    "usedSpace" : 12345
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

DELETE /hypervisor-storages/{guid}

Remove hypervisor storage.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor storage (use by vProtect)

Example

Request
DELETE /hypervisor-storages/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /hypervisor-storages/{guid}

Get a single hypervisor storage.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor storage (use by vProtect)
Response Body
media type data type description
application/json HypervisorStorageRecordExtendedDetail (JSON) hypervisor storage details

Example

Request
GET /hypervisor-storages/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "guid" : "...",
  "uuid" : "...",
  "hvmType" : "RHV",
  "name" : "...",
  "hvmStrategy" : "CHANGED_BLOCK_TRACKING",
  "storagePoolName" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "LVM_THIN",
  "storagePool" : {
    "guid" : "...",
    "uuid" : "...",
    "name" : "...",
    "storageProvider" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "size" : 12345,
    "usedSpace" : 12345
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

PUT /hypervisor-storages/{guid}

Change hypervisor storage details.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor storage (use by vProtect)
Request Body
media type data type description
application/json HypervisorStorageUpdate (JSON) specify hypervisor storage details to update
Response Body
media type data type description
application/json HypervisorStorageRecordExtendedDetail (JSON) updated details of hypervisor storage

Example

Request
PUT /hypervisor-storages/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "LVM",
  "storagePool" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "guid" : "...",
  "uuid" : "...",
  "hvmType" : "OPENNEBULA",
  "name" : "...",
  "hvmStrategy" : "DISK_IMAGE_TRANSFER",
  "storagePoolName" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "OPENSTACK_CINDER",
  "storagePool" : {
    "guid" : "...",
    "uuid" : "...",
    "name" : "...",
    "storageProvider" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "size" : 12345,
    "usedSpace" : 12345
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

GET /hypervisor-storages/query/detailed

Returns list of hypervisor storages filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
backupFileGuid query   no
cluster query   no
cluster-uuid query   no
direction query   no
filter query   no
hvm-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor query   no
hypervisor-manager query   no
nameLike query   no
nfs-storage query boolean no
orderBy query   no
page query   no
project-uuid query   no
size query   no
storage-pool-name query   no
uuid query   no
Response Body
media type data type description
application/json array of HypervisorStorageRecordExtendedDetail (JSON) list of hypervisor storages filtered by specified query parameters

Example

Request
GET /hypervisor-storages/query/detailed
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "guid" : "...",
  "uuid" : "...",
  "hvmType" : "AWS",
  "name" : "...",
  "hvmStrategy" : "DISK_ATTACHMENT",
  "storagePoolName" : "...",
  "totalUsedSpace" : 12345,
  "totalAvailableSpace" : 12345,
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "clusters" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "projects" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "visibleForAllProjects" : true,
  "type" : "NONE",
  "storagePool" : {
    "guid" : "...",
    "uuid" : "...",
    "name" : "...",
    "storageProvider" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "size" : 12345,
    "usedSpace" : 12345
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]