REST API
You can use the REST API 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.
access_control_records
The object set represents records that describe access to volumes and snapshots on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| delete |
active_directory_memberships
The object set represents storage array's membership with the Active Directory.
| RESTful Operations | RPC Actions |
|---|---|
| create | remove |
| read | report_status |
| update | test_group |
| test_user |
alarms
The object set reports alarms to know current issues on the group.
| RESTful Operations | RPC Actions |
|---|---|
| read | acknowledge |
| update | unacknowledge |
| delete |
application_servers
The object set represents external agents that collaborate with an array to manage storage resources.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
application_categories
The object set Provides the list of application categories that are available, to classify volumes depending on the applications that use them.
| RESTful Operations | RPC Actions |
|---|---|
| read |
arrays
The object set represents the configuration for the underlying physical hardware on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| create | failover |
| read | halt |
| update | reboot |
| delete |
audit_log
The object set reports audit log records to gain operational insight into activities on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| read |
chap_users
The object set represents Challenge-Response Handshake Authentication Protocol (CHAP) accounts for iSCSI initiator authentication.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
disks
The object set Manages disks on an array.
| RESTful Operations | RPC Actions |
|---|---|
| read | |
| update |
shelves
The object set Manages physical external shelf and head unit on an array.
| RESTful Operations | RPC Actions |
|---|---|
| read | |
| update |
master_key
The object set manages the master key.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
events
The object set review event records to gain operational insight into activities on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| read |
fibre_channel_configs
The object set represents Fibre Channel configurations for the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| read | hw_upgrade |
| regenerate |
fibre_channel_initiator_aliases
The object set represents Fibre Channel initiator aliases for initiators.
| RESTful Operations | RPC Actions |
|---|---|
| read |
fibre_channel_interfaces
The object set represents Fibre Channel interfaces on a storage array configured with Fibre Channel ports.
| RESTful Operations | RPC Actions |
|---|---|
| read | |
| update |
fibre_channel_ports
The object set represents Fibre Channel ports on a storage array configured with Fibre Channel host bus adapters (HBAs).
| RESTful Operations | RPC Actions |
|---|---|
| read |
fibre_channel_sessions
The object set represents Fibre Channel sessions connected to this group.
| RESTful Operations | RPC Actions |
|---|---|
| read |
folders
The object set Folders are a way to group volumes, as well as a way to apply space constraints to them.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
groups
The object set represents a collection of arrays.
| RESTful Operations | RPC Actions |
|---|---|
| read | get_eula |
| update | get_group_discovered_list |
| halt | |
| merge | |
| software_cancel_download | |
| software_download | |
| software_update_precheck | |
| software_update_start | |
| test_alert | |
| validate_merge |
initiator_groups
The object set represents groups of initiators that can access specific volumes and/or snapshots on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| create | suggest_lun |
| read | validate_lun |
| update | |
| delete |
initiators
The object set represents initiators in initiator groups.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| delete |
jobs
The object set reports in-process operations on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| read |
network_configs
The object set represents active, backup, and draft network configurations for the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| create | activate_netconfig |
| read | validate_netconfig |
| update | |
| delete |
network_interfaces
The object set represents network interfaces on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| read |
performance_policies
The object set represents application policies for volumes, for example, Microsoft Exchange DB and VMware ESX are both performance policies.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
pools
The object set represents storage pools.
| RESTful Operations | RPC Actions |
|---|---|
| create | merge |
| read | |
| update | |
| delete |
protection_schedules
The object set represents protection schedules that determine the frequency of snapshot schedules and the interval at which snapshots are taken, plus whether to replicate the volume after a specified number of snapshots.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
protection_templates
The object set represents the templates on which volume collection schedules and retention are based.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
protocol_endpoints
The object set Manages protocol endpoints, which are administrative logical units (LUs) in an LU conglomerate to be used with VMware Virtual Volumes.
| RESTful Operations | RPC Actions |
|---|---|
| read |
replication_partners
The object set manages replication of data between storage arrays.
| RESTful Operations | RPC Actions |
|---|---|
| create | pause |
| read | resume |
| update | test |
| delete |
snapshot_collections
The object set represents collections of snapshots for a volume collection.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
snapshots
The object set represents all snapshots for a given volume.
| RESTful Operations | RPC Actions |
|---|---|
| create | bulk_create |
| read | |
| update | |
| delete |
software_versions
The object set represents the version of the software that is installed or waiting to be installed on storage arrays.
| RESTful Operations | RPC Actions |
|---|---|
| read |
space_domains
The object set reports space usage of objects in the group.
| RESTful Operations | RPC Actions |
|---|---|
| read |
subnets
The object set reports subnet configuration. 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 |
|---|---|
| read |
tokens
The object set represents tokens for user sessions on the storage array.
| RESTful Operations | RPC Actions |
|---|---|
| create | report_user_details |
| read | |
| delete |
user_groups
The object set represents Active Directory groups thats are given permissions to manage the system.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
users
The object set represents users configured to manage the system.
| RESTful Operations | RPC Actions |
|---|---|
| create | |
| read | |
| update | |
| delete |
versions
The object set reports the version of the API that are supported on a storage array.
| RESTful Operations | RPC Actions |
|---|---|
| read |
volume_collections
The object set represents collections of volumes that can be associated with a schedule and snapshotted together.
| RESTful Operations | RPC Actions |
|---|---|
| create | abort_handover |
| read | demote |
| update | handover |
| delete | promote |
| validate |
volumes
The object set represents volumes, which are the basic storage units from which the total capacity on a storage array is apportioned. The terms volume and LUN are used interchangeably.
| RESTful Operations | RPC Actions |
|---|---|
| create | abort_move |
| read | bulk_move |
| update | bulk_set_dedupe |
| delete | get_allocated_bitmap |
| get_unshared_bitmap | |
| move | |
| restore |