List the systems included in a group

GET /zosmf/resttopology/systems/groupName/<groupName>

where:

• zosmf/resttopology identifies the topology services.
• systems/groupName informs the service that the request is to retrieve a list of the systems that are defined to a specific group.
• <groupName> identifies the group for which to obtain the list of systems. If the group name contains a number sign (#), encode the number sign as %23. For example, if the group name is test#systems, specify test%23systems. Otherwise, the service will truncate #systems, and use test as the group name.

Use the following standard HTTP header with this request:

Content-Type: application/json

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

{
 "items":[
   {
    "systemNickName":"system-nickname",
    "systemName":"system-name",
    "sysplexName":"sysplex-name",
    "groupNames":"group-names",
    "url":"url",
    "zosVR":"zos-level",
    "jesMemberName":"JES-member-name",
    "jesType":"JES-type",
    "cpcName":"CPC-name",
    "cpcSerial":"CPC-serial",
    "httpProxyName":"proxy-name",
    "ftpDestinationName":"server-name"
   }
 ],
 "numRows":"total-items"
}

where:

system-nickname

Unique name assigned to the system definition.

system-name

Name specified for the system on the SYSNAME parameter in the IEASYSxx parmlib member.

sysplex-name

Name of the sysplex where the z/OS® system is a member. The name is the value specified for the SYSPLEX parameter of the cross-system coupling facility (XCF) couple data set format utility.

group-names

Comma-separated list of the groups to which the system is assigned.

url

URL used to access the z/OSMF instance that resides in the same sysplex as the system identified by the systemName attribute. Or, the URL used to access the application server that is hosting the server-side code for the plug-ins your enterprise imported into z/OSMF.

zos-level

Version and release of the z/OS image installed on the system. The version and release has the format z/OS VxxRyy where V stands for version, xx is the version number, R stands for release, and yy is the release number. For example, z/OS V2R1.

JES-member-name

JES2 multi-access spool (MAS) member name or JES3 complex member name that is assigned to the primary job entry subsystem (JES) that is running on the system.

JES-type

Type for the primary job entry subsystem running on the system. The type is either JES2 or JES3.

CPC-name

Name specified for the central processor complex (CPC) at the support element (SE) of that processor complex.

CPC-serial

Serial number of the CPC.

proxy-name

Name of the HTTP proxy definition that specifies the settings required to access the system through an HTTP or SOCKS proxy server.

server-name

Name of the server definition that specifies the settings required to access the FTP or SFTP server that is running on the system.

total-items

Number of system definitions that were retrieved.

In the following example, the GET method is used to retrieve a list of the systems that are defined to the z/OSMF instance with host name zosmf1.yourco.com and that are assigned to the group test.

A sample response is shown in Figure 2.