 |
The parameter descriptions are listed in alphabetical order. Default
values are underlined: - ,ANSAREA=ansarea
- Use this output parameter to specify the storage area where IXCQUERY
returns the requested information. The IXCYQUAA macro provides the
format of the information area. The area can be in the primary address
space or in an address/data space that is addressable through a public
entry on the caller's DU-AL. Use the ANSLEN parameter to specify the
length of the area.
To Code: Specify the RS-type name or
address (using a register from 2 to 12) of the output area where IXCQUERY
is to return the requested information.
- ,ANSLEN=anslen
- Use this input parameter to specify the length in bytes of the
area that you provided on the ANSAREA parameter. You can estimate
the length by consulting the data structures mapped by the IXCYQUAA
macro. If you do not provide enough space, XCF lets you know how
much space you should have provided.
To Code: Specify the
RS-type name or address (using a register from 2 to 12) of a fullword
storage area which contains the length in bytes.
- ,CFLEVEL=cflevel
- Use this output parameter to specify a storage area to contain
the maximum coupling facility operational level supported by the MVS™ operating system where the IXCQUERY
macro was issued.
To Code: Specify the RS-type name or
address (using a register from 2 to 12) of a fullword output area
to contain the coupling facility level.
- ,CFNAME=NO_CFNAME
- ,CFNAME=cfname
- Use this input parameter to specify the name of the coupling facility
for which query data is to be returned. The name must be eight characters
long, padded on the right with blanks if necessary; the valid characters
are A-Z, 0-9, $, @, #, and underscore (_). The name must begin with
an uppercase alphabetic character.
CFNAME is an optional parameter.
If CFNAME is not specified, or if CFNAME=NO_CFNAME is specified, then
general information about all coupling facilities in the CFRM active
policy is returned.
If a specific CFNAME is requested, then
detailed information about that coupling facility is returned if the
specified facility is in the active policy.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of an
8-character input area which contains the name of the coupling facility.
- ,CURRMAXSYS=currmaxsys
- Use this output parameter to specify a storage area to contain
the maximum number of systems that can participate in the sysplex.
When control returns from IXCQUERY processing, this area contains
the current maximum number of systems that could participate in the
sysplex given its current environment and restrictions. The value
can range from 1 to the value returned for MAXSYS.
- If you specified either PLEXCFG=LOCAL or PLEXCFG=MONOPLEX in IEASYSxx,
then the value of currmaxsys is 1.
- If you specified a different configuration with PLEXCFG, then
this area contains the maximum number of systems that could appear
within a sysplex.
Note: The value can change dynamically over time without a
system or sysplex re-IPL.
To Code: Specify the RS-type
name or address (using a register from 2 to 12) of a fullword storage
area to contain the value of the current maximum number of systems.
- ,ELEMENT=element
- Use this input parameter to specify the name of the element for
which data is to be returned. The element name must be 16 characters
long, padded on the right with blanks.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a 16-byte
field that contains the name of the element.
- ,FEATAREA=featarea
- Use this output parameter to specify a storage area in which the
system is to return information about the XCF and XES software features
installed on this system.
To Code: Specify the RS-type
name or address (using a register from 2 to 12) of a 32-byte field
to contain the XCF and XES software features as mapped by QUREQFEATURES
in IXCYQUAA.
- ,GRPNAME=NO_GRPNAME
- ,GRPNAME=grpname
- Use this input parameter to specify the name of the group for
which query data is to be returned. The name must be eight characters
long, padded on the right with blanks if necessary; the valid characters
are A-Z, 0-9, $, @, and #. The record returned for each member of
the specified group includes the state of the member, its member token,
the name of the system on which the member was last active, and all
user state fields.
If GRPNAME is not specified, or if GRPNAME=NO_GRPNAME
is specified, information about all groups is returned.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of an 8-character input field which contains the name of
the group.
 ,IPLTOKEN=ipltoken  - Use this output parameter to specify a storage area to contain
