z/OS MVS Programming: Callable Services for High-Level Languages
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Parameters

z/OS MVS Programming: Callable Services for High-Level Languages
SA23-1377-02

Start of change
The parameters are explained as follows:
ReturnCode
Returned parameter
  • Type: Integer (non-REXX), character representation of an integer (REXX)
  • Length: 4 bytes (non-REXX)

ReturnCode contains the return code from the service.

ConnectToken
Supplied parameter
  • Type: Character string
  • Length: 16 bytes

ConnectToken represents a logical connection between the application and a CPC, image, capacity record, activation profile, or user-defined image group. The ConnectToken is an output parameter on the HWICONN service call.

Start of changeIn most cases, the ConnectToken specified must have originated from a HWICONN service call that was issued from the same address space as this service call. For BCPii REXX execs running under the TSO/E or ISV-provided REXX environments, the ConnectToken specified must have originated from a HWICONN service call that was issued from the same task.End of change

QueryParm_Ptr (non-REXX)
QueryParm. (REXX)
Supplied parameter
  • Type: Pointer (non-REXX), stem variable (REXX)
  • Length: 4 bytes (non-REXX)
Non-REXX:
QueryParm_Ptr specifies the address of a user-defined query structure that contains a list of one or more requested attributes to be queried, in the following form: attribute that is required, address of where returned value is to be stored, the length of the storage available to HWIQUERY to store the returned value, and the actual length of the data that will be returned in the data area.

The size of the data area pointed to by this parameter must be 16 bytes multiplied by the NumOfAttributes parameter. For example, if NumofAttributes is 4, the data area pointed to by this parameter must be at least 64 bytes long (16 x 4).

The storage area that contains each attribute in the QueryParm is shown below:
Field Name Field Type
AttributeIdentifier 32-bit unsigned integer
AttributeValue_Ptr Pointer
AttributeValueLen 32-bit unsigned integer
AttributeValueLenReturned 32-bit unsigned integer

This table is mapped by the data structure Hwi_QueryParm_Type in the data mappings provided for the various programming languages supported. See Syntax, linkage and programming considerations for more information.

If all of the data can be written into the data area (the AttributeValueLen is greater than or equal to the actual data returned), the AttributeValueLenReturned field contains the actual length of the data written in the storage specified at address AttributeValue_Ptr.

The AttributeValueLenReturned is only used as an output parameter. Any value contained in the field when HWIQUERY is called is ignored.

REXX:
QueryParm is a compound (stem) variable which contains one or more requested attributes to be queried and returned.
The compound (stem) variable is specified as follows (where x is the user-defined QueryParm stem variable and n is the n-th attribute for the request):
  • x.0 specifies the number of attributes to be queried. The maximum number of attributes allowed is 64. (Supplied parameter)
  • x.n.ATTRIBUTEIDENTIFIER specifies the requested attribute. Set this variable to one of the query attribute constants defined in HWICIREX. (Supplied parameter)
  • x.n.ATTRIBUTEVALUE is the data value to be returned for most attributes. (Returned parameter)
  • Some single attributes can return multiple objects in a formatted structure. For those attributes, x.n.ATTRIBUTEVALUE.0 (Returned parameter) is the total number of returned objects. See the query attribute table below for the following attributes that are in a different format. These attributes include: HWI_SUPPPPOWERMODE, HWI_LIST_IP_ADDRESSES and HWI_PSWS.
The following is the list of valid query attributes identifiers. For more information about these attributes, see the following publications:
  • System z Application Programming Interfaces (SB10-7030-13)
  • System z10 and eServer zSeries Application Programming Interfaces (SB10-7030-09)
  • System z9 and eServer zSeries Application Programming Interfaces (SB10-7030-08)
  • Publication appropriate to the level of hardware that the HWIQUERY is targeted

Constant in hexadecimal
(Decimal)
Equate symbol

Description

1

(1)

HWI_NAME

Requests to retrieve the name that represents the connect token.
Note: The input connection token must represent a CPC connection, an image connection, a reset activation profile connection, an image activation profile connection, a load activation profile connection, or an image group connection.

2

(2)

HWI_ERRSTAT

Requests to retrieve whether the status is acceptable.
Note: The input connection token must represent a CPC connection an image connection, or an image group connection.

3

(3)

HWI_BUSYSTAT

Requests to retrieve whether the status is busy.
Note: The input connection token must represent a CPC connection an image connection, or an image group connection.

4

(4)

HWI_MSGSTAT

Requests to retrieve whether hardware messages are present.
Note: The input connection token must represent a CPC connection or an image connection.

5

(5)

HWI_OPERSTAT

Requests to retrieve the current status.
Note: The input connection token represents a CPC connection or an image connection.

6

(6)

HWI_ACCSTAT

Requests to retrieve the acceptable status values.
Note: The input connection token represents a CPC connection or an image connection.

7

(7)

HWI_APROF

