DataCore REST API Reference Guide
To Table of Operations Abort Move Logical Disk
Aborts an active Move Logical Disk operation for the specified virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Abort Snapshot Group Operation
Aborts the current operation that is being performed on the specified snapshot group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Abort Snapshot Operation
Aborts the current operation that is being performed on the specified snapshot.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshots/{snapshotid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Abort Task
Aborts the specified running task.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/tasks/{taskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Abort Virtual Disk Reclamation
Aborts reclamation on the specified virtual disk. If aborted, the process can be restarted at a later time without damage to the virtual disk integrity, see Start Virtual Disk Reclamation.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Activate Licenses
Activates software license keys.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/licenses |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Terms of the license agreement must be accepted in order to activate a license. Pass one of the following parameter combinations: Server, ServerKey, CompanyName, ContactName, EmailAddress, PhoneNumber or GroupKey, Capacity, CompanyName, ContactName, EmailAddress, PhoneNumber. ServerKey and GroupKey parameters must be passed in separate operations. LicenseKeys is an array of LicenseKeyActivationInfo Partial activation of licensed storage capacity is allowed. For example, to activate half of a total licensed capacity of "100TB", pass "50TB" for the Capacity parameter. |
|
Response Code
|
200
|
|
Returns
|
None
|
|
Example 1
|
Description
URL
Request body Response body |
|
Example 2
|
Description
URL
Request body Response body |
|
Example 3
|
Description
URL
Request body Response body |
To Table of Operations Add Capacity Optimization Disks
Adds physical disks to the capacity optimization pool, which supports deduplication and compression.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Capacity Optimization Mirrored Special Device Disks
Adds physical disks to the capacity optimization pool and creates a new Mirrored Special Device group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add DvaRaidPool Disks
Adds physical disks to the capacity optimization pool and creates a new RAID 5 group, which supports deduplication and compression.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Host
Adds a host to the server group. After adding the host, ports can be added (see "Assign Port to Host" or "Register Port to Host").
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/hosts |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Host to Group
Adds a host to an existing host group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/hostgroups/{hostgroupid}/hosts |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Log Message
Adds a custom log message to the event log.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/logmessages |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
None
|
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Add Mirror Disk To Pool Member
Adds a mirror disk to the specified pool member.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/poolmembers/{poolmemberid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The physical disk that will be added as a mirror to the selected pool member must have size that is bigger or equal to the pool member. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Physical Disks to Pool
Adds physical disks to the specified disk pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/pools/{poolid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
To add disks to a shared pool, pass the pool ID, not the shared pool ID (SharedPoolID). To add a disk as a pool mirror, see Add Mirror Disk to Pool Member. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Replication Partner Group
Partners one server group to another server group in order to replicate virtual disks.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/replicationpartners |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Server
Adds a server to the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/servers |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Target Portal
Creates an iSCSI session connection.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/ports/iscsi/{portid}/targets |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
When UseChap is set to true the Username and Password are mandatory. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add User
Registers a user to gain access to the software.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/users |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Operating system credentials are used to authenticate users. User names must match Windows user accounts and must reside on all servers in the local server group. To use an email address, mail server and logon account must be set in the SMTP Settings for the server group, see Set SMTP Settings. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add User Ownership
Adds user ownership to the specified virtual disk resource.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/ownerships |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add vCenter
Adds vCenter in the list of the clients.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/vcenters |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Virtual Disk Mirror
Adds one more level of redundancy to a virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
When using a physical disk (pass-through) as the new storage source, data on the virtual disk will be copied to the pass-through disk. The physical disk must be at least as large as the virtual disk. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Add Virtual Disks To Group
Adds virtual disks to the specified virtual disk group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid}/virtualdisks |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Assign Port To Host
Assigns a discovered or known port to the specified host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/hosts/{hostid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Assign Role
Assigns the specified role to a user.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/users/{userid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Back Up Configuration
Backs up the current server group configuration and stores it in the configuration backup folder.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servergroups/{servergroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The Configuration Backup Folder must be set for all servers in the server group using Set Server Properties before running this operation. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Cancel Deactivate Replication
Aborts the pending deactivation of a virtual disk in a replication.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Cancel Delete Replication
Aborts the pending process to remove the relationship between the source and destination virtual disks in a replication.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Cancel Support Bundle Collection
Aborts the current support bundle process on servers in a server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/supportbundles |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Close Session
Closes the session identified by the specified token.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/sessions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
None
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Collect Support Bundle
Creates a support bundle and optionally transmits the support bundle to DataCore Technical Support.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/supportbundles |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Uploading the support bundle requires internet access from the server and port 3793 must be open in firewalls. If SkipUpload is set to true, the support bundle can be sent to technical support manually, no need to pass CompanyName and IncidentNumber. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Convert To Full Snapshot
Converts (promotes) a differential snapshot to a full snapshot.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshots/{snapshotid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Convert To Full Snapshot Group
Converts (promotes) a differential snapshot to a full snapshot group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Convert Virtual Disk To Dual
Convert a single virtual disk to dual.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Checkpoint" Trigger
Creates a checkpoint trigger for a task.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/triggers |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Log Message" Action
Creates a task action to post a log message.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Monitor" Trigger
Creates a monitor trigger for a task.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/triggers |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
Description
URL
Request body Response body |
To Table of Operations Create "Reclaim Space" Action
Creates a task action to reclaim space on a virtual disk.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Revert From Snapshot Group" Action
Creates a task action to revert all snapshots in the group. The source virtual disks become an image of the current state of the snapshots in the group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Revert From Snapshot" Action
Creates a task action to revert from a snapshot. The source virtual disk becomes an image of the current state of the snapshot.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Run Command" Action
Creates a task action to run a command.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Run PowerShell Script" Action
Creates a task action to run a PowerShell script.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Send Checkpoint Marker" Action
Creates a task action to send a checkpoint marker to a replication destination virtual disk.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Send Notification" Action
Creates a task action to send an email notification.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
The user must have an email address specified in the user properties and SMTP mail server information must be set for the server group. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Update Snapshot Group" Action
Creates a task action to update all snapshots in the group with the latest changes that occurred on the source virtual disks.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create "Update Snapshot" Action
Creates a task action to update a snapshot with the latest changes that occurred on the source virtual disk.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Dual Virtual Disks
Creates dual virtual disks.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtualdisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Creating a dual virtual disk requires the user to acknowledge that a shared pool meets all of the requirements of a shared multi-port array;
the parameter SMPAApproved is required to be true.
To create a dual virtual disk, pass one of the following combinations:
"FirstPool" and "SecondPool", which are the same shared pool (in this case the pool ID also identifies the server),
"FirstPhysicalDisk" and "SecondPhysicalDisk", which are the same shared physical disk,
"SharedPool" and both servers ("FirstServer" and "SecondServer"), or
"SharedPhysicalDisk" and both servers ("FirstServer" and "SecondServer").
"Size" parameter value consists of the number followed by the unit of measurement (MB, GB, TB).
Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB.
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Host Group
Creates a host group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/hostgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Mirrored Virtual Disks
Creates mirrored virtual disks.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtualdisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
To create a mirror virtual disk, pass one of the following parameter combinations: "FirstPool" and "SecondPool", "FirstPhysicalDisk" and "SecondPhysicalDisk", "FirstPool" and "SecondPhysicalDisk", or "FirstPhysicalDisk" and "SecondPool". "Size" parameter value consists of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB. OptimizeStaleOnly option can be enabled only when Inline Compression or Inline Deduplication, or both, are enabled. StaleDataWeight's Valid values are "32", "64", and "96". The input is rounded to these valid values. The default value is "64" which specifies the Normal Optimization Policy. Similarly "32" specifies Lazy and "96" specifies Aggressive Optimization Policy. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Passthrough Snapshot
Creates a full snapshot of a virtual disk on a passthrough disk. The passthrough disk should be intialized, but not partitioned.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/snapshots |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Pool
Creates a disk pool on the specified server in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/pools |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Description, ChunkSize, BlockSize, MaxTierNumber, TierReservePct, Disks, and Deduplication are optional parameters. Default values are: ChunkSize - "128MB", BlockSize - "512B", MaxTierNumber - 3, TierReservePct - 0, Deduplication - false |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Replication
Creates a replication relationship between a source and a destination virtual disk in order to asynchronously mirror data. The contents of the destination virtual disk will be overwritten.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/replications |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Role
Creates a custom user role and assigns privileges to the role. All, none, or individual privileges in each privilege group can be assigned.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/roles |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Use the referenced enums to find the decimal values for the individual privileges in the privilege group.
Privilege groups with no privileges do not need to be included in the request body; the default of 0 (no privileges) is assigned.
All roles should include the ViewInformation privilege ("1") in the General privilege group so that users can view information in the console.
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Create Rollback
Creates a rollback of a virtual disk.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/rollbacks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Rollback Group
Creates a rollback group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/rollbackgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Single Virtual Disks
Creates single virtual disks.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtualdisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
To create a single virtual disk, pass either "Pool" or "PhysicalDisk" parameter, not both. "Size" parameter value consists of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB. OptimizeStaleOnly option can be enabled only when Inline Compression or Inline Deduplication, or both, are enabled. StaleDataWeight's Valid values are "32", "64", and "96". The input is rounded to these valid values. The default value is "64" which specifies the Normal Optimization Policy. Similarly "32" specifies Lazy and "96" specifies Aggressive Optimization Policy. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Snapshot
Creates a snapshot of a virtual disk.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/snapshots |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Also see Create Passthrough Snapshot to create a snapshot on a passthrough disk. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Snapshot Group
Creates a snapshot group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/snapshotgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
Description
URL
Request body Response body |
|
Example 2
|
Description
URL
Request body Response body |
To Table of Operations Create Storage Profile
Creates a custom storage profile.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/storageprofiles |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Task
Creates a task used to automatically perform actions when triggered by events.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/tasks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
MaxRunTime is shared by all actions in the task. When the time has been reached, all actions will be terminated. If triggered again, the same time will be allotted to perform the actions again. To configure triggers, see Create "Checkpoint" Trigger, Create "Log Message" Trigger, Create "Scheduled Time" Trigger, Create "Monitor" Trigger. To configure actions, see Create "Log Message" Action, Create "Reclaim Space" Action, Create "Snapshot Group" Action, Create "Revert From Snapshot" Action, Create "Run Command" Action, Create "Run PowerShell Script" Action, Create "Send Checkpoint Marker" Action, Create "Send Notification" Action, Create "Update Snapshot Group" Action, and Create "Update Snapshot" Action. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Virtual Disk Group
Creates a virtual disk group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtualdiskgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Virtual Disk Template
Creates a virtual disk template.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtualdisktemplates |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
When creating a dual virtual disk template, use the PoolId for the servers (not SharedPoolId) for the parameters FirstPool and SecondPool. Size parameter value consists of the number followed by the unit of measurement(MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB. ContinuousDataProtectionLogSize parameter value consists of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "10GB", "20.5GB", and "5000MB" are valid sizes. The history log size can range from a minimum of 8GB up to 1024TB. OptimizeStaleOnly option can be enabled only when Inline Compression or Inline Deduplication, or both, are enabled. StaleDataWeight's Valid values are "32", "64", and "96". The input is rounded to these valid values. The default value is "64" which specifies the Normal Optimization Policy. Similarly "32" specifies Lazy and "96" specifies Aggressive Optimization Policy. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Virtual Disks From Template
Creates virtual disks from template.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtualdisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
All parameters except the VirtualDiskTemplate are optional. Use them to overwrite the values in the template. "Size" parameter value consists of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "100GB","1.5TB", and "500000MB" are valid sizes. Size can range from 1GB to 1024TB. OptimizeStaleOnly option can be enabled only when Inline Compression or Inline Deduplication, or both, are enabled. StaleDataWeight's Valid values are "32", "64", and "96". The input is rounded to these valid values. The default value is "64" which specifies the Normal Optimization Policy. Similarly "32" specifies Lazy and "96" specifies Aggressive Optimization Policy. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Virtual Disks From Virtual Disk
Creates virtual disks from virtual disk.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtualdisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
All parameters except the VirtualDisk are optional. Use them to overwrite the values from the virtual disk. |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Create Virtual Logical Unit
Creates a virtual logical unit (a front-end or mirror path for the specified logical disk).
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/virtuallogicalunits |
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
Either InitiatorPort or InitiatorHost must be passed. InitiatorPort is passed to select a specific port to use. When InitiatorHost is passed (without InitiatorPort), an initiator port from the InitiatorHost will be automatically selected. TargetPort is optional; when not passed a suitable target port is automatically selected based on the server of the logical disk. Ports must have the required role for the mapping type (mirror or front-end). |
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
Description
URL
Request body Response body |
|
Example 2
|
Description
URL
Request body Response body |
To Table of Operations Delete Action
Removes the specified action in a task.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/actions/{actionid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Alerts
Deletes all alerts for all servers in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
DELETE |
|
URI template
|
/1.0/alerts |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
None
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Host
Removes the specified host from the server group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/hosts/{hostid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Host Group
Removes the specified host group from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/hostgroups/{hostgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Logical Disk
Removes the specified logical disk from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/logicaldisks/{logicaldiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Ownership
Removes the specified ownership from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/ownerships/{ownershipid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Pool
Removes the specified disk pool from the server group. Pool cannot be removed if virtual disks are created from the pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/pools/{poolid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Port
Deletes a no longer present port from the server group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/ports/{portid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Replication
Removes (splits) a replication relationship between two virtual disks on different servers. The virtual disks will exist, but data changes will no longer be asynchronously mirrored between them.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Replication
Removes (splits) a replication relationship between two virtual disks on different servers. The virtual disks will exist, but data changes will no longer be asynchronously mirrored between them.
|
Version
|
2.0 |
|---|---|
|
Method
|
|
|
URI template
|
|
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
None
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Replication Partnerships
Removes a replication partner group from the server group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/replicationgroups/{replicationgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Role
Removes a specified role from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/roles/{roleid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Rollback
Removes the specified rollback from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/rollbacks/{rollbackid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Rollback From Group
Removes the specified rollback from a rollback group.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
DELETE |
||||||
|
URI template
|
/1.0/rollbackgroups/{rollbackgroupid}/rollbacks/{rollbackid} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
None
|
||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Rollback Group
Removes the specified rollback group from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/rollbackgroups/{rollbackgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Server
Removes the specified server from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Snapshot
Removes the specified snapshot from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/snapshots/{snapshotid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Snapshot From Group
Removes the specified snapshot from a snapshot group.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
DELETE |
||||||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid}/snapshots/{snapshotid} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
None
|
||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Snapshot Group
Removes the specified snapshot group from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Storage Profile
Removes the specified storage profile from the server group configuration. Default profiles cannot be removed.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/storageprofiles/{storageprofileid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Task
Removes the specified task from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/tasks/{taskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Trigger
Removes the specified task trigger from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/triggers/{triggerid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete User
Removes the specified user from the configuration. Default users cannot be removed.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/users/{userid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete vCenter
Removes the specified vCenter from the server group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/vcenters/{vcenterid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Virtual Disk
Removes the specified virtual disk from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Virtual Disk From Group
Removes virtual disks from a virtual disk group.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
DELETE |
||||||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid}/virtualdisks/{virtualdiskid} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
None
|
||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Virtual Disk Group
Removes the specified virtual disk group from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Virtual Disk Template
Removes the specified virtual disk template from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/virtualdisktemplates/{virtualdisktemplateid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Delete Virtual Logical Unit
Removes the specified virtual logical unit from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
DELETE |
|||
|
URI template
|
/1.0/virtuallogicalunits/{virtuallogicalunitid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Disable Capacity Optimization
Deletes capacity optimization pool in the server and disables capacity optimization on the server.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Disable Continuous Data Protection
Disables Continuous Data Protection (CDP) on the specified virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Disable Continuous Data Protection on Group
Disables Continuous Data Protection (CDP) on the specified virtual disk group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Disable Replication Test Mode
Disables replication test mode for a local standby virtual disk. Data changes on the standby virtual disk made during test mode are temporary and will be deleted when test mode is disabled.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Disable Sequential Storage
Disables Sequential Storage on the specified virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Disable Sequential Storage on Group
Disables the sequential storage setting on the specified virtual disk group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Disable Task
Disables the specified task.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/tasks/{taskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Edit Capacity Optimization
Changes the capacity optimization setting to the one specified.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/pools/{poolid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Enable Capacity Optimization
Creates a capacity optimization pool with RAID 0 or RAID 5 for the server with the specified physical disks and enables capacity optimization on the server.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Enable Continous Data Protection
Enables Continuous Data Protection (CDP) on the specified virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Enable Continuous Data Protection on Group
Enables Continuous Data Protection (CDP) on the specified virtual disk group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
When enabled, data changes are saved in a history log. If necessary, rollbacks can be created to recover data, see Create Rollback Group. To enable at the group level, all group members must be eligible for CDP and not be enabled; otherwise, members must be enabled individually. The default history log size will be used for all virtual disks in the group. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Enable Replication Test Mode
Enables replication test mode for a local standby virtual disk. Test mode temporarily activates the standby (destination) virtual disk which temporarily enables all host paths on the standby side. In test mode, users can ensure that paths are correctly configured and hosts have read/write access to the virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Warning: Test mode can take a considerable amount of time, uses storage allocation overhead, and can affect performance. Do not enable test mode during a disaster. Disable test mode when testing is complete, see Disable Replication Test Mode. Data changes on the standby virtual disk made during test mode are temporary and will be deleted when test mode is disabled. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Enable Sequential Storage
Enables Sequential Storage on the specified virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Enable Sequential Storage on Group
Enables the sequential storage setting on the specified virtual disk group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
To enable at the group level, all group members must be eligible for sequential storage and not be enabled; otherwise, members must be enabled individually. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Enable Task
Enables the specified task.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/tasks/{taskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Extend datastore
Extends the size of a datastore by increasing the size of the datastore's virtual disk and doing a VIM extend.
|
Version
|
2.0 |
|---|---|
|
Method
|
|
|
URI template
|
|
|
URI parameters
|
None |
|
Request Body
|
|
|
Notes
|
The datastore must be based on an SSY Virtual Disk from the connected server group. |
|
Response Code
|
200
|
|
Returns
|
None
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Force Logical Disk Online
Forces a logical disk of a mirrored virtual disk online in order to start mirror recovery. This operation is only valid when the data status of both logical disks of a virtual disk are not defined, unknown, or double failure. WARNING: This operation involves risks, use extreme caution. Recovering from the incorrect storage source can result in data loss.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/logicaldisks/{logicaldiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Actions
Returns data for all task actions for all servers in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/actions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Alerts
Returns data for all alerts for all servers in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/alerts |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Get Chunk Allocation Map
Returns storage allocation unit (SAU) data for each physical disk in the specified pool. Data can be used to determine the allocation distribution for disks in a pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/pools/{poolId}/chunkallocationmap |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Get Chunk Reclamation Map
Returns storage allocation unit (SAU) data for SAUs in reclamation for the specified pool. Data returned can be used to determine the distribution for SAUs in reclamation in the pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/pools/{poolId}/chunkreclamationmap |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Get Configuration
Returns the configuration state data for the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/configuration |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Get Current Time
Returns the current time for the specified server.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/servers/{serverid}/currenttime |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Get DcsDvaPool
Returns data for all DvaPools in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/dcsdvapool?server={server}&dvapool={dvapool} |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
Description
URL
Request body Response body |
|
Example 2
|
Description
URL
Request body Response body |
To Table of Operations Get DcsDvaPoolDisks
Returns data for DcsDvaPool disks in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/dcsdvapooldisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Disk Paths
Returns the mirror and back-end path data for physical disks in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/diskpaths |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get FC Ports
Returns data for Fibre Channel ports in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/ports/fc |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Host Groups
Returns data for all host groups in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/hostgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Hosts
Returns data for all hosts in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/hosts |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get iSCSI Ports
Returns data for server and host iSCSI ports in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/ports/iscsi |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Logical Disks
Returns logical disk (storage source) data for the server group. Data can be filtered by the parameters server and virtualDisk. If both parameters are specified, the logical disk on the specific server for the specific virtual disk are returned. If only the parameter server is specified, all logical disks on the specific server are returned. If no parameters are specified all logical disks in the server group are returned. (Also see Get Pool Logical Disks.)
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
GET |
||||||
|
URI template
|
/1.0/logicaldisks?server={server}&virtualDisk={virtualDisk} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
|||||||
|
Example 1
|
Description
URL
Request body Response body |
To Table of Operations Get Mirror Relations
Returns mirror relation data between two logical disks (storage sources) which are in such relation.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/mirrorrelations |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Monitor Templates
Returns templates for all system monitor types. This function can be used to identify a monitor template type ID for the Get Triggers function.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/monitortemplates |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Monitors
Returns all monitors in the system.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/monitors |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Object
Returns the identifiable object specified by the ID. This operation can be used to get an object that is identified by ID in the object returned from another operation.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/objects/{objectid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Ownerships
Returns user ownership data for resources in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/ownerships |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Performance
Returns performance counter data for the specified object (resource).
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/performance/{objectid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The returned type depends on the object used when getting performance. For example, if an ID of a virtual disk is passed, the VirtualDiskPerformance object is returned. See enum PerformanceType for more information. Some counter values accumulate and some counter values are displayed as the value at collection time. Accumulated values in returned objects are raw, unprocessed data at collection time, not "per second" as in the Management Console. For instance, to receive values per second the cmdlet would have to be invoked at least twice to calculate values per second. Descriptions of performance counters are provided as tool tips in the Performance tool in the DataCore Management Console. Some counters in the Performance tool are derived from raw data counters found in PerformanceData objects. Therefore, some raw data counters may not appear in the tool and some derived counters may not appear in retrieved PerformanceData objects. Special notes about these raw data counters are documented. For the Pool PerformanceData object: TotalWriteTime is a cumulative counter that measures the total time it took to perform all the write I/Os to the back-end pool disk. It is used to compute the Average Time/Write counter in the Performance tool. Average Time per Write = Δ TotalWriteTime / Δ TotalWrites. TotalReadTime is a cumulative counter that measures the total time it took to perform all read I/Os to the back-end pool disk. It is used to compute the Average Time/Read counter in the Performance tool. Average Time per Read = Δ TotalReadTime / Δ TotalReads. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Performance By Type
Returns performance counter data for the specified performance type (resource).
|
Version
|
2.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/2.0/performancebytype/{objecttypes} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Performance By Type
Returns performance counter data for the specified performance type (resource).
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/performancebytype/{objecttypes} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The returned type depends on the object used when getting performance. For example, if the type VirtualDiskPerformance is passed, an array of VirtualDiskPerformance objects is returned. See enum PerformanceType for more information. Some counter values accumulate and some counter values are displayed as the value at collection time. Accumulated values in returned objects are raw, unprocessed data at collection time, not "per second" as in the Management Console. For instance, to receive values per second the cmdlet would have to be invoked at least twice to calculate values per second. Descriptions of performance counters are provided as tool tips in the Performance tool in the DataCore Management Console. Some counters in the Performance tool are derived from raw data counters found in PerformanceData objects. Therefore, some raw data counters may not appear in the tool and some derived counters may not appear in retrieved PerformanceData objects. Special notes about these raw data counters are documented. For the Pool PerformanceData object: TotalWriteTime is a cumulative counter that measures the total time it took to perform all the write I/Os to the back-end pool disk. It is used to compute the Average Time/Write counter in the Performance tool. Average Time per Write = Δ TotalWriteTime / Δ TotalWrites. TotalReadTime is a cumulative counter that measures the total time it took to perform all read I/Os to the back-end pool disk. It is used to compute the Average Time/Read counter in the Performance tool. Average Time per Read = Δ TotalReadTime / Δ TotalReads. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get PhysicalDisks
Returns data for physical disks in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/physicaldisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Pool Logical Disks
Returns all logical disks created from the specified pool. (Also see Get Logical Disks.)
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/poollogicaldisks?poolid={poolId} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Pool Member Purge Prerequisites
Returns purge prerequisites for the specified pool member.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/poolmembers/{poolmemberid}/purgeprerequisites |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Get Pool Members
Returns data for pool members in all disk pools in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/poolmembers |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Pools
Returns the data for disk pools in the server group. Data can be filtered with the parameters server or pool. Specifying the server without the pool returns all pools for a specific server.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
GET |
||||||
|
URI template
|
/1.0/pools?server={server}&pool={pool} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
|||||||
|
Example 1
|
Description
URL
Request body Response body |
||||||
|
Example 2
|
Description
URL
Request body Response body |
To Table of Operations Get Port Connections
Returns data for the port connections in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/portconnections |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Ports
Returns SCSI port data for all servers and hosts in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/ports |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Preferred Servers
Returns the preferred servers that are set for the specified host. The settings Auto select and All return no data.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/hosts/{hostId}/preferredservers |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Recording Endpoints
Returns all performance recording endpoints. Each endpoint may be connected to a local DataCore Server or a remote SQL DataBase. The "Enabled" property determines if the user can modify the endpoint. One endpoint can be used from multiple(recording) sessions(for example both the "ChargeBackSession" and "UserRecordingSession").
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/recordingendpoints |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Recording Instances
Returns the instances in the database to which the specified recording endpoint.
|
Version
|
1.0 |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Method
|
GET |
||||||||||||
|
URI template
|
/1.0/recordinginstances?endpoint={endpoint}&category={category}&starttime={starttime}&endtime={endtime} |
||||||||||||
|
URI parameters
|
|
||||||||||||
|
Request Body
|
|
||||||||||||
|
Response Code
|
200
|
||||||||||||
|
Returns
|
|||||||||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Recording Performance
Returns recorded performance data for a specific instance or counters.
|
Version
|
1.0 |
||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Method
|
GET |
||||||||||||||||||||||||
|
URI template
|
/1.0/recordinginstances?endpoint={endpoint}&instance={instance}&starttime={starttime}&endtime={endtime}&resolution={resolution}&category={category}&counters={counters}&filtration={filtration} |
||||||||||||||||||||||||
|
URI parameters
|
|
||||||||||||||||||||||||
|
Request Body
|
|
||||||||||||||||||||||||
|
Response Code
|
200
|
||||||||||||||||||||||||
|
Returns
|
|||||||||||||||||||||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Replication Groups
Returns replication partner group data for the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/replicationgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Replications
Returns replication data for local and remote server group replications.
|
Version
|
1.0 |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Method
|
GET |
|||||||||
|
URI template
|
/1.0/replications |
|||||||||
|
URI parameters
|
|
|||||||||
|
Request Body
|
|
|||||||||
|
Response Code
|
200
|
|||||||||
|
Returns
|
||||||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Roles
Returns all user roles in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/roles |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Get Rollback Groups
Returns all rollback group data for the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/rollbackgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Rollbacks
Returns rollback data for all rollbacks in the server group.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
GET |
||||||
|
URI template
|
/1.0/rollbacks |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
|||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Server Groups
Returns server group data for the server group, including replication partner groups.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/servergroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Server Groups Ex
Returns extended server group data for the server group
|
Version
|
2.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/2.0/servergroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Server Hosts
Returns data for server hosts
|
Version
|
2.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/2.0/servers |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Servers
Returns system and product information, and server properties for all servers in the server group, including replication partners.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/servers |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Shared Physical Disks
Returns data for all shared physical disks for all servers in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/sharedphysicaldisks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Shared Pools
Returns data for shared pools in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/sharedpools |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Snapshot Group Creation Properties
Returns snapshot group creation data for all virtual disk(s) in the specified virtual disk group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/snapshotgroupcreationproperties/{virtualDiskGroupId} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Snapshot Groups
Returns snapshot group data for all snapshot groups in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/snapshotgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Snapshots
Returns all snapshot data for all virtual disks in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/snapshots |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Storage Profiles
Returns data for all storage profiles in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/storageprofiles |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Target Devices
Returns path data for all target ports used by all virtual disks in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/targetdevices |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Target Domains
Returns initiator/target path data for servers and hosts in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/targetdomains |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Tasks
Returns all tasks in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/tasks |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Triggers
Returns triggers for the tasks in the server group. Data can be filtered by a task ID to get all triggers for a specific task. If the parameter is not specified, all triggers in the server group are returned.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
GET |
|||
|
URI template
|
/1.0/triggers |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get User-Role Relationships
Returns data showing the relationship between all users in the server group and their assigned roles.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/userrolerelations |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Users
Returns data for all users in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/users |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get vCenters
Returns all registered vCenters.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/vcenters |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Virtual Disk Groups
Returns virtual disk group data for all virtual disk groups in the server group. (This will not return rollback groups or snapshot groups associated with the virtual disk groups, see Get Rollback Groups or Get Snapshot Groups.)
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/virtualdiskgroups |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Virtual Disk Templates
Returns all virtual disk templates for the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/virtualdisktemplates |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Get Virtual Disks
Return data for virtual disks in the server group, including the replication partner groups. Data can be filtered by parameters type and/or kind. If no parameters are specified, all virtual disks in the server group are returned.
|
Version
|
1.0 |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Method
|
GET |
||||||||||||
|
URI template
|
/1.0/virtualdisks?type={type}&kind={kind}&snapshot={snapshot}&rollback={rollback} |
||||||||||||
|
URI parameters
|
|
||||||||||||
|
Request Body
|
|
||||||||||||
|
Response Code
|
200
|
||||||||||||
|
Returns
|
|||||||||||||
|
Example 1
|
URL
Request body Response body |
||||||||||||
|
Example 2
|
URL
Request body Response body |
To Table of Operations Get Virtual Logical Units
Returns front-end or mirror path data for logical disks on all servers in the server group.
|
Version
|
1.0 |
|||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Method
|
GET |
|||||||||||||||
|
URI template
|
/1.0/virtuallogicalunits?initiatorport={initiatorport}&targetport={targetport}&initiatorhost={initiatorhost}&targethost={targethost}&virtualdisk={virtualdisk} |
|||||||||||||||
|
URI parameters
|
|
|||||||||||||||
|
Request Body
|
|
|||||||||||||||
|
Response Code
|
200
|
|||||||||||||||
|
Returns
|
||||||||||||||||
|
Example 1
|
URL
Request body Response body |
|||||||||||||||
|
Example 2
|
URL
Request body Response body |
|||||||||||||||
|
Example 3
|
URL
Request body Response body |
To Table of Operations Get VVol Bindings
Returns all VVOL bindings in the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
GET |
|
URI template
|
/1.0/vvolbindings |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Import DvaPool
Imports DvaPool for ILDC
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Import Pool
Imports a foreign pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/pools/{poolid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Login iSCSI Target
Logs in an iSCSI target port from the Microsoft Initiator on a server.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
POST |
||||||
|
URI template
|
/1.0/ports/iscsi/{portid}/targets/{targetid} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Notes
|
To use mutual authentication, specify both parameters "UseChap" and "UseMutualAuthentication". |
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
|||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Logout iSCSI Target
Logs out a specified iSCSI target port from the Microsoft Initiator on a server. Target cannot be in use.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
POST |
||||||
|
URI template
|
/1.0/ports/iscsi/{portid}/targets/{targetid} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
|||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Mark Replication Check Point
Sends a checkpoint marker to the virtual disk in a replication.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Move Logical Disk
Moves a logical disk in a mirrored or dual virtual disk. Paths are adjusted to use the new source.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The logical disk in a mirrored virtual disk can be moved to another disk pool on the same server. The logical disk in a dual virtual disk can be moved to another server that shares the pool. Use the PoolId for the correct server (not the SharedPoolId). |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Open Session
Opens new session and returns a token to identify it.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/sessions |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Pause Replication
Temporarily stops data transfers from the local (active) virtual disk in a replication.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
To begin transferring data again, see Resume Replication. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Pause Virtual Disk Mirror Recovery
Temporarily stops the current mirror recovery of the specified virtual disk. The recovery process will be paused until Resume Virtual Disk Recovery is run.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Purge Pool Member
Purges failed or missing physical disk (pool member) from a pool. Purging a physical disk removes the disk from the pool and from the server group configuration.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/poolmembers/{poolmemberid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The purge operation cannot prevent data loss on affected single or dual virtual disks. To allow the purge operation when single or dual virtual disks are affected by a failed disk, the AllowDataLoss parameter is required. Using this switch parameter signifies that you are aware that there will be data loss when the failed disk is purged. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Quick Create Virtual Disk and Serve
Create a virtual disk and serves it to the host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/hosts/{hostid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
"Size" parameter value consists of the number followed by the unit of measurement(MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Register Port To Host
Registers an undiscovered or unknown port to the specified host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/hosts/{hostid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Release Physical Disk
Releases a protected physical disk to the operating system.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/physicaldisks/{physicaldiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Discovered physical disks are initially protected or locked from use by the operating system. Releasing the physical disk allows it to be used by the operation system. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Remove Capacity Optimization Disks
Removes physical disks from the capacity optimization pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Use the physical disk ID (and not the capacity optimization disk ID). |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Remove Capacity Optimization Mirrored Special Device
Removes Mirrored Special Device from the capacity optimization pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Remove Host From Group
Removes the specified host from the specified host group.
|
Version
|
1.0 |
||||||
|---|---|---|---|---|---|---|---|
|
Method
|
DELETE |
||||||
|
URI template
|
/1.0/hostgroups/{hostgroupid}/hosts/{hostid} |
||||||
|
URI parameters
|
|
||||||
|
Request Body
|
|
||||||
|
Response Code
|
200
|
||||||
|
Returns
|
None
|
||||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Remove Physical Disks from Pool
Removes the specified physical disks from the specified disk pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/pools/{poolid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Physical disks cannot be removed if used in a virtual disk unless the physical disk is mirrored in the pool. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Repair Capacity Optimization
Repair capacity optimization tries to clear the errors on Capacity Optimization if it is not in healthy state.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Replace DvaRaidPool Disk
Replaces a specific disk in the capacity optimization pool with new disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Replace Logical Disk
Replaces a logical disk in a mirrored virtual disk using a new storage source from the same server.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The new storage source for the logical disk can be from a pool, pass-through disk, or logical disk. Use one of the following parameters: PhysicalDisk, LogicalDisk or Pool. Server parameter is not mandatory. All paths are adjusted to use the new source. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Replace Virtual Logical Unit
Replaces the initiator and/or target of a mapping (path) of the specified virtual logical unit. The same mapping type and access are used during the replacement.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtuallogicalunits/{virtuallogicalunitid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Also see Create Virtual Logical Unit to add a new path. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Rescan Port
Rescans the specified server port to discover disks.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/ports/{portid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Rescan Server Ports
Rescans all ports on the specified server to discover disks.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Reset Syslog Settings
Resets the Syslog settings to configure the settings used for outgoing Syslog messages.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/servergroups/{servergroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Resume Replication
Resumes data transfers on a paused virtual disk replication.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Resume Virtual Disk Mirror Recovery
Resumes the mirror recovery of the specified virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Reverse Replication
Reverses the direction of the data transfer between virtual disks used in a replication. The virtual disk in Active status is deactivated, and the virtual disk in Standby status is activated.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Revert Rollback
Reverts the CDP-enabled virtual disk to the state of the rollback.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/rollbacks/{rollbackid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Revert Rollback Group
Reverts the CDP-enabled virtual disk to the state of the rollback group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/rollbackgroups/{rollbackgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Revert Snapshot
Reverts the source virtual disk to the state of the snapshot.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshots/{snapshotid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Revert Snapshot Group
Reverts the source virtual disk to the state of the snapshot group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Run Task
Runs the specified task.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/tasks/{taskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Serve Virtual Disk
Serves the specified virtual disk to a host or host group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Virtual disks can be served through the following combinations of parameters: - InitiatorPort, TargetPort, and LUN (LUN is optional) - Host - HostGroup |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
Description
URL
Request body Response body |
|||
|
Example 2
|
Description
URL
Request body Response body Notes
|
To Table of Operations Serve Virtual Disk Group
Serves a virtual disk group to the specified host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Default Kmip Endpoint
Set default kmip endpoint to the server group.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/setdefaultkmipendpoint |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Host Group Properties
Sets the properties of the specified host group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/hostgroups/{hostgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
To disable the "MaxDataPerSecond" and "MaxIOPerSecond" parameters, set the value to 0. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Host Properties
Changes the requested properties of the specified host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/hosts/{hostid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
To remove preferred servers and set to Auto select, pass an empty string. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Logical Disk Access
Sets logical disk mirror and host access for the specified logical disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/logicaldisks/{logicaldiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Physical Disk Properties
Changes the name of the specified physical disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/physicaldisks/{physicaldiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Pool Member Properties
Changes the disk tier number of the specified pool member.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/poolmembers/{poolmemberid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Pool Properties
Changes the requested properties of the specified disk pool.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/pools/{poolid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Port Properties
Changes the name and/or description of the specified server or host port.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/ports/{portid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Replication Group Properties
Sets the requested properties of the specified replication group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/replicationgroups/{replicationgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Address, RemoteUsername and RemotePassword parameters must be passed together when changing any one of them. EnableCompression can be changed without passing the other parameters. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Replication Initialization Type
Sets the initialization type for the specified replication.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Replication Partner Transfer Address
Changes the replication transfer address for a replication partner
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/replicationpartners/{replicationpartnerid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Replication Snapshot
Assigns a snapshot to be updated for the destination virtual disk when a checkpoint is received.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/replications/{replicationid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
To remove the snapshot, pass an empty string in the parameter "Snapshot". |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Role Properties
Changes the properties of the specified user role.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/roles/{roleid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Use the referenced enums to find the decimal values for the individual privileges in the privilege group. All, none, or individual privileges in each privilege group can be assigned. Only the privilege groups with changes need to be passed in the body. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body Notes
|
To Table of Operations Set Rollback Group Properties
Changes the requested properties of the specified rollback group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/rollbackgroups/{rollbackgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Rollback Properties
Changes the requested properties of the specified rollback.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/rollbacks/{rollbackid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Server Default Snapshot Pool
Sets the pool used as default snapshot pool for the specified server.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Server Group Properties
Sets properties of the server group, such as name, description, recovery speed, and support bundle relay address. See Set SMTP Properties to configure the SMTP properties for the mail server used for outgoing email messages for the server group. See Set Syslog Settings to configure the settings used for outgoing Syslog messages.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/servergroups/{servergroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Server Mapstore
Sets the pool used for the snapshot mapstore for the specified server.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The mapstore setting cannot be removed after setting it, the mapstore can only be changed. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Server Properties
Changes the requested properties of the specified server. Properties include description, logstore, configuration backup folder, cache size, enabling or disabling cache, replication buffer folder, and hypervisor host. To set snapshot mapstore pool, see Set Server Mapstore.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
If the configuration backup folder does not exist, it will be created. The value for cache size is the number and unit of measurement such as "256MG" or 1GB". After changing the cache size, the server must be stopped and restarted (see Stop Server and Start Server operations). Caution: The default setting is the system managed cache size which has been optimized for I/O performance based on memory in the server. Do not alter default settings unless you are aware of the affect your changes will have on performance. If the Replication buffer folder does not exist, it will be created. The buffer should reside on the server used as the source of replications. The buffer should be a local NTFS volume partition with a drive letter (and optional folder name). Use a dedicated volume to avoid contention with other system or application files. Do not use a buffer on the boot disk or a virtual disk. To remove the buffer, pass an empty string. Hypervisor host allows virtual machines running DataCore software to create virtual disks from local storage and serve them to the hypervisor host. The hypervisor host must be registered as a host in the server group (see Add Host). |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set SMTP Properties
Sets the SMTP properties for the mail server used for outgoing email messages for the specified server group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/servergroups/{servergroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Email logon account must match an existing account known to the operating system and exist as a user in the server group. The parameter TCPPort is optional, and if not provided the default number 25 is used. Refer to Test SMTP Settings to send a test email. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Snapshot Group Properties
Changes the requested properties of the specified snapshot group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Snapshot Pool
Sets the preferred snapshot pool for the specified virtual disk. This is the pool from which snapshots will be created.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Snapshot Properties
Changes the requested properties of the specified snapshot.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/snapshots/{snapshotid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Storage Profile Properties
Changes the properties of a custom storage profile.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/storageprofiles/{storageprofileid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Syslog Settings
Sets the Syslog settings to configure the settings used for outgoing Syslog messages.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/servergroups/{servergroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Both AllSources and SourceType cannot be set in the same REST API Command. Both AllLevels and Level cannot be set in the same REST API Command. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Task Properties
Changes the requested properties of the specified task.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/tasks/{taskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set User Properties
Changes the requested properties of the specified user.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/users/{userid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Virtual Disk Group Properties
Changes the requested properties of the specified virtual disk group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
To disable the "MaxDataPerSecond" and "MaxIOPerSecond" parameters, set the value to 0. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Virtual Disk Properties
Modifies the requested properties of the specified virtual disk, including data protection (CDP) properties, and SCSI ID and inquiry data.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
NOTE: Use caution when changing values for SCSI Inquiry data (Vendor, Product, Revision, Serial). SCSI Inquiry data should not be changed unless it is required for hosts to discover and correctly use virtual disks. Changing these values unnecessarily or incorrectly will cause errors. Maximum lengths for the inquiry data: Vendor: 8, Product : 16, Revision: 4, Serial: 64. ScsiId: maximum length - 32, and valid characters: A-F; a-f; 0-9. Value for "Size" parameter is a string consisting of the number followed by unit of measurement (MB, GB, TB, PB). Size can range from "8GB" to "1PB". Value for "HistorySize" parameter is a string consisting of the number followed by unit of measurement (MB, GB, TB, PB). Size can range from "8GB" to "1PB". The history log retention time can be set for less than the licensed retention time. Value for "RetentionTime" parameter is a string consisting of the number of days, hours, minutes, and seconds. For example, "01.12:30:30" represents one day, 12 hours, 30 minutes, 30 seconds. (The retention time set can be retrieved by the Get Logical Disks operation, see RetentionTime in the returned object.) Value for "ReservedSpace" parameter is a string consisting of the number followed by unit of measurement (MB, GB, TB, PB). Size can range from "1GB" to the size of the virtual disk. OptimizeStaleOnly option can be enabled only when Inline Compression or Inline Deduplication, or both, are enabled. StaleDataWeight's Valid values are "32", "64", and "96". The input is rounded to these valid values. The default value is "64" which specifies the Normal Optimization Policy. Similarly "32" specifies Lazy and "96" specifies Aggressive Optimization Policy. See Set Snapshot Pool operation to set the preferred snapshot pool for a virtual disk. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set Virtual Logical Unit Properties
A virtual logical unit is a front-end or mirror path of a logical disk on a server. This operation changes the front-end path properties (Access and Preferred path) for the specified logical disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/1.0/virtuallogicalunits/{virtuallogicalunitid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Set VirtualDiskTemplate Properties
Changes the requested properties of the specified virtual disk template.
|
Version
|
2.0 |
|||
|---|---|---|---|---|
|
Method
|
PUT |
|||
|
URI template
|
/2.0/virtualdisktemplate/{vdtid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Split and Unserve Virtual Disk
Splits and unserves the storage source of the specified server from a mirrored, 3-copy, or dual virtual disk. All front-end paths from the specified server to hosts will be removed. In the case of a mirrored virtual disk, each server will retain a copy of the data as a single virtual disk. In the case of a 3-copy virtual disk, the specified server will retain a copy of the data as a single virtual disk, and a mirrored virtual disk is left from the remaining storage sources. In the case of a dual virtual disk, the specified server will be removed as a storage source of the virtual disk and result in a single virtual disk on the remaining server.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
The parameter Force will force the operation to be performed in the case of 3-copy virtual disks, when one of the active storage sources is being split and the inactive storage source is failed or is determined to be not up-to-date by the software. For example, the split will be forced when virtual disk is failed or in recovery. Forcing this operation may cause a full recovery. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Split Rollback
Terminates the relationship between a CDP-enabled virtual disk and a rollback.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/rollbacks/{rollbackid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Split Rollback Group
Terminates the relationship between a CDP-enabled virtual disk group and a rollback group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/rollbackgroups/{rollbackgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Split Snapshot
Terminates the relationship between the source virtual disk and a full snapshot. When split, the snapshot will be independent of the source and operation as a standard virtual disk.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshots/{snapshotid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Split Snapshot Group
Terminates the relationship between the source virtual disk group and a full snapshot group.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Split Virtual Disk
Splits a multi-copy or dual virtual disk that is not served. When splitting a multi-copy virtual disk, each server will retain a data copy as a single virtual disk. A dual virtual disk will become one single virtual disk on one server (the first server selected when the virtual disk was created).
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Start Server
Starts virtualization (mirroring capabilities) on the specified server. If the server is preferred, virtual disk paths using the server will failback and single virtual disks will be accessible to the host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Start Virtual Disk Reclamation
Starts reclamation on the specified virtual disk. The reclamation process de-allocates storage allocation units (SAUs) that are completely filled with zeros in the virtual disk. Those SAUs are added back to the available free space in the pool. The reclamation process could have an impact on the performance of the host. The process can be aborted without damage to the virtual disk integrity and restarted at a later time if performance is impacted, see Abort Virtual Disk Reclamation.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Stop Server
Stops virtualization on the specified server. Mirroring capabilities of the server are disabled and active server paths will failover and single virtual disks will be inaccessible to the host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servers/{serverid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Test SMTP Settings
Tests email notifications settings by sending a test email.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/servergroups/{servergroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Notes
|
Email logon account must match an existing account known to the operating system and exist as a user in the server group. The parameter TCPPort is optional, and if not provided the default number 25 is used. When the SMTP settings are set for the server group, the operation can be performed using only the Operation and TestEmailAddress parameters. To set SMTP settings, refer to the Set SMTP Settings operation. |
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Test Supportbundle Relay Address
Tests the connections between all servers in the server group and the support bundle relay server.
|
Version
|
1.0 |
|---|---|
|
Method
|
POST |
|
URI template
|
/1.0/supportbundles |
|
URI parameters
|
None |
|
Request Body
|
|
|
Response Code
|
200
|
|
Returns
|
|
|
Example 1
|
URL
Request body Response body |
To Table of Operations Unassign Port From Host
Unassigns a port from the specified host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/hosts/{hostid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Unassign Role
Removes the specified role from the user.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/users/{userid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Unserve All Virtual Disks from Host
Unserves all virtual disks from the specified host. Front-end paths are removed and virtual disks become inaccessible to the host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/hosts/{hostid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Unserve Virtual Disk
Unserves a virtual disk from a host. Front-end paths are removed and the virtual disk becomes inaccessible to the host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdisks/{virtualdiskid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Unserve Virtual Disk Group
Unserves virtual disk group from the specified host.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/virtualdiskgroups/{virtualdiskgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
None
|
|||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Update Snapshot
Updates a snapshot with the changes that have occurred on the source virtual disk since the snapshot was created or last updated.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshots/{snapshotid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Operations Update Snapshot Group
Updates a snapshot group with the changes that have occurred on the source virtual disk since the snapshot was created or last updated.
|
Version
|
1.0 |
|||
|---|---|---|---|---|
|
Method
|
POST |
|||
|
URI template
|
/1.0/snapshotgroups/{snapshotgroupid} |
|||
|
URI parameters
|
|
|||
|
Request Body
|
|
|||
|
Response Code
|
200
|
|||
|
Returns
|
||||
|
Example 1
|
URL
Request body Response body |
To Table of Types AccessToken
Represents access token that allows access to a specific network node from a specific iSCSI port.
|
To Table of Types AgentSet
|
To Table of Types APIUsage
APIUsage data for a one particular API
|
To Table of Types AsyncOperation
|
To Table of Types AsyncReplicationData
The data object that defines an asynchronous replication relationship.
|
To Table of Types AsyncReplicationNotification
Replication partner notification
|
To Table of Types BaseRecordingPointData
Basic type for recording data at a given point.
|
To Table of Types BitArrayEx
A mutable version of BitArray.
|
To Table of Types CategoryRecordingPointData
Recording data at a given point by category.
|
To Table of Types ChapLoginOptions
CHAP Login credentials
|
To Table of Types CheckpointTriggerData
Triggers when a replication checkpoint marker is received.
|
To Table of Types CheckpointTriggerState
State on which the task will be activated when the replication virtual disk receives a checkpoint marker.
|
To Table of Types ClientDiskData
Served virtual disk
|
To Table of Types ClientHostData
A client or host computer, one to which SANsymphony serves virtual disks.
|
To Table of Types ClientHostDataEx
A client host machine.
|
To Table of Types ClientReplicationData
A client or host computer, one to which SANsymphony serves virtual disk and have repliction on this disk.
|
To Table of Types ClientRollbackData
The data object that defines a rollback.
|
To Table of Types ClientServerRelationData
Client - preferred server relation information .
|
To Table of Types ClientSnapshotData
The data object defining a snapshot.
|
To Table of Types CollectionPointData
A single performance data point for a specific object.
|
To Table of Types ConfigurationData
Node configuration data.
|
To Table of Types ConfigurationInfoData
Latest configuration info.
|
To Table of Types ConnectionBinding
Connection binding information
|
To Table of Types ConnectionCredentials
Partnership connection credentials used to connect to remote server group
|
To Table of Types ConnectionDescriptor
Connection descriptor of one of the ports in the connection.
|
To Table of Types ConnectionParams
iSCSI connection parameters
|
To Table of Types ContactData
Contact information for the individual assigned to communicate with DataCore Support.
|
To Table of Types ContactSettings
Details of the individual who is the primary user contact for DataCore Support.
|
To Table of Types ContractVersionAttribute
Contract version attributes.
|
To Table of Types ContractVersionData
The service contract version.
|
To Table of Types DailyTriggerData
Every day at a specified time, optionally only on weekdays.
|
To Table of Types DataCoreDiskData
Represents a physical disk that is a member of a virtual disk, i.e. a pass through disk
|
To Table of Types DataSize
Represents the data size
|
To Table of Types DiscoveryConfig
ConfigTSIH configuration
|
To Table of Types DiskPathData
A disk path consists of a target channel, initiator channel, and a Logical Unit Number or LUN (this triplet may also be commonly referred to as a LUN) and the physical disk presented on that connection.
|
To Table of Types DiskPoolData
Properties of a disk pool
|
To Table of Types DiskPoolDataEx
A disk pool.
|
To Table of Types DiskPoolPerformance
Disk pool performance data.
|
To Table of Types DistributionResult
Provides the result of distribution action.
|
To Table of Types DistributionResultSet
Provides an array of DistributionResult
|
To Table of Types DvaPerformance
Disk pool performance data.
|
To Table of Types DvaPoolData
Properties of a Dva disk pool
|
To Table of Types DvaPoolDeviceData
Properties of a device that is used in a Dva pool
|
To Table of Types DvaPoolDiskData
Properties of a physical disk that is used in a Dva disk pool
|
To Table of Types DvaPoolVolData
|
To Table of Types EmailActionData
An action sends an email to the specified recipient.
|
To Table of Types ExceptionType
An enum to describe the type of error, and thus how to handle it in an interface that connects to the Rest service.
|
To Table of Types ExecutiveError
Executive error details
|
To Table of Types FcConnectionData
Fibre Channel (FC) connection data, describing a connection between two FC ports.
|
To Table of Types FcPortCapabilityInfo
Fibre Channel port capabilities
|
To Table of Types FcPortConfigInfo
Fiber Channel port configuration
|
To Table of Types FcPortData
Fibre Channel-specific data.
|
To Table of Types FcPortExtraCapability
Extra capabilities valid only after Port can talk to the hardware
|
To Table of Types FcPortIdInfo
Fibre Channel hardware information
|
To Table of Types FcPortStateInfo
Fibre Channel port state info
|
To Table of Types FeatureFlagData
Contains all feature flags
|
To Table of Types GroupConsistencyPoint
A point in time defining a stable state for a virtual disk group.
|
To Table of Types GroupConsistencyPointData
Basic data for a point in time defining a stable state for a virtual disk group.
|
To Table of Types HeatmapCompressedValue
A helper class for compressing heatmap information.
|
To Table of Types HostData
A host computer, either a server or a client.
|
To Table of Types HostGroupData
Host group.
|
To Table of Types HostGroupPerformance
Host Group performance data.
|
To Table of Types HostVersionData
Version information for the service host system.
|
To Table of Types HostVirtualDiskData
An extended representation of the virtual disk data.
|
To Table of Types Identifiable
All Data Contract types are derived from identifiable objects, providing a consistent identification and description mechanism.
|
To Table of Types IdentifiablePerformanceData
Performance data for every identifiable object.
|
To Table of Types IldcConfigurationData
Internal parameters used to configure the performance and behavior of the ILDC feature.
|
To Table of Types InquiryData
Data returned from the SCSI inquiry command, describing the device queried.
|
To Table of Types InstanceCollectionPointData
Particular point data for a specific instance.
|
To Table of Types InstanceRecordingPointData
Recording data at a given point by instance.
|
To Table of Types iScsiPortalConfigInfo
iSCSI portal configuration
|
To Table of Types iScsiPortCapabilityInfo
iSCSI port capabilities
|
To Table of Types iScsiPortIdInfo
iSCSI port hardware information
|
To Table of Types iScsiPortStateInfo
iSCSI portal state information
|
To Table of Types iScsiSessionData
iSCSI session data for a port connection.
|
To Table of Types iScsiTargetData
Description of an iSCSI target.
|
To Table of Types iScsiTargetPortalData
iSCSI target portal information.
|
To Table of Types iSNSConfig
iSNS server configuration
|
To Table of Types KeyTypeEnum
The type of key
|
To Table of Types KmipEndpointContactRequest
The status of a Kmip endpoint contact request indicating what server issued the request, to which endpoint, and the success \ failure.
|
To Table of Types KmipEndpointData
A class used to define an external KMS server
|
To Table of Types KmipResponseData
A class that represents the response of a kmip request indicating success or failure, what kmip endpoint was contacted, and from which server.
|
To Table of Types LicenseActivationBinding
The license activation binding.
|
To Table of Types LicenseActivationEndpointAddress
The endpoint address for the DataCore licensing service.
|
To Table of Types LicenseFeatures
Server license features
|
To Table of Types LicenseKeyActivationInfo
The data required for a license key activation
|
To Table of Types LicenseResult
The license result which includes the license and description.
|
To Table of Types LicenseSettings
The settings for all licensed features.
|
To Table of Types LinkErrors
Link errors - A link error occurs when the communication link is "broken" for any period of time when the Fibre Channel port is logged in.
|
To Table of Types LocalRecordingEndpointSettings
Local recording endpoint settings.
|
To Table of Types LogFilterExpression
Log filter expression based on specific log parameter.
|
To Table of Types LogicalDiskData
The base class for the various types of logical disks.
|
To Table of Types LogicalDiskDistributionSet
Provides a map of logical disks to the list of servers they can be evacuated to, arranged by the preference.
|
To Table of Types LogicalDiskPerformance
Logical disk performance data.
|
To Table of Types LogMachineInfo
Log machine information
|
To Table of Types LogMachinePrefilters
Complete prefilter information for a logging machine.
|
To Table of Types LogMessage
Treat all fields as readonly. Use for all operations on this class including creation of new instance of it.
|
To Table of Types LogMessageId
Log message id
|
To Table of Types LogPrefilters
Logging prefilter values organized by categories. Each field contains values for a corresponding category.
|
To Table of Types LogSearchResult
The result of searching for the next or previous log message.
|
To Table of Types LogSortCriteria
Log messages sort criteria based on the specific parameter.
|
To Table of Types LogSource
Source of the log
|
The SCSI logical unit number.
|
To Table of Types MachinePerformance
Machine performance data.
|
To Table of Types MachinePerformanceEx
An extended representation of machine performance data
|
To Table of Types MemberAllocationInfoData
Provides a bit map array of the allocated chunks of a pool member.
|
To Table of Types MessageActionData
A message action posts a log message.
|
To Table of Types MessageTriggerData
Triggers when a log message meeting specified conditions is received.
|
To Table of Types MessageTriggerState
State on which the task will be activated based on the matching event log.
|
To Table of Types MethodActionData
Method actions are SSV operations that can be directly triggered by a task. Each of these operate on a specified SSV object.
|
To Table of Types MirrorData
The data object that defines a mirror.
|
To Table of Types MirrorDiskData
Represents the two logical disks used in a mirrored virtual disk, one of which is the physical disk in the local logical disk.
|
To Table of Types MirroringPerformance
Mirroring performance data (counters related to mirroring data between two logical disks).
|
To Table of Types MirrorRelationData
Data of a one-directonal mirror relation
|
To Table of Types MonitorData
The common properties of all monitors.
|
To Table of Types MonitorTemplateData
A template is created first, and applies to the specified object type. A specific monitor is then created from a template. This is done automatically by SANsymphony for all monitorable objects, monitors and templates cannot be created through the API.
|
To Table of Types MonitorTriggerData
Triggers when a specified monitor matches a specified condition.
|
To Table of Types MonitorTriggerState
State on which the task will be activated when the chosen monitor reaches the specified state criteria.
|
To Table of Types MonthlyTriggerData
Monthly at a specified time and day of the month, optionally a day of a week in the month (third Tuesday, for example).
|
To Table of Types NetAddress
Net address
|
To Table of Types Node
Represents a single iSCSI node
|
To Table of Types NodeList
Represents list of iSCSI nodes
|
To Table of Types OperationContextData
Stores the context of the operation being executed.
|
To Table of Types OperationData
Base class for all interactor state objects.
|
To Table of Types OwnershipData
Ownership information between user and target objects.
|
To Table of Types PartnerServerHostData
A remote replication partner server data.
|
To Table of Types PartnershipData
Partnership data. Partnerships support remote replication.
|
To Table of Types PassThroughLogicalDiskData
A pass-through disk is used and presented through a virtual disk without writing anything to the disk. This means that any file system, for example, already present on the disk is preserved completely.
|
To Table of Types PCIInfo
SCSI PCI information
|
To Table of Types PerfMonitorTemplateData
The template for performance monitors. In the performance monitor case there is a one-to-one relationship between the monitors and the templates, i.e. each monitor has one template and vice-versa.
|
To Table of Types PerformanceData
The base of all performance data classes.
|
To Table of Types PerformanceInstanceData
Object identifying and describing the instance in a recording session.
|
To Table of Types PerformanceInstanceKeyData
Performance key data of a specific object instance.
|
To Table of Types PerformanceRecordingSessionData
Description of performance recording session.
|
To Table of Types PerformanceRequestData
Performance data request.
|
To Table of Types PerfRecordingStatisticsData
Statistics data for a performance record.
|
To Table of Types PhysicalDiskData
The properties and status of physical disks. Physical disks are the direct representation of hardware disk devices presented by the operating system.
|
To Table of Types PhysicalDiskDataEx
An extended representation of physical disk data
|
To Table of Types PhysicalDiskLayout
The presented physical layout of a virtual disk, i.e. how the SCSI initiator sees the disk.
|
To Table of Types PhysicalDiskPerformance
Physical disk performance data.
|
To Table of Types Plugin
Plugin information tracked by API Scoreboard
|
To Table of Types PoolHeatmapData
A snapshot of the heatmap state at a particular point in time.
|
To Table of Types PoolLogicalDiskData
A logical disk that has been created from a pool and is therefore thin-provisioned.
|
To Table of Types PoolLogicalDiskPerformance
Pool logical disk performance data, includes all logical disk data plus thin provisioning data.
|
To Table of Types PoolMemberData
A pool member is an abstraction of the physical disks that constitute a pool, specifically because a pair of mirrored disks in a pool is considered a single member for many purposes. For example, tiering applies to members, not physical disks, essentially meaning both disks in a mirrored member must be in the same tier.
|
To Table of Types PoolMemberDataEx
A pool member, a representation of the physical disks assigned to a pool.
|
To Table of Types PoolMemberHeatmapData
The heatmap data for a particular pool member.
|
To Table of Types PoolMemberPerformance
Pool member performance data.
|
To Table of Types PoolPhysicalDiskChunkStatistics
Statistics for the allocated SAUs on a physical disk per virtual disk.
|
To Table of Types PortalCapabilityInfo
iSCSI portal capability info
|
To Table of Types PortalIdInfo
iSCSI portal hardware information
|
To Table of Types PortalStateInfo
Represents portal state
|
To Table of Types PortConfigInfo
iSCSI port configuration
|
To Table of Types PortConnectionData
General connection data for all types of ports.
|
To Table of Types PortDescriptor
The port descriptor of one of the ports in the connection.
|
To Table of Types PrivilegeSet
Represents a set of privilege groups
|
To Table of Types ProcessorInformation
Provides information about the processor architecture and number of cores.
|
To Table of Types ProductKeyData
Product keys are identifiers provided by DataCore product fullfillment that are used to activate product features.
|
To Table of Types ProductKeyDataEx
An extended representation of product key data
|
To Table of Types ProductVersionData
Version information for the software product.
|
To Table of Types RecordingEndpointData
Recording endpoint data
|
To Table of Types RecordingEndpointProperties
Properties of a recording endpoint.
|
To Table of Types RecordingSessionPropertiesData
Description of recording session properties.
|
To Table of Types RegionNodeData
Region node data. A node is a computer that is a member of the region. Currently all nodes are host servers, so the distinction between nodes and hosts is for future development. A node is where the controller resides. The controller is a client to all servers in the region that coordinates the servers, controls and synchronizes the region configuration, and handles communication with external clients. The controller is always running on just one node and will migrate with arbitration if a node become unavailable.
|
To Table of Types RemoteRecordingEndpointSettings
Remote recording endpoint settings.
|
To Table of Types ReplicationData
The data object that defines an asynchronous replication relationship.
|
To Table of Types ReplicationEndpoint
Defines an endpoint of a replication relationship, which is a specific virtual disk on a specific server.
|
To Table of Types ReplicationGroupData
Unused: for future enhancements.
|
To Table of Types ReplicationPerformance
Replication performance data
|
To Table of Types ReplicationStateInfo
This class contains all the information that determines a replication state.
|
To Table of Types RestDataBase
Base class
|
To Table of Types RestOperation
|
To Table of Types RoleData
A role is a set of privileges which can be assigned to users.
|
To Table of Types RollbackData
The data object that defines a rollback.
|
To Table of Types RollbackGroupData
Unused: for future enhancements
|
To Table of Types RollbackStateData
Rollback on client's virtual disks
|
To Table of Types RollbackVirtualDiskData
Client's rollbacks with snapshots
|
To Table of Types SauSizeExtensions
Extension methods for SAU sizes
|
To Table of Types ScheduledTriggerData
Time-based scheduled triggers. Used directly, this class supports one-time schedules.
|
To Table of Types ScriptActionData
A script action invokes either a general script or a powershell script.
|
To Table of Types ScsiPath
The low-level SCSI path information.
|
To Table of Types ScsiPortData
A SCSI port of any type.
|
To Table of Types ScsiPortDataEx
An extended representation of the SCSI port data.
|
To Table of Types ScsiPortNexusData
A nexus is a pair of ports that can communicate; one being the initiator and the other the target.
|
To Table of Types ScsiPortPerformance
Scsi port performance data, totals for both initiator and target operations.
|
To Table of Types ServerFcPortData
Data about Fibre Channel ports on DataCore Servers.
|
To Table of Types ServerFcPortPropertiesData
Fibre Channel port properties.
|
To Table of Types ServerGroupPerformance
Server group performance data.
|
To Table of Types ServerHostData
DataCore Server data.
|
To Table of Types ServerHostDataEx
An extended representation of server hosts
|
To Table of Types ServerHostGroupData
Server group data. A server group contains servers that can participate in mirroring with each other.
|
To Table of Types ServerHostGroupDataEx
An extended representation of server groups
|
To Table of Types ServeriScsiPortData
Data about iSCSI ports on DataCore Servers.
|
To Table of Types ServeriScsiPortPropertiesData
iSCSI server port properties.
|
To Table of Types ServerMachinePerformance
Server machine performance data.
|
To Table of Types ServerMSiScsiInitiatorData
The Microsoft Initiator description on a DataCore Server.
|
To Table of Types ServerPoolData
Server-specific pool details.
|
To Table of Types ServerPortPropertiesData
Server port-specific properties.
|
To Table of Types ServerScsiPortData
A port in a DataCore Server.
|
To Table of Types ServerScsiPortDataEx
An extended representation of server ports
|
To Table of Types ServerScsiPortPerformance
Server scsi port performance data, which is broken down by initiator and target operations.
|
To Table of Types ServerTime
Server time data type
|
To Table of Types SessionData
Data for the token used for the authorization and session info
|
To Table of Types SessionDescriptor
Descriptor of one of the ports in the connection.
|
To Table of Types SessionParams
Session communication parameters.
|
To Table of Types SharedDiskPoolData
Properties of a shared disk pool.
|
To Table of Types SharedDiskPoolPerformance
Shared disk pool performance data.
|
To Table of Types SharedPhysicalDiskData
A shared physical disk is a construct representing a common backend storage source seen between two or more servers.
|
To Table of Types SharedPhysicalDiskPerformance
Shared physical disk performance data.
|
To Table of Types SLPConfig
Service Location Protocol config
|
To Table of Types SmtpServerSettings
Settings for sending mail through an SMTP mail server.
|
To Table of Types Snapshot
Snapshot on client's virtual disks
|
To Table of Types SnapshotBitmapData
Provides a bit map array of the allocated chunks of a snapshot.
|
To Table of Types SnapshotData
The data object defining a snapshot.
|
To Table of Types SnapshotGroupCreationData
Provides an array of default snapshot properties like destination pool, storage profile and compression for each virtual disk in virtual disk group.
|
To Table of Types SnapshotGroupData
For future use.
|
To Table of Types SnapshotGroupPerformance
Snapshot group performance data
|
To Table of Types SnapshotRelationPerformance
Snapshot relation performance data.
|
To Table of Types SnapshotVirtualDisk
Client's virtual disks with snapshots
|
To Table of Types StatusLevel
A basic representation on the severity of a status message.
|
To Table of Types StorageDomainSettings
Settings that will be provided to the DcsSDC driver.
|
To Table of Types StorageProfileData
A storage profile encapsulates attributes of storage which can be associated with multiple virtual volumes, centralizing management of those attributes.
|
To Table of Types StorageUsage
Represents the storage usage from a foreign storage to DataCore Disk backend.
|
To Table of Types StreamLogicalDiskData
All pool logical disks are in fact stream logical disks, since it is impractical to convert disk types. A disk with CDP enabled actually consists of two disks, both of which are StreamLogicalDisks. The base disk has the settings and controls CDP operation. The base disk is the image of the oldest point in time, the history has all the writes since then. As the retention time is exceeded, blocks from the history log are destaged to the base disk. There is also a space limit (a soft limit, in as much as it can be temporarily exceeded in some scenarios), so the oldest data is destaged if the space limit or the time limit is exceeded. When CDP is enabled, new history log disk is created. The history log disk keeps a chain of disk blocks with time stamps, remembering every block that has been changed based on the base disk.
|
To Table of Types StreamLogicalDiskPerformance
Stream logical disk performance data.
|
To Table of Types SupportBundleRelayTest
Support bundle relay test type
|
To Table of Types SyslogServerSettings
Settings for sending logs to a Syslog server.
|
To Table of Types TaskActionData
The base class of all task actions.
|
To Table of Types TaskData
The data defining a task. Actions and triggers are associated with a task by virtue of having the task Id.
|
To Table of Types TaskTriggerData
Task trigger configuration, the root of all types of triggers.
|
To Table of Types TelemetryData
The information about the plug-ins and software installed on the host
|
To Table of Types ThresholdMonitorData
Threshold monitors apply to objects with continuous values as opposed to discrete states. The threshold levels can be set through this service.
|
To Table of Types ThresholdMonitorTemplateData
Threshold monitors specify three levels of the performance counter corresponding to the alarm states of the monitor.
|
To Table of Types TimeInterval
Represents a time interval.
|
To Table of Types TimeIntervalTriggerData
Periodically with an fixed interval in hours and minutes.
|
To Table of Types TokenAuthorizationInfo
|
To Table of Types TokenData
Information for the token.
|
To Table of Types TriggerState
State on which the task will be activated at the specified date and time.
|
To Table of Types UserData
The data object that defines a user.
|
To Table of Types UserRoleRelationData
User - role relation information.
|
To Table of Types VcenterPluginData
vCenter plugin required information
|
To Table of Types VersionData
The version information for a public service.
|
To Table of Types VimClientHostData
A VMware client machine (host or virtual machine).
|
To Table of Types VimClientHostDataEx
A VMware client machine (host or virtual machine).
|
To Table of Types VimClusterData
A VMware Cluster.
|
To Table of Types VimClusterDataEx
Vim Cluster data
|
To Table of Types VimConnectorData
Base class for VMware systems (vCenter or ESX).
|
To Table of Types VimDatacenterData
A VMware Datacenter.
|
To Table of Types VimDatacenterDataEx
Vim DataCenter data
|
To Table of Types VimDatastoreData
A VMware Datastore.
|
To Table of Types VimHostData
A VMware host.
|
To Table of Types VimHostDataEx
A VMware host.
|
To Table of Types VimVirtualCenterData
A VMware Virtual Center.
|
To Table of Types VimVirtualCenterDataEx
vCenter data
|
To Table of Types VimVirtualMachineData
A VMware virtual machine.
|
To Table of Types VimVirtualMachineDataEx
A VMware virtual machine.
|
To Table of Types VirtualDiskChunkStatistics
Statistics for the allocated SAUs on a virtual disk.
|
To Table of Types VirtualDiskData
The data object that defines a virtual disk.
|
To Table of Types VirtualDiskGroupBasePerformance
Virtual Disk Group performance data.
|
To Table of Types VirtualDiskGroupData
Virtual disk group.
|
To Table of Types VirtualDiskGroupPerformance
Virtual disk group performance data
|
To Table of Types VirtualDiskPerformance
Virtual disk performance data.
|
To Table of Types VirtualDiskTemplateData
A class used to simplify the creation of virtual disks.
|
To Table of Types VirtualLogicalUnitData
The data object that defines a virtual logical unit, which is a mapping (path) of a disk to a device.
|
To Table of Types VirtualLogicalUnitPerformance
Virtual logical unit performance data.
|
To Table of Types VirtualTargetDeviceData
The device information from the perspective of the target.
|
To Table of Types VirtualTargetDevicePerformance
Virtual target device performance data.
|
To Table of Types VirtualTargetDomainData
A pair of servers that can host mappings, one as an initiator, one as a target.
|
To Table of Types VirtualTargetDomainPerformance
Virtual target domain performance data.
|
To Table of Types VVOLBindingData
The information required to present a VVOL virtual disk to a host machine.
|
To Table of Types WeeklyTriggerData
Weekly at a specified time and day(s).
|
To Table of Types WitnessContactRequest
The status of a witness contact request indicating what server issued the request, to which witness, and the success \ failure.
|
To Table of Types WitnessData
A class used to keep virtual disks from experiencing mirror corruption.
|
To Table of Types WitnessResponseData
A class that represents the response of a witness request indicating success or failure, what witness was contacted, and from which server.
|
World Wide Name used to identify Fibre Channel.
|
To Table of Types XYPoint
Class that holds a point of time and performance value
|
To Table of Types YearlyTriggerData
Yearly at a specified time and date, optionally a day of a week in a month (first Monday in January, for example).
|
To Table of Enums AccessRights
Storage access rights
|
To Table of Enums ActionBehavior
How an action is invoked.
|
To Table of Enums AliasType
Alias type
|
To Table of Enums AsyncReplicationNotificationType
Replication partner notification type
|
To Table of Enums AsyncReplicationPriority
The replication priority setting in the virtual disk storage profile.
|
To Table of Enums AuthenticationMode
iSCSI Authentication modes
|
To Table of Enums AuthenticationType
iSCSI Authentication type
|
To Table of Enums AuthorizationContext
The authorization context used by VSS
|
To Table of Enums BitMapType
Snapshot map type
|
To Table of Enums CacheState
Write chaching state
|
To Table of Enums ClassOfService
Fibre Channel class of service which defines the flow control.
|
To Table of Enums ClientMachinePrivileges
Grants privileges to perform actions on hosts such as creating, configuring, and deleting hosts.
|
To Table of Enums ClientMachineType
Client machine type
|
To Table of Enums ClientState
Client state
|
To Table of Enums ComparisonOperator
The type of comparison between two values.
|
To Table of Enums ConfigurationState
Configuration state type
|
To Table of Enums ConnectionMode
Fibre channel port connection modes with user friendly description
|
To Table of Enums DataRateMode
Fibre channel port data rate modes with user friendly description
|
To Table of Enums DataStatus
Data status between the two copies of data in a mirrored virtual disk and the recovery.
|
To Table of Enums DataStoreServiceState
Recording session status
|
To Table of Enums DiagnosticMode
Diagnostic mode type
|
To Table of Enums DiskDataProtectionRole
The CDP role of a logical disk.
|
To Table of Enums DiskPoolPrivileges
Grants privileges to perform actions on disk pools such as creating, configuring, deleting, and importing pools, as well as adding and removing disks from pools.
|
To Table of Enums DiskPoolStatus
Disk Pool States
|
To Table of Enums DiskSmartStatus
Disk smart status
|
To Table of Enums DiskType
Physical disk types
|
To Table of Enums DistributionWarning
Warnings if the virtual disk is not eligible to be moved
|
To Table of Enums DvaPoolDiskResilveringStatus
Dva pool disk states
|
To Table of Enums EndpointType
Endpoint type
|
To Table of Enums ErrorRecoveryLevel
Error recovery level
|
To Table of Enums ExecutivePrivileges
Grants privileges to perform actions on service level operations such as starting and stopping the DataCore Executive service, synchronizing out-of-synch configurations, and running a diagnostic operation.
|
To Table of Enums FileSystemType
File system type
|
To Table of Enums FilterConnective
Specifies the logical operator used to evaluate a set of filters.
|
To Table of Enums GeneralPrivileges
Grants privileges to perform general actions, such as viewing information in the consoles and cmdlets, and renaming objects. This privilege set is necessary and will be automatically added to all roles without being selected by the administrator.
|
To Table of Enums HostGroupPrivileges
Grants privileges to perform actions on host groups such as creating, configuring, and deleting host groups, and adding or removing hosts from host groups.
|
To Table of Enums KmipPrivileges
Grants privileges to perform actions on witnesses such as creating, configuring, and deleting.
|
To Table of Enums LicensedSqlServerEdition
Licensed Sql Server Edition
|
To Table of Enums LicensePrivileges
Grants privileges to perform actions on licenses such as generating and importing software licenses.
|
To Table of Enums LicenseSettingState
License type
|
To Table of Enums LicenseType
License type
|
To Table of Enums LogExpressionOperators
Log expression operators
|
To Table of Enums LogicalDiskFailure
Storage Source Failure
|
To Table of Enums LogicalDiskStatus
Storage source status
|
To Table of Enums LogicalUnitAccess
The type of access allowed to a LUN (mapped disk).
|
To Table of Enums LogicalUnitType
The type of logical unit, mirror or client mapping.
|
To Table of Enums LogLevel
The level of a log messages determines the system's automatic response and who is able to see the message.
|
To Table of Enums LogParameterNames
Parameters for log message sorting or filtering
|
To Table of Enums LogPrefilterCategory
Logging prefilter categories.
|
To Table of Enums LogPrivileges
Grants privileges to perform actions on event logs such as acknowledging messages, searching logs, and performing cleanup of logs.
|
To Table of Enums LogSourceType
Logging source types
|
To Table of Enums LogStatus
The status of the logging system.
|
To Table of Enums LogVisibility
Log visibility types
|
To Table of Enums MethodActionType
Method actions are SSV operations that can be directly triggered by a task. Each of these operate on a specified SSV object.
|
To Table of Enums MirrorPathConversionState
The current state of a virtual disk that is toggling trunk mirror mappings.
|
To Table of Enums MirrorRecoveryPriority
The mirror recovery priority setting in the virtual disk storage profile.
|
To Table of Enums Mode
Mode types
|
To Table of Enums MonitorPrivileges
Grants privileges to perform actions on system health monitors such as configuring monitor templates in the cmdlets.
|
To Table of Enums MonitorState
The state of a monitor, indicating what level of alert it is in. The states are assigned specific values that allow them to be compared and to be easily masked with bitmask operators.
|
To Table of Enums NativeVolumeType
Native volume types
|
To Table of Enums NetAddressType
Net address types
|
To Table of Enums OperationState
Operation state
|
To Table of Enums PartnerControllerPrivileges
Grants privileges to perform actions on replication partners such as adding, configuring, and removing a replication partner.
|
To Table of Enums PartnerState
Partner state
|
To Table of Enums PathPolicy
Path policy type
|
To Table of Enums PerfCounterType
The types of performance counters.
|
To Table of Enums PerfMonitorTemplateType
Performance monitor templates type
|
To Table of Enums PerformanceClass
The performance class setting in the virtual disk storage profile.
|
To Table of Enums PerformanceRecordingPriviledges
Grants privileges to perform actions on performance recordings such as creating, deleting, updating recording sessions, as well as starting and stopping recording sessions.
|
To Table of Enums PerformanceType
Performance categories types
|
To Table of Enums PerfValueType
The type of performance value. Used to determine the display format.
|
To Table of Enums PhysicalDiskPrivileges
Grants privileges to perform actions on physical disks such as configuring physical disks, making pass-through disks, and releasing disks to the operating system.
|
To Table of Enums PhysicalDiskStatus
Physical disk states
|
To Table of Enums PoolDiskHeatmapInfoType
The type of point in time data for a pool heatmap.
|
To Table of Enums PoolMemberState
The state of a mirrored member's recovery. When a mirror is created or one of the physical disks is replaced, recovery will start, copying the current disk's contents to the new mirror disk.
|
To Table of Enums PoolMode
Pool modes
|
To Table of Enums PoolType
Pool type
|
To Table of Enums PoolVolumeType
Type of pool volume, which is either striped or spanned.
|
To Table of Enums PortalState
iSCSI portal state
|
To Table of Enums PortConnectionType
Fibre channel port connection modes with technical description
|
To Table of Enums PortDataRate
Fibre channel port data rate modes with technical description
|
To Table of Enums PortLocation
Port location type
|
To Table of Enums PortPrivileges
Grants privileges to perform actions on Fibre Channel and iSCSI ports such as creating, configuring, and deleting ports, and also configuring authentication and logging in and out of iSCSI ports.
|
To Table of Enums PortRole
Server port roles
|
To Table of Enums PortState
Fibre Channel Port States
|
To Table of Enums PortType
Fiber channel port types
|
To Table of Enums PowerState
Power state of the server machine
|
To Table of Enums PreferredPathOption
Preferred Back-end Paths types
|
To Table of Enums PresenceStatus
Presence status type
|
To Table of Enums ProcessorArchitecture
Processor architecture type
|
To Table of Enums PublicServicesState
Public services states
|
To Table of Enums ReclamationState
Pool reclamation state
|
To Table of Enums RecoveryStatus
Recovery status between the two copies of data in a mirrored virtual disk and the recovery.
|
To Table of Enums RecurrenceType
The type of schedule recurrence.
|
To Table of Enums ReplicationBackendStatus
The status of a replication's backend operation.
|
To Table of Enums ReplicationFailure
The error state of an asynchronous replication partnership.
|
To Table of Enums ReplicationInitializationFailure
The failure state of replication initialization.
|
To Table of Enums ReplicationInitType
How a replication is initialized: offline or online.
|
To Table of Enums ReplicationOfflineInitStatus
The status of an offline initialization.
|
To Table of Enums ReplicationOperation
Replication operation types
|
To Table of Enums ReplicationPrivileges
Grants privileges to perform actions on replications such as creating and deleting replications, configuring initialization type, test mode, and checkpoint snapshots, marking checkpoints, and activating and deactivating replications.
|
To Table of Enums ReplicationState
The state of the asynchronous replication.
|
To Table of Enums ReplicationTestModeStatus
The status of a replication's test mode
|
To Table of Enums ReplicationTransferStatus
The status of an asynchronous replication transfer.
|
To Table of Enums RolePrivileges
Grants privileges to perform actions on user roles such as creating, configuring, and deleting roles.
|
To Table of Enums RollbackPrivileges
Grants privileges to perform actions on rollbacks such as creating, reverting, splitting, and deleting rollbacks.
|
To Table of Enums RollbackRelationState
The state of the rollback relation.
|
To Table of Enums ScriptActionType
The type of script, general or PowerShell.
|
To Table of Enums ScsiMode
SCSI mode types
|
To Table of Enums ScsiPortType
SCSI port type
|
To Table of Enums ServerMachineGroupPrivileges
Grants privileges to perform actions on server groups such as configuring server groups, creating support bundles, setting SMTP settings and email notifications.
|
To Table of Enums ServerMachinePrivileges
Grants privileges to users to perform actions on DataCore Servers such as adding or removing servers from a server group, configuring servers, and rescanning ports, and backing up configurations.
|
To Table of Enums ServerProductType
Server product types
|
To Table of Enums ServerState
The state of the server
|
To Table of Enums SessionState
iSCSI Session States
|
To Table of Enums SnapshotFailure
Snapshot failure codes.
|
To Table of Enums SnapshotOperation
Snapshot operations, including snap, resnap and revert.
|
To Table of Enums SnapshotPrivileges
Grants privileges to perform actions on snapshots such as creating, configuring, reverting, and deleting snapshots as well as designating mapstores.
|
To Table of Enums SnapshotRelationState
The state of the snapshot relationship
|
To Table of Enums SnapshotType
The type of snapshot.
|
To Table of Enums StorageBusType
Storage bus types
|
To Table of Enums StorageHandleType
Storage type
|
To Table of Enums StorageProfilePrivileges
Grants privileges to perform actions on storage profiles such as creating, configuring, and deleting storage profiles.
|
To Table of Enums StreamState
CDP state types
|
To Table of Enums SubscriberContext
Provides the context for the service connection. This includes by default the current machine name, the current process id and optionally a user-supplied subscriber name.
|
To Table of Enums SupportBundleType
Support bundle type
|
To Table of Enums SupportServiceState
Support State types
|
To Table of Enums TaskActionState
The state of the action.
|
To Table of Enums TaskActionType
The type of action.
|
To Table of Enums TaskPrivileges
Grants privileges to perform actions on tasks such as creating, configuring, deleting, aborting, and running tasks. In addition, this privilege group also allows creating, configuring, and deleting triggers and actions for tasks.
|
To Table of Enums TaskState
The execution state of the task.
|
To Table of Enums TaskTriggerType
The type of task trigger.
|
To Table of Enums TriggerConnective
How two triggers are evaluated
|
To Table of Enums UserPrivileges
Grants privileges to perform actions on user accounts such as creating, configuring, and deleting user accounts, assigning roles to users, and assigning and removing virtual disk ownership.
|
To Table of Enums VimDataCoreDiskSettingsChanged
Properties that need to be updated for a VimDataCoreDisk
|
To Table of Enums VimHostState
ESX host state from vCenter
|
To Table of Enums VimMultipathPolicy
VMware path selection policy types
|
To Table of Enums VimServiceClientState
VMware host client state
|
To Table of Enums VimVirtualMachineState
VMWare virtual machine state from vCenter
|
To Table of Enums VirtualDiskGroupPrivileges
Grants privileges to perform actions on virtual disk groups such as creating, configuring, deleting virtual disk groups, as well as adding or removing virtual disks from groups.
|
To Table of Enums VirtualDiskGroupType
Virtual disk group type
|
To Table of Enums VirtualDiskPrivileges
Grants privileges to perform actions on virtual disks such as creating, configuring, deleting, serving, unserving, and splitting virtual disks. This also includes other actions such as forcing a virtual disk online, pausing and resuming mirror recovery. This privilege group does not include actions on snapshots or rollbacks.
|
To Table of Enums VirtualDiskPurgeActions
The necessary actions before the disk can be purged size of the VD
|
To Table of Enums VirtualDiskStatus
Virtual disk status
|
To Table of Enums VirtualDiskSubType
Virtual disk subtype
|
To Table of Enums VirtualDiskTemplatePrivileges
Grants privileges to perform actions on virtual disk templates such as creating, configuring, and deleting virtual disk templates.
|
To Table of Enums VirtualDiskType
Virtual disk type
|
To Table of Enums VmIdMode
Fibre channel VM ID Modes with technical description
|
To Table of Enums VolumeStatus
State of native volume in the disk in disk management
|
To Table of Enums WeekdayFlags
A flag enumeration of the days of the week.
|
To Table of Enums WitnessPrivileges
Grants privileges to perform actions on witnesses such as creating, configuring, and deleting.
|