INQUIRE TSMODEL

Retrieve information about a temporary storage model.

Syntax

Warning: System commands are powerful as they provide information about the state of the system and allow changes to be made to it. System commands should be used only by authorized applications and users.

Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).

INQUIRE TSMODEL

Conditions: END, ILLOGIC, NOTAUTH, NOTFND

NOHANDLE, RESP, and RESP2 are common options that can be added to all EXEC CICS commands to process error conditions. They are not explicitly included in the command syntax diagram and option descriptions. For information about these common options and EXEC CICS command syntax, see EXEC CICS command format and programming considerations. For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

This command is threadsafe.

Description

The INQUIRE TSMODEL command returns information about a particular TS model.

Browsing

You can also browse the temporary storage models in your system by using the browse options (START, NEXT, and END) on INQUIRE TSMODEL commands.

See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

The resource signature

You can use this command to retrieve the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Identifying changes to resources (resource signatures). See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Options

CHANGEAGENT(cvda)

Returns a CVDA value that identifies the agent that made the last change to the resource definition. The possible values are as follows:

CREATESPI: The resource definition was last changed by an EXEC CICS CREATE command.
CSDAPI: The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.
CSDBATCH: The resource definition was last changed by a DFHCSDUP job.
DREPAPI: The resource definition was last changed by a CICSPlex® SM BAS API command.
OVERRIDE: The resource definition was last changed by application of an override rule in the resource overrides file.

CHANGEAGREL(data-area)

Returns a 4-digit number of the CICS® release that was running when the resource definition was last changed: for example, 0760 is the identifier for CICS TS for z/OS®, beta.

CHANGETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.

CHANGEUSRID(data-area)

Returns the 8-character user ID that ran the change agent.

DEFINESOURCE(data-area)

Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.

DEFINETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was created.

EXPIRYINT(data-area)

Returns a fullword binary field giving the expiry interval, in hours, for temporary storage queues matching this model. The value returned is derived from the EXPIRYINTMIN value rounded up to the next hour, or if minutes are not specified from any EXPIRYINT value defined in the model from a previous release. If a temporary storage queue is not referenced during its expiry interval, it becomes eligible to be deleted automatically by CICS. A value of zero means that no expiry interval applies to queues matching this model, so they are never eligible for automatic deletion. CICS does not apply an expiry interval to recoverable, remote or temporary storage queues created by CICS. Starting with CICS TS 5.3, the expiry interval now also applies to shared temporary storage queues.

EXPIRYINTMIN(data-area)

Returns a fullword binary field giving the expiry interval, in minutes, for temporary storage queues matching this model. CICS uses the value rounded up to the nearest multiple of 10 minutes. If a temporary storage queue is not referenced during its expiry interval, it becomes eligible to be deleted automatically by CICS. A value of zero means that no expiry interval applies to queues matching this model, so they are never eligible for automatic deletion. CICS does not apply an expiry interval to recoverable, remote, or temporary storage queues created by CICS. Starting with CICS TS 5.3, the expiry interval now also applies to shared temporary storage queues.

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. The possible values are as follows:

CREATESPI: The resource was installed by an EXEC CICS CREATE command.
CSDAPI: The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.
GRPLIST: The resource was installed by GRPLIST INSTALL.

INSTALLTIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource was installed.

INSTALLUSRID(data-area)

Returns the 8-character user ID that installed the resource.

LOCATION(cvda)

Returns a CVDA value indicating where queues matching the model are to be stored. CVDA values are as follows:

AUXILIARY: Queues matching this model are to be held on auxiliary storage.
MAIN: Queues matching this model are to be held in main storage.

POOLNAME(data-area)

Returns an 8-character shared pool name.

PREFIX(data-area)

Returns a 16 byte character string or a 32 byte hexadecimal string with the value of the prefix for this model.

RECOVSTATUS(cvda)

Returns a CVDA value indicating the recovery status for this model. CVDA values are as follows:

RECOVERABLE: Queue names matching this model are recoverable.
NOTRECOVABLE: Queue names matching this model are not recoverable.

REMOTEPREFIX(data-area)

Returns the 16 byte character string or 32 byte hex string to be used as the name prefix on the remote system.

REMOTESYSTEM(data-area)

Returns the 4-character name of the remote system on which the queues matching this model is defined.

SECURITYST(cvda)

Returns a CVDA value indicating the security status for this model. CVDA values are as follows:

SECURITY: Security checking is performed for queue names matching this model.
NOSECURITY: Security checking is not performed for queue names matching this model.

TSMODEL(data-value)

Specifies the 8-character name of a temporary storage model about which you are inquiring.

Conditions

END

RESP2 values:

2: There are no more resource definitions of this type.

ILLOGIC

RESP2 values:

1: You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.

NOTAUTH

RESP2 values:

100: The user associated with the issuing task is not authorized to use this command.

NOTFND

RESP2 values:

1: The TSMODEL does not exist.