the IPL token of the MVS system where the IXCQUERY macro was issued.
In XCF-LOCAL mode, the returned IPLTOKEN value is 0.
To code: Specify
the RS-type name or address (using a register from 2 to 12) of a 64-bit
field to contain the IPL token.
- ,JOBNAME=jobname
- Use this input parameter to specify the name of the batch job
or started task for which data is to be returned.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of an
8-byte field that contains the jobname.
- ,LOCAL=local
- Use this output parameter to specify a storage area that you use
to test if the sysplex is in XCF-local mode. If the system is in XCF-local
mode, then XCF returns the value X'01' in the storage area;
otherwise XCF returns the value X'00' in the storage area.
To Code: Specify the RS-type name or address (using a register
from 2 to 12) of an 8-bit output area to contain the local mode indicator.
- ,LOCAL_ONLY=NO
- ,LOCAL_ONLY=YES
- Use this input parameter to specify the scope of the data for
which information is to be provided.
- NO
- This indicates that information is to returned for elements running
on any system in the sysplex that satisfy this request.
- YES
- This indicates that information is to be returned for all elements
running on the current system.
- ,MAXSYS=maxsys
- Use this output parameter to specify a storage area to contain
the maximum number of systems that can participate in the sysplex,
based on the MVS system level
of the system on which the IXCQUERY request is issued and the sysplex
configuration. When control returns from IXCQUERY:
- If you specified either PLEXCFG=LOCAL or PLEXCFG=MONOPLEX in IEASYSxx,
then the value of maxsys is 1.
- If you specified a different configuration with PLEXCFG, then
this area contains the maximum number of systems that could appear
within a sysplex.
To Code: Specify the RS-type name or address (using
a register from 2 to 12) of a fullword storage area to contain the
value of the maximum number of systems.
- ,MEMNAME=NO_MEMNAME
- ,MEMNAME=memname
- Use this input parameter to specify the name of the specific member
of the group for which data is to be returned. The name must be 16
characters long, padded on the right with blanks if necessary; the
valid characters are A-Z, 0-9, $, @, and #.
If MEMNAME is not
specified, or if MEMNAME=NO_MEMNAME is specified, data is returned
for all members of the group.
To Code: Specify the
RS-type name or address (using a register from 2 to 12) of a 16-character
input field which contains the name of the member.
- ,MEMTOKEN=memtoken
- Use this input parameter to specify the member token of the specific
member for which data is to be returned.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of an
8-byte input variable that contains the member token.
- ,MF=S
- ,MF=(L,mfctrl)
- ,MF=(L,mfctrl,mfattr)
- ,MF=(L,mfctrl,0D)
- ,MF=(E,mfctrl)
- ,MF=(E,mfctrl,COMPLETE)
- Use MF=S to specify the standard form of the macro, which builds
an inline parameter list and generates the macro invocation to transfer
control to the service.
Use MF=L to specify the list form of the macro. Use the list form
together with the execute form of the macro for applications that
require reentrant code. The list form defines an area of storage that
the execute form uses to store the parameters. Only the PLISTVER parameter
can be coded with the list form of the macro.
Use MF=E to specify the execute form of the macro. Use the execute
form together with the list form of the macro for applications that
require reentrant code. The execute form stores the parameters into
the storage area defined by the list form, and generates the macro
invocation to transfer control to the service.
- ,mfctrl
- Use this output parameter to specify a storage area to contain
the parameters.
To Code: Specify the RS-type name or address (using a register
from 2 to 12) of the parameter list.
- ,mfattr
- Use this input parameter to specify the name of a 1- to 60-character
string that can contain any value that is valid on an assembler DS
pseudo-op. You can use this parameter to force boundary alignment
of the parameter list. If you do not code mfattr, the system
provides a value of 0D, which forces the parameter list to a doubleword
boundary.
- ,COMPLETE
- Use this input parameter to require that the system check for
required parameters and supply defaults for omitted optional parameters.
Note: In the macro expansion you might see some defaults for optional
parameters that are not documented here. The ones that are not documented
do not have any effect on the macro. For example, if SMILE=var were
an optional parameter and the default is SMILE=NO_SMILE then it would
not be documented. However, if the default was SMILE=:-), then it
would be documented because a value would be the default.
- ,MONOPLEX=monoplex
- Use this output parameter to specify a storage area that you use
to test if the sysplex is in monoplex mode. If the system is in monoplex
mode, then XCF returns the value X'01' in the storage area;
otherwise XCF returns the value X'00' in the storage area.
To Code: Specify the RS-type name or address (using a register
from 2 to 12) of an 8-bit output area to contain the monoplex mode
indicator.
- ,ND=nd
- Use this output parameter to specify a storage area to contain
the node descriptor of the MVS system
where the IXCQUERY macro was issued.
To Code: Specify the
RS-type name or address (using a register from 2 to 12) of a 32-byte
field to contain the node descriptor.
- ,IPLTOKEN=ipltoken
- Use this output parameter to specify a storage area to contain
the IPL token of the MVS system
where the IXCQUERY macro was issued. In XCF-LOCAL mode, the returned
IPLTOKEN value is 0.
To Code: Specify the RS-type name
or address (using a register from 2 to 12) of a 64-bit field to contain
the IPL token.
- ,PLEXNAME=plexname
- Use this output parameter to specify a storage area to contain
the name of the sysplex. When control returns from IXCQUERY processing,
this area contains the name of the sysplex in which this system is
participating.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of an 8-byte output area to contain
the sysplex name.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=plistver
- Use this input parameter to specify the version of the macro.
See Understanding IXCQUERY Version Support for a description of the
options available with PLISTVER.
- ,QUAALEVEL=0
- ,QUAALEVEL=quaalevel
- Use this input parameter to specify the level of the IXCYQUAA
record mappings that the system returns in the answer area. Valid values are 0, 1 and 2 .
- A value of 0 indicates that base level IXCYQUAA records will be
returned.
- A value of 1 indicates that level-1 IXCYQUAA records will be returned.
A level-1 IXCYQUAA record is identified by the final “1”
in its mapping name. For example, QUACF1, QUASTR1, and QUASTRCF1
are some of the level-1 mapping macros available. To request a level-1
IXCYQUAA record, use version 2 of the IXCQUERY macro by coding QUAALEVEL=1.
To Code: Specify the RS-type name or address (using
a register from 2 to 12) of the one-byte area containing the level
of the IXCYQUAA record mappings.
- ,REQINFO=GROUP
- ,REQINFO=SYSPLEX
- ,REQINFO=CF
- ,REQINFO=CF_ALLDATA
- ,REQINFO=STR
- ,REQINFO=STR_ALLDATA
- ,REQINFO=COUPLE
- ,REQINFO=FEATURES
- ,REQINFO=ARMSTATUS
- ,REQINFO=ARMS_ALLDATA
- ,REQINFO=SERVERS
- Use this input parameter to specify the type of information that
is requested:
- GROUP
- Specifies that IXCQUERY is to return data about all groups, a
specific group, or a single member of a specific group.
- When requesting information about all groups (IXCQUERY REQINFO=GROUP),
the data returned includes a header record, mapped by QUAHDR, followed
by one record for each group, mapped by QUAGRP.
- When requesting information about all members of
a specified group (IXCQUERY REQINFO=GROUP, GRPNAME=group_name, the
data returned includes a header record, mapped by QUAHDR, followed
by one record for each member of the specified group, mapped by QUAMEM,
QUAMEM1, or QUAMEM2.
- When requesting information about a specific member of a group
(IXCQUERY REQINFO=GROUP, GRPNAME=group_name, MEMNAME=member_name or
IXCQUERY REQINFO=GROUP, MEMTOKEN=member_token), the data returned
includes a header record, mapped by QUAHDR, followed by a record for
the specified member, mapped by QUAMEM, QUAMEM1, or QUAMEM2.
The data includes a header and one record for each group requested
mapped by QUAHDR, QUAGRP, and QUAMEM, QUAMEM1, or QUAMEM2.
- SYSPLEX
- Specifies that IXCQUERY is to return data about all systems in
the sysplex. The data includes a header record, mapped by QUAHDR,
and one record for each system in the sysplex, mapped by QUASYS (QUASYS1
when QUAALEVEL=1). The record includes the system name, effective
operator notification interval, effective failure detection interval,
and system status. See z/OS® MVS
Setting Up a Sysplex for more information about effective operator
notification interval and effective failure detection interval.
- CF
- Specifies that IXCQUERY is to return general information about
all coupling facilities or detailed information about a named coupling
facility. General information includes one header record, mapped by
QUAHDR, and one record for each coupling facility defined in the CFRM
active policy, mapped by QUACF (QUACF1 when QUAALEVEL=1). The information
includes the name and ID of the coupling facility, the size of the
dump space, the number of systems connected, the number of structures
in the coupling facility that cannot be added to the policy, and the
name and node descriptor of the coupling facility (as mapped by IXLYNDE).
Detailed
information includes one header record, mapped by QUAHDR, and information
mapped by QUACFSC, QUACF, QUACFSTR, (QUACFSC1, QUACF1, and QUACFSTR1
when QUAALEVEL=1). The detailed information includes names of the
systems connected to the coupling facility and names of structures
and their allocation status.
- CF_ALLDATA
- Specifies that IXCQUERY is to return detailed information about
all coupling facilities defined in the active CFRM policy. The answer
area will contain the QUAHDR, the QUACF, and the QUACFSC and QUACFSTR
for each coupling facility. When QUAALEVEL=1, the answer area includes
QUAHDR, QUACF1, QUACFSC1, and QUACFSTR1 for each coupling facility.
- STR
- Specifies that IXCQUERY is to return general information about
all coupling facility structures in the CFRM active policy or detailed
information about a named coupling facility structure. General information
includes a header record, mapped by QUAHDR, and one record for each
coupling facility structure in the CFRM active policy, mapped by QUASTR
(QUASTR1 when QUAALEVEL=1). The information includes the name of the
coupling facility structure, the size, indicators as to the state
of the coupling facility structure, the number of associated preference
list records, the number of associated exclusion list records, the
number of allocated structures with this name, and the number of connectors
to the structure.
Detailed information includes a header record,
mapped by QUAHDR, and information mapped by QUASTR, QUASTRPL, QUASTRXL,
QUASTRCF, QUASTRUSER, and QUASTRSYS, (QUASTR1, QUASTRPL1, QUASTRXL1,
QUASTRCF1, QUASTRUSER1, and QUASTRSYS when QUAALEVEL=1). The information
includes names of the coupling facilities in the structure's preference
list, names of the structures in the structure's exclusion list, names
of the coupling facilities where the structure is allocated, and detailed
information about each connector to the specified structure.
- STR_ALLDATA
- Specifies that IXCQUERY is to return detailed information about
all coupling facility structures in the CFRM active policy. The answer
area will contain the QUAHDR, the QUASTR, and the QUASTRPL, QUASTRXL,
QUASTRCF, QUASTRUSER, and QUASTRSYS for each structure. When QUAALEVEL=1,
the answer area includes QUAHDR, QUASTR1, QUASTRPL1, QUASTRXL1, QUASTRCF1,
QUASTRUSER1, and QUASTRSYS for each structure.
- COUPLE
- Specifies that IXCQUERY is to return information about the sysplex.
The scope of the information depends on the other parameters specified.
IXCQUERY with REQINFO=COUPLE:
- Generates an inline expansion
- Does not require a control parameter list
- Does not produce a return code,
- Does not preserve registers 0, 1, 14, or 15 across the expansion.
Note: You cannot code REQINFO=COUPLE on the execute form of IXCQUERY.
- FEATURES
- Specifies that IXCQUERY is to return information about the XCF
and XES software features installed on the system from which the request
is made. The system returns a bit string mapped by QUREQFEATURES in
IXCYQUAA.
IXCQUERY with REQINFO=FEATURES: - Generates an inline expansion
- Does not require a control parameter list
- Does not produce a return code,
- Does not preserve registers 0, 1, 14, or 15 across the expansion.
Note: You cannot code REQINFO=FEATURES on the execute form
of IXCQUERY.
- ARMSTATUS
- Specifies that IXCQUERY is to return information about elements
that are registered with the automatic restart manager. The scope
of the information depends on the other parameters specified.
The
information returned is mapped by the IXCYQUAA macro in the QUAARMS
section. This information includes the name of the element, the status
of the element, and the number of times the element has been restarted.
- ARMS_ALLDATA
- Specifies that IXCQUERY is to return information about all elements
that are registered with the automatic restart manager.
The information
returned is mapped by the IXCYQUAA macro in the QUAARMS section. This
information includes the name of the elements, the status of the elements,
and the number of times the elements have been restarted.
For more information about the REQINFO option,
see z/OS MVS Programming: Sysplex Services Guide.
- ,REQTYPE=DEFER
- ,REQTYPE=IMMEDIATE
- Use this input parameter to indicate whether you want the most
current group and member data.
- DEFER
- This indicates that you are requesting the most current group
and member data. The system suspends your work unit while the data
requested is serialized and accessed.
- IMMEDIATE
- This indicates that you are requesting the in-storage version
of the group and member data. The system does not suspend your work
unit while the data requested is accessed.
- ,RESTARTGRP=restartgrp
- Use this input parameter to specify the name of the restart group
for which data is to be returned. The restart group name must be
16 characters long, padded on the right with blanks. Data on all
elements in the group will be returned.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a 16-byte
field that contains the name of the restart group.
- ,RETCODE=retcode
- Use this output parameter to specify the location in which the
system is to copy the return code from GPR 15.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
field to contain the return code.
- ,RSNCODE=rsncode
- Use this output parameter to specify the location in which the
system is to copy the reason code from GPR 0.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
field to contain the reason code.
- ,SERVERNAME=NO_SERVERNAME
- ,SERVERNAME=servername
- Use this input parameter to specify the name of one or more servers
for which information is to be returned. A given server name matches
the server name pattern indicated by the SERVERNAME keyword if the
nonzero sections of the pattern are identical to the corresponding
sections of the server name. If you do not sepcify the SERVERNAME
keyword, information about servers with any name is returned.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of a 32-byte area containing the server name pattern. The
server name pattern indicated by the SERVERNAME keyword must be a
valid server name, except that 8-byte sections 2, 3, and 4 (in any
combination) can contain hexadecimal zero instead of a name. For
a description of server naming conventions, see IXCSRVR — Define a Server to XCF.
- ,STRNAME=NO_STRNAME
- ,STRNAME=strname
- Use this input parameter to specify the name of the coupling facility
structure for which query data is to be returned. The name must be
16 characters long, padded on the right with blanks if necessary;
the valid characters are A-Z, 0-9, $, @, #, and underscore (_). The
name must begin with an uppercase alphabetic character. IBM® structure names begin with SYS or the letters
A-I.
STRNAME is an optional parameter. If STRNAME is not specified,
or if STRNAME=NO_STRNAME is specified, then general information about
all coupling facility structures in the CFRM active policy is returned.
If
a specific STRNAME is requested, then detailed information about that
coupling facility structure is returned if the specified structure
is defined in the CFRM active policy.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a 16-character
input area to contain the structure name.
- ,SYSNAME=sysname
- Use this input parameter to specify the name of the system for
which data is to be returned. Information about elements currently
running on the specified system and elements that originally
registered on the specified system will be returned.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of an
8-byte field that contains the system name.
- ,SYSNAME=sysname
- Use this input parameter to limit the returned information to
servers residing on the named system. If the SYSNAME keyword is not
specified, information about servers on all systems is returned.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of an 8-byte area containing the system name.
- ,SYSPLEXID=sysplexid
- Use this output parameter to specify a storage area to contain
the sysplex identifier. When control returns from IXCQUERY processing,
this area contains the unique sysplex identifier, or token, that identifies
the particular sysplex. The token is established when a sysplex is
initialized and exists as long as the sysplex exists. (A sysplex is
initialized when the first system IPLs into the sysplex.)
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of a 64-bit output area to contain the sysplex identifier.
- ,SYSTEMID=systemid
- Use this output parameter to specify a storage area to contain
the XCF system identifier of the system on which the IXCQUERY was
invoked. When control returns from IXCQUERY processing, the high
order byte contains the XCF system slot number (an index into a table
of systems in the sysplex). The low order three bytes contain the
XCF system sequence number used to identify a unique instantiation
of the system in the sysplex.
To Code: Specify the RS-type
name or address (using a register from 2 to 12) of a 32-bit output
area to contain the system identifier.
|
z/OS MVS Programming: Sysplex Services Reference
Copyright IBM Corporation 1990, 2014