Requests to retrieve the next activation reset profile name.
Note: The input connection token must represent a CPC connection or an image connection.

8

(8)

HWI_LUAPROF

Requests to retrieve the last used activation profile.
Note: The input connection token must represent a CPC connection or an image connection.

9

(9)

HWI_OBJTYPE

Requests to retrieve the object type.
Input connection
token represents              Returns
CPC                            HWMCA_CPC_OBJECT
CPC image                      HWMCA_CPC_IMAGE_OBJECT
Capacity record                HWMCA_CAPACITY_RECORD
Reset activation profile       HWMCA_ACT_PROFILE_RESET
Image activation profile       HWMCA_ACT_PROFILE_IMAGE
Load activation profile        HWMCA_ACT_PROFILE_LOAD
Image Group                    HWMCA_CPC_IMAGE_USER_GROUP       
Note: The input connection token must represent a CPC connection, an image connection, a capacity record connection, a reset activation profile connection, an image activation profile connection, a load activation profile connection, or an image group connection.

A

(10)

HWI_IMLMODE

Requests to retrieve the initial machine load (IML) mode (LPAR).
Note: The input connection token must only represent a CPC connection or an image connection.

B-16

(11–22)

RESERVED

Reserved for attributes that are common to CPC and image connections unless otherwise noted.

17

(23)

HWI_IPADDR

Requests to retrieve the internet address (IPv4 format).
Note: The input connection token must only represent a CPC connection.

18

(24)

HWI_SNAADDR

Requests to retrieve the SNA address (netid.nau).
Note: The input connection token must only represent a CPC connection.

19

(25)

HWI_MMODEL

Requests to retrieve the machine model.
Note: The input connection token must only represent a CPC connection.

1A

(26)

HWI_MTYPE

Requests to retrieve the machine type.
Note: The input connection token must only represent a CPC connection.

1B

(27)

HWI_MSERIAL

Requests to retrieve the machine serial.
Note: The input connection token must only represent a CPC connection.

1C

(28)

HWI_CPCSERIAL

Requests to retrieve the CPC serial number.
Note: The input connection token must only represent a CPC connection.

1D

(29)

HWI_CPCID

Requests to retrieve the CPC identifier.
Note: The input connection token must only represent a CPC connection.

1E

(30)

HWI_RESERVEID

Requests to retrieve the name of the application that is holding the reserve (if any).
Note: The input connection token must only represent a CPC connection.

1F

(31)

HWI_SVCEREQD

Requests to retrieve the service required.
Note: The input connection token must only represent a CPC connection.

20

(32)

HWI_CBUINSTD

Requests to retrieve the CBU installed.
Note: The input connection token must only represent a CPC connection.

21

(33)

HWI_CBUENABLD

Requests to retrieve the CBU enabled.
Note: The input connection token must only represent a CPC connection.

22

(34)

HWI_CBUACTIVE

Requests to retrieve the CBU activated.
Note: The input connection token must only represent a CPC connection.

23

(35)

HWI_CBUACTDT

Requests to retrieve the CBU activation date.
Note: The input connection token must only represent a CPC connection.

24

(36)

HWI_CBUEXPDT

Requests to retrieve the CBU expiration date.
Note: The input connection token must only represent a CPC connection.

25

(37)

HWI_CBUTESTAR

Requests to retrieve the CBU tests left (test activations remaining).
Note: The input connection token must only represent a CPC connection.

26

(38)

HWI_CBUREALAV

Requests to retrieve the CBU real activation available.
Note: The input connection token must only represent a CPC connection.

27

(39)

HWI_PRUNTYPE

Requests to retrieve the processor running time type.
Note: The input connection token must only represent a CPC connection or a reset activation profile connection.

28

(40)

HWI_PRUNTIME

Requests to retrieve the processor running time.
Note: The input connection token must only represent a CPC connection or a reset activation profile connection.

29

(41)

HWI_PRUNTSEW

Requests to retrieve the processor running time slice end wait processing.
Note: The input connection token must only represent a CPC connection or a reset activation profile connection.

2A

(42)

HWI_OOCINST

Requests to retrieve the on and off capacity on demand installed.
Note: The input connection token must only represent a CPC connection.

2B

(43)

HWI_OOCACT

Requests to retrieve the on and off capacity on demand currently activated.
Note: The input connection token must only represent a CPC connection.

2C

(44)

HWI_OOCENAB

Requests to retrieve the on and off capacity on demand enabled.
Note: The input connection token must only represent a CPC connection.

2D

(45)

HWI_OOCADT

Requests to retrieve the on and off capacity on demand activation date.
Note: The input connection token must only represent a CPC connection.

2E

(46)

HWI_PCPCSWM

Requests to retrieve the permanent CPC software model. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

2F

(47)

HWI_PPBPSWM

Requests to retrieve the permanent plus billable processor software model. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

30

(48)

HWI_PPTPSWM

Requests to retrieve the permanent plus (all) temporary processor software model. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

31

