Running an inventory job for application server instances¶
IBM Spectrum Protect Plus supports application-level operations for the following solutions of application servers:
File Systems
Microsoft Windows
Containers
Kubernetes
OpenShift
Cloud Management
Microsoft 365
Databases
Db2
Exchange
MongoDB
Oracle
SQL
An inventory job for application servers will rebuild a list of application servers and application data on it such as databases that are registered in IBM Spectrum Protect Plus. An inventory job for application servers will start automatically as soon as you register a new application server on IBM Spectrum Protect Plus. In addition, every time you you make any changes in an application such as deploying new databases on it, you have to run an inventory job at IBM Spectrum Protect Plus to update its list of application instances.
See also
To run an inventory job for virtualized systems (VMware, Hyper-V, and Amazon EC2), follow the instructions in Running an inventory job for virtualized systems.
Method and URI¶
To start an inventory job for application server instances, use a POST method and a URI, where {jobId}
is the ID for the application server inventory job:
POST https://{hostname|IPv4}/api/endeavour/job/{jobId}
Tip
To get the {jobId}
for the application server inventory job, follow the instructions in Getting a {jobId}, where the object name is Application Server Inventory
. This {jobId}
may vary by the IBM Spectrum Protect Plus appliances.
Parameters¶
Parameter 1: action
Specify the type of action.
Value:
start
Type: System string. Required. Available in the web interface.
Parameter 2: actionname
Specify the step of the action.
Value:
start
Type: System string. Required. Available in the web interface.
Data¶
None.
Example: Start an inventory job for application server instances¶
Assume that you want to run an application server inventory job.
Create a function that converts the policy name, Application Server Inventory
, into the job ID:
job_id = converter_job("Application Server Inventory")
print(job_id)
1004
A Python snippet that is similar to the following example can be used to start an inventory job for application server instances:
_params = {
"action": "inventory",
"actionname": "start"
}
_response = requests.post('https://' + spp_ipv4 + '/api/endeavour/job/' + job_id
headers={...}, params=_params, verify=...)

Figure 26 The same action can be taken in the IBM Spectrum Protect Plus web user interface: In any of application server pages (for example, Oracle), click Run an inventory. The blue Run Inventory button changes into Inventory In Progress in gray.¶
You will receive a response with no body and the HTTP status code of 204 (No Content).
Restriction: Do not determine the status of the application inventory jobs by referring to the HTTP status code in a response. This request only starts an inventory job and receives a response with the HTTP status code of 204 (No Content) regardless of the status or the result. To see the status of the inventory jobs, follow the instructions in Getting the status of an inventory job for application servers.