Examples of performing operations using Veritas InfoScale Operations Manager Web services API

Last published : Jun 19, 2026
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_new on 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 perform service group online operation:
    https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/
    service_group_id/online
    -  To perform service group offline operation:
    https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/
    service_group_id/offline
  • To perform service group switch operation: https://veritasdomain.example.com:14161/vom/api/op/hadr/servicegroup/ service_group_id/switch

> **Note:** If "Ask reason for all operations" is enabled underAdvanced Authorizationin theManagement Serverperspective, then it is mandatory to to provide a reason for performing the operation.

More Information

[About performing operations using Veritas InfoScale Operations Manager Web services API](about-performing-operations-using-veritas-infoscale-operations-manager-web-services-api.md)
Related information