Examples of performing operations using Veritas InfoScale Operations Manager Web services API
Following are some examples on performing operations using Web services API:
-
To get metadata for a host:
https://veritasdomain.example.com:14161/vom/api/meta/server/host
- To define an extended attribute named **``department``** on object type cluster:
https://veritasdomain.example.com:14161/vom/api/meta/hadr/cluster
/add?name=department
Adds and displays the extended attribute
department for object type cluster in the Management Server console.
-
To modify an extended attribute named
departmenttoDept_newon object type cluster:https://veritasdomain.example.com:14161/vom/api/meta/hadr/cluster
/modify?name=department&new_name=Dept_new
- To delete an extended attribute named **``Dept_new``** on object type cluster:
https://veritasdomain.example.com:14161/vom/api/meta/hadr/cluster
/delete?name=dept_new
When you delete an extended attribute, it is not displayed in the Management Server console.
-
To update the extended attribute value for a host where the extended attribute is location:
https://veritasdomain.example.com:14161/vom/api/update/server/host
/myhost_id?location=1st floor
- To filter disk group objects whose display type is private:
https://veritasdomain.example.com:14161/vom/api/query/server/host
/myhost_id/diskgroup?display_type=private -
To run a recovery plan https://veritasdomain.example.com:14161/vom/api/op/hadr/ recoveryplan/rplan_id/execute/
Payload information required to run a recovery plan is task order and time out duration. If a task is to be skipped during run-time, IS_SKIP should be true. If shared service groups are to be brought offline then OfflineSharedSg should be set to true. Use the above URL along with the payload information in an HTTPS client to run the recovery plan operation.
- To provision storage using a storage template, enter the following URL to view the payload information.
```txt
https://veritasdomain.example.com:14161/vom/api/op/server/
template/storage/storage_template_id/provision
Payload information required to execute the storage template operation is host ID, disk group ID, and volume size. Use the above URL along with the payload information in a HTTPS client to execute the operation.
-
To online service group with the parameters force or propogate.
https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/
service_group_id/host/{hostname}/{force}/{propogate}/online
Example: Service group online with the parameter force
https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/
ABC_12/host/example.com/true/false/online
Example: Service group online with the parameter propogate https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/ ABC_12/host/example.com/false/true/online
-
To offline service group with the parameters force, probe, or propogate. https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/ service_group_id/host/{hostname}/{force}/{probe}/{propogate}/offline Example: Service group offline with parameter force https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/ x1@linux_clus-00000/host/example.com/true/false/false/offline Example: Service group offline with parameter propogate https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/ x1@linux_clus-00000/host/example.com/false/false/true/offline Example: Service group offline with the parameters force and probe https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/ x1@linux_clus-00000/host/example.com/true/true/false/offline
-
To Switch service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/ service_group_id/host/{hostname}/switch/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/
x1@linux_clus-00000/host/example.com/switch/ -
To move managed host in the Data Center. https://veritasdomain.example.com:14161/vom/api/op/server/ {host_id}/moveto/datacenter/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/server/
34001234-1234-4dxx-0000-00000000000/moveto/datacenter/ -
To move managed host from Organization OE1 to child-Organization OE3 of Organization OE2. https://veritasdomain.example.com:14161/vom/api/ op/server/{host_id}/moveto_oe/OE2,OE3/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/server/
0001234-1234-4dzz-0000-00000000011/moveto_oe/OE2,OE3/ -
To move cluster in the Data Center. https://veritasdomain.example.com:14161/vom/api/ op/hadr/{cluster_id}/moveto/datacenter/
> **Note:** cluster_id is the encoded ID of the cluster.
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/
hadr/rhelclust-10098/moveto/datacenter/ -
To move cluster from an organization OE1 to child-Organization OE3 of Organization OE2. https://veritasdomain.example.com:14161/vom/api/ op/hadr/{cluster_id}/moveto_oe/OE2,OE3/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/
hadr/rhelclust-10098/moveto_oe/OE2,OE3/ -
To freeze service group with the parameter persistent. https://veritasdomain.example.com:14161/vom/api/ op/hadr/servicegroup/{service_group_id}/{persistent}/freeze/ Example: Freeze service group with parameter persistent https://veritasdomain.example.com:14161/vom/api/ op/hadr/servicegroup/x1@linux_clus-00000/true/freeze/ Example: Freeze service group without any parameter https://veritasdomain.example.com:14161/vom/api/ op/hadr/servicegroup/x1@linux_clus-00000/false/freeze/
-
To unfreeze service group. https://veritasdomain.example.com:14161/vom/api/ op/hadr/servicegroup/{service_group_id}/unfreeze/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/
op/hadr/servicegroup/x1@linux_clus-00000/unfreeze/ -
To clear fault on service group. https://veritasdomain.example.com:14161/vom/api/ op/hadr/servicegroup/{service_group_id}/host/{hostname}/clear/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/
x1@linux_clus-00000/host/example.com/clear -
To clear the ADMIN_WAIT state for service group. https://veritasdomain.example.com:14161/vom/api/ op/hadr/servicegroup/{service_group_id}/host/ {hostname}/{fault}/clearadminwait/ Example: Clear the ADMIN_WAIT state and the fault. https://veritasdomain.example.com:14161/ vom/api/op/hadr/servicegroup/ x1@linux_clus-00000/host/example.com/true/clearadminwait/ Example: Clear the ADMIN_WAIT state without clearing the fault. https://veritasdomain.example.com:14161/ vom/api/op/hadr/servicegroup/ x1@linux_clus-00000/host/example.com/false/clearadminwait/
-
To flush service group. https://veritasdomain.example.com:14161/vom/api/ op/hadr/servicegroup/{service_group_id}/host/{hostname}/flush/
Example
```txt
https://veritasdomain.example.com:14161/
vom/api/op/hadr/servicegroup/
ABC_12/host/example.com/flush/ -
To bring a resource in a service group online. https://veritasdomain.example.com:14161/vom/api/op/hadr/ resource/{resourceid}/host/{hostname}/{force}/online/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/
resource/XYZ@sles11sp3-10000X1/host/example-xx00/false/online/ -
To offline a resource in a service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/ resource/{resourceid}/host/{hostname}/{ignore-parent}/offline/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/
resource/XYZ@sles11sp3-10000X1/host/example-xx00/false/offline/ -
To disable a resource in a service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/ resource/{resourceid}/disable/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/
resource/XYZ@sles11sp3-10000X1/disable/ -
To enable a resource in a service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/ resource/{resourceid}/enable/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/
resource/XYZ@sles11sp3-10000X1/enable/ -
To enable all the resources in a service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/ servicegroup/{sgid}/enableallresources/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/
servicegroup/my_group%00rhel6_10_58000/enableallresources/ -
To disable all the resources in a service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/ servicegroup/{sgid}/disableallresources/
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/
servicegroup/my_group%00rhel6_10_58000/disableallresources/ -
To clear a resource in a service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/ resource/{resourceid}/host/{hostname}/clear
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/resource/
rhel6_00_00%40rhel6_19-12340File_on_off_00/host/example.com/clear -
To probe a resource in a service group. https://veritasdomain.example.com:14161/vom/api/op/hadr/resource/ {resourceid}/host/{hostname}/probe
Example
```txt
https://veritasdomain.example.com:14161/vom/api/op/hadr/resource/
rhel6_00_00%40rhel6_19-12340File_on_off_00/host/example.com/probe -
To display a child service group. https://example.veritas.com:14161/vom/api/query/hadr/ cluster/{clus_id}/sg/{sg_id}
> **Note:** clus_id is the encoded ID of the cluster..
Example
```txt
https://example.veritas.com:14161/vom/api/query/hadr/
cluster/rhel6_00-012345/sg/grp_0009%00rhel6_00-12345
Note: If "Ask reason for all operations" is enabled underAdvanced Authorizationin theManagement Serverperspective, then it is mandatory to provide a reason for performing the operation.
More Information
Related information