Collect Server Inventory

Overview

This job initiates a server inventory data collection job on directly managed or OneView managed servers.

Job Template ID	Resource Type	Data
d6595f1b-84e6-4587-ade5-656e2a5ea20d	compute-ops-mgmt/server	`filters` `is_reports_call`

Create Job

A job can be created by issuing a POST to the /compute-ops-mgmt/v1beta3/jobs endpoint with the correct payload for the job.

The following properties are used when creating a job:

Property	JSON Type	Description	Required?
`jobTemplateUri`	string (uri)	A job-template URI with the durable Template ID of the job	Yes
`resourceUri`	string (uri)	A resource URI that the job will operate on	Yes
`data`	object	Any additional data required by the job	No

If the job was created successfully, a 201 Created response is returned. The response includes the job resource which has a job resourceUri that you can use to track the progress of the job.

Data

This table summarizes the supported properties in data.

Property	JSON Type	Values	Required?
`filters`	array	List of inventory subresources to be requested	No
`is_reports_call`	boolean	Populates inventory to roundup DB	No

Data properties

filters : This property is a list of inventory resources that should be collected from the server. An empty list will collect all inventory resources. The following case sensitive values are supported:
- Chassis
- Processor
- memory
- networkAdapters
- localStorage
- localStorageV2
- devices
- devicesV2
- powerSupplies
- fans
- firmware
- software
is_reports_call : This flag determines if the inventory should be made available to reports.
- Default: false

Examples

Inventory request payload examples for creating this job.

Example 1

Collect complete inventory of a server.

Copy

Copied

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/d6595f1b-84e6-4587-ade5-656e2a5ea20d",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/854361-001+2C201515GR",
}

Example 2

Collect complete server inventory and make it available for reporting.

Copy

Copied

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/d6595f1b-84e6-4587-ade5-656e2a5ea20d",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/854361-001+2C201515GR",
    "data": {
        "is_reports_call": true
    }
}

Example 3

Collect server inventory for the provided subresources in the filters.

Copy

Copied

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/d6595f1b-84e6-4587-ade5-656e2a5ea20d",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/854361-001+2C201515GR",
    "data": {
        "filters": [
            "Chassis", "Processor", "memory", "networkAdapters"
        ]
    }
}

Example 4

Collect server inventory for the provided subresources in the filters and also make it available for reporting.

Copy

Copied

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/d6595f1b-84e6-4587-ade5-656e2a5ea20d",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/854361-001+2C201515GR",
    "data": {
        "is_reports_call": true,
        "filters": [
            "devices", "powerSupplies", "fans", "firmware", "software"
        ]
    }
}