Retrieve the properties of a software instance

GET /zosmf/swmgmt/swi/<system-nickname>/<swi-name>

where:

• zosmf/swmgmt identifies the software management services.
• swi informs the service that the request is for the software instance object.
• <system-nickname>/<swi-name> further qualifies the request and indicates the specific software instance to be retrieved. A software instance is uniquely identified by its name (swi-name) and the nickname (system-nickname) of the z/OSMF host system that has access to the volumes and data sets where the software instance resides.

  To obtain information about the specified system, you can use the z/OSMF topology services. For more details, see Topology services.

If the request is successful, the response also includes the following JSON object:

{
  "name":"swi-name",
  "system":"system-nickname", 
  "description":"swi-description",
  "globalzone":"global-zone", 
  "targetzones":["target-zones"], 
  "categories":"["categories"],
  "productinforetrieved":"last-retrieved", 
  "lastmodified":"last-modified", 
  "modifiedby":"modified-user-ID", 
  "created":"date-created",
  "createdby":"created-user-ID", 
  "locked":"date-locked", 
  "lockedby":"locked-user-ID",
  "datasets":[
  {
    "dsname":"data-set-name",
    "volume":"volume-serial"
  }],
  "products":[
  {
    "prodname":"product-name",
    "prodid":"product-ID",
    "release":"product-level",
    "vendor":"vendor-name",
    "generalavailability":"general-availability",
    "endofservice":"end-of-service",
    "url":"product-URL",
    "productinfofileversion":"file-version",
    "features":[
    {
      "feature":"feature-name",
      "fmids":[
      {
        "fmid":"fmid-name",
        "description":"fmid-description",
        "targetzones":["fmid-target-zones"]
      }]
    }]
  }]
}

where:

swi-name

Name of the software instance.

system-nickname

Nickname of the z/OSMF host system that has access to the volumes and data sets where the software instance resides. To obtain information about the specified system, you can use the z/OSMF topology services. For more details, see Topology services.

swi-description

Description of the software instance.

global-zone

CSI data set that contains the global zone used to manage the software. If the software instance has no global zone, then this property will be null.

target-zones

Comma-separated list of the target zones included in the software instance. If the software instance has no global zone, then this property will be null.

categories

Comma-separated list of the categories to which the software instance is assigned.

last-retrieved

Date and time the product, feature, and FMID information was last retrieved for the software instance. This attribute is blank if this information has not been retrieved.

last-modified

Date and time in ISO 8601 format that the software instance was last modified.

modified-user-ID

User ID of the user who last modified the software instance.

date-created

Date and time in ISO 8601 format that the software instance was created.

created-user-ID

User ID of the user who created the software instance.

date-locked

Date and time in ISO 8601 format that the software instance was locked. This attribute is null if the software instance is not currently locked.

locked-user-ID

User ID of the user who locked the software instance. This attribute is null if the software instance is not currently locked.

datasets

Array that contains each non-SMP/E managed data set that is included in the software instance.

data-set-name

Name of the non-SMP/E managed data set.

volume-serial

Volume on which the non-SMP/E managed data set resides.

products

Array that contains each product that is included in the software instance.

product-name

Name of the product. If any FMIDs are not related to a product and feature, those FMIDs are listed under a product named No Product.

product-ID

Identifier of the product.

product-level

Version, release, and modification level of the product. The value has the format VV.RR.MM, where VV is the two-digit version, RR is the two-digit release, and MM is the two-digit modification level.

vendor-name

Name of the vendor that provides the product.

general-availability

Date this level of the product is available to all users.

end-of-service

Last date on which the vendor will deliver standard support services for this level of the product. This date is the general end of service date. It does not account for lifecycle extensions.

product-URL

URL that links to additional information about the product. This information can include, for example, product life cycle dates, product highlights, planning information, and technical descriptions.

file-version

Version of the most recent product information file that was retrieved that contains the corresponding product. The version represents the date that file was created or last updated.

features

Array that contains each feature that is included in the product.

feature-name

Name of the feature. If any FMIDs are not related to a product and feature, those FMIDs are listed under a feature named No Feature.

fmids

Array that contains each FMID that is included in the feature.

fmid-name

Name of the FMID.

fmid-description

Description of the FMID.

fmid-target-zones

Name of the target zones where the FMID is installed.

In the following example, the GET method is used to retrieve the properties of software instance DB2V9 on system PEV174.

A sample response is shown in Figure 2.