IBM Support

Operations Center V7.1.3 REST API Commands

Question & Answer


Question

What are the REST API commands that can be used with the IBM Spectrum Protect V7.1.3 Operations Center? Tip: Beginning with Version 7.1.3, IBM® Tivoli® Storage Manager is now IBM Spectrum Protect™. Some applications such as the software fulfillment systems and IBM License Metric Tool use the new product name. However, the software and its product documentation continue to use the Tivoli Storage Manager product name. To learn more about the rebranding transition, see http://www.ibm.com/support/docview.wss?uid=swg21963634 .

Answer

Note: Some of the URLs were changed for Version 7.1.4. If you are using Version 7.1.4, see http://www.ibm.com/support/docview.wss?uid=swg21973011

All URLs start with https://{oc server url}:{port}/oc/api/

GET Service

Description
URL
Helphelp
Serversservers
Server detailserver/{server name}/detail
Clientsclients
Client detailserver/{server name}/client/{client name}/detail
Client at riskserver/{server name}/client/{client name}/atrisk
Client filespacesserver/{server name}/client/{client name}/filespaces
Client filespace detailserver/{server name}/client/{client name}/filespace/{filespace}/detail
Domainsdomains
Domain detailserver/{server name}/domain/{domain name}/detail
Domain management classesserver/{server name}/domain/{domain name}/mgmtclasses
Domain management class detailserver/{server name}/domain/{domain name}/mgmtclass/{mgmtclass}/detail
Schedulesschedules
Schedule detailsserver/{server name}/domain/{domain name}/schedule/{schedule name}/detail
Schedule assigneesserver/{server name}/domain/{domain name}/schedule/{schedule name}/assignees
Storage poolsstoragepools
Storage pool detailserver/{server name}/storagepool/{storage pool}/detail
Storage devicesstoragedevices
Storage device detailserver/{server name}/storagedevice/{device name}/detail


PUT Service
Description
URL
Body Parameter
Update client passwordserver/{server name}/client/{client name}/password{
"password": "<new password>"
}
Lock clientserver/{server name}/client/{client name}/lock
Unlock clientserver/{server name}/client/{client name}/unlock
Assign a client to a new backup scheduleserver/{server name}/client/{client name}/assignschedule{
"schedule": "<schedule name>"
}
Decommission clientserver/{server name}/client/{client name}/decommissionclient
Decommission virtual machineserver/{server name}/client/{client name}/vm/{vm name}/decommissionclient

POST Service
Description
URL
Body Parameter (All keys are required, but [ ] indicates optional value)
Register nodeserver/{server name}/client{
"name":"<node name>",
"authentication":"<authentication type>",
"password":"<password>",
"domain":"<domain name>",
"contact":"<contact name>",
"email":"<email>",
"schedule":"[ <schedule name> ]",
"optionset":"[ <optionset name> ]",
"deduplication":"[ <deduplication> ]",
"sslrequired":"[ <sslrequired> ]",
"sessioninitiation":"[ <sessioninitiation> ]"
}
Issue commandcli/issueCommand<tsm command>
Issue confirm commandcli/issueConfirmed/Command<tsm command>

[{"Product":{"code":"SSER5J","label":"IBM Spectrum Protect Extended Edition"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Component":"Not Applicable","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"7.1.3","Edition":"","Line of Business":{"code":"LOB26","label":"Storage"}}]

Document Information

Modified date:
17 June 2018

UID

swg21963573