Replication
put__replication_edit
Code samples
PUT /replication/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /replication/edit
Edit a replication pair.
Body parameter
{
"Application": "string",
"Volume": "string",
"TargetSystem": "string",
"Synchronous": true,
"Semisynchronous": true,
"Asynchronous": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ReplicationEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__replication_list
Code samples
GET /replication/list HTTP/1.1
Accept: application/json
GET /replication/list
List replicated volumes.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Limit results by the application instance name. |
| volume | query | string | false | Limit results by the volume name. |
| filterSecondary | query | boolean | false | Show only secondary volumes. |
| filterPrimary | query | boolean | false | Show only primary volumes. |
Example responses
200 Response
{
"Data": [
{
"Application": "string",
"Template": "string",
"Description": "string",
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"ConsistencyGroups": [
{
"Id": 0,
"ParentConsistencyGroupId": 0,
"ParentSnapshotId": 0,
"SnapshotScheduler": [
"string"
],
"IsVssBasedSnapshotScheduler": true,
"VssInitiators": [
"string"
],
"IsDirectVssMapping": true,
"IsAvailable": true,
"WorkerProcess": 0,
"Volumes": [
{
"Application": "string",
"Volume": "string",
"VolumeEntityId": 0,
"Id": 0,
"MetadataVolumeEntityId": 0,
"IsInternalVolume": true,
"CapacityInBytes": 0,
"SnapshotCapacityInBytes": 0,
"Tiers": {
"TierEntityIds": [
0
],
"TierPools": [
"string"
],
"TierN": [
0
],
"TierK": [
0
],
"TierSizesInBytes": [
0
],
"EvacuationThresholdsInPercentage": [
0.1
],
"LowerThresholdsInPercentage": [
0.1
],
"TierDataDegradationHistogram": [
[
0
]
],
"TierMetadataDegradationHistogram": [
[
0
]
]
},
"IsRoot": true,
"State": "Ok",
"Vms": [
"string"
],
"Shares": [
{
"Application": "string",
"Volume": "string",
"Share": "string",
"Path": "string",
"Browsable": true,
"RecycleBin": true,
"ReadonlyAccess": true,
"AllowedSubnets": [
"string"
],
"Smb": true,
"Nfs": true
}
],
"Profile": "string",
"Mapping": [
{
"Host": "string",
"LunId": 0
}
],
"Naa": "string",
"StatsInfo": {
"UserDataAllocatedSizeInBytes": 0.1,
"UserDataConsumedSizeInBytes": 0.1,
"UpperTierAllocatedSizeInBytes": 0.1,
"UpperTierConsumedSizeInBytes": 0.1,
"RetentionAllocatedSizeInBytes": 0.1,
"RetentionConsumedSizeInBytes": 0.1,
"VRAIDAllocatedSizeInBytes": 0.1,
"VRAIDConsumedSizeInBytes": 0.1,
"Iops": 0.1,
"LatencyInMilliseconds": 0.1,
"IoSizeInBytes": 0.1,
"ThroughputInBytes": 0.1
},
"FileSystemInformation": {
"MountState": "Mounted",
"ReplicationMetadata": "None",
"EnableSnapone": true,
"Profile": "string",
"FilesystemState": "string",
"InodeCount": "string",
"FreeInodes": "string",
"BlockSize": "string",
"BlockCount": "string",
"FreeBlocks": "string",
"FilesystemCreated": "string",
"LastMountTime": "string",
"LastWriteTime": "string",
"MountCount": "string",
"LastChecked": "string",
"LifeTimeWrites": "string"
},
"Object": {
"Application": "string",
"Volume": "string",
"IP": "string",
"FloatingIp": "string",
"Port": 0,
"EnableSsl": true,
"AccessKeys": [
"string"
],
"ObjectProvider": "Minio"
},
"ConnectivityType": "None",
"Replication": {
"IpAddress": "string",
"Port": 0,
"Role": "Unknown",
"InternalRole": "Unknown",
"LocalDataStatus": "NotAvailable",
"ReplicationPairs": [
{
"SyncInPercentage": 0.1,
"ReplicationId": 0,
"RemoteSystemName": "string",
"RemoteSystemId": 0,
"RemoteSystemRole": "Unknown",
"IpAddress": "string",
"Port": 0,
"RemoteAppName": "string",
"RemoteVolName": "string",
"ReplicationProtocol": "None",
"ConnectionStatus": "Initializing",
"RemoteDataStatus": "NotAvailable",
"RemoteDiskStatus": "Unknown"
}
]
},
"Pool": "string",
"StripedPools": [
"string"
],
"Log2StrideSectors": 0,
"DataDegradationHistogram": [
0
],
"MetadataDegradationHistogram": [
0
],
"MetadataPool": "string",
"StripedMetadataPools": [
"string"
],
"N": 0,
"K": 0,
"MetadataN": 0,
"MetadataK": 0,
"SectorSize": "string",
"Cgid": 0,
"GroupedVolume": "string",
"DisableSpaceReclamation": true,
"EncryptionKey": "string",
"SaveEncryptedRecoveryKey": true,
"Encrypted": true,
"Uptime": "string",
"ReadOnly": true,
"Force": true
}
],
"Snapshots": [
{
"Id": 0,
"Date": "2019-08-24T14:15:22Z",
"Owner": "None"
}
]
}
],
"Vms": [
{
"Name": "string",
"VolumeName": "string"
}
]
}
]
}
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ApplicationElementApiResult |
| 400 | Bad Request | Bad Request | string |
put__replication_primary
Code samples
PUT /replication/primary HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
PUT /replication/promote_primary
Promote secondary volumes to active/primary state.
Body parameter
{
"Application": "string",
"Volume": [
"string"
],
"Cgids": [
0
],
"AllSecondaryVolumes": true,
"InactiveFloatingToActivate": [
"string"
],
"ActivateAllInactiveFloatingIps": true,
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ReplicationPrimary | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__replication_refresh
Code samples
GET /replication/refresh HTTP/1.1
Accept: application/json
GET /replication/refresh
Refresh replication connections.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | Perform on this application only. |
| volume | query | string | false | Perform on this volume only. |
| reconnect | query | boolean | false | Disconnect and reconnect the replication link. |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
post__replication_start
Code samples
POST /replication/start HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /replication/start
Replicate a volume.
Body parameter
{
"Application": "string",
"Volume": "string",
"TargetSystem": "string",
"TargetApplication": "string",
"TargetVolume": "string",
"SourceFloatingIp": "string",
"TargetFloatingIp": "string",
"Synchronous": true,
"Semisynchronous": true,
"Asynchronous": true,
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ReplicationStart | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__replication_stop
Code samples
DELETE /replication/stop HTTP/1.1
Accept: application/json
DELETE /replication/stop
Stop volume replication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| application | query | string | false | The source app on which the volume you want to stop the replication. |
| volume | query | string | false | Source volume to stop replicating. |
| targetSystem | query | string | false | Stop replication for this target system. |
| allowOnDisconnected | query | boolean | false | Allow stopping the replication on systems which are disconnected. --force Force operation. |
| force | query | boolean | false | Force operation. |
| forceDeleteReplicationMetadata | query | boolean | false | Delete the replication metadata for NAS volumes. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
post__replication_floatingips_create
Code samples
POST /replication/floatingips/create HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /replication/floatingips/create
Create a replication floating ip.
Body parameter
{
"Name": "string",
"Nodes": [
"string"
],
"Interfaces": [
"string"
],
"Addresses": [
"string"
],
"Mask": "string",
"Gateway": "string",
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ReplicationFloatingipsCreate | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
delete__replication_floatingips_delete
Code samples
DELETE /replication/floatingips/delete HTTP/1.1
Accept: application/json
DELETE /replication/floatingips/delete
Delete a replication floating ip.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | The replication floating ip to delete. |
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
post__replication_floatingips_edit
Code samples
POST /replication/floatingips/edit HTTP/1.1
Content-Type: application/json-patch+json
Accept: application/json
POST /replication/floatingips/edit
Edit a replication floating ip.
Body parameter
{
"Name": "string",
"Newname": "string",
"Nodes": [
"string"
],
"Interfaces": [
"string"
],
"Addresses": [
"string"
],
"Mask": "string",
"Gateway": "string",
"Force": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| async | query | boolean | false | none |
| uncommitAndAggregateId | query | string | false | none |
| body | body | ReplicationFloatingipsEdit | false | none |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
get__replication_floatingips_list
Code samples
GET /replication/floatingips/list HTTP/1.1
Accept: application/json
GET /replication/floatingips/list
View replication floatings ips.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | Filter replication floating ips by name. |
| ip | query | string | false | Filter replication floating ips by ip. |
Example responses
200 Response
"string"
400 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
| 400 | Bad Request | Bad Request | string |
No Comments