(49)

HWI_PCPCMSU

Requests to retrieve the permanent CPC millions of service units (MSU) value. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

32

(50)

HWI_PPBPMSU

Requests to retrieve the permanent plus billable processor MSU value. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

33

(51)

HWI_PPTPMSU

Requests to retrieve the permanent plus (all) temporary processor MSU value. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

34

(52)

HWI_NUMGPP

Requests to retrieve the number of general purpose processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

35

(53)

HWI_NUMSAP

Requests to retrieve the number of service assist processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

36

(54)

HWI_NUMIFAP

Requests to retrieve the number of the integrated facility for applications (IFA) processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

37

(55)

HWI_NUMIFLP

Requests to retrieve the number of the integrated facility for Linux (IFL) processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

38

(56)

HWI_NUMICFP

Requests to retrieve the number of the internal coupling facility (ICF) processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

39

(57)

HWI_NUMIIPP

Requests to retrieve the number of integrated information processors (IIP). This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

3A

(58)

HWI_NUMFLTYP

Requests to retrieve the number of defective (faulty) processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

3B

(59)

HWI_NUMSPARE

Requests to retrieve the number of spare processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

3C

(60)

HWI_NUMPENDP

Requests to retrieve the number of pending (activation) processors. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

3D

(61)

HWI_CAPCHGALLWD

Requests to determine if activate/deactivate of capacity are permitted. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must only represent a CPC connection.

3E

(62)

HWI_DGRSTAT

Requests to retrieve degraded status.
Note: The input connection token must only represent a CPC connection.

3F

(63)

HWI_CURRPPOWERMODE

Requests to retrieve the current processor power savings mode active on the targeted CPC. This attribute is only available when targeting a zEnterprise or higher CPC.
Note: The input connection token must only represent a CPC connection.

40

(64)

HWI_SUPPPPOWERMODE

Requests to retrieve the supported processor power savings modes available on the targeted CPC. This attribute is only available when targeting a zEnterprise or higher CPC.
Non-REXX:
The returned data is mapped as follows:

Field Name      Field Type
---------------       -----------
Number of       32-bit integer
supported
powersave modes

For each supported powersave mode, the following is returned:

Powersave mode  32-bit integer value

Note: The query parameter for this attribute must specify a data area large enough to contain all of the above structure (that is, 32 bits + 32 bits per supported powersave mode returned). For example, if there are 2 supported powersave modes on the targeted CPC, then the structure must be at least 32 + (32 x 2) = 96 bits (12 bytes).
REXX:
The returned data is mapped as follows (where x is the user-defined QueryParm stem, n is the n-th requested attribute and m is the m-th returned powersave mode value):
  • x.n.ATTRIBUTEVALUE.0 is the number of supported powersave modes (m).
  • x.n.ATTRIBUTEVALUE.m.PSMODE is the m-th powersave mode value.
Note: The input connection token must only represent a CPC connection.

41

(65)

HWI_STPCONFIG

Requests to retrieve the Server Timer Protocol (STP) configuration data.
Note: The input connect token must only represent a CPC connection.

42

(66)

HWI_NUMPGPP

Requests to retrieve the number of pending general purpose processors.
Note: The input connect token must only represent a CPC connection.

43

(67)

HWI_NUMPSAP

Requests to retrieve the number of pending service assist processors.
Note: The input connect token must only represent a CPC connection.

44

(68)

HWI_NUMPAAP

Requests to retrieve the number of pending Application Assist Processor (AAP) processors.
Note: The input connect token must only represent a CPC connection.

45

(69)

HWI_NUMPIFLP

Requests to retrieve the number of pending Integrated Facility for Linux (IFL) processors.
Note: The input connect token must only represent a CPC connection.

46

(70)

HWI_NUMPICFP

Requests to retrieve the number of pending Internal Coupling Facility (ICF) processors.
Note: The input connect token must only represent a CPC connection.

47

(71)

HWI_NUMPIIPP

Requests to retrieve the number of pending Integrated Information (IIP) processors.
Note: The input connect token must only represent a CPC connection.

48

(72)

HWI_POWERMODEALLOWED

Requests to retrieve the processor power savings mode allowed. This attribute is only available when targeting a zEnterprise or higher CPC.
HWMCA_TRUE
The processor currently allows switching to power savings mode.
HWMCA_FALSE
The processor currently does not allow switching to power savings mode.
Note: The input connection token must only represent a CPC connection.

49

(73)

HWI_VERSION

Requests to retrieve the CPC version number.
Note: The input connection token must only represent a CPC connection.

4A

(74)

HWI_EC_MCL_INFO

Requests to retrieve an XML string that describes the Engineering Change (EC) and Microcode Level (MCL) levels.
Note: The input connection token must only represent a CPC connection.
Attention: The data returned by the support element can be quite large. Consider using a larger data area when requesting this attribute.

4B

(75)

HWI_LIST_IP_ADDRESSES

