Ops Center Administrator REST API Reference Guide

Version: 10.8.x
File Size: 3.3 MB
Audience: anonymous
Part Number: MK-99ADM002-13

Using the Ops Center Administrator REST API
REST architecture
API functionality and HTTP methods
Security and authentication
Privileges and roles
Identifying a resource
HTTP response
Token management resources
Getting a token
Creating a token
Deleting a token
Sending API requests using cURL
Block storage management resources
Storage system management
Listing storage systems
Getting a storage system
Getting storage systems summary
Getting storage system license information
Adding a storage system
Updating a storage system
Deleting a storage system
Switching the access point to GUM
Manual update
Disk management
Listing disks
Getting disk details
Updating disks
Parity group management resources
Listing parity groups
Getting a parity group in a storage system
Listing parity groups summary
Listing external parity groups
Creating external parity groups
Initializing an external parity group
Deleting external parity groups
Getting a specific external parity group in a storage system
Listing external parity groups summary
Creating a parity group
Enabling compression on a parity group
Initializing a parity group
Deleting a parity group
Getting parity group template
Creating parity group template
Pool management resources
Listing pools
Getting a specific pool
Getting pool summaries
Creating a pool
Updating a pool
Deleting a pool
Getting pool templates
Getting a specific pool template
Creating pool template
Updating a pool template
Volume management resources
Listing volumes
Getting volume details
Getting a volumes summary
Creating a volume
Updating a volume
Deleting a volume
Deleting volumes
Detaching volumes
Creating multiple volumes
Attaching volumes
Attaching and protecting volumes
Creating, attaching, and protecting volumes
Updating multiple volumes
Detaching volumes from multiple servers
Edit volume LUN path
Getting auto-selection paths
Getting host groups
Getting host group information
Editing a host group
Adding a mutual CHAP user of a host group
Updating a mutual CHAP user of a host group
Deleting a mutual CHAP user of a host group
Shredding volumes
Interrupting volume shredding
Host group management resources
Creating host groups
Adding volumes to host groups
Removing volumes from host groups
Deleting host groups
Port management resources
Listing ports
Getting a port
Updating a port
Getting port login information
Tier management resources
Listing tiers
Updating a tier
File storage management resources
Virtual file server management resources
Getting virtual file servers from all storage systems
Getting virtual file servers for a storage system
Getting information about a specific virtual file server
Creating a virtual file server
Enabling a virtual file server
Disabling a virtual file server
Renaming a virtual file server
Deleting a virtual file server
File pool management resources
Listing file pools for a storage system
Getting a file pool
Getting a file pool creation template
Creating a file pool from a template
Getting a file pool expansion template
Expanding a file pool
Modifying a file pool
Deleting a file pool
File system management resources
Getting file systems for a storage system
Getting a single file system
Getting file systems for a file pool
Getting file systems for a virtual file server
Creating a file system
Mounting a file system
Unmounting a file system
Updating a file system
Deleting a file system
Share management resources
Listing all shares
Listing shares in the file system
Getting a share
Creating a share
Modifying a share
Deleting a share
Export management resources
Listing all exports in a storage system
Listing exports in a file system
Getting an export
Creating an export
Modifying an export
Deleting an export
Server management resources
Listing servers
Getting a server
Getting servers summary
Adding servers
Updating a server
Deleting a server
Deleting multiple servers
Updating world wide port names
Listing attached volumes
Updating iSCSI settings
Scanning host groups
Getting a list of server groups
Getting a server group
Listing volumes attached to servers in a server group
Creating a server group
Updating a server group
Adding servers to a server group
Deleting a server group
Removing multiple servers from a server group
Use existing LUN paths
Volume Migration resources
Attaching volumes to storage
Creating external volumes
Deleting external volumes
Discovering external devices
Listing external devices
Listing external volumes
Getting a specific external volume
Detaching volumes from storage
Listing migration tasks
Getting a specific migration task
Creating a migration task
Interrupting a running migration job
Updating a migration task
Deleting a migration task
Getting migration pairs
Fabric switch management resources
List all fabric switches
List a fabric switch
Create a fabric switch
Edit a fabric switch
Delete a fabric switch
Virtual storage machine management resources
Listing virtual storage machines
Getting virtual storage machine details
Getting a physical storage system summary in a virtual storage machine
Listing volume IDs assigned to a physical storage system in a virtual storage machine
Listing volume IDs in a virtual storage machine
Getting a volume ID in a virtual storage machine
Listing host group IDs in a virtual storage machine
Getting a host group ID in a virtual storage machine
Creating a virtual storage machine
Adding resources to a virtual storage machine
Getting a virtual storage machine summary
Moving volumes to a virtual storage machine
Removing resources from a virtual storage machine
Removing defined volumes from a virtual storage machine
Deleting a physical storage system from a virtual storage machine
Deleting a virtual storage machine
Data protection management resources
Getting a data protection summary for all storage systems
Getting a data protection summary for a storage system
Listing replication groups
Getting a replication group by ID
Getting a replication group summary
Creating a replication group
Adding volumes to a replication group on a storage system
Removing volumes from a replication group on a storage system
Restoring volumes on a storage system
Updating clone replication groups on a storage system
Updating a snapshot replication group on a storage system
Updating high availability replication groups on a storage system
Suspending data replication
Resuming replication
Deleting a replication group
Listing volume pairs
Viewing volume pairs affected by actions performed on a replication group
Getting primary volume pairs
Getting secondary volume pairs
Getting secondary volumes
Listing failed volume pairs
Getting Ops Center Protector information
Registering/Deleting the Hitachi Ops Center Protector
Testing the connection to Ops Center Protector
Importing high availability pairs from Ops Center Protector
Listing quorum disks
Getting remote paths
Getting high availability setup steps
GET HA-Status External Volumes
Monitoring resources
Capacity monitoring resources
Listing total number of capacity alerts for all storage systems
Displaying capacity alert details for all storage systems
Listing total number of capacity alerts for a storage system
Displaying capacity alert details for a storage system
Getting a summary of data reduction savings and capacity efficiency
Getting a data reduction savings and capacity efficiency summary for a specific storage system
Monitoring hardware resources
Listing total number of hardware alerts for all storage systems
Displaying resource-specific hardware alerts for all storage systems
Listing hardware alerts for a storage system
Displaying resource-specific hardware alerts for a storage system
Listing disk information for all storage systems
Listing disk information for a storage system
SNMP resources
Listing SNMP managers
Adding SNMP managers
Updating an SNMP manager
Deleting an SNMP manager
System administration resources
Account domain resources
Listing account domains
Getting an account domain
Adding an account domain
Updating an account domain
Deleting an account domain
User management resources
Listing user groups
Listing group mappings
Getting a group mapping
Creating role mappings
Deleting role mappings
Listing users
Getting users
Updating users
Getting a job
Listing jobs
Listing storage system task information
Getting a storage system task information summary

Back to home page