Group Apply OneView Server Templates Job

Overview

This job copies the server templates in the configured setting to the selected target appliance group members. The group must have a configured 'OVE_SERVER_TEMPLATES_VM' setting.

Job Template ID Resource Type Data
db3620d4-19a4-4b54-9804-83f8f59d48a4 compute-ops-mgmt/group targetApplianceIds*

Data properties marked with a * are required.

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

The following table summarizes the supported properties in data.

Property JSON Type Values Required?
targetApplianceIds array List of device IDs Yes

Data properties

  • targetApplianceIds : This property lists the appliance IDs to include in the group apply setting. If specified, this non-empty list of appliance IDs limits the scope of the operation to the specified appliances in the group. If no device IDs are specified, an error occurs.

Example

Here is an example request payload for creating this job.

Example 1

Copy OneView server templates associated with a group to specific appliance group members.

Copy
Copied
{
   "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/db3620d4-19a4-4b54-9804-83f8f59d48a4",
   "resourceUri": "/compute-ops-mgmt/v1beta3/groups/213e7c32-3046-4419-95dc-cc816adb95e9",
   "data": {
       "targetApplianceIds": [
           "oneview+2ec6bdbf-59e2-4d1c-b59e-8147927321fd"
       ]
   }
}