Requests to retrieve all the IP addresses (in either IPv4 or IPv6 format, or both) used for the targeted CPC.
Non-REXX:
The returned data is mapped as follows:
Field Name             Field Type
----------             -----------
Number of IP addresses 32-bit unsigned integer
IP address value       39-character value padded
                       with blanks
Note: The query parameter for this attribute must specify a data area large enough to contain all of the above structure (that is, a 4-byte length field plus a 39-byte field for each IP address returned). For example, if there are 3 IP addresses returned, the AttributeValueLen specified for this attribute must be at least (4 + (39 x 3)) = 121 bytes.
REXX:
The returned data is mapped as follows (where x is the user-defined QueryParm stem, n is the n-th requested attribute and m is the m-th returned IP address value):
  • x.n.ATTRIBUTEVALUE.0 is the number of IP addresses (m).
  • x.n.ATTRIBUTEVALUE.m.IPADDR is the m-th IP address value.
Note: The input connection token must only represent a CPC connection.

4C

(76)

HWI_AUTO_SWITCH_ENABLED

Requests to retrieve a value used to determine if automatic switching between primary and alternate support elements is enabled.
A 4-byte integer type value is returned:
HWMCA_TRUE
Automatic switching is enabled.
HWMCA_FALSE
Automatic switching is disabled.
Note: The input connection token must only represent a CPC connection.

4D-68

(77-104)

RESERVED

Reserved for CPC attributes unless otherwise noted.

69

(105)

HWI_CPCNAME

Requests to retrieve the parent (CPC) name.
Note: The input connection token must only represent an image connection.

6A

(106)

HWI_OSNAME

Requests to retrieve the SW operating system name.
The values returned on the HWI_OSNAME attribute are not owned by z/OS BCPii and are subject to change. The possible values returned by the various operating systems at the time of this publication include:
HWI_OSTYPE value: MVS
The HWI_OSNAME value returned is the SYSNAME parameter as defined in IEASYSxx parmlib member for the targeted image.
HWI_OSTYPE value: VM
The HWI_OSNAME value returned is the system identifier or system name as defined in the SYSTMID field in the SYSCM (System Common Area) control block.
HWI_OSTYPE value: LINUX
The HWI_OSNAME value returned is N/A.
HWI_OSTYPE value: VSE
The HWI_OSNAME value returned is the VSE system name.
HWI_OSTYPE value: Z TPF EE
The HWI_OSNAME value returned is the id value representing the targeted image's CPU designation in the z/TPF complex.
Note: The input connection token must only represent an image connection.

6B

(107)

HWI_OSTYPE

Requests to retrieve the SW operating system type.

The values returned on the HWI_OSTYPE attribute are not owned by z/OS BCPii and are subject to change. Possible values include MVS, VM, LINUX, VSE, and Z TPF EE.

Note: The input connection token must only represent an image connection.

6C

(108)

HWI_OSLEVEL

Requests to retrieve the SW operating system level.
The values returned on the HWI_OSLEVEL attribute are not owned by z/OS BCPii and are subject to change. The possible values returned by the various operating systems at the time of this publication include:
HWI_OSTYPE value: MVS
The HWI_OSLEVEL value is mapped by the CVTOSLVL field of the CVT control block.
HWI_OSTYPE value: VM
The HWI_OSLEVEL value is mapped as follows:
  • 4-bit release #
  • 4-bit modification level
  • 8-bit version #
  • 16-bit service level
  • 8-bit MVS guest count
  • 8-bit LINUX guest count
  • 8-bit VSE guest count
  • 8-bit Solaris guest count
HWI_OSTYPE value: LINUX
The HWI_OSLEVEL value is mapped as follows, in hexadecimal:
  • 40 bits N/A
  • 8-bit major kernel revision
  • 8-bit major release
  • 8-bit minor release
HWI_OSTYPE value: VSE
The HWI_OSLEVEL value is mapped as follows:
  • 32-bit VSE/AF release level
  • 32-bit latest service level (if available)
HWI_OSTYPE value: Z TPF EE
The HWI_OSLEVEL value is mapped as follows:
  • 16-bit version #
  • 8-bit PUT level

Examples:

For MVS, FFFFFFFFEF7F0000 implies that the target is running z/OS V1R13 because the CVTZOS_V1R13 bit is the last supported release flag that is on.

For VM, 4005100200320000 implies that the target is running z/VM Release 4, Modification Level 0, Version 5, Service Level 1002, MVS guest count 0, Linux guest count 32, VSE guest count 0, and Solaris guest count 0.

For LINUX, 0000000000020620 implies that the target is running z/LINUX major kernel revision 2, major release 6, and minor release 32.

For VSE, 0830000000000000 implies that the target is running at the VSE/AF 8.3 release level and no service level is available.

For Z TPF EE, 0101070000000000 implies that the target is running z/TPF version 1.1, PUT level 7.

Note: The input connection token must represent an image connection.

6D

(109)

