Retrieve z/OSMF information

You can use this operation to retrieve information about z/OSMF on a particular z/OS system.

HTTP method and URI path

GET /zosmf/info

where zosmf/info identifies the z/OSMF information retrieval service.

Standard headers

Use the following standard HTTP header with this request:

Content-Type: application/json

Custom headers

None.

Request content

None.

Content type used for HTTP response data

The JSON content type ("Content-Type: application/json") is used for response data. The following JSON object is received as output from the request. 
{
"zosmf_saf_realm":"SAF-profile-prefix",
"zosmf_port":"zosmf-server-port-number",
"zosmf_full_version":"zosmf-release-level",
"plugins":
	[{
	"pluginVersion":"plugin-fmid-build-level",
	"pluginStatus":"plugin-status",
	"pluginDefaultName":"plugin-name"
	},
	 ⋮
  {
	"pluginVersion":"plugin-fmid-build-level",
	"pluginStatus":"plugin-status",
	"pluginDefaultName":"plugin-name"
	}],
"api_version":"api-version",
"zos_version":"zos-release",
"zosmf_version":"zosmf-version",
"zosmf_hostname":"host-system-URL"
}
where:
zosmf_saf_realm
Realm associated with the system on which z/OSMF is installed. Usually, this is the sysplex name.
zosmf_port
Port number for SSL encrypted traffic for the active instance of z/OSMF on the z/OS system.
zosmf_full_version
Indicates the z/OSMF version, further qualified by a service level.
plugins
Array of zero, one, or more elements that contain information about each of the installed z/OSMF plug-ins. If no plug-ins are installed, this area is empty.
Each element contains the following attributes:
pluginVersion
Indicates the plug-in version (FMID) and build level.
pluginStatus
Indicates the status of the plug-in. The status is reported for IBM-supplied plug-ins only. For an external application, the status is blank.
The following values are valid:
ACTIVE
The plug-in is running.
INSTALLED
The plug-in is installed, but not running.
UNINSTALLED
The plug-in was installed in a previous z/OSMF configuration, but is not installed in the current configuration. This status can result when a plug-in is removed from z/OSMF.

After a plug-in is started, its status remains as ACTIVE, even if the plug-in is later stopped.

pluginDefaultName
Indicates the plug-in name.
api_version
Version of the z/OSMF information retrieval service and the JSON object structure used for this request. The version sequence starts at 1, and is incremented if the service or the JSON structure changes.
zos_version
Indicates the z/OS operating system level. The following values are valid:
04.24.00
Indicates that the z/OS level is V2R1.
zosmf_version
Indicates the z/OSMF level. The following values are valid:
24
Indicates that the z/OSMF level is V2R1.
zosmf_hostname
Indicates the hostname or IP address of the z/OS system on which z/OSMF is installed

Usage considerations

See Usage considerations for the z/OSMF REST services.

Required authorizations

See Required authorizations.

Expected response

On completion, the service returns an HTTP response, which includes a status code indicating whether your request completed. Status code 200 indicates success. A status code of 4nn or 5nn indicates that an error has occurred. For more details, see Error handling.

The response also includes a JSON object that contains the retrieved data. For details, see Content type used for HTTP response data.

Example request

In the following example, the GET method is used to retrieve information about z/OSMF.
Figure 1. Sample request to retrieve z/OSMF information
GET /zosmf/info HTTP/1.1
Host: host.name.com

Example response

For a successful request, the HTTP response includes a JSON document containing the requested information.
HTTP/1.1 200 OK
Date: Wed, 06 Mar 2013 06:39:28 +0000GMT
Content-Type: text/plain
Connection: close

{
"zosmf_saf_realm":"SAFRealm",
"zosmf_port":"443",
"zosmf_full_version":"24.02",
"plugins":
	[{"pluginVersion":"hsma210.spe2;driver05;2014-02-11T03:21:53",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"Import Manager"},
	{"pluginVersion":"hsma213.spe2;driver05;2014-02-11T10:17:27",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"WorkloadManagement"},
	{"pluginVersion":"HQX7790;driver122;2014-02-18T00:00:00Z",
	"pluginDefaultName":"IBM SDSF"},
	{"pluginVersion":"hsma216;DRIVER04;2014-01-14T19:03:40",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"Capacity Provisioning"},
	{"pluginVersion":"hsma214.spe2;driver05;2014-02-11T08:28:24",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"Software Deployment"},
	{"pluginVersion":"hsma21a;pm93903;2013-08-12T03:52:53",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"ConfigurationAssistant"},
	{"pluginVersion":"hsma215.spe2;driver05;2014-02-11T10:16:30",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"IncidentLog"},
	{"pluginVersion":"hsma211.spe2;driver05;2014-02-11T03:29:52",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"ISPF"},
	{"pluginVersion":"hsma212;DRIVER4B;2014-01-14T12:43:43",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"ResourceMonitoring"},
	{"pluginVersion":"hsma217.spe2;driver05;2014-02-11T12:01:40",
	"pluginStatus":"ACTIVE",
	"pluginDefaultName":"Workflow"}],
"api_version":"1",
"zos_version":"04.24.00",
"zosmf_version":"24",
"zosmf_hostname":"host.name.com"
}
Parent topic: z/OSMF information retrieval service