Group Internal Storage configuration Job

Overview

This job initiates a server group internal storage configuration that will affect some or all of the server group members. As a pre-requisite, create a server setting with "STORAGE" as the category and assign it to the server group.

Job Template ID	Resource Type	Job Parameters
c708eb57-235d-4ea8-9e21-8ceea2438773	compute-ops-mgmt/group	`devices*` `isStorageVolumeDeletionAllowed` `storageVolumeName`

Job parameters marked with an * are required.

Create Job

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

The following properties are used when creating a job:

Property	JSON Type	Description	Required?
`jobTemplate`	string (id)	The durable Template ID of the job	Yes
`resourceType`	string (type)	The TYPE of the resource the job will operate on	Yes
`resourceId`	string (id)	The ID of the resource the job will operate on	Yes
`jobParams`	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.

Job Parameters

This table summarizes the supported properties in jobParams.

Property	JSON Type	Values	Required?
`devices`	array	List of server IDs	Yes
`isStorageVolumeDeletionAllowed`	boolean	When enabled, any existing internal storage configuration will be erased prior to creating the new OS volume	No
`storageVolumeName`	string	When creating a storage volume, associate a name with the created volume	No

Parameter properties

devices : This required property is a list of server IDs to include in the server group internal storage configuration. At least one device must be included in the list. All devices in the list must belong to the group.
isStorageVolumeDeletionAllowed : When enabled, any existing internal storage configuration will be erased prior to creating the new OS volume.
- Default: false
storageVolumeName : When creating a storage volume, associate a name with the created volume.

Examples

Here are a couple of example request payloads for creating this job.

Example 1

Internal storage configuration for one server in a group.

Copy

Copied

{
  "jobTemplate": "c708eb57-235d-4ea8-9e21-8ceea2438773",
  "resourceType": "compute-ops-mgmt/group",
  "resourceId": "04460955-6038-4339-ba72-c9b05a03876e",
  "jobParams": {
    "devices": ["059826-706+8899059826806785"],
    "isStorageVolumeDeletionAllowed": true,
    "storageVolumeName": "Test1"
  }
}

Example 2

Internal storage configuration for all servers in a group with volume name set to empty.

Copy

Copied

{
  "jobTemplate": "c708eb57-235d-4ea8-9e21-8ceea2438773",
  "resourceType": "compute-ops-mgmt/group",
  "resourceId": "a3853ee1-da05-47d6-bcc4-d35244d59605",
  "jobParams": {
    "devices": ["063573-L08+8899063573208133", "855308-N51+8899855308351678"],
    "isStorageVolumeDeletionAllowed": false
  }
}