Running an inventory job for virtualized systems

An inventory job for virtualized systems will rebuild a list of those and resources on it, such as virtual machines and virtual hard disks on it, that IBM Spectrum Protect Plus can protect. This section discusses how you can invoke an inventory job for hypervisors that applies to VMware vCenter, Microsoft Hyper-V, and Amazon EC2.

Every time you add a new hypervisor server or make any changes in their resources such as deploying new virtual machines on it, you have to run an inventory job at IBM Spectrum Protect Plus to update its list of hypervisor instances.

See also

To run an inventory job for application servers (Oracle Database, SQL Server, Db2, MongoDB, Exchange Server, and Office 365), see Running an inventory job for application server instances.

Method and URI

To start an inventory job, use a POST method and a URI:

POST    https://{hostname|IPv4}/api/endeavour/job/1004

Parameters

Parameter 1: action

Specify the type of the action.

  • Value: inventory

  • 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 virtualized system instances

_params = {
    "action":     "start",
    "actionname": "start"
}

_response = requests.post('https://' + spp_ipv4 + '/api/endeavour/job/1004'
    headers={...}, params=_params, verify=...)
_images/reference_hypervisor_inventory01.png

Figure 20 The same action can be taken in the IBM Spectrum Protect Plus web user interface: In any of hypervisor pages (e.g. VMware), 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).

Attention

Do not determine the status of 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, see Getting status of a hypervisor inventory job.