HWI_SYSPLEX

Requests to retrieve the SW sysplex name (z/OS only).
Note: The input connection token must only represent an image connection.

6E

(110)

HWI_CLUSTER

Requests to retrieve the LPAR cluster name.
Note: The input connection token must only represent an image connection.

6F

(111)

HWI_PARTITIONID

Requests to retrieve the partition ID. Start of changeIf the connection token represents an image connection, the image partition ID is returned; if the connection token represents an image activation profile connection, the image activation profile partition ID is returned.End of change The image partition ID is only retrievable when the partition has been activated.
Note: The input connection token must only represent an image connection or an image activation profile connection.

70

(112)

HWI_DEFCAP

Requests to retrieve the current defined capacity.
Note: The input connection token must only represent an image connection or an image activation profile connection.

71

(113)

HWI_SGPIPW

Requests to retrieve the shared general processor initial processing weight (SGPIPW).
Note: The input connection token must only represent an image connection or an image activation profile connection.

72

(114)

HWI_SGPIPWCAP

Requests to retrieve the SGPIPW to be capped or not capped.
Note: The input connection token must only represent an image connection or an image activation profile connection.

73

(115)

HWI_SGPPWMIN

Requests to retrieve the minimum SGPPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

74

(116)

HWI_SGPPWMAX

Requests to retrieve the maximum SGPPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

75

(117)

HWI_SGPPW

Requests to retrieve the current SGPPW value.
Note: The input connection token must only represent an image connection.

76

(118)

HWI_SGPPWCAP

Requests to retrieve the SGPPW to be capped or not capped.
Note: The input connection token must only represent an image connection.

77

(119)

HWI_WLM

Requests to retrieve whether WLM is allowed to change processing weight-related attributes.
Note: The input connection token must only represent an image connection or an image activation profile connection.

78

(120)

HWI_IFAIPW

Requests to retrieve the integrated facility for applications initial processing weight (IFAIPW).
Note: The input connection token must only represent an image connection or an image activation profile connection.

79

(121)

HWI_IFAIPWCAP

Requests to retrieve the IFAIPW to be capped or not capped.
Note: The input connection token must only represent an image connection or an image activation profile connection.

7A

(122)

HWI_IFAPWMIN

Requests to retrieve the minimum IFAPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

7B

(123)

HWI_IFAPWMAX

Requests to retrieve the maximum IFAPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

7C

(124)

HWI_IFAPW

Requests to retrieve the current IFAPW value.
Note: The input connection token must only represent an image connection.

7D

(125)

HWI_IFAPWCAP

Requests to retrieve the IFAPW to be currently capped or not capped.
Note: The input connection token must only represent an image connection.

7E

(126)

HWI_IFLIPW

Requests to retrieve the integrated facility for Linux initial processing weight.
Note: The input connection token must only represent an image connection or an image activation profile connection.

7F

(127)

HWI_IFLIPWCAP

Requests to retrieve the IFLIPW to be capped or not capped.
Note: The input connection token must only represent an image connection or an image activation profile connection.

80

(128)

HWI_IFLPWMIN

Requests to retrieve the minimum IFLPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

81

(129)

HWI_IFLPWMAX

Requests to retrieve the maximum IFLPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

82

(130)

HWI_IFLPW

Requests to retrieve current IFLPW value.
Note: The input connection token must only represent an image connection.

83

(131)

HWI_IFLPWCAP

Requests to retrieve the IFLPW to be capped or not capped.
Note: The input connection token must only represent an image connection.

84

(132)

HWI_ICFIPW

Requests to retrieve the internal coupling facility initial processing weight (ICFIPW).
Note: The input connection token must only represent an image connection (Coupling Facility images only) or an image activation profile connection.

85

(133)

HWI_ICFIPWCAP

Requests to retrieve the ICFIPW be capped or not capped.
Note: The input connection token must only represent an image connection (Coupling Facility images only) or an image activation profile connection.

86

(134)

HWI_ICFPWMIN

Requests to retrieve the minimum ICFPW value.
Note: The input connection token must only represent an image connection (Coupling Facility images only) or an image activation profile connection.

87

(135)

HWI_ICFPWMAX

Requests to retrieve the maximum ICFPW value.
Note: The input connection token must only represent an image connection (Coupling Facility images only) or an image activation profile connection.

88

(136)

HWI_ICFPW

Requests to retrieve the current ICFPW value.
Note: The input connection token must only represent an image connection (Coupling Facility images only).

89

(137)

HWI_ICFPWCAP

Requests to retrieve the ICFPW to be capped or not capped.
Note: The input connection token must only represent an image connection (Coupling Facility images only).

8A

(138)

HWI_IIPIPW

Requests to retrieve the integrated information processors initial processing weight (IIPIPW).
Note: The input connection token must only represent an image connection or an image activation profile connection.

8B

(139)

HWI_IIPIPWCAP

