Delete a portable software instance

You can use this operation to remove a portable software instance definition from z/OSMF. The delete operation removes only the definition of the portable software instance from z/OSMF. The UNIX directory that contains the portable software instance files is not affected.

HTTP method and URI path

DELETE /zosmf/swmgmt/pswi/<system-nickname>/<pswi-name>

where:

zosmf/swmgmt: Identifies the software management services.
pswi: Informs the service that the request is for a portable software instance object.
<system-nickname>: Nickname of the z/OSMF host system that has access to the volumes and data sets where the portable software instance is located. In combination with <pswi-name>, it further qualifies the request and indicates the specific portable software instance to delete.
To obtain information about the specified system, you can use the z/OSMF topology services. For more information, see Topology services.
<pswi-name>: Name of the portable software instance. In combination with <system-nickname>, it further qualifies the request and indicates the specific portable software instance to delete.

Standard headers

Use the following standard HTTP header with this request:

Accept-Language

Identifies the preferred language for any messages that are returned to the caller. The following values are acceptable:

Accept-Language: en (English)
Accept-Language: ja (Japanese)

If any other language value is specified or if the header is omitted, then English is used.

Custom headers

None.

Request content

None.

Usage considerations

See Usage considerations for the z/OSMF REST services.

Required authorizations

Certain authorizations are required to submit a request through the software management services to delete a portable software instance. The user ID that initiates the request requires the same authorizations as the ones needed to perform a remove operation with the z/OSMF Software Management task. The user ID needs READ access to the Software Management task and CONTROL access to the SAF resources that correspond to the portable software instance to delete. For more information about access controls for the Software Management task, see Creating access controls for the Software Management task in IBM z/OS Management Facility Configuration Guide.

Expected response

On completion, the service returns an HTTP response with a status code that indicates whether your request completed. Status code 200 indicates success. A status code of 4nn or 5nn indicates that an error occurred. For more information about errors, see Error handling.

Example

In the following example, the DELETE method is used to delete portable software instance Hooli from system PEV174.

Figure 1. Sample request to delete a portable software instance

DELETE /zosmf/swmgmt/pswi/PEV174/Hooli HTTP/1.1
Host: pev174.yourco.com

Figure 2 provides a sample response that indicates that the delete operation was successful.

Figure 2. Sample response for a delete portable software instance request

HTTP/1.1 200 OK
Date: Tues, 05 June 2020 18:53:27 +00004GMT