Retrieve Service Attributes (QESRSRVA) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Number of service attribute keys | Input | Binary(4) |
| 4 | Service attribute keys | Input | Array(*) of Binary(4) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Service Attributes (QESRSRVA) API copies specified service attributes into the receiver variable.
Authorities and Locks
None.
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
-
The variable in which this API returns the data. See Receiver Variable Format.
- Length of receiver variable
- INPUT; BINARY(4)
-
The length of the receiver variable. The length of the receiver variable is 16 times the number of service attributes to be retrieved, plus the length of each service attribute retrieved, plus 4.
As an example, the size of the receiver variable needed to retrieve the automatic problem analysis and automatic problem reporting attributes is (16 * 2) + 1 + 1 + 4.
Note: If this value is larger than the actual size of the receiver variable, the results may not be predictable.
- Number of service attribute keys
- INPUT; BINARY(4)
-
The total number of service attributes to retrieve.
- Service attribute keys
- INPUT: ARRAY(*) of BINARY(4)
-
A list of keys that identify which service attributes to retrieve. The keys and their associated service attributes are:
Key Service attribute 1 Automatic problem analysis 2 Automatic problem reporting 3 Service provider to report problem 4 PTF install type 5 Critical message recipients 6 Send data packets 7 Copy PTFs 8 PTF group levels 9 ECS message queue 10 System-disabled reporting connection number 11 System-disabled call-back connection number 12 Service provider connection number 
13Order PTFs automatically 14Order PTF groups
- Error code
- I/O; CHAR(*)
-
The structure in which to return error information. For the format of the structure, see Error code parameter.
Receiver Variable Format
The format of the receiver variable follows.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of service attributes retrieved |
| 4 | 4 | ARRAY(*) of BINARY(4) | Offsets to service attribute templates |
| * | * | CHAR(*) | Service attribute templates |
Field Descriptions
Number of service attributes retrieved.The number of service attributes the API put into the receiver variable. This number will be less than the number requested if the receiver variable is too small.
Offsets to service attribute templates. A list of values. Each value is an offset from the beginning of the receiver variable to a service attribute template.
Service attribute templates. The templates of the requested service attributes. There is one template for each service attribute retrieved. The formats of the templates are shown in Service Attribute Template Format.
Service Attribute Template Format
The format of a service attribute template follows.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Service attribute key |
| 4 | 4 | CHAR(1) | Data type of service attribute |
| 5 | 5 | CHAR(1) | Status of service attribute |
| 6 | 6 | CHAR(2) | Reserved |
| 8 | 8 | BINARY(4) | Length of service attribute |
| 12 | C | CHAR(*) | Service attribute |
Field Descriptions
Data type of service attribute. The type of data returned.
| 0 | The service attribute was not available. |
| 1 | The service attribute is returned in character format. |
| 2 | The service attribute is returned in binary format. |
Length of service attribute. The length of the service attribute. If the service attribute was not available, this value is 0.
Reserved. This field will contain null characters.
Service attribute. The requested service attribute. See Service Attributes Format for the formats of the service attributes.
Service attribute key. A value that identifies the service attribute that was retrieved.
Status of service attribute. Whether the service attribute was available for retrieval.
| 0 | The service attribute was available. |
| 1 | The service attribute was locked. |
Service Attributes Format
The Service Attributes Format has the following self-explanatory keys:
- Key 1--Automatic Problem Analysis
- Key 2--Automatic Problem Reporting
- Key 3--Service Provider to Report Problem
- Key 4--PTF Install Type
- Key 5--Critical Message Recipients
- Key 6--Send Data Packets
- Key 7--Copy PTFs
- Key 8--PTF group levels
- Key 9--ECS message queue
- Key 10--System-Disabled Reporting Connection Number
- Key 11--System-Disabled Call-Back Connection Number
- Key 12--Service Provider Connection Number
- Key 13--Order PTFs automatically
- Key 14--Order PTF groups
Key 1--Automatic Problem Analysis
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Attribute |
Field Descriptions
Attribute. The problem analysis attribute specifies when to analyze problems.
| 0 | Problems will not be analyzed when they are logged. Instead, the operator must analyze the problem from the QSYSOPR message queue or from the Work with Problems (WRKPRB) command. |
| 1 | The system will analyze the problem as soon as the problem is logged. |
Key 2--Automatic Problem Reporting
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Attribute |
Field Descriptions
Attribute. The problem reporting attribute specifies when to report problems.
| 0 | Problems will not be reported when they are logged. Instead, the operator must report the problem from the QSYSOPR message queue or from the Work with Problems (WRKPRB) command. |
| 1 | If the problem analysis attribute specifies that problems are to be analyzed as soon as the problem is logged, the system will report the problem to the service provider specified in the Service provider to report problem attribute as soon as the problem is analyzed. |
Key 3--Service Provider to Report Problem
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Name format |
| 1 | 1 | CHAR(17) | Service provider name |
Field Descriptions
Name format. This is an 'A' to show that the name is an SNA node name.
Service provider name. This identifies the service provider to report problems to if the automatic problem reporting' attribute specifies that problems are to be reported as soon as a problem is analyzed. If this field contains *IBMSRV, problems will be sent to IBM. Otherwise, the first eight characters of this field contain the control point name of the service provider. The next nine characters contain either the network identifier of the service provider, or *LCLNETID if the network identifier of the service provider is the same as that of the system that is reporting the problem.
Key 4--PTF Install Type
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Type of PTF install |
Field Descriptions
Type of PTF install. This service attribute determines whether the immediate PTFs are applied immediately or delayed.
| *DLYIPL | All PTFs will be marked for delayed apply and the system will be IPLed. |
| *DLYALL | All PTFs will be marked for delayed apply and the system will not be IPLed. |
| *IMMONLY | The immediate PTFs will be applied and the delayed PTFs marked for apply at the next IPL. |
| *IMMDLY | Only the immediate PTFs will be applied and the system will not be IPLed. |
Key 5--Critical Message Recipients
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of entries |
| 4 | 4 | ARRAY(50) of CHAR(10) | User list |
Field Descriptions
Number of entries. This is the number of entries in the user list.
User list. This is an ordered list of user identifiers and user classes. If the system detects a critical condition such as a disk failure, and the first entry in this list is a user identifier, and that user is signed on, the system will send a break message to that user. If the first entry is a user class, the system will try to send a break message to all the users in that class that are signed on.
If the specified user is not signed on, or none of the users in the user class are signed on, the system tries to send the break message to the user identifier or user class in the second entry of this list.
The system keeps trying to find a user that is signed on until it reaches the end of the list.
This function is only used if problem analysis routines are run automatically at the time of failure (the ANZPRBAUTO service attribute is *YES).
| *SYSOPR | All users of user class *SYSOPR will receive a message when a critical message is sent. |
| *SECOFR | All users of user class *SECOFR will receive a message when a critical message is sent. |
| *SECADM | All users of user class *SECADM will receive a message when a critical message is sent. |
| *PGMR | All users of user class *PGMR will receive a message when a critical message is sent. |
| *USER | All users of user class *USER will receive a message when a critical message is sent. |
Key 6--Send Data Packets
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Attribute |
Field Descriptions
Attribute. The Send data packets attribute specifies whether or not to send problem data to the service provider.
| 0 | Data will not be sent to the service provider. |
| 1 | Up to 2000 bytes of data will be sent to the service provider. |
Key 7--Copy PTFs
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Attribute |
Field Descriptions
Attribute. The Copy PTFs attribute specifies whether or not to copy PTF save files and cover letters into *SERVICE when PTFs are loaded from a tape or optical device. PTF save files must be in *SERVICE when distributing PTFs to other systems or when using the Save System Information (SAVSYSINF) command.
| 0 | PTF save files and cover letters are not copied into *SERVICE when PTFs are loaded from tape or optical. |
| 1 | PTF save files and cover letters that do not already exist are copied into *SERVICE when PTFs are loaded from tape or optical. |
Key 8--PTF group levels
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Attribute |
Field Descriptions
Attribute. The PTF group levels attribute specifies the maximum number of levels of a PTF group to keep on the system. The following special value can be returned:
| -1 | Specifies that all levels should be kept on the system. |
Key 9--ECS message queue
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | ECS message queue |
| 10 | A | CHAR(10) | Library |
Field Descriptions
ECS message queue. The message queue name where electronic customer support (ECS) will be sending the message when resuming PTF orders.
Library. The library where the message queue is located.
Key 10--System-Disabled Reporting Connection Number
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(30) | System-disabled reporting connection number |
Field Descriptions
System-disabled reporting connection number. The complete electronic connection number used for automatic reporting to external support when this system is disabled. This number should include the entire sequence of numbers required to complete the call, including international access codes, country or region codes, area codes, exchanges, and so on, as appropriate.
Key 11--System-Disabled Call-Back Connection Number
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(30) | System-disabled call-back connection number |
Field Descriptions
System-disabled call-back connection number. The complete electronic connection number used to call back this system from external support when this system is disabled. This number should include the entire sequence of numbers required to complete the call, including international access codes, country or region codes, area codes, exchanges, and so on, as appropriate.
Key 12--Service Provider Connection Number
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(30) | Service provider connection number |
Field Descriptions
Service provider connection number. The complete electronic connection number to the service provider. This number should include the entire sequence of numbers required to complete the call, including international access codes, country or region codes, area codes, exchanges, and so on, as appropriate.
Key 13--Order PTFs automatically
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Attribute |
Field Descriptions
Attribute. The Order PTFs automatically attribute specifies if PTF groups should be ordered automatically.
| 0 | PTF groups are not ordered automatically. |
| 1 | The QORDPTFGRP job is scheduled to order PTF
groups once a month. The frequency, scheduled day, and scheduled
time of job QORDPTFGRP can be changed with the Change Job Schedule
Entry (CHGJOBSCDE) command. The Send PTF Order (SNDPTFORD) command
is used to order the latest level of the PTF groups when the scheduled
job is run. The PTF groups will be downloaded as save files and
the list of PTF groups to order will be retrieved from the
Order PTF groups service attribute.
Note: PTF groups can only be ordered automatically if the universal connection is configured. Use the Send Service Request (SNDSRVRQS) command specifying ACTION(*TEST) to verify the communications link to the remote service support system. |
Key 14--Order PTF groups
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of entries |
| 4 | 4 | ARRAY(20) of CHAR(10) | PTF group list |
Field Descriptions
Number of entries. This is the number of entries in the PTF group list.
PTF group list. This is a list of PTF groups to order when the Order PTFs automatically attribute is set to automatically order PTF groups.
| PTF group name | The name of an IBM PTF group. The latest level of the specified PTF group will be automatically ordered. |
| *CUMPKG | Order the latest level of the Cumulative PTF package group (SF99vrm) for the operating system release that is installed on the system. The HIPER and DB2 for IBM i PTF groups are automatically included in the order when the Cumulative PTF package group is specified. |
| *ALLGRP | Order the latest level of all PTF groups for the installed operating system release, except the Cumulative PTF package group. This special value is not allowed with any PTF group except the Cumulative PTF package group (*CUMPKG or SF99vrm). |
| *HIPERGRP | Order the latest level of the HIPER PTF group for the operating system release that is installed on the system. |
| *DB2GRP | Order the latest level of the DB2 for IBM i PTF group for the operating system release that is installed on the system. |
| *BRSGRP | Order the latest level of the Backup Recovery Solutions PTF group for the operating system release that is installed on the system. |
| *HTTPGRP | Order the latest level of the IBM HTTP Server for i PTF group for the operating system release that is installed on the system. |
| *JVAGRP | Order the latest level of the Java PTF group for the operating system release that is installed on the system. |
| *PFRGRP | Order the latest level of the Performance Tools PTF group for the operating system release that is installed on the system. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF8C50 E | Key in input list not valid. |
| CPF8C51 E | Error with receiver variable length. |
| CPF8C52 E | Number of values in input list not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R1
[ Back to top | Problem Management APIs | APIs by category ]