Requests to retrieve the IIPIPW be capped or not capped.
Note: The input connection token must only represent an image connection or an image activation profile connection.

8C

(140)

HWI_IIPPWMIN

Requests to retrieve the minimum IIPPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

8D

(141)

HWI_IIPPWMAX

Requests to retrieve the maximum IIPPW value.
Note: The input connection token must only represent an image connection or an image activation profile connection.

8E

(142)

HWI_IIPPW

Requests to retrieve the current IIPPW value.
Note: The input connection token must only represent an image connection.

8F

(143)

HWI_IIPPWCAP

Requests to retrieve the IIPPW to be capped or not capped.
Note: The input connection token must only represent an image connection.

90

(144)

HWI_IPLTOKEN

Requests to retrieve the IPL token associated with the current IPL of the image targeted.
Note: The input connection token must only represent an image connection.

91

(145)

HWI_PSWS

Requests to retrieve the program status word (PSW) for each of the central processors (CP) associated with this image.
Non-REXX:
The returned data is mapped as follows:
Field Name        Field Type
---------------   -----------
Number of CPs     32-bit unsigned integer

For each CP, the following is returned:
CPUID             32-bit unsigned integer
PSW               Start of change128-bitEnd of change unsigned integer
Note: The query parameter for this attribute must specify a data area large enough to contain all of the above structure (that is 32 bits + Start of change160End of change bits per CP). For example, if there are 4 CPs on the targeted image, the AttributeValueLen specified for this attribute must be 32 + (Start of change160End of change x 4) = Start of change672End of change bits (Start of change84End of change bytes).
REXX:
The returned data is mapped as follows (where x is the user-defined QueryParm stem, n is the n-th requested attribute and m is the m-th returned CPUID or PSW value):
  • x.n.ATTRIBUTEVALUE.0 is the number of CPs (m).
  • x.n.ATTRIBUTEVALUE.m.CPUID is the m-th CPUID value.
  • x.n.ATTRIBUTEVALUE.m.PSW is the m-th PSW value.
Note: The input connection token must represent an image connection.

92

(146)

HWI_GROUP_PROFILE _CAPACITY

Requests to change or set the workload unit capacity for the group profile associated with an image.
Note:
  1. The input connection token must only represent an image connection.
  2. This attribute requires that the target image be:
    • On a z196 (zEnterprise) or higher CPC.
    • A member of a LPAR (defined capacity) group.
    If both the above requirements are not met, the HWIQUERY fails with RC=X'406' (HWI_QUERY_ATTRIBUTE_NOT_SUPPORTED).

93-B6

(147-182)

RESERVED

Additional attributes and reserved numbers for attributes that are for image connections only.

B7

(183)

HWI_RECID

Requests to retrieve the record ID.
Note: The input connection token must only represent a capacity record connection.

B8

(184)

HWI_RECTYPE

Requests to retrieve the record type.
Note: The input connection token must only represent a capacity record connection.

B9

(185)

HWI_ACTSTAT

Requests to retrieve the record activation status.
Note: The input connection token must only represent a capacity record connection.

BA

(186)

HWI_ACTDATE

Requests to retrieve the record activation date.
Note: The input connection token must only represent a capacity record connection.

BB

(187)

HWI_EXPDATE

Requests to retrieve the record expiration date.
Note: The input connection token must only represent a capacity record connection.

BC

(188)

HWI_ACTEXP

Requests to retrieve the record activation expiration date.
Note: The input connection token must only represent a capacity record connection.

BD

(189)

HWI_MAXRADS

Requests to retrieve the maximum real activation days.
Note: The input connection token must only represent a capacity record connection.

BE

(190)

HWI_MAXTADS

Requests to retrieve the maximum test activation days.
Note: The input connection token must only represent a capacity record connection.

BF

(191)

HWI_REMRADS

Requests to retrieve the remaining real activation days.
Note: The input connection token must only represent a capacity record connection.

C0

(192)

HWI_REMTADS

Requests to retrieve the remaining test activation days.
Note: The input connection token must only represent a capacity record connection.

C1

(193)

HWI_OOCODREC

Request to retrieve all aspects of a capacity record in XML format.
Note: The input connection token must only represent a capacity record connection.

C3-C8

(195-200)

RESERVED

Reserved for capacity record attributes.

C9

(201)

HWI_IOCDS

Requests to retrieve the IOCDS.
Note: The input connection token must represent a reset activation profile.

CA

(202)

HWI_IPL_ADDRESS

Requests to retrieve the IPL address.
Note: The input connection token must represent an image activation profile or a load activation profile.

CB

(203)

HWI_IPL_PARM

Requests to retrieve the IPL parameter.
Note: The input connection token must represent an image activation profile or a load activation profile.

CC

(204)

HWI_IPL_TYPE

Requests to retrieve the IPL type for the activation profile.
Note: The input connection token must represent an image activation profile or a load activation profile.

CD

(205)

HWI_WW_PORTNAME

