INQUIRE BUNDLE

Description

Use the INQUIRE BUNDLE command to retrieve information about an installed BUNDLE resource. The contents of a BUNDLE resource are defined in a manifest that can contain imports, exports, modifiers, and definitions. The definitions section of the manifest describes the resources that CICS® dynamically creates for you when you install the BUNDLE resource. Use this command to find out the location of the bundle on z/OS® UNIX, the number of imports, exports, modifiers, and definitions that are listed in the manifest, and how many of those definitions are currently enabled in the CICS region.

For more detailed information about each of the resources that are contained in an installed BUNDLE resource, use the INQUIRE BUNDLEPART command to browse the resources.

Browsing

You can browse through all the BUNDLE resources that are installed in your region by using the browse options, START, NEXT, and END, on INQUIRE BUNDLE 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 Auditing resources. The resource signature fields are BUNDLE, CHANGEAGENT, CHANGEAGREL, CHANGETIME, CHANGEUSRID, DEFINESOURCE, DEFINETIME, INSTALLAGENT, INSTALLTIME, and INSTALLUSRID. See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Options

AVAILSTATUS(cvda)

Returns the status of the BUNDLE resource that represents the CICS bundle:

AVAILABLE

Callers can access all the resources identified in the CICS bundle as application entry points.

UNAVAILABLE

Callers cannot access any of the resources identified in the CICS bundle as application entry points.

SOMEAVAIL

Some application entry points are available and some are unavailable.

NONE

The bundle does not contain any statements of application entry points.

BASESCOPE(data-area)

Returns the 1 - 255 character string that defines the root namespace for the contents of the bundle.

If the bundle was installed for a platform, this attribute returns a URI that describes the platform and application in which the bundle is deployed. The URI has the following format:

cicsapplication://Platform/ApplicationID/MajorVersion/MinorVersion/MicroVersion

Platform is the name of the platform in which the application is running, ApplicationID is the ID of the application bundle, followed by the version of the application.

BUNDLE(data-value)

Specifies the name of the BUNDLE resource about which you are inquiring. The name can be up to 8 characters in length.

BUNDLEDIR(data-area)

Returns the 1 - 255 character fully qualified name of the root directory for the bundle on z/OS UNIX.

BUNDLEID(data-value)

Returns the 1 - 64 character ID of the bundle. If no ID is specified, this option returns blanks.

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.

CHANGEAGREL(data-area)

Returns a 4-digit number of the CICS release that was running when the resource definition was last changed.

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.

ENABLEDCOUNT(data-area)

Returns the current number of resources and entry points that were dynamically created by the bundle and are enabled in the CICS region.

ENABLESTATUS(cvda)

Returns the status of the BUNDLE resource. The possible values are as follows:

ENABLING

The bundle is being initialized. It is creating and enabling the resources that are defined in the bundle manifest file.

ENABLED

The bundle is ready for use.

DISABLING

The bundle is quiescing before entering DISABLED state. The bundle disables any resources that it enabled.

DISABLED

The bundle is not available.

DISCARDING

A DISCARD command was issued for the bundle. The bundle is quiescing before being discarded. The bundle discards any resources that it disabled.

INSTALLAGENT(cvda)

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

CLOUD

The resource was installed by an application or platform deployment.

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.

MAJORVERSION(data-area)

Returns the major version number of the bundle. If no major version is specified, this option returns 0.

MGMTPART(data-value)

Returns the 8 - byte ID of the management part under which this bundle was installed for an application or platform. If the bundle was not installed for an application or platform, this option returns binary zeros.

MICROVERSION(data-area)

Returns the micro version number of the bundle. If no micro version is specified, this option returns 0.

MINORVERSION(data-area)

Returns the minor version number of the bundle. If no minor version is specified, this option returns 0.

PARTCOUNT(data-area)

Returns the total number of imports, exports, modifiers, and definition statements that are defined in the bundle manifest.

TARGETCOUNT(data-area)

Returns the total number of dynamically created resources, entry points, and policy scopes in the bundle. CICS automatically enables the BUNDLE resource when all of the dynamically created resources are in an enabled state.

Conditions

END

RESP2 values:

2

There are no more resource definitions of this type.

ILLOGIC

RESP2 values:

1

A START command was issued when a browse of BUNDLE resources is already in progress, or a NEXT or an END command was issued when a browse of BUNDLE resources is not in progress.

INVREQ

RESP2 values:

7

CICS failed to link to the registered bundle callback program.

NOTAUTH

RESP2 values:

100

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

101

The user associated with the issuing task is not authorized to access this particular resource in the way required by this command.

NOTFND

RESP2 values:

3

The BUNDLE cannot be found.