Ops Center API Configuration Manager REST API Reference Guide

Version: 11.0.x
File Size: 6194 KB
Audience: anonymous
Part Number: MK-99CFM000-25
Published: 2026-03-16

Configuring a REST API environment
System configuration of the REST API
Supported storage systems
System configuration of the REST API (VSP One B20 series)
Notes on managing VSP One B20 series
System configuration of the REST API (VSP 5000 series )
Notes on managing VSP 5000 series storage systems
System configuration of the REST API (VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900)
System configuration of the REST API (VSP G200, G400, G600, G800, VSP G1000, VSP G1500, VSP F400, F600, F800, VSP F1500)
Method for installing the REST API
Workflow for preparing to use the REST API
Checking management server requirements and prerequisite programs
Installing and upgrading the REST API
REST API installation destination
Installing the REST API (in a Windows OS)
Installing the REST API as the root user (in a Linux OS)
Upgrading Amazon Corretto 17
Settings required when using virus detection programs and process monitoring software
Building a redundant environment
Configuring a cluster environment (in a Windows OS)
Setting the port numbers used by the REST API
Ports used by the REST API
Ports used during remote copy operations
Changing the port number to be used for HTTPS communication
Changing the port number to be used for HTTP communication
Disabling HTTP communication
Enabling HTTP communication
Re-initializing the port number settings used for HTTP and HTTPS
Changing the port numbers used by the REST API server
Changing the port numbers used for communications with CCI
Returning the port numbers used for CCI communications to their initial state
Changing the port number for receiving notifications about changes made to storage system configurations
Setting up SSL communication
Server certificate verification function (VSP One B20 series)
SSL communication routes between the Configuration Manager REST API server and the Platform REST API server (VSP 5000 series)
SSL communication routes between the Configuration Manager REST API server and the Platform REST API server (VSP One B20 series, VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900)
SSL communication routes between the Configuration Manager REST API server and the storage system (VSP G200, G400, G600, G800, VSP F400, F600, F800)
SSL communication routes between the Configuration Manager REST API server and the storage system (VSP G1000, VSP G1500, or VSP F1500)
SSL communication routes for performing remote copy operations
Specifying settings for using SSL communication between REST API clients and the REST API server (when using a self-signed certificate)
Specifying settings for using SSL communication between REST API clients and the REST API server (when using a server certificate issued by a certificate authority)
Specifying settings for SSL communication between the Configuration Manager REST API server and the Platform REST API server (VSP 5000 series )
Specifying settings for SSL communication between the Configuration Manager REST API server and the Platform REST API server (VSP One B20 series, VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900)
Specifying settings for SSL communication between the Configuration Manager REST API server and the storage system (VSP G200, G400, G600, G800, VSP F400, F600, F800)
Specifying settings for SSL communication between the Configuration Manager REST API server and the storage system (VSP G1000, VSP G1500, or VSP F1500)
Setting the timeout value that is applied to communication between the Configuration Manager REST API server and the encryption module
Changing the certificate used for SSL communication between the Configuration Manager REST API server and the storage system (when a notification about configuration changes is received)
Changing host information for the Configuration Manager REST API server
Setting the number of storage systems to be managed by the REST API
Starting, stopping, and checking the status of the REST API services
Starting the REST API services
Stopping the REST API services
Checking the status of the REST API service
Removing the REST API
Removing the REST API (in a Windows OS)
Removing the REST API as the root user (in a Linux OS)
Removing the REST API in a cluster environment
Operation in an environment where the REST API is installed by a non-root user (in Linux OS)
Workflow for preparing to perform REST API operations as a non-root user
Checking management server requirements and prerequisite programs (when the REST API is installed by a non-root user)
Registering firewall exceptions
Installing the REST API as a non-root user
Changing the port numbers (when the REST API is installed by a non-root user)
Setting up SSL communication (when the REST API is installed by a non-root user)
Removing the REST API as a non-root user
Common specifications of the REST API
Specifying the resource to be managed
Specifying an object ID
Supported HTTP methods
User authentication
Session management
Request headers
Response headers
HTTP status codes
Request and response formats
Query parameters
Data type
Output format
Data object
Job object
Error object
Request object
Action template object
Locking resources
Common operations in the REST API
Getting the version information
Getting a list of storage systems
Getting information about a specific storage system
Registering a storage system
Changing information about a storage system
Deleting information about a storage system
Getting summary information about storage systems
Getting a list of sessions
Getting information about a specific session
Generating sessions
Discarding sessions
Getting a list of job information
Getting job information
Locking a resource group
Unlocking a resource group
User management and access control
Overview of user management and access control
User management and access control operations
Workflow for user management and access control
Input rules for user IDs and passwords
Getting a list of resource groups
Getting information about a specific resource group
Creating a resource group
Adding a resource to a resource group
Removing a resource from a resource group
Deleting a resource group
Getting a list of user groups
Getting information about a specific user group
Creating a user group
Changing the user group settings
Assigning resource groups to a user group
Releasing resource groups assigned to a user group
Deleting a user group
Getting a list of users
Getting information about a specific user
Creating a user account
Changing the password of the user
Adding users to user groups
Removing users from user groups
Deleting a user account
Search function for storage systems
Overview of the search function for storage systems
Methods for updating the REST API server database to its latest state
Refreshing the storage system configuration information
Getting the refresh status of storage system configuration information
Refreshing the configuration information of storage systems
Query parameters to be used for the search function
List of query parameters
$query parameter
Examples of how to specify query parameters
Searching for storage system information
Resource information obtainable from storage systems by the search function
Searching for information about parity groups
Searching for information about parity groups and volumes
Searching for information about parity groups and pools
Searching for information about external volume groups
Searching for volume information
Searching for information about host groups or iSCSI targets
Searching for port information
Searching for the LU path information of volumes that belong to host groups or iSCSI targets
Searching for information related to the WWNs registered in host groups
Searching for information related to the iSCSI names registered in iSCSI targets
Searching for the LU path information for host WWNs
Searching for the LU path information for the iSCSI names of hosts
Searching for pool information
Storage system resources obtained by the search function
Parity groups (parityGroup)
External volume groups (externalParityGroup)
Volume (ldev)
Host group or iSCSI target (hostGroup)
Port (port)
LUN (lun)
WWN (wwn)
iSCSI name (iscsi)
WWNs registered in host groups (hostWwn)
iSCSI registered in the iSCSI target (hostIscsi)
Pool (pool)
Enabling or disenabling the search function
Enabling the search function
Disabling the search function
Parity group management
Overview of a parity group
Getting information about parity groups
Getting information about a specific parity group
Getting a list of drive information
Getting information about a specific drive
Creating a parity group
Changing the drive settings
Changing the accelerated compression setting of a parity group
Formatting a parity group
Deleting a parity group
Volume allocation
Overview of volume allocation
Getting information about the capacity of a storage system
Getting information about the total efficiency of a storage system
Getting volume information
Getting information about a specific volume
Creating a volume
Formatting a volume
Expanding the capacity of a volume
Changing the volume settings
Changing the volume status
Shredding a volume
Reclaiming zero pages of a DP volume
Changing the MP blade assigned to a volume
Deleting a volume
Getting port information
Getting information about a specific port
Changing the port settings
Getting information about host groups or iSCSI targets
Getting information about a specific host group or iSCSI target
Getting a list of host modes and host mode options
Creating a host group or an iSCSI target
Changing the host group or iSCSI target settings
Deleting a host group or the iSCSI target
Getting WWN information
Getting information about a specific WWN
Registering a WWN for the host group
Setting the nickname for a WWN
Deleting the WWN from a host group
Getting iSCSI names
Getting information about a specific iSCSI name
Registering the iSCSI name for the iSCSI target
Setting the nickname for an iSCSI name
Deleting the iSCSI name from the iSCSI target
Getting information about CHAP users
Getting information about a specific CHAP user
Setting the CHAP user name for the iSCSI target
Setting a secret for the CHAP user
Deleting the CHAP user from the iSCSI target
Getting information about LU paths
Getting information about a specific LU path
Sending the ping command to a specified host
Setting the LU path
Setting the priority levels of ALUA paths
Deleting a LU path
Setting the command device
Getting a list of MP information
Releasing the host reservation status by specifying the LU path
Releasing the host reservation status by specifying a host group
Volume Allocation (when an NVMe-oF connection is used)
Overview of volume allocation (NVMe-oF)
Getting NVM subsystem information
Getting information about a specific NVM subsystem
Creating an NVM subsystem
Changing the NVM subsystem settings
Deleting an NVM subsystem
Getting NVM subsystem port information
Getting information about a specific NVM subsystem port
Setting an NVM subsystem port for the NVM subsystem
Deleting an NVM subsystem port
Getting host NQN information
Getting information about a specific host NQN
Registering a host NQN in an NVM subsystem
Setting the nickname for a host NQN
Deleting the login information of the host NQN
Deleting a host NQN
Getting namespace information
Getting information about a specific namespace
Creating a namespace in an NVM subsystem
Setting the nickname for a namespace
Deleting a namespace
Getting host-namespace path information
Getting information about a host-namespace path
Setting a host-namespace path
Deleting a host-namespace path
Pool management
Overview of a pool
Getting pool information
Getting information about a specific pool
Creating a pool
Changing pool settings
Expanding a pool
Shrinking a pool
Performing performance monitoring of a pool
Performing tier relocation
Restoring a pool
Initializing the capacity saving function for a pool
Deleting a pool
Optimizing I/O performance
Overview of optimizing I/O performance
Getting information about CLPRs
Getting information about a specific CLPR
Creating a CLPR
Changing the settings of a CLPR
Deleting a CLPR
Assigning LDEVs to a CLPR
Assigning parity groups to a CLPR
Getting information about external volume groups
Getting information about a specific external volume group
Assigning external volume groups to a CLPR
Changing the MP blade assigned to an external volume group
Configuring QoS settings for a volume
Getting performance information for a volume on which QoS has been set up
Managing QoS groups
Getting a list of Server Priority Manager information
Getting Server Priority Manager information by specifying a volume and the WWN or iSCSI name of an HBA
Setting Server Priority Manager information by specifying a volume and the WWN or iSCSI name of the HBA
Changing the Server Priority Manager information
Deleting Server Priority Manager information
Managing ShadowImage pairs
Overview of ShadowImage
Workflow for operating ShadowImage pairs
Pair status (ShadowImage)
Getting a list of copy groups
Getting information about a specific copy group
Getting a list of ShadowImage pairs
Getting information about a specific ShadowImage pair
Getting information about all of ShadowImage pairs
Creating a ShadowImage pair
Splitting ShadowImage pairs in units of copy groups
Splitting a ShadowImage pair
Resynchronizing ShadowImage pairs in units of copy groups
Resynchronizing a ShadowImage pair
Restoring ShadowImage pairs in units of copy groups
Restoring a ShadowImage pair
Deleting a copy group
Deleting a ShadowImage pair
Managing Thin Image pairs
Overview of Thin Image
Workflow for operating Thin Image pairs
Pair status (Thin Image)
Getting information about Thin Image pairs in units of snapshot groups
Getting information about Thin Image pairs in a specified snapshot group
Getting information about Thin Image pairs
Getting information about a specific Thin Image pair
Getting information about all of Thin Image pairs
Getting a list of volumes that have the vClone Parent attribute
Getting information about volumes that have the vClone attribute
Creating a Thin Image pair
Storing snapshot data in units of snapshot groups
Storing snapshot data
Resynchronizing Thin Image pair in units of snapshot groups and deleting snapshot data
Resynchronizing a Thin Image pair and deleting snapshot data
Restoring snapshot data in units of snapshot groups
Restoring snapshot data
Assigning a secondary volume to snapshot data
Unassigning the secondary volume for snapshot data
Setting the retention period for obtained snapshot data in units of snapshot groups
Setting the retention period for obtained snapshot data
Deleting Thin Image pairs in units of snapshot groups
Deleting a Thin Image pair
Deleting Thin Image pairs by snapshot tree
Deleting garbage data of all Thin Image pairs in a snapshot tree
Cloning pairs in a specified snapshot group
Cloning a Thin Image pair
Performing virtual clone operations in units of snapshot groups
Performing virtual clone operations
Configuring a remote copy environment
Workflow for configuring a remote copy environment
Registering and deleting information about remote storage systems
Overview of registering and deleting information about remote storage systems
Getting a list of remote storage systems
Getting information about a specific remote storage system
Registering information about remote storage systems
Deleting information about remote storage systems
Setting remote connections
Overview of the remote connection settings
Getting a list of remote connections
Getting information about a specific remote connection
Creating a remote connection
Changing the remote connection settings
Adding remote paths to a remote connection
Deleting a remote path from a remote connection
Deleting a remote connection
Getting information about iSCSI ports
Getting information about a specific iSCSI port
Registering an iSCSI port
Removing the registration of an iSCSI port
Getting information about the remote replica options
Changing the remote replica options settings
Setting journals
Getting journal information
Getting information about a specific journal
Creating a journal
The mirror journal status
Changing journal settings
Adding a journal volume
Deleting a journal volume from a journal
Changing the MP blade assigned to a journal
Deleting a journal
Setting quorum
Getting information about quorum disks
Getting information about a specific quorum disk
Registering information about a quorum disk
Deleting information about a quorum disk
Managing TrueCopy pairs or Universal Replicator pairs
Overview of TrueCopy and Universal Replicator
Workflow for operating TrueCopy pairs or Universal Replicator pairs
Flow of recovery operations to be performed when a failure occurs at the primary site of a Universal Replicator pair
Pair status (TrueCopy and Universal Replicator)
Getting a list of remote copy groups
Getting information about a specific remote copy group
Getting information about a specific remote copy pair
Getting TrueCopy or Universal Replicator pair information
Getting information about all of remote copy pairs
Creating a TrueCopy pair or Universal Replicator pair
Splitting TrueCopy pairs or Universal Replicator pairs in units of copy groups
Splitting a TrueCopy pair or Universal Replicator pair
Resynchronizing TrueCopy pairs or Universal Replicator pairs in units of copy groups
Resynchronizing a TrueCopy pair or Universal Replicator pair
Deleting TrueCopy pairs or Universal Replicator pairs in units of copy groups
Deleting a TrueCopy pair or Universal Replicator pair
Enabling volumes at the secondary site to take over work in units of copy groups
Enabling volumes at the secondary site to take over work in units of copy pairs
Managing global-active device pairs
Overview of global-active device
Workflow for operating global-active device pairs
Pair status (global-active device)
Getting a list of remote copy groups
Getting information about a specific remote copy group
Getting information about global-active device pairs
Getting information about a specific remote copy pair
Getting information about all of remote copy pairs
Creating a global-active device pair
Deleting global-active device pairs in units of copy groups
Deleting a global-active device pair
Suspending global-active device pairs in units of copy groups
Suspending a global-active device pair
Resynchronizing global-active device pairs in units of copy groups
Resynchronizing a global-active device pair
Performing Volume Migration operations
Overview of Volume Migration
Workflow for performing Volume Migration
Pair status transitions (Volume Migration)
Creating a pair to be used for Volume Migration
Performing migration for an entire copy group
Performing migration
Getting a list of copy groups (Volume Migration)
Getting information about a specific copy group (Volume Migration)
Getting a list of pairs (Volume Migration)
Getting information about a specific pair (Volume Migration)
Deleting a pair (Volume Migration)
Deleting a copy group (Volume Migration)
Canceling migration for an entire copy group
Canceling migration
Performing Universal Volume Manager operations
Overview of Universal Volume Manager
Workflow for Universal Volume Manager
Getting information about an iSCSI target of a port on an external storage system
Registering an iSCSI name of an external storage system to a port on the local storage system
Getting the iSCSI name of an external storage system that is registered to a port on the local storage system
Performing a login test on an iSCSI target of an external storage system that is registered to a port on the local storage system
Getting a list of ports on an external storage system
Getting a list of LUs defined for a port on an external storage system
Mapping a volume on the external storage system
Getting a list of external path groups
Getting information about a specific external path group
Adding an external path to an external path group
Removing an external path from an external path group
Setting the blocked path monitoring time for external paths
Unmapping a volume on the external storage system
Disconnecting from a volume on the external storage system
Deleting an iSCSI name of an external storage system that is registered to a port on the local storage system
Initial settings for a storage system
Overview of the initial settings of a storage system
Getting the system date and time of a storage system
Getting a list of time zones that can be used in a storage system
Setting the system date and time of a storage system
Uploading the files required to set the transfer destination of audit log files or alert notifications
Getting information about the transfer destinations of audit log files
Specifying the transfer destinations of audit log files
Sending test messages to the transfer destinations of audit log files
Getting information about the transfer destinations of alert notifications
Specifying the transfer destinations of alert notifications
Sending test messages to the transfer destinations of alert notifications
Getting SNMP settings
Specifying the SNMP alert notification destinations
Sending a test SNMP trap
Getting information about the alert notification email settings
Specifying settings for alert notification emails
Adding a destination address for alert notification emails
Deleting a destination address for alert notification emails
Sending a test alert notification email
Getting a list of license information
Getting information about a specific license
Installing software
Enabling or disabling a license
Removing software
Changing the user information used in searches of the external authentication server set for a storage system
Getting information about certificate files (for external server verification)
Getting information about a specific certificate file (for external server verification)
Uploading the certificate files (for external server verification)
Deleting a certificate file (for external server verification)
Encrypting data
Overview of data encryption
Workflow for operations related to data encryption
Getting information about the encryption environment settings
Changing the encryption environment settings
Getting information about the module used for encryption
Getting the number of encryption keys
Getting information about a list of encryption keys
Getting a specific encryption key
Creating encryption keys
Deleting one or more encryption keys at one time
Deleting an encryption key
Backing up encryption keys on the REST API client
Restoring encryption keys on the REST API client
Getting information about certificate files
Getting information about a specific certificate file
Uploading the certificate files
Deleting a certificate file
Getting key management server information
Getting information about a specific key management server
Registering information about a key management server
Testing communications with the key management server
Changing the key management server settings
Changing the priority of key management servers within a cluster
Deleting information about a key management server
Backing up encryption keys to the key management server
Restoring encryption keys backed up to a key management server
Rekeying the key encryption key
Monitoring storage systems
Getting a list of alert information
Getting information about the hardware installed in a storage system
Getting information about channel boards
Managing resources by using virtual storage machines
Overview of managing resources by using virtual storage machines
Workflow for managing resources by using virtual storage machines
Getting a list of virtual storage machines
Getting information about a specific virtual storage machine
Creating a virtual storage machine
Deleting a virtual storage machine
Getting information about virtual LDEVs
Setting a virtual LDEV number
Deleting a virtual LDEV number
Sample coding
Overview of sample coding
Sample coding for registering storage system information
Sample coding for volume allocation
Sample coding for ShadowImage pair operations
Sample coding for registering remote storage system information
Sample coding for TrueCopy pair operations
Sample coding for uploading files (specifying the transfer destinations of audit log files)
Sample coding for downloading a file (backing up encryption keys)
Sample coding for re-creating a parity group (data encryption)
Functions used in the sample coding
Changing the communication mode of the REST API server
Overview of changing the communication mode for the REST API server
Settings required to change the communication mode of the REST API server
Changing the communication mode of the REST API server
Backup and restore
Backing up the REST API database and the environment settings file
Restoring the REST API database and environment settings file
Troubleshooting
Information to be collected when an error occurs
Collecting maintenance information about the REST API
Sending notifications about changes to storage system configurations
Notifications of changes to storage system configurations
Workflow for handling notifications of configuration changes (VSP One B20 series)
Workflow for handling notifications of configuration changes (VSP 5000 series)
Workflow for handling notifications of configuration changes (VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900)
Workflow for handling notifications of configuration changes (VSP G200, G400, G600, G800, VSP G1000, VSP G1500, VSP F400, F600, F800, VSP F1500)
Getting a list of destinations for sending notifications about changes to storage system configurations
Getting specific destinations for sending notifications about changes to storage system configurations
Registering destinations for sending notifications about changes to storage system configurations
Deleting destinations for sending notifications about changes to storage system configurations
Getting configuration information (including additional information) from the SVP
About getting additional information from the SVP
API requests for getting information from the SVP
Updating the cache of storage system configuration information
Specifying settings to link the REST API to Ops Center Analyzer detail view
Changing the Java heap size when the REST API is to be linked to Ops Center Analyzer detail view
VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 configurations in which a link to the SVP is established
Configuration in which a link to the SVP is established
SSL communication using VSP G1000, VSP G1500, VSP F1500 storage systems with a microcode version earlier than 80-05-2X-XX/XX
About VSP G1000, VSP G1500, VSP F1500 storage systems with a microcode version earlier than 80-05-2X-XX/XX
SSL communication routes and ports used when remote copy operations are performed
Configuration Manager version compatibility
Compatible versions of Configuration Manager
Notes regarding environments where a storage system's microcode version has been downgraded
Implementing retry processing
Implementing retry processing
Sample coding for implementing retry processing
Running the REST APIs that respond quickly for the storage systems VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900
Running the REST APIs
Running VSP One Block Administrator REST API requests for VSP One B20 series storage systems
Running VSP One Block Administrator REST API requests
Operations performed on QoS groups by using REST API requests that include simple in the request line
Operations on QoS groups
Getting a list of QoS groups
Getting information for a specific QoS group
Getting performance information for a specific QoS group
About the Data in Place upgrade of VSP 5000 series storage systems
Re-registering a storage system after a Data in Place upgrade

Back to home page