Requests to retrieve the worldwide port name for the activation profile.
Note: The input connection token must represent an image activation profile or a load activation profile.

CE

(206)

HWI_BOOT_PGM_SELECTOR

Requests to retrieve the boot program selector for the activation profile.
Note: The input connection token must represent an image activation profile or a load activation profile.

CF

(207)

HWI_LU_NUM

Requests to retrieve the logical unit number value for the activation profile.
Note: The input connection token must represent an image activation profile or a load activation profile.

D0

(208)

HWI_BOOTREC_BLK_ADDR

Requests to retrieve the boot record logical block address for the activation profile.
Note: The input connection token must represent an image activation profile or a load activation profile.

D1

(209)

HWI_OPSYS_LOADPARM

Requests to retrieve the operating system specific load parameter.
Note: The input connection token must represent an image activation profile or a load activation profile.

D2

(210)

HWI_GROUP_PROF_NAME

Requests to retrieve the name of the group capacity profile that is to be used for the CPC image or image object activated with this profile.
Note: The input connection token must represent an image activation profile.

D3

(211)

HWI_LOAD_AT_ACTIVATION

Requests to retrieve the indicator if the CPC image object activated with this profile should be loaded (IPLed) at the end of the activation.
Note: The input connection token must represent an image activation profile.

D4

(212)

HWI_CENTRAL_STOR

Requests to retrieve the initial amount of central storage (in megabytes) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

D5

(213)

HWI_RES_CENTRAL_STOR

Requests to retrieve the reserved amount of central storage (in megabytes) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

D6

(214)

HWI_EXPANDED_STOR

Requests to retrieve the initial amount of expanded storage (in megabytes) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

D7

(215)

HWI_RES_EXPANDED_STOR

Requests to retrieve the reserved amount of expanded storage (in megabytes) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

D8

(216)

HWI_NUM_GPP

Requests to retrieve the number of dedicated general purpose processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

D9

(217)

HWI_NUM_RESGPP

Requests to retrieve the number of reserved dedicated general purpose processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

DA

(218)

HWI_NUM_IFA

Requests to retrieve the number of dedicated integrated facility for applications (IFA) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

DB

(219)

HWI_NUM_RESIFA

Requests to retrieve the number of reserved dedicated integrated facility for applications (IFA) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

DC

(220)

HWI_NUM_IFL

Requests to retrieve the number of dedicated integrated facility for Linux (IFL) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

DD

(221)

HWI_NUM_RESIFL

Requests to retrieve the number of reserved dedicated integrated facility for Linux (IFL) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

DE

(222)

HWI_NUM_ICF

Requests to retrieve the number of dedicated internal coupling facility (ICF) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

DF

(223)

HWI_NUM_RESICF

Requests to retrieve the number of reserved dedicated internal coupling facility (ICF) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E0

(224)

HWI_NUM_ZIIP

Requests to retrieve the number of dedicated System z Integrated Information Processors (zIIPs) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E1

(225)

HWI_NUM_RESZIIP

Requests to retrieve the number of reserved dedicated System z Integrated Information Processors (zIIPs) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E2

(226)

HWI_NUM_SHARED_GPP

Requests to retrieve the number of shared general purpose processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E3

(227)

HWI_NUM_RES_SHARED_GPP

Requests to retrieve the number of reserved shared general purpose processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E4

(228)

HWI_NUM_SHARED_IFA

Requests to retrieve the number of shared integrated facility for applications (IFA) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E5

(229)

HWI_NUM_RES_SHARED_IFA

Requests to retrieve the number of reserved shared integrated facility for applications (IFA) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E6

(230)

HWI_NUM_SHARED_IFL

Requests to retrieve the number of shared integrated facility for Linux (IFL) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E7

(231)

HWI_NUM_RES_SHARED_IFL

Requests to retrieve the number of reserved shared integrated facility for Linux (IFL) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E8

(232)

HWI_NUM_SHARED_ICF

Requests to retrieve the number of shared internal coupling facility (ICF) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

E9

(233)

HWI_NUM_RES_SHARED_ICF

Requests to retrieve the number of reserved shared internal coupling facility (ICF) processors to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

EA

(234)

HWI_NUM_SHARED_ZIIP

Requests to retrieve the number of shared System z Integrated Information Processors (zIIPs) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

EB

(235)

HWI_NUM_RES_SHARED_ZIIP

Requests to retrieve the number of reserved shared System z Integrated Information Processors (zIIPs) to be used for the CPC image object activated with this profile.
Note: The input connection token must represent an image activation profile.

EC

(236)

HWI_BASIC_CPU_AUTH

_COUNT_CNTL

Requests to retrieve the enablement value of the Basic CPU counter facility for the CPC image. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

ED

(237)

HWI_PROBSTATE_CPU_AUTH

_COUNT_CNTL

Requests to retrieve the enablement value of the Problem state CPU counter facility for the CPC image. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

EE

(238)

HWI_CRYPTOACTIVITY_CPU

