CV Regions
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
CVRegion list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
capabilities | array | Capabilities available in the CVRegion. Example: PF , GPF , Replication . |
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CVRegion identifier. Possible IDs available at the /cv_regions endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
CVRegion details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
capabilities | array | Capabilities available in the CVRegion. Example: PF , GPF , Replication . |
400
Missing parameters.
404
CVRegion not found.
422
Invalid parameters.
CloudVolumes
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
CloudVolume list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
networks | array | List of networks associated with the Cloud Volume |
422
Invalid parameters.
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | True | Name. |
region_id | integer | True | Region identifier where to locate the new CloudVolume. The /regions endpoint provides the list of available Regions. |
size | integer | True | Size (in MiB). |
iops | integer | True | IOPS limit. |
perf_policy | string | True | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
schedule | string | True | Protection schedule frequency. Possible values:hourly , twicedaily , daily , weekly , monthly , none |
retention | integer | True | Number of Snapshots to retain for the selected schedule. Possible values per schedule: none: 0 hourly: 6 , 12 , 24 twicedaily: 4 , 8 , 14 daily: 3 , 7 , 14 weekly: 2 , 4 , 8 monthly: 3 , 6 , 12 |
private_cloud | string | True | AWS VPC or Azure VNET where the CloudVolume is available. The AWS or Azure account portals and APIs provide this information. Example: vpc-12d45ec . |
existing_cloud_subnet | string | True | AWS VPC or Azure VNET's subnet CIDR where the CloudVolume is available. The AWS or Azure account portals and APIs provide this information. Example: 192.168.0.0/16 . |
private_cloud_resource_group | string | False | If using Azure, this is the resource group where the VNET is located. The Azure account portal and APIs provides this information. |
encryption | boolean | True | Denotes whether to encrypt the CloudVolume's data at rest. Always Defaults to True. |
volume_type | string | True | Volume type or performance tier. Possible values: PF , GPF . |
cloud_account_id | string | False | Cloud Account used by the Volume. The /session/cloud_accounts endpoint provides the list of available Cloud Accounts. |
automated_connection | boolean | False | Set to false to opt out of automatically attempting to complete cloud connections in AWS or Azure. Defaults to true when AWS or Azure automation is configured with the Account. |
app_uuid | string | False | Application identifier of volume. Defaults to null when not specified |
private_cloud_project_id | string | False | GCP Project ID that the Cloud Volume will be used in |
peered_subnet | string | False | Subnet for GCP Peered Network to use |
Responses
200
CloudVolume created successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
new_connection | boolean | Denotes if a new connection to the Provider was initiated. | |
request_id | string | Request identifier used for retrieving provisioning status when creating a new connection. The ID is provided in the response when creating a new CloudVolume (POST to /cloud_volumes ) that requires new cloud provisioning. |
400
Missing parameters.
409
CloudVolume already exists or the CVRegion cannot accommodate it.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
CloudVolume details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
avg_stats_last_5mins | object | Average usage statistics for the last 5 mins. | {'type': 'object', 'description': 'Average usage statistics for the last 5 mins.', 'title': 'Avg 5min Stats'} |
block_size | integer | Block size. | |
connected_initiators | array | List of iSCSI Initiators currently connected to the CloudVolume. | |
protection_schedule | string | Protection schedule and retention policy. Example: snap:hourly:8:retention . |
|
creation_time | number | Timestamp (in secs) when the CloudVolume was created. | |
last_modified | number | Timestamp (in secs) when the CloudVolume was last modified. | |
target_name | string | Name of the iSCSI target needed to connect to the CloudVolume. | |
multi_initiator | boolean | Indicates whether multiple Initiators are allowed to connect to the CloudVolume at the same time. | |
online | boolean | Indicates if the CloudVolume currently online. | |
offline_reason | string | When a CloudVolume is offline, this explains the reason why. | |
size_used | integer | Amount of space (in bytes) currently in use. | |
snapshot_usage | integer | Amount of space (in bytes) currently used by the CloudVolume's Snapshots. | |
discovery_ip | string | iSCSI Discovery IP hosting the CloudVolume. | |
encryption | boolean | Denotes whether the CloudVolume's data is encrypted at rest. | |
connection_provisioning | string | Describes how the cloud connections for the CloudVolume were completed during provisioning (automated , manual or ongoing ). |
|
status | string | Indicates the cloud volume's current status. | |
networks | array | List of networks associated with the Cloud Volume |
404
CloudVolume not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
force | string | Immediately deletes the CloudVolume. |
Responses
204
Successfully deleted the CloudVolume.
404
CloudVolume not found.
409
CloudVolume has clones or connected Initiators.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | False | Name. |
size | integer | False | Size (in MiB). |
iops | integer | False | IOPS limit. |
schedule | string | False | Protection schedule frequency. Possible values:hourly , twicedaily , daily , weekly , monthly , none |
retention | integer | False | Number of Snapshots to retain for the selected schedule. Possible values per schedule: none: 0 hourly: 6 , 12 , 24 twicedaily: 4 , 8 , 14 daily: 3 , 7 , 14 weekly: 2 , 4 , 8 monthly: 3 , 6 , 12 |
multi_initiator | boolean | False | Indicates whether multiple Initiators are allowed to connect to the CloudVolume at the same time. |
app_uuid | string | False | Application identifier for volume. Defaults to null when not specified |
Responses
200
Edit completed successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
avg_stats_last_5mins | object | Average usage statistics for the last 5 mins. | {'type': 'object', 'description': 'Average usage statistics for the last 5 mins.', 'title': 'Avg 5min Stats'} |
block_size | integer | Block size. | |
connected_initiators | array | List of iSCSI Initiators currently connected to the CloudVolume. | |
protection_schedule | string | Protection schedule and retention policy. Example: snap:hourly:8:retention . |
|
creation_time | number | Timestamp (in secs) when the CloudVolume was created. | |
last_modified | number | Timestamp (in secs) when the CloudVolume was last modified. | |
target_name | string | Name of the iSCSI target needed to connect to the CloudVolume. | |
multi_initiator | boolean | Indicates whether multiple Initiators are allowed to connect to the CloudVolume at the same time. | |
online | boolean | Indicates if the CloudVolume currently online. | |
offline_reason | string | When a CloudVolume is offline, this explains the reason why. | |
size_used | integer | Amount of space (in bytes) currently in use. | |
snapshot_usage | integer | Amount of space (in bytes) currently used by the CloudVolume's Snapshots. | |
discovery_ip | string | iSCSI Discovery IP hosting the CloudVolume. | |
encryption | boolean | Denotes whether the CloudVolume's data is encrypted at rest. | |
connection_provisioning | string | Describes how the cloud connections for the CloudVolume were completed during provisioning (automated , manual or ongoing ). |
|
status | string | Indicates the cloud volume's current status. | |
networks | array | List of networks associated with the Cloud Volume |
400
Missing parameters.
404
CloudVolume not found.
409
CloudVolume name already exists or the CVRegion cannot accommodate it.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
initiator_ip | string | True | IP address of the Initiator to attach. Format: 192.168.42.3 . |
private_cloud | string | False | Virtual Private Cloud identifier. |
cloud_account_id | string | False | ID of the Cloud Account |
existing_cloud_subnet | string | False | Subnet in the Customer Cloud. |
private_cloud_resource_group | string | False | Resource Group of the account |
bandwidth | integer | False | Bandwidth required for the connection. |
automated_connection | boolean | False | Property to determine if the client wants to connect automatically to the Inititator or manually. |
multi_initiator | boolean | False | Property to determine if the cloud volume can connect to multiple initiators. |
private_cloud_project_id | string | False | GCP Project ID that the Cloud Volume will be used in |
peered_subnet | string | False | Subnet for GCP Peered Network to use |
Responses
200
Attach completed successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
new_connection | boolean | Denotes if a new connection to the Provider was initiated. | |
request_id | string | Request identifier used for retrieving provisioning status when creating a new connection. The ID is provided in the response when creating a new CloudVolume (POST to /cloud_volumes ) that requires new cloud provisioning. |
400
Missing parameters.
404
CloudVolume not found.
409
CloudVolume configuration is not yet complete.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | True | Name of the new clone. |
snapshot_ref | string | True | Identifier for the Snapshot to clone. The /cloud_volumes/{ident}/snapshots endpoint provides the list of possible IDs. |
region_id | integer | True | Region identifier where to locate the clone. The /regions endpoint provides the list of available Regions. |
iops | integer | False | IOPS limit of the new clone. |
cloud_account_id | string | False | Cloud Account used by the Volume. The /session/cloud_accounts endpoint provides the list of available Cloud Accounts. |
schedule | string | False | Protection schedule frequency. Possible values:hourly , twicedaily , daily , weekly , monthly , none |
retention | integer | False | Number of Snapshots to retain for the selected schedule. Possible values per schedule: none: 0 hourly: 6 , 12 , 24 twicedaily: 4 , 8 , 14 daily: 3 , 7 , 14 weekly: 2 , 4 , 8 monthly: 3 , 6 , 12 |
private_cloud | string | False | VPC/VNET where the clone will be made available. The service provider account portals and APIs provide this information. Example: vpc-12d45ec . |
existing_cloud_subnet | string | False | VPC/VNET's subnet CIDR where the clone will be made available. The service provider account portals and APIs provide this information. Example: 192.168.0.0/16 . |
private_cloud_resource_group | string | False | If using Azure, this is the resource group where the VNET is located. The Azure account portal and APIs provides this information. |
automated_connection | boolean | False | Set to false to opt out of automatically attempting to complete cloud connections in AWS or Azure. Defaults to true when AWS or Azure automation is configured with the Account. |
app_uuid | string | False | Application identifier of the clone. Defaults to null when not specified |
private_cloud_project_id | string | False | GCP Project ID that the Cloud Volume will be used in |
peered_subnet | string | False | Subnet for GCP Peered Network to use |
Responses
200
CloudVolume cloned successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
new_connection | boolean | Denotes if a new connection to the Provider was initiated. | |
request_id | string | Request identifier used for retrieving provisioning status when creating a new connection. The ID is provided in the response when creating a new CloudVolume (POST to /cloud_volumes ) that requires new cloud provisioning. |
400
Missing parameters.
404
CloudVolume or Snapshot not found.
409
CloudVolume already exists or not enough room to clone.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
replication_store_id | integer | True | Identifier of the ReplicationStore that will host the ReplicaVolume. |
replica_volume_collection_id | string | True | Identifier of the ReplicaVolumeCollection that will contain the ReplicaVolume. |
Responses
200
CloudVolume converted successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
replication_store | object | ReplicationStore where the ReplicaVolume exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolume exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolume is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolume is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
replica_volume_collection | object | ReplicaVolumeCollection that owns this ReplicaVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'string', 'title': 'ID', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'ReplicaVolumeCollection that owns this ReplicaVolume.'} |
cv_region | object | CVRegion where ReplicaVolume is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where ReplicaVolume is located.', 'required': True} |
encryption | boolean | Denotes whether the CloudVolume is encrypted at rest. | |
size | integer | Size (in MiB). | |
sn | string | Serial number. | |
replica_volume_collection_name | string | The owning ReplicaVolumeCollection's Name | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
block_size | integer | Block size. | |
creation_time | number | Timestamp (in secs) when the CloudVolume was created. | |
last_modified | number | Timestamp (in secs) when the CloudVolume was last modified. | |
size_used | integer | Amount of space (in bytes) currently in use. | |
snapshot_usage | integer | Amount of space (in bytes) currently used by the CloudVolume's Snapshots. | |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. |
400
Missing parameters.
404
CloudVolume or ReplicationStore not found.
409
CloudVolume is using resources that cannot be moved to the supplied ReplicationStore.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
initiator_ip | string | True | IP address of the Initiator to detach. Format: 192.168.42.3 . |
Responses
200
Successfully detached the Initiator.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
request_id | string | Request identifier used for retrieving connection status when automatically detaching from a CloudVolume. |
400
Missing parameters.
404
CloudVolume not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
min | string | Start time (in secs). |
max | string | End time (in secs). |
Responses
200
CloudVolume metrics information.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
capacity | array | Capacity usage statistics over time. | |
performance | array | Performance statistics over time. | |
predicted_days_until_full | integer | Number of days remaining before the CloudVolume is full. |
404
CloudVolume not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
replication_store_id | integer | False | Identifier of the ReplicationStore that will host the CloudVolume. |
replica_volume_collection_id | string | False | Identifier of the ReplicaVolumeCollection that will contain the CloudVolume. |
schedule | string | False | Protection schedule frequency. Possible values:hourly , twicedaily , daily , weekly , monthly , none |
retention | integer | False | Number of Snapshots to retain for the selected schedule. Possible values per schedule: none: 0 hourly: 6 , 12 , 24 twicedaily: 4 , 8 , 14 daily: 3 , 7 , 14 weekly: 2 , 4 , 8 monthly: 3 , 6 , 12 |
Responses
200
CloudVolume is set for replication.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. |
400
Missing parameters.
404
CloudVolume or ReplicaVolumeCollection not found.
409
CloudVolume is using resources that cannot be moved to the supplied ReplicationVolumeCollection.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
snapshot_ref | string | True | Identifier for the Snapshot to restore. The /cloud_volumes/{ident}/snapshots endpoint provides the list of possible IDs. |
Responses
200
Successfully restored the Snapshot.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. |
400
Missing parameters.
404
CloudVolume or Snapshot not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
Snapshot list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
schedule_name | string | Name of the schedule that generated the Snapshot. | |
description | string | Description. | |
creation_time | number | Timestamp (in secs) when the Snapshot was generated. | |
size | integer | Size (in MiB). | |
app_uuid | string | Application identifier of snapshot. |
404
CloudVolume not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | True | Name. |
description | string | False | Description. |
app_uuid | string | False | Application identifier of Snapshot. |
Responses
200
Snapshot created successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
schedule_name | string | Name of the schedule that generated the Snapshot. | |
description | string | Description. | |
creation_time | number | Timestamp (in secs) when the Snapshot was generated. | |
size | integer | Size (in MiB). | |
app_uuid | string | Application identifier of snapshot. |
400
Missing parameters.
404
CloudVolume not found.
409
Snapshot already exists.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | CloudVolume identifier. Possible IDs available at the /cloud_volumes endpoint. |
snapshot_ref | string | Snapshot identifier. Possible IDs available at /cloud_volumes/{ident}/snapshots . |
Responses
204
Snapshot successfully deleted
404
CloudVolume or Snapshot not found.
409
Snapshot has clones.
Initiators
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
Initiator list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
ip | string | IP Address. | |
cloud_volumes | array | List of CloudVolumes to which the Initiator is attached. |
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | Initiator identifier. Possible IDs available at the /initiators endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
Initiator details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
ip | string | IP Address. | |
cloud_volumes | array | List of CloudVolumes to which the Initiator is attached. |
400
Missing parameters.
404
Initiator not found.
422
Invalid parameters.
Interfaces
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
Interface list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
provider | object | Provider. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'Provider.', 'required': True} |
cv_region | object | CVRegion where the Interface exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the Interface exists.', 'required': True} |
interface_ref | string | AWS Private Virtual Interface / Azure Circuit identifier. | |
state | string | State of the Interface connection. | |
gateway | string | AWS Virtual Gateway the Interface connects to. | |
vpc_ref | string | AWS Virtual Private Cloud to which the Interface connects. | |
provisioning_state | string | Provisioning state of the Azure Circuit. | |
authorization_key | string | Authorization key for the Azure Circuit. | |
vnet_ref | string | Azure Virtual Network to which Interface connects. | |
vnet_resource_group_ref | string | Azure Resource Group where the VNET resides. | |
cloud_account | object | Cloud Account. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.'}, 'provider': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'Cloud Service Provider'}, 'automation_enabled': {'type': 'boolean', 'description': 'Indicates whether automation is enabled for the user.', 'title': 'Automation Indicator'}, 'aws_account': {'type': 'string', 'title': 'AWS Account', 'description': 'AWS Account to be used for the Cloud Account.'}, 'azure_subscription': {'type': 'string', 'title': 'Azure Subscription', 'description': 'Azure Subscription to be used for the Cloud Account.'}, 'gcp_projects': {'project_id': {'type': 'string', 'title': 'Project ID', 'description': 'Project ID used by Cloud Account', 'required': True}, 'service_account': {'project_id': {'type': 'string', 'title': 'Project ID', 'description': 'Project ID associated with Service Account in GCP', 'required': True}, 'private_key_id': {'type': 'string', 'title': 'Private Key ID', 'description': 'Private Key ID for Service Account'}, 'private_key': {'type': 'string', 'title': 'Private Key', 'description': 'Private Key for Service Account'}, 'client_email': {'type': 'string', 'title': 'Client Email', 'description': "Service Account's email", 'required': True}, 'client_id': {'type': 'string', 'title': 'Client ID', 'description': "Service Account's ID"}, 'token_uri': {'type': 'string', 'title': 'Token URI', 'description': 'Google Token URL'}, 'type': 'object', 'description': 'Service Account authorized to use the Project ID for the Cloud Account'}, 'type': 'object'}, 'type': 'object', 'description': 'Cloud Account.'} |
hpe_project_id | string | GCP Project ID used by HPE where VPC resides. | |
hpe_vpc_name | string | GCP VPC used by HPE where subnet resides. | |
peered_subnet | string | Subnet used by HPE in GCP. |
422
Invalid parameters.
OnPrem Replication Partners
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
OnPremReplicationPartners list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
alias | string | Auto-generated alias. | |
group_uid | string | Universal identifier for the group that this partner represents. | |
user | object | User that owns the OnPremReplicationPartner. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the OnPremReplicationPartner.', 'required': True} |
proxy_user | string | Username assigned for the proxy replication service. | |
shared_secret | string | Secret used in replication setup. | |
replication_partnerships | array | List of ReplicationPartnerships connected to the OnPremReplicationPartner. |
422
Invalid parameters.
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | True | Name. |
group_uid | string | True | Universal identifier for the group this partner represents. |
keys | string | True | Public RSA keys for group's root user. |
Responses
200
OnPremReplicationPartner successfully created.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
alias | string | Auto-generated alias. | |
group_uid | string | Universal identifier for the group that this partner represents. | |
user | object | User that owns the OnPremReplicationPartner. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the OnPremReplicationPartner.', 'required': True} |
proxy_user | string | Username assigned for the proxy replication service. | |
shared_secret | string | Secret used in replication setup. | |
replication_partnerships | array | List of ReplicationPartnerships connected to the OnPremReplicationPartner. |
400
Missing parameters.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | OnPremReplicationPartner identifier. Possible IDs available at the /onprem_replication_partners endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
OnPremReplicationPartner details
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
alias | string | Auto-generated alias. | |
group_uid | string | Universal identifier for the group that this partner represents. | |
user | object | User that owns the OnPremReplicationPartner. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the OnPremReplicationPartner.', 'required': True} |
proxy_user | string | Username assigned for the proxy replication service. | |
shared_secret | string | Secret used in replication setup. | |
replication_partnerships | array | List of ReplicationPartnerships connected to the OnPremReplicationPartner. |
404
OnPremReplicationPartner not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | OnPremReplicationPartner identifier. Possible IDs available at the /onprem_replication_partners endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | False | Name. |
keys | string | False | Public RSA keys for group's root user. |
Responses
200
Update completed successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
alias | string | Auto-generated alias. | |
group_uid | string | Universal identifier for the group that this partner represents. | |
user | object | User that owns the OnPremReplicationPartner. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the OnPremReplicationPartner.', 'required': True} |
400
Missing parameters.
404
OnPremReplicationPartner not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | OnPremReplicationPartner identifier. Possible IDs available at the /onprem_replication_partners endpoint. |
Responses
204
OnPremReplicationPartner successfully deleted.
404
OnPremReplicationPartner not found.
422
Invalid parameters.
Providers
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
Provider list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. |
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | Provider identifier. Possible IDs available at the /providers endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
Provider details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. |
400
Missing parameters.
404
Provider not found.
422
Invalid parameters.
Regions
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
Region list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
provider | object | Provider. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'Provider.', 'required': True} |
cv_region | object | CVRegion from which the Region is accessible. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion from which the Region is accessible.', 'required': True} |
name | string | Name. | |
latency | float | IO Latency. |
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | Region identifier. Possible IDs available at the /regions endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
Region details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
provider | object | Provider. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'Provider.', 'required': True} |
cv_region | object | CVRegion from which the Region is accessible. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion from which the Region is accessible.', 'required': True} |
name | string | Name. | |
latency | float | IO Latency. |
400
Missing parameters.
404
Region not found.
422
Invalid parameters.
Replica Snapshots
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
ReplicaSnapshot list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
schedule_name | string | Name of the schedule that generated the Snapshot. | |
description | string | Description. | |
creation_time | number | Timestamp (in secs) when the Snapshot was generated. | |
size | integer | Size (in MiB). | |
app_uuid | string | Application identifier of snapshot. | |
replication_store | object | ReplicationStore where the ReplicaSnapshot exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaSnapshot exists.'} |
replication_partnership | object | ReplicationPartnership through which the ReplicaSnapshot was replicated. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaSnapshot was replicated.'} |
404
ReplicationStore not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes endpoint. |
snapshot_ref | string | ReplicaSnapshot Identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes/{vol_ref}/snapshots endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
204
ReplicaSnapshot successfully deleted
404
ReplicationStore, ReplicaVolume or ReplicaSnapshot not found.
409
ReplicaSnapshot is cloned.
422
Invalid parameters.
Replica Volume Collections
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
ReplicaVolumeCollection list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_count | integer | Total number of ReplicaVolumes in the collection. | |
replication_store | object | ReplicationStore where the ReplicaVolumeCollection exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolumeCollection exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolumeCollection is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolumeCollection is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
requires_app_sync_setup | boolean | Indicates if this Volume Collection requires manual configuration for its Application Synchronization setting. |
404
ReplicationStore not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
ReplicaVolumeCollection details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_count | integer | Total number of ReplicaVolumes in the collection. | |
replication_store | object | ReplicationStore where the ReplicaVolumeCollection exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolumeCollection exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolumeCollection is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolumeCollection is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
requires_app_sync_setup | boolean | Indicates if this Volume Collection requires manual configuration for its Application Synchronization setting. | |
replica_volumes | array | List of replica volumes for this volume collection. | |
protection_schedules | array | List of protection schedules for this volume collection. |
404
ReplicationStore not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
volcoll_ref | string | ReplicaVolumeCollection identifier. Possible IDs available at /replication_stores/{ident}/replica_volume_collections . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
204
ReplicaVolumeCollection successfully deleted.
404
ReplicationStore not found.
409
ReplicaVolumeCollection has cloned ReplicaVolumes.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
volcoll_ref | string | ReplicaVolumeCollection identifier. Possible IDs available at /replication_stores/{ident}/replica_volume_collections . |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
replication_partnership_id | integer | True | Identifier of the ReplicationPartnership where we want to move this ReplicaVolumeCollection. |
replication_direction | string | True | Replication direction. Either incoming to the cloud, outgoing to OnPremises or stopped . |
Responses
200
Update completed successfully
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_count | integer | Total number of ReplicaVolumes in the collection. | |
replication_store | object | ReplicationStore where the ReplicaVolumeCollection exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolumeCollection exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolumeCollection is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolumeCollection is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
requires_app_sync_setup | boolean | Indicates if this Volume Collection requires manual configuration for its Application Synchronization setting. |
400
Missing parameters.
404
ReplicationStore, ReplicationPartnership or ReplicaVolumeCollection not found.
409
ReplicaVolumeCollection with same name already exists in the selected partnership.
422
Invalid parameters.
Replica Volumes
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume Identifier. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
ReplicaVolume list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
replication_store | object | ReplicationStore where the ReplicaVolume exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolume exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolume is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolume is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
replica_volume_collection | object | ReplicaVolumeCollection that owns this ReplicaVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'string', 'title': 'ID', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'ReplicaVolumeCollection that owns this ReplicaVolume.'} |
cv_region | object | CVRegion where ReplicaVolume is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where ReplicaVolume is located.', 'required': True} |
encryption | boolean | Denotes whether the ReplicaVolume is encrypted at rest. | |
size | integer | Size (in MiB). |
404
ReplicationStore not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
ReplicaVolume details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
replication_store | object | ReplicationStore where the ReplicaVolume exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolume exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolume is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolume is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
replica_volume_collection | object | ReplicaVolumeCollection that owns this ReplicaVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'string', 'title': 'ID', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'ReplicaVolumeCollection that owns this ReplicaVolume.'} |
cv_region | object | CVRegion where ReplicaVolume is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where ReplicaVolume is located.', 'required': True} |
encryption | boolean | Denotes whether the CloudVolume is encrypted at rest. | |
size | integer | Size (in MiB). | |
sn | string | Serial number. | |
replica_volume_collection_name | string | The owning ReplicaVolumeCollection's Name | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
block_size | integer | Block size. | |
creation_time | number | Timestamp (in secs) when the CloudVolume was created. | |
last_modified | number | Timestamp (in secs) when the CloudVolume was last modified. | |
size_used | integer | Amount of space (in bytes) currently in use. | |
snapshot_usage | integer | Amount of space (in bytes) currently used by the CloudVolume's Snapshots. | |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. |
404
ReplicationStore or ReplicaVolume not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
204
ReplicaVolume successfully deleted.
404
ReplicationStore not found.
409
ReplicaVolume has cloned ReplicaSnapshots or is actively replicating.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes endpoint. |
min | string | Start time (in secs). |
max | string | End time (in secs). |
Responses
200
CloudVolume metrics information
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
capacity | array | Capacity usage statistics over time. | |
performance | array | Performance statistics over time. | |
predicted_days_until_full | integer | Number of days remaining before the CloudVolume is full. |
404
ReplicationStore or ReplicaVolume not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | True | Clone name. |
snapshot_ref | string | True | Identifier for the Snapshot to clone. The /replication_stores/{ident}/replica_volumes/{vol_ref}/snapshots endpoint provides the list of possible IDs. |
region_id | integer | True | Region identifier where to locate the new CloudVolume. The /regions endpoint provides the list of available Regions. |
iops | integer | True | IOPS limit of the new clone. |
private_cloud | string | True | Name of the VPC or VNET hosting the virtual machines that will attach to this clone. |
existing_cloud_subnet | string | True | Subnet CIDR for the VPC or VNET network. |
private_cloud_resource_group | string | False | Azure Resource Group where the private cloud is located. |
private_cloud_project_id | string | False | GCP Project ID that the Cloud Volume will be used in |
peered_subnet | string | False | Subnet for GCP Peered Network to use |
schedule | string | False | Protection schedule frequency. Possible values:hourly , twicedaily , daily , weekly , monthly , none |
retention | integer | False | Number of Snapshots to retain for the selected schedule. Possible values per schedule: none: 0 hourly: 6 , 12 , 24 twicedaily: 4 , 8 , 14 daily: 3 , 7 , 14 weekly: 2 , 4 , 8 monthly: 3 , 6 , 12 |
cloud_account_id | string | False | Cloud Account used by the Volume. The /session/cloud_accounts endpoint provides the list of available Cloud Accounts. |
automated_connection | boolean | False | Set to false to opt out of automatically attempting to complete cloud connections in AWS or Azure. Defaults to true when AWS or Azure automation is configured with the Account. |
Responses
200
The ReplicaVolume was cloned successfully
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
new_connection | boolean | Denotes if a new connection to the Provider was initiated. | |
request_id | string | Request identifier used for retrieving provisioning status when creating a new connection. The ID is provided in the response when creating a new CloudVolume (POST to /cloud_volumes ) that requires new cloud provisioning. |
400
Missing parameters.
404
ReplicationStore, ReplicaVolume or ReplicaSnapshot not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
vol_ref | string | ReplicaVolume identifier. Possible IDs available at the /replication_stores/{ident}/replica_volumes endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | True | Clone name. |
region_id | integer | True | Region identifier where to locate the new CloudVolume. The /regions endpoint provides the list of available Regions. |
iops | integer | False | IOPS limit of the new clone. |
schedule | string | False | Protection schedule frequency. Possible values:hourly , twicedaily , daily , weekly , monthly , none |
retention | integer | False | Number of Snapshots to retain for the selected schedule. Possible values per schedule: none: 0 hourly: 6 , 12 , 24 twicedaily: 4 , 8 , 14 daily: 3 , 7 , 14 weekly: 2 , 4 , 8 monthly: 3 , 6 , 12 |
private_cloud | string | True | Name of the VPC or VNET hosting the virtual machines that will attach to this clone. |
existing_cloud_subnet | string | True | Subnet CIDR for the VPC or VNET network. |
private_cloud_resource_group | string | False | Azure Resource Group where the private cloud is located. |
cloud_account_id | string | False | Cloud Account used by the Volume. The /session/cloud_accounts endpoint provides the list of available Cloud Accounts. |
automated_connection | boolean | False | Set to false to opt out of automatically attempting to complete cloud connections in AWS or Azure. Defaults to true when AWS or Azure automation is configured with the Account. |
private_cloud_project_id | string | False | GCP Project ID that the Cloud Volume will be used in |
peered_subnet | string | False | Subnet for GCP Peered Network to use |
Responses
200
The ReplicaVolume was cloned successfully
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. | |
new_connection | boolean | Denotes if a new connection to the Provider was initiated. | |
request_id | string | Request identifier used for retrieving provisioning status when creating a new connection. The ID is provided in the response when creating a new CloudVolume (POST to /cloud_volumes ) that requires new cloud provisioning. |
400
Missing parameters.
404
ReplicationStore, ReplicaVolume or not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
snapshot_ref | string | True | Identifier for the Snapshot to restore. The /replication_stores/{ident}/replica_volumes/{vol_ref}/snapshots endpoint provides the list of possible IDs. |
Responses
200
Successfully restored the Snapshot.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
replication_store | object | ReplicationStore where the ReplicaVolume exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolume exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolume is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolume is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
replica_volume_collection | object | ReplicaVolumeCollection that owns this ReplicaVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'string', 'title': 'ID', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'ReplicaVolumeCollection that owns this ReplicaVolume.'} |
cv_region | object | CVRegion where ReplicaVolume is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where ReplicaVolume is located.', 'required': True} |
encryption | boolean | Denotes whether the ReplicaVolume is encrypted at rest. | |
size | integer | Size (in MiB). |
400
Missing parameters.
404
ReplicaVolume or Snapshot not found.
409
ReplicaVolume is not in a supported replication direction for this action.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
Replica Cloud Volumes list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
marked_for_deletion | boolean | Indicates whether CloudVolume is scheduled for deletion. | |
user | object | User that owns the CloudVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'User that owns the CloudVolume.', 'required': True} |
cv_region | object | CVRegion where the CloudVolume is available. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the CloudVolume is available.', 'required': True} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
cloud_accounts | array | CloudAccounts used by CloudVolume | |
sn | string | Serial number | |
size | integer | Size (in MiB). | |
limit_iops | integer | IOPS limit. | |
limit_mbps | integer | Throughput limit (in MBps). | |
perf_policy | string | Application performance policy. Possible values: Exchange 2003 data store , Exchange 2007 data store , Exchange 2010 data store , Exchange log , Oracle OLTP , Other Workloads , SharePoint , SQL Server , SQL Server Logs , SQL Server 2012 , Windows File Server |
|
private_cloud | object | VPC/VNET where the CloudVolume is available. | {'aws': {'vpc': {'type': 'string', 'title': 'VPC', 'description': 'AWS VPC where the resource is available.'}, 'type': 'object', 'description': 'AWS information where resource is available.'}, 'azure': {'vnet': {'title': 'VNET', 'type': 'string', 'description': 'Azure Virtual Network where the resource is available.'}, 'resource_group': {'title': 'VNET Resource Group', 'type': 'string', 'description': 'Azure Resource Group where the VNET exists.'}, 'type': 'object', 'description': 'Azure information where the resource is available.'}, 'gcp': {'vpc': {'title': 'VPC', 'type': 'string', 'description': 'GCP VPC where the resource is available.'}, 'project_id': {'title': 'Project ID', 'type': 'string', 'description': 'GCP Project that the resource is accessible.'}, 'peered_subnet': {'title': 'Peer Subnet', 'type': 'string', 'description': 'GCP Subnet the VPC uses.'}, 'type': 'object', 'description': 'GCP information where the resource is available.'}, 'type': 'object', 'description': 'VPC/VNET where the CloudVolume is available.'} |
subnet | string | VPC/VNET's subnet CIDR where the CloudVolume is available. | |
cloned_from | object | Parent CloudVolume if this is a clone. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'Parent CloudVolume if this is a clone.'} |
cloned_snapshot_ref | string | Parent Snapshot identifier if this is a clone. | |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.'} |
assigned_initiators | array | List of Initiators with access to the CloudVolume. | |
app_uuid | string | Application identifier of volume. |
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
ReplicaVolumes list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
replication_store | object | ReplicationStore where the ReplicaVolume exists. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore where the ReplicaVolume exists.', 'required': True} |
replication_partnership | object | ReplicationPartnership through which the ReplicaVolume is replicating. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'onprem_replication_partner': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True}, 'replication_store': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True}, 'type': 'object', 'description': 'ReplicationPartnership through which the ReplicaVolume is replicating.'} |
replication_direction | string | Direction in which replication is occurring. | |
replica_volume_collection | object | ReplicaVolumeCollection that owns this ReplicaVolume. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'string', 'title': 'ID', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'ReplicaVolumeCollection that owns this ReplicaVolume.'} |
cv_region | object | CVRegion where ReplicaVolume is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where ReplicaVolume is located.', 'required': True} |
encryption | boolean | Denotes whether the ReplicaVolume is encrypted at rest. | |
size | integer | Size (in MiB). |
422
Invalid parameters.
Replication Partnerships
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
ReplicationPartnership list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
starting_port | integer | The first port over which to configure replication. | |
alias | string | Auto-generated alias. | |
onprem_replication_partner | object | OnPremReplicationPartner linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True} |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True} |
422
Invalid parameters.
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
replication_store_id | integer | True | Identifier for the ReplicationStore with which to link. The list of possible IDs is available at the /replication_stores endpoint. |
onprem_replication_partner_id | integer | True | Identifier for the OnPremReplicationPartner with which to link. The list of possible IDs is available at the /onprem_replication_partners endpoint. |
Responses
200
ReplicationPartnership successfully created.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
starting_port | integer | The first port over which to configure replication. | |
alias | string | Auto-generated alias. | |
onprem_replication_partner | object | OnPremReplicationPartner linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True} |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True} |
proxy_external_ip | string | External SSH Proxy server's IP address. | |
replication_ip | string | ReplicationStore IP address. | |
proxy_user | string | Username of the proxy replication service. | |
shared_secret | string | Secret used in replication setup. |
400
Missing parameters.
404
ReplicationPartnership not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationPartnership identifier. Possible IDs available at the /replication_partnerships endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
ReplicationPartnership details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
starting_port | integer | The first port over which to configure replication. | |
alias | string | Auto-generated alias. | |
onprem_replication_partner | object | OnPremReplicationPartner linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'OnPremReplicationPartner linked to the ReplicationPartnership.', 'required': True} |
replication_store | object | ReplicationStore linked to the ReplicationPartnership. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'volume_type': {'type': 'string', 'description': 'Volume type or performance tier. Possible values: PF , GPF .', 'title': 'Type / Tier', 'required': True}, 'user': {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'required': True}, 'type': 'object', 'description': 'ReplicationStore linked to the ReplicationPartnership.', 'required': True} |
proxy_external_ip | string | External SSH Proxy server's IP address. | |
replication_ip | string | ReplicationStore IP address. | |
proxy_user | string | Username of the proxy replication service. | |
shared_secret | string | Secret used in replication setup. |
404
ReplicationPartnership not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationPartnership identifier. Possible IDs available at the /replication_partnerships endpoint. |
Responses
204
ReplicationPartnership successfully deleted.
404
ReplicationPartnership not found.
422
Invalid parameters.
Replication Stores
Query Parameters
Name | Type | Description |
---|---|---|
filters | csv | Comma separated list of conditionals with which to filter responses using = , < , > , <= , >= , ~ operators. For example, searching a collection for resources of a specific name: ?filters=name=ABC . |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
sort | csv | Comma separated list of attributes on which to sort, preceded by + or - to indicate sort order. For example: ?sort=+name |
Responses
200
ReplicationStore list.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
limit_size | integer | Size limit (in MiB). | |
used_size | integer | Used space (in bytes). | |
limit_mbps | integer | Throughput limit (in MBps). | |
user | object | Owning User. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'Owning User.', 'required': True} |
cv_region | object | CVRegion where the ReplicationStore is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the ReplicationStore is located.'} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
configured_replication_partnerships | integer | Total number of existing ReplicationPartnerships in the store. | |
max_replication_partnerships | integer | Maximum number of ReplicationPartnerships allowed in the store. |
422
Invalid parameters.
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | True | Name. |
cv_region_id | integer | True | CVRegion identifier where to locate the new store. The /cv_regions endpoint provides the list of available IDs with the Replication capability. |
limit_size | integer | True | Size limit (in MiB). |
volume_type | string | True | Volume type or performance tier. Possible values: PF , GPF . |
Responses
200
ReplicationStore successfully created.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
limit_size | integer | Size limit (in MiB). | |
used_size | integer | Used space (in bytes). | |
limit_mbps | integer | Throughput limit (in MBps). | |
user | object | Owning User. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'Owning User.', 'required': True} |
cv_region | object | CVRegion where the ReplicationStore is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the ReplicationStore is located.'} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
configured_replication_partnerships | integer | Total number of existing ReplicationPartnerships in the store. | |
max_replication_partnerships | integer | Maximum number of ReplicationPartnerships allowed in the store. |
400
Missing parameters.
404
ReplicationStore not found.
409
ReplicationStore already exists, is in an CVRegion that does not support replication, or that is out of resources.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
ReplicationStore details.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
limit_size | integer | Size limit (in MiB). | |
used_size | integer | Used space (in bytes). | |
limit_mbps | integer | Throughput limit (in MBps). | |
user | object | Owning User. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'Owning User.', 'required': True} |
cv_region | object | CVRegion where the ReplicationStore is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the ReplicationStore is located.'} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
configured_replication_partnerships | integer | Total number of existing ReplicationPartnerships in the store. | |
max_replication_partnerships | integer | Maximum number of ReplicationPartnerships allowed in the store. | |
replication_partnerships | array | List of ReplicationPartnerships connected to the ReplicationStore. | |
proxy_external_ip | string | External SSH Proxy server's IP address. | |
replication_ip | string | ReplicationStore IP address |
404
ReplicationStore not found.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | False | Name. |
limit_size | integer | False | Size limit (in MiB). |
Responses
200
Update completed successfully.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
name | string | Name. | |
limit_size | integer | Size limit (in MiB). | |
used_size | integer | Used space (in bytes). | |
limit_mbps | integer | Throughput limit (in MBps). | |
user | object | Owning User. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'email': {'type': 'string', 'title': 'Email', 'format': 'email', 'description': "User's email address."}, 'type': 'object', 'description': 'Owning User.', 'required': True} |
cv_region | object | CVRegion where the ReplicationStore is located. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).', 'required': True}, 'id': {'type': 'integer', 'title': 'Resource ID', 'format': 'int64', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.', 'required': True}, 'type': 'object', 'description': 'CVRegion where the ReplicationStore is located.'} |
volume_type | string | Volume type or performance tier. Possible values: PF , GPF . |
|
configured_replication_partnerships | integer | Total number of existing ReplicationPartnerships in the store. | |
max_replication_partnerships | integer | Maximum number of ReplicationPartnerships allowed in the store. |
400
Missing parameters.
404
ReplicationStore not found.
409
ReplicationStore is actively replicating or already exists.
422
Invalid parameters.
Query Parameters
Name | Type | Description |
---|---|---|
ident | integer | ReplicationStore identifier. Possible IDs available at the /replication_stores endpoint. |
Responses
204
ReplicationStore successfully deleted
404
ReplicationStore not found.
422
Invalid parameters.
Session
Query Parameters
Name | Type | Description |
---|---|---|
user_ref | string | User identifier. Possible IDs available at the /users endpoint. |
fields | csv | Comma separated list of fields to return in the response beyond the required attributes. |
Responses
200
Session information.
Response Attributes
Name | Type | Description | Object Structure |
---|---|---|---|
account | object | Account that owns the User. | {'href': {'type': 'string', 'title': 'URL', 'format': 'uri', 'description': 'Valid URL (https://www.example.com ).'}, 'id': {'type': 'string', 'title': 'Resource ID', 'description': 'Resource Identifier.', 'required': True}, 'name': {'type': 'string', 'title': 'Name', 'description': 'Name.'}, 'account_type': {'type': 'string', 'title': 'Account Type', 'description': 'Account Type.'}, 'type': 'object', 'description': 'Account that owns the User.', 'required': True} |
active | boolean | Indicates whether the User is allowed to log-in. | |
confirmed_at | number | Time (in secs) at which the User confirmed the Terms and Conditions. | |
string | Email address. | ||
firstname | string | First name. | |
last_login_at | number | Time (in secs) of the User's last login. | |
lastname | string | Last name. | |
login_count | integer | Count of successful logins. | |
phone | string | The phone number for the User. | |
roles | array | Roles. | |
cloud_accounts | array | Cloud Account Status | |
settings | object | User Settings. | {'type': 'object', 'description': 'User Settings.', 'title': 'User Settings', 'required': True} |
user_id | string | User identifier | |
aws_automation_enabled | boolean | Indicates whether AWS automation is enabled for the user. | |
aws_configured | boolean | Indicates whether AWS account information is configured for the user. | |
azure_automation_enabled | boolean | Indicates whether Azure automation is enabled for the user. | |
azure_configured | boolean | Indicates whether Azure account information is configured for the user. | |
chap_user | string | User's iSCSI CHAP user. | |
chap_secret | string | User's iSCSI CHAP secret. | |
limits | object | Account limits. | {'per_cloud_volume_max_iops': {'type': 'integer', 'format': 'int64', 'description': 'Maximum allowed IOPS for CloudVolumes.', 'title': 'Max CloudVolume IOPS', 'required': True}, 'per_cloud_volume_max_size': {'type': 'integer', 'format': 'int64', 'description': 'Maximum allowed size (in MiB) for CloudVolumes.', 'title': 'Max CloudVolume Size', 'required': True}, 'per_replication_store_max_size': {'type': 'integer', 'format': 'int64', 'description': 'Maximum allowed size (in MiB) for ReplicationStores.', 'title': 'Max ReplicationStore Size', 'required': True}, 'per_replication_store_max_mbps': {'type': 'integer', 'format': 'int64', 'description': 'Maximum allowed throughput for ReplicationStores.', 'docs-hidden': True, 'title': 'Max ReplicationStore Throughput', 'required': True}, 'per_cloud_volume_min_iops': {'type': 'integer', 'format': 'int64', 'description': 'Minimum allowed IOPS for CloudVolumes.', 'title': 'Min IOPS', 'required': True}, 'per_cloud_volume_min_size': {'type': 'integer', 'format': 'int64', 'description': 'Minimum allowed size (in MiB) for CloudVolumes.', 'title': 'Min Size', 'required': True}, 'per_replication_store_min_size': {'type': 'integer', 'format': 'int64', 'description': 'Minimum allowed size (in MiB) for ReplicationStores.', 'title': 'Min ReplicationStore Size', 'required': True}, 'per_replication_store_min_mbps': {'type': 'integer', 'format': 'int64', 'description': 'Minimum allowed throughput for ReplicationStores.', 'docs-hidden': True, 'title': 'Min ReplicationStore Throughput', 'required': True}, 'max_cloud_volume_count': {'type': 'integer', 'format': 'int64', 'description': 'Maximum number of CloudVolumes allowed.', 'docs-hidden': True, 'title': 'Max CloudVolume Count'}, 'per_user_max_cloud_volume_count': {'type': 'integer', 'format': 'int64', 'description': 'Maximum number of CloudVolumes allowed per user.', 'docs-hidden': True, 'title': 'Max CloudVolumes Per User'}, 'max_replication_store_count': {'type': 'integer', 'format': 'int64', 'description': 'Maximum number of ReplicationStores allowed.', 'docs-hidden': True, 'title': 'Max ReplicationStore Count'}, 'per_user_max_replication_store_count': {'type': 'integer', 'format': 'int64', 'description': 'Maximum number of ReplicationStores allowed per user.', 'docs-hidden': True, 'title': 'Max ReplicationStores Per User'}, 'bandwidth_limits': {'type': 'array', 'format': 'int64', 'item-type': 'integer', 'description': 'Available bandwidth limits for Azure Circuits.', 'docs-hidden': True, 'required': True}, 'type': 'object', 'description': 'Account limits.', 'required': True} |
discount | float | Account discount. | |
access_key | string | API access key. |
422
Invalid parameters.