About performing operations using InfoScale Operations Manager Web services API
Table: Operations and URLs lists the URLs you can use to view the objects and manage their extended attributes. The supported output format is JSON. The extended attributes are reported in the metadata with editable value set to true. All successful operations return
HTTP 200 OK response. An unsuccessful operation has an error element in the output which describes the error condition.
Related information
Table: Operations and URLs
| Operation | HTTP method | URL |
|---|---|---|
| Get metadata for object | GET | base_url/meta/perspective/object type |
| Define extended attribute | POST | base_url/meta/perspective/object type/add?name=ea_name |
| Delete extended attribute | POST | base_url/meta/perspective/object type/delete?name=ea_name |
| Modify extended attribute | POST | base_url/meta/perspective/object type/modify?name=ea_name&new_name=ea_new_name |
| Set extended attribute | POST | base_url/update/perspective/object type/object id?ea_name=value |
| Get object attributes | GET | base_url/query/perspective/object type/object id |
Where base_url is
https://ManagementServer_hostname:14161/vom/api. Object type is the objects supported by InfoScale Operations Manager Web services API, for example host, cluster, LDEV, and virtualization server. ea_nameis the name of the extended attribute andvalue is the value you assign to the extended attribute.
Using the InfoScale Operations Manager Web services API you can also perform the following operations:
-
Start and stop Virtual Business Services.
This operation can be performed in the Server and Availability perspective.
-
Start and stop VVR replication.
-
Run a recovery plan.
-
Provision storage using a storage template.
To perform this operation you need to install Storage Provisioning and Enclosure Migration Add-on version 8.0.2
-
Perform thin reclamation on disks, volumes, and thin pools of an enclosure.
To perform this operation on an enclosure, you need to install Storage Insight Add-on version 6.1.
-
Move managed host in the Data Center.
You can move managed hosts in the Data Center. This operation can be performed in the server perspective.
Note: Managed host can be moved only in the Data Center. Note: If the rule is set on the parent Organization, then the managed host will move to the defined Organization.
-
Move managed hosts in the Organization/child-Organization.
Provide the parent Organization name first, followed by the subsequent child-Organizations names (s).
-
Move cluster in the Data Center.Note: The cluster can be moved only in the Data Center. Note: If the rule is set on the parent Organization, then the cluster will move to defined Organization.
-
Move cluster in the Organization/child-Organization.
Provide the parent Organization name first, followed by the subsequent child-Organization name(s).
-
Bring service group online with the parameters as force or propogate.
-
Switch service group.
-
Offline service group with the parameters as force, probe, or propogate.
-
Freeze service group with the parameter as persistent.
-
Unfreeze service group.
-
Clear fault on service group.
-
Clear the clearadminwait state for service group.
-
Flush service group.
-
Remove or unconfigure a managed host
Use the following URL to view the above listed operations.
base_url/op/
The GET request on an operation URL shows a sample URL for executing the operation along with the payload information.
For example to start the replication of a replicated volume group (RVG), the start_replication operation URL would include the host ID along with the RVG ID.
base_url/op/server/host/{host_id}/rvg/{rvg_id}/startreplication
Enter the operation URL and the payload information in any HTTPS client to execute the operation. On successful completion of the operation, the Task URL is displayed. Click on the Task URL to view complete information about the operation.
operation_urls are displayed when
base_url/query is executed for an object. This is the list of operations that can be performed on that object.
Note: operation_urlsare displayed only when there are operations which are supported from Web API. If there are no operations availableoperation_urlsis not displayed.
More Information