_AUTH_COUNT_CNTL

Requests to retrieve the enablement value of the crypto activity CPU counter facility for the CPC image. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

EF

(239)

HWI_EXTENDED_CPU_AUTH

_COUNT_CNTL

Requests to retrieve the enablement value of the extended CPU counter facility for the CPC image. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F0

(240)

HWI_COPROCESSOR_CPU

_AUTH_COUNT_CNTL

Requests to retrieve the enablement value of the coprocessor group CPU counter facility for the CPC image. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F1

(241)

HWI_BASIC_CPU_SAMPLING

_AUTH_CNTL

Requests to retrieve the enablement value of the basic CP CPU sampling facility for the CPC image. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F2

(242)

HWI_APROF_STORE_STATUS

Requests to retrieve the store status function value. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent a load activation profile.

F3

(243)

HWI_APROF_LOADTYPE

Requests to retrieve the type of load being requested. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent a load activation profile.

F4

(244)

HWI_PROFILE_DESCRIPTION

Requests to retrieve the activation profile description. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F5

(245)

HWI_PROFILE_PARTITION

_ID

Requests to retrieve the partition identifier for the activation profile. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F6

(246)

HWI_OPERATING_MODE

Requests to retrieve the operating mode value for the activation profile. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F7

(247)

HWI_CLOCK_TYPE

Requests to retrieve the clock type assignment (time source setting) for the activation profile. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F8

(248)

HWI_TIME_OFFSET_DAYS

Requests to retrieve the time offset days (the number of days currently set as the offset from the external time source's time of day) for the activation profile. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

F9

(249)

HWI_TIME_OFFSET_HOURS

Requests to retrieve the time offset hours (the number of hours currently set as the offset from the external time source's time of day) for the activation profile. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

FA

(250)

HWI_TIME_OFFSET

_MINUTES

Requests to retrieve the time offset minutes (the number of minutes currently set as the offset from the external time source's time of day) for the activation profile. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

FB

(251)

HWI_TIME_OFFSET

_INCREASE

Requests to retrieve the time offset increase or decrease value for the activation profile. The time offset, as specified in days, hours, and minutes, is increased or decreased from GMT. TRUE means that the time offset is east of GMT. FALSE means that the time offset is west of GMT. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

FC

(252)

HWI_LICCC_VALIDATION

_ENABLED

Requests to retrieve whether the activation profile must conform to the current Licensed Internal Code Configuration Control (LICCC) configuration. This attribute is only available when targeting a zEnterprise or higher CPC.
Note: The input connection token must represent an image activation profile.

FD

(253)

HWI_GLOBAL

_PERFORMANCE

_DATA_CONTROL

Requests to retrieve whether the logical partition can be used to view the processing unit activity data for all other LPARs activated on the same CPC. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

FE

(254)

HWI_IO_CONFIGURATION

_CONTROL

Requests to retrieve whether the logical partition can be used to read and write any Input/Output Configuration Data Set (IOCDS) in the configuration. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

FF

(255)

HWI_CROSS_PARTITION

_AUTHORITY

Requests to retrieve whether the logical partition can be used to issue control program instructions that reset or deactivate other LPARs. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

100

(256)

HWI_LOGICAL_PARTITION

_ISOLATION

Requests to retrieve whether reconfigurable channel paths assigned to the logical partition are reserved for its exclusive use. This attribute is only available when targeting a z10 or higher CPC.
Note: The input connection token must represent an image activation profile.

101-109

(257–265)

RESERVED

Reserved for activation profile attributes.
NumOfAttributes (non-REXX)
Supplied parameter
  • Type: Integer
  • Length: 4 bytes

NumOfAttributes specifies the number of attributes to be queried. The maximum number of attributes allowed is 64.

DiagArea (non-REXX)
DiagArea. (REXX)
Returned parameter
  • Type: Character string (non-REXX), stem variable (REXX)
  • Length: 32 bytes (non-REXX)
DiagArea contains diagnostic data to help determine the cause of a failure from the service. For many return codes, the DiagArea can contain further information to help determine the cause of the failure. See the descriptions of different return codes for a partial list of data returned in this area.
Note: For all environmental errors (with return code X'F00' and higher), the DiagArea might not be filled in, and the data returned in the area should be ignored.
Field Name (non-REXX) / Tail name constant of the user-defined DiagArea stem (REXX) Field Type (non-REXX) Description
Diag_Index 32-bit integer The array index to the parameter field that causes the error.
Diag_Key 32-bit integer The constant value represents the field that causes the error.
Diag_Actual 32-bit integer The incorrect actual value specified.
Diag_Expected 32-bit integer The expected value to be used.
Diag_CommErr 32-bit integer The returned code that is returned from the console application API or the BCPii transport layer.
Diag_Text Character (12) Additional diagnostic information in text format.

See BCPii communication error reason codes for a partial list of the descriptive communication transport error return codes and suggested actions.

End of change

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014