REST API
You can use the Object Sets to manage adaptive-flash storage arrays programmatically.
In addition to the RESTful create (POST), read (GET), update (PUT), and delete (DELETE) operations, some of the object sets provide custom RPC actions. An object set is an externalized view of a set of managed objects of the same type, such as volumes and snapshots. The RESTful operations and custom RPC actions are identified in the following lists.
Manage access control records for volumes.
Manages the storage array's membership with the Active Directory.
| RESTful Operations | RPC Actions |
|---|---|
Provides the list of application categories that are available, to classify volumes depending on the applications that use them.
| RESTful Operations | RPC Actions |
|---|---|
An application server is an external agent that collaborates with an array to manage storage resources; for example, Volume Shadow Copy Service (VSS) or VMware.
Retrieve information of specified arrays. The array is the management and configuration for the underlying physical hardware array box.
Manage Challenge-Response Handshake Authentication Protocol (CHAP) user accounts. CHAP users are one method of access control for iSCSI initiators. Each CHAP user has a CHAP password, sometimes called a CHAP secret. The CHAP passwords must match on the array and on the iSCSI initiator in order for the array to authenicate the initiator and allow it access. The CHAP user information must exist on both the array and the iSCSI initiator. Target authentication gives security only for the specific iSCSI target.
Manage group wide Fibre Channel configuration.
| RESTful Operations | RPC Actions |
|---|---|
fibre_channel_initiator_aliases
This API provides the alias information for Fibre Channel initiators.
| RESTful Operations | RPC Actions |
|---|---|
Represent information of specified Fibre Channel interfaces. Fibre Channel interfaces are hosted on Fibre Channel ports to provide data access.
Fibre Channel ports provide data access. This API provides the list of all Fibre Channel ports configured on the arrays.
| RESTful Operations | RPC Actions |
|---|---|
Fibre Channel session is created when Fibre Channel initiator connects to this group.
| RESTful Operations | RPC Actions |
|---|---|
Folders are a way to group volumes, as well as a way to apply space constraints to them.
Manage initiator groups for initiator authentication. An initiator group is a set of initiators that can be configured as part of your ACL to access a specific volume through group membership.
Manage initiators in initiator groups. An initiator group has a set of initiators that can be configured as part of your ACL to access a specific volume through group membership.
Manage performance policies. A performance policy is a set of optimizations including block size, compression, and caching, to ensure that the volume's performance is the best configuration for its intended use like databases or log files. By default, a volume uses the \"default\" performance policy, which is set to use 4096 byte blocks with full compression and caching enabled. For replicated volumes, the same performance policy must exist on each replication partner.
Manage pools. Pools are an aggregation of arrays.
Manage protection schedules used in protection templates.
Manage protection templates. Protection templates are sets of snapshot schedules, replication schedules, and retention limits that can be used to prefill the protection information when creating new volume collections. A volume collection, once created, is not affected by edits to the protection template that was used to create it. All the volumes assigned to a volume collection use the same settings. You cannot edit or delete the predefined protection templates provided by storage array, but you can create custom protection templates as needed.
Protocol endpoints are administrative logical units (LUs) in an LU conglomerate to be used with VMware Virtual Volumes.
| RESTful Operations | RPC Actions |
|---|---|
Manage replication partner. Replication partners let one storage array talk to another for replication purposes. The two arrays must be able to communicate over a network, and use ports 4213 and 4214. Replication partners have the same name as the remote group. Replication partners can be reciprocal, upstream (the source of replicas), or downstream (the receiver of replicas) partners.
Snapshot collections are collections of scheduled snapshots that are taken from volumes sharing a volume collection. Snapshot collections are replicated in the order that the collections were taken.
Snapshots are point-in-time copies of a volume. Snapshots are managed the same way you manage volumes. In reality, snapshots are volumes: they can be accessed by initiators, are subject to the same controls, can be modified, and have the same restrictions as volumes. Snapshots can be cloned and replicated. The initial snapshot uses no space: it shares the original data with the source volume. Each successive snapshot captures the changes that have occurred on the volume. The changed blocks are compressed.
| RESTful Operations | RPC Actions |
|---|---|
Search subnets information. Many networking tasks require that objects such as replication partners are either on the same network or have a route to a secondary network. Subnets let you create logical addressing for selective routing.
| RESTful Operations | RPC Actions |
|---|---|
Represents Active Directory groups configured to manage the system.
Represents users configured to manage the system.
Manage volume collections. Volume collections are logical groups of volumes that share protection characteristics such as snapshot and replication schedules. Volume collections can be created from scratch or based on predefined protection templates.