Prime a WLM resource pool

Use this operation to create a record for a WLM resource pool.

HTTP method and URI path

POST /zosmf/zwlm/rest/wrps

Query parameters

None.

Description

This operation creates a WRP record in a persistent file for WRP data. In addition, it causes a new WRP record to be displayed on the WLM Resource Pool page of the z/OSMF Workload Management task. The actual provisioning for the report class, and the definition and installation of the service definition, occurs only when the WRP definition is completed by the WLM administrator in z/OSMF.

On successful completion of a prime a WLM resource pool request, a response body that describes the request is returned.

For the properties that you can specify on the request body, see Request content.

For a description of the response content, see Response content.

Request content

The request content is expected to contain a JSON object. See Table 1 for a description of the fields.

Table 1. Request content for the prime WLM resource pool request
Field name	Required or Optional	Description
cloud-info	Required	Specifies the attributes of the cloud: domain-name Name of the domain of systems domain-id Generated identifier of the domain of systems tenant-name Name of the tenant for the domain tenant-id Generated identifier of the tenant template-name Name of the software services template
wrp-data	Required	Specifies the attributes of the WLM resource pool: wrp-name Name of the WLM resource pool service-level-agreements Array of service-level agreements, in the form "sla-name":"level", for example: `“service-level-agreements”: [ {“SlaOne”:”GOLD”}, {“SlaTwo”:”SILVER”}, ]` report-class-name Name of the report class

Authorization requirements

See Required authorizations.

HTTP status codes

For a successful request, the response body is provided, as described in Request content.

For a list of status codes, see Error handling.

Response content

On successful completion, the service returns a response body, which contains a JSON object. For a description of fields in the JSON object, see Table 2.

Table 2. Response content for a successful prime WLM resource pool request
Field name	Description
status	Status of the request.
return-code	Return code of the request.
message	Message issued for the request.
wrp-id	Identifier of the WLM resource pool
state	State of the request.

Example HTTP interaction

The example in Figure 1 shows a request to prime a WLM resource pool.

Figure 1. Sample request to issue a prime WRP request

POST  https://host:port/zosmf/zwlm/rest/wrps
 
{
  “cloud-info”:{
                “domain-name”:”DOMAIN1”,
                “domain-id”:”12345ABC”,
                “tenant-name”:”Joey”,
                “tenant-id”:”IZU$000,
                “template-name”:”CICSBasic”                       
               }
   
   “wrp-data”{
                 “wrp-name”:”WRP1”,
                 “service-level-agreements”:[ 
                                            {“sla-name”:”GOLD”},
                                            {“sla-name”:”SILVER”}
                                            ],
                 “report-class-name”:”Joey00”
	      }
}

The following is the response body for the request.

Figure 2. Sample response body

{
  “status”:”success',
  “return-code”:”0”,
  “message”:null,
  “wrp-id”:”1090f34e-0a5a-4506-b553-91e932a46f3e”,
  “wrp-name”:”WRP1”,
  “state”:”initialized”    
}