com an dos

179
CICS Administration Reference Resource definition commands and offline utilities About the CICS commands cicscheckup - Check CICS for Windows installation and configuration (On Windows (R) only) cicsadd - Add CICS resource definitions cicscleandce - Remove DCE groups and CDS directories cicscopystanza command cicscp - CICS control program cicscp - all options cicscp - COBOL commands (On Open Systems only) cicscp - DCE commands cicscp - PPC Gateway server commands (On Open Systems only) cicscp - region commands cicscp - SFS commands cicscp - SNA commands cicscp - telnet server commands cicscvt - Create data conversion table cicsdb2conf - Configure DB2 cicsdb2import - Build metadata for DB2 cicsddt - DB2 diagnostic tool cicsdefault - Create a copy of the default region cicsdefaultservers - Create default resource files for servers Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to... 1 de 179 03/03/12 14:46

Upload: rogelio-buendia

Post on 14-Oct-2014

144 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Com an Dos

CICS Administration Reference

Resource definition commands andoffline utilities

About the CICS commands

cicscheckup - Check CICS for Windows installation and configuration (On

Windows(R) only)

cicsadd - Add CICS resource definitions

cicscleandce - Remove DCE groups and CDS directories

cicscopystanza command

cicscp - CICS control program

cicscp - all options

cicscp - COBOL commands (On Open Systems only)

cicscp - DCE commands

cicscp - PPC Gateway server commands (On Open Systems only)

cicscp - region commands

cicscp - SFS commands

cicscp - SNA commands

cicscp - telnet server commands

cicscvt - Create data conversion table

cicsdb2conf - Configure DB2

cicsdb2import - Build metadata for DB2

cicsddt - DB2 diagnostic tool

cicsdefault - Create a copy of the default region

cicsdefaultservers - Create default resource files for servers

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

1 de 179 03/03/12 14:46

Page 2: Com an Dos

cicsdelete - Delete CICS resource definitions

cicsdestroy - Destroy a CICS region

cicsdfmt - Dump formatter

cicsexport - Export CICS resource definitions

cicsget - Get CICS resource definition information

cicsgetbindingstring - Get binding string for region or Encina server

cicsgpid - Get region process identifier

cicshpterm - 3270 terminal emulator (On Open Systems only)

cicsimport - Import CICS resource definitions

cicsinstall - Install CICS resource definitions

cicsivp - Set up resource definitions for installation verification

cicslssrc - Check subsystem status (On Open Systems only)

cicslterm - Invoke the local CICS client 3270 terminal emulator(On Windowsonly)

cicsmakelv - Create a logical volume(On Windows only)

cicsmfmt - Monitoring data formatter

cicsmigrate - Create migration script (On Open Systems only)

cicsmigrateclass - Add and delete resource attributes (On Open Systems only)

cicsmigrateclients - Reconfigure DCE (On Open Systems only)

cicsmkcobol - Create the cicsprCOBOL file (On Open Systems only)

cicsnotify - Deallocate resources (On Open Systems only)

cicsoraconf - Configure Oracle

cicsoraimport - Build metadata for Oracle

cicsodt - Oracle diagnostic tool

cicsppcgwy - Start a PPC Gateway server (On Open Systems only)

cicsppcgwycreate - Create a PPC Gateway server server (On Open Systemsonly)

cicsppcgwydestroy - Destroy a PPC Gateway server (On Open Systems only)

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

2 de 179 03/03/12 14:46

Page 3: Com an Dos

cicsppcgwylock - Lock or unlock a PPC Gateway server (On Open Systemsonly)

cicsppcgwyshut - Shut down a PPC Gateway server (On Open Systems only)

cicsremovelv - Remove a logical volume (On Windows only)

cicsrlck - Remove old region lock files

cicssdt - SFS diagnostic tool

cicssetupclients - Configure DCE for the CICS clients

cicssetupdce - Create directories and groups within a DCE cell

cicssfmt - Statistics formatter

cicssfs - Start a CICS SFS

cicssfsconf - Configure a CICS SFS

cicssfscreate - Create a CICS SFS

cicssfsdestroy - Destroy a CICS SFS

cicssfsimport - Build an SFS's metadata

cicssfslock - Release an SFS lock file

cicssfsshut - Shut Down a CICS SFS

cicsstart - Start a CICS region

cicsstop - Stop a CICS region

cicstail - Display the end of a file

cicstcpnetname - Display NETNAME for CICS family TCP/IP connection

cicsteld - Connect telnet clients to regions

cicsterm - Invoke the CICS 3270 terminal emulator (On Open Systems only)

cicstermp - Printer emulation (On Open Systems only)

cicstfmt - Trace formatter

cicstracefilter - Trace filter

cicsupdate - Modify CICS resource definitions

cicsupdateclass command

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

3 de 179 03/03/12 14:46

Page 4: Com an Dos

cicsusedceservers - Migrate CICS regions and Encina servers to use DCE

About the CICS commands

CICS commands can be used to configure and control your CICS system. ForWindows, they are also used indirectly by the Administration Tool graphical userinterface.

Several commands have prerequisite tasks or conditions that must be met beforeyou can use the command. Some commands require a userid of cics or require thatyou are logged on as a user with root (For Open Systems) or administrator (forWindows) privileges.

CICS on Open Systems only

A user with root privileges is any userid that has system as the primary group. Thisuserid needs to be a member of every group that root is in. (Processes can runwith root privileges if the effective userid of the process is zero.) Even if a useridmay meet the above criteria, but there are some commands that must be run bythe native root userid.

CICS for Windows only

For Windows, a user with administration privileges is any userid that is a memberof the group Administrators.

The following list describes how to use the CICS commands:

PurposeDescribes the purpose of the command.

SyntaxShows the syntax of the command flags and parameters.

Prerequisite Tasks or ConditionsWhere applicable, the command reference information lists tasks or conditionsthat must take place before the command can be used.

DescriptionWhere necessary, provides a detailed description of how the command is used.

OptionsDescribes the purpose of each flag and parameter used with the command.

Returned ValuesWhere applicable, lists each possible value returned and describes the

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

4 de 179 03/03/12 14:46

Page 5: Com an Dos

meaning of it.

ExamplesProvides examples of command usage and describes what the example is usedfor.

cicsadd - Add CICS resource definitions

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to add new CICS resource definitions.

Syntax

cicsadd -c className [-r regionName] [-P | -B] [-f fileName] [-m modelId]resourceName [attributeName=attributeValue ... ]

cicsadd -?

Description

The Resource Definition Online (RDO) command cicsadd adds a resource definitionof a given class to the permanent resources database, and can install a resourcedefinition into the runtime database.

All resource attributes are optional. If you do not set an attribute, its value isobtained from the resource definition defined by the -m parameter or from thedefault resource definition if you do not specify a model. You can use cicsupdate tomodify the default definition.

The cicsadd command initializes the data structures for the resource with defaultvalues from the reserved resource default, before overwriting them with yourspecified values. Stopping the command before completion can result in a damageddatabase. The command returns 0 if the run is successful, 1 otherwise.

Options

-c classNamedetermines the resource class to which the resource definition is to be added,and is one of these two- or three-character codes:

cdCommunication

fdFiles

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

5 de 179 03/03/12 14:46

Page 6: Com an Dos

gdGateways

gsdGateway Servers

jdJournals

ldListeners

odObjects (AIX only)

pdPrograms

scdSFS Schemas

ssdSFS Servers

tdTransactions

tddTransient Data Queues

tsdTemporary Storage Queues

udUsers

wdTerminals

xadProducts

-r regionNamespecifies the region to which the resource definition is added. If you do notspecify a region name, CICS adds the resource definition to the regionspecified by the CICSREGION environment variable.

The -r parameter is invalid if you specify scd, ssd, or gsd as the resourceclass, because these classes are associated with a collection of regions ratherthan with a specific one.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

6 de 179 03/03/12 14:46

Page 7: Com an Dos

-m modelIdspecifies the model used to supply the values for the definition that are notexplicitly given in the attributeName=attributeValue pairs. If you do notspecify a model, values for omitted attributes are obtained from the defaultdefinition. If the named model does not exist, an error is generated.

-f fileNamespecifies the file that contains the schema definitions. This flag is valid onlywhen you specify scd (SFS schema definitions) as the resource class.

-Pinstructs the command to add the resource definition to the permanentdatabase, without installing it into the runtime database. This is the defaultoption if you do not specify either the -P or -B options.

-Binstructs the command to add the resource definition to the permanentdatabase and then to update the runtime database and install the resourcedefinition in a running system.

The -B flag is invalid if you specify gsd, scd, ssd, or xad as the resource class.If you are using DCE authentication, you must be authenticated as a DCEprincipal before running the command with this flag.

resourceNameis the name of the resource definition to be added.

attributeName=attributeValue ...are the names and values of attributes for which you do not wish to use thedefault values or the values from the specified model.

If you are using cicsadd from the command line and you want to use ametacharacter within an attribute value, you must use the shell escapemechanism. For example, to use a value of **, enter one of the following:

"**"\*\*'**'

You must use the pipe (|) character as the separator for multiple entries intoTransaction Security Level (TSL) and Resource Security Level (RSL) key lists.

Note:The term metacharacter refers to the following special characters: dollar($), at sign (@), period (.), slash (/), dash (-), underscore (_), percent (%),ampersand (&), question mark (?), exclamation (!), vertical bar or pipe (|),double quote ("), comma (,), semicolon (;), less than (<), greater than (>),and decimal 170.

The set of attributeName=attributeValue pairs depends on the class of the

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

7 de 179 03/03/12 14:46

Page 8: Com an Dos

resource.

-?causes the usage message to be displayed.

Examples

To add a definition for the file TEST in the region REGION1 in the permanentdatabase only:

cicsadd -c fd -r REGION1 -P TEST ActivateOnStartup=yes

1.

To add a definition for the program PROG1 in the region REGION2 in both thepermanent and runtime databases:

cicsadd -c pd -r REGION2 -B PROG1 PathName= /var/cics_regions/REGION2/bin/prog1 \ ProgType=program ActivateOnStartup=yes

2.

To add a definition for journal 03 to region rb in both the permanent andruntime databases (the command places the journal files in the same place asany extrapartition Transient Data Queues defined by the system):

cicsadd -c jd -r rb -B 03 RSLKey=public DiskA=j03a DiskB=j03b

3.

cicscheckup - Check CICS for Windows installationand configuration

AIX HP-UX Sun Solaris Windows

X

Use this command to check various aspects of CICS for Windows installation andconfiguration.

Syntax

cicscheckup {-o [-v] | -x [-v] | -m [-v] | -r region | -s sfs_server | -l logical_volume | -ttelnet_server} [-o output_file] [-q]

cicscheckup --?

Description

The cicscheckup command lets you check various aspects of the CICS for Windowsnstallation and configuration. It reports on the current configuration of a particularmachine and any CICS regions or SFS servers that have been defined. In addition, itattempts to identify more-general features of the current machine configurationthat can have an impact on the CICS or Encina products that have been installed.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

8 de 179 03/03/12 14:46

Page 9: Com an Dos

Each report generated by the cicscheckup command begins with a header thatshows the command option that was specified, along with the time and date that thecommand was run. Depending on the particular option chosen, the report is thendivided into sections, with each section displaying a particular aspect of themachine's configuration, for example, NT Registry information, file systeminformation, and so on.

Any errors in the machine or region, SFS server, or logical volume configuration arereported with a prefix of "ERROR:". Any situations that are not errors but that canlead to further problems are reported with a prefix of "WARNING:".

The cicscheckup command does not alter the configuration; it only reports what itfinds. The user must repair or investigate any errors or warnings that are reported.

cicscheckup -m

The -m option causes the cicscheckup command to check aspects of the machinethat can affect the operations of CICS. The sections in the report informationinclude the following:

System information -- This section describes the processor or processors inthe machine. It also lists the various memory settings for both physicalmemory and paging memory. If the "Free physical memory available" value islow, it can prevent CICS or SFS from starting correctly. The local HOSTNAMEis also reported. This must match any value set in the CICS_HOSTSenvironment variable.

Software stack level information -- This section shows which software itemsare installed and what levels of software are installed. This section reports onsoftware of different types: operating system, CICS components, databases,and communications servers.

For each product, a key executable file is identified and searched for. If it isfound, its resource segment is queried to report file version and descriptioninformation, as well as the language in which the resources have beenlocalized.

C runtime support DLLs in PATH - This section lists all the C runtimedynamic link libraries (DLLs) matching a file pattern of MSVCRT*.DLL that arefound in the PATH environment variable. The creation date and the size inbytes are shown.

If the -v option is also specified, a more verbose output is produced. Thisoutput lists the version and level information for all DLLs found. In addition,DLLs matching the file specification MFC*.DLL are included in the search. Thiscan produce a large amount of output; the -o option can be used to redirect theoutput to a file.

Machine filesystem information -- This section shows drives on which CICS,Encina, and DCE are installed. For each drive, it lists attributes about that

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

9 de 179 03/03/12 14:46

Page 10: Com an Dos

drive, including the amount of free space.

Machine environment variables -- This section shows the environmentvariables that are used by CICS. After displaying the PATH environmentvariable, the command checks the PATH. If an ERROR: message is displayed,correct the PATH environment variable and reboot the machine beforeattempting to run any part of CICS. Any USER environment variables that canmask a SYSTEM version of the same variable are noted. For instance, if a userhas an INCLUDE variable in the environment, this can prevent the value ofINCLUDE in the system environment from being used, leading to unexpectedproblems.

This section can also identify invalid drives that appear at any point in thePATH. In some cases, invalid drives can cause runtime failures for CICSservices. If an invalid drive occurs before a CICS, DCE, Encina, or DB2directory, an ERROR message is issued.

Machine registry variables -- This section shows the NT Registry data forCICS. This information is intended for service personnel.

DCE status -- This section identifies the current DCE configuration on themachine and also displays the appropriate information for this currentconfiguration. The command also attempts to ensure that the installed DCEversion is compatible with the versions of CICS and Encina that have beendetected on this system.

Members of local cicsgroup group -- This section lists all the NT users whoare part of the cicsgroup NT user group. For SFS user IDs, the home directoryis listed and checked.

cicscheckup -r region

The -r option causes the cicscheckup command to check the specified region. Thefollowing information is reported:

Filesystem data for region -- This section lists information about the regiondirectory on the filesystem. It is used to ensure that it is a valid regiondirectory.

Registry data for region -- This section lists the region attributes found inthe NT Registry. The cicscheckup command verifies that the cics.exeexecutable file listed in the registry exists.

SCM Data for Region -- This section lists NT Service Control Manager (SCM)information. The cicscheckup command verifies that the executable filereferenced by the SCM entry exists.

DCE Data for Region -- This section lists information about DCE. Thecicscheckup command checks the DCE configuration of the specified regionand compares it to the DCE configuration on the machine. Any mismatches are

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

10 de 179 03/03/12 14:46

Page 11: Com an Dos

displayed in this section, preceded by "ERROR:." If the region is configured touse DCE, then the command checks the DCE principal (cics) and verifies thatthe keytab file for the region exists.

Current status for region -- This section summarizes the current state of thespecified region, for example, whether it is defined and whether it is active.

cicscheckup -s sfs_server

The -s option causes the cicscheckup command to check the SFS server. The typesof data reported are the same as those reported when the -r option is specified.

cicscheckup -l logical_volume

The -l option causes the cicscheckup command to check the specified logicalvolume. The following information is reported:

Registry data for logvol -- This section displays the registry data for thespecified logical volume. An error is reported if the entry does not exist. Thecommand checks that the file name found in the registry entry exists.

cicscheckup -t telnet_server

The -l option causes the cicscheckup command to check the specified Telnetserver. The following information is reported:

Registry data for telnet server -- This section lists the command-lineinvocation, as stored in the NT Registry, for the specified Telnet server.

SCM data for telnet server -- This section displays information about theTelnet server as specified to the NT Service Control Manager (SCM). Thecicscheckup checks to see if the specified Telnet server is defined to the SCM.It also verifies that the executable file referenced by the SCM entry does exist.The command also checks to ensure that there is a keytab file in \var\cics_clientto allow the Telnet client to connect to a CICS region. If no keytab file is found,a warning message is displayed.

Current status for telnet server -- This section summarizes the current stateof the specified Telnet server, that is, whether or not it is defined and whetheror not it is active.

cicscheckup -x

The -x option causes the cicscheckup command to check for all C runtime DLLs onthe system. A list of fixed local disks is searched in turn, depth first, to identify allfiles that match the file patterns MSVCRT*.DLL and MFC*.DLL. For each matchingmodule, its creation date and file size in bytes is reported. If the -v option is alsospecified, each matching file is displayed with details from its resource segment,including file version, product version, file description, product name, and thelocale information for the resources.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

11 de 179 03/03/12 14:46

Page 12: Com an Dos

Options

-Aspecifies that the command is to check the entire machine including contentsof the NT Registry and Service Control Manager database, and the NTfilesystem. The results of this option are a superset of the results of the -m and-c options. If the -v option is also specified, the cicscheckup command alsoreports version levels for C runtime DLLs found the command path.

-xspecifies that the command is to locate all C runtime DLLs on all the localdisks. If the -v option is also specified, the cicscheckup command also reportsthe version levels for C runtime DLLs found.

-mspecifies that the command is to check the entire machine configuration. If the-v option is also specified, the cicscheckup command also reports the versionlevels for the C runtime DLLs found in the command path.

-r regionspecifies that the command is to check a specified CICS region.

-s sfs_serverspecifies that the command is to check a specified SFS server.

-l logical_volumespecifies that the command is to check a specified SFS logical volume.

-t telnet_serverspecifies that the command is to check a specified Telnet server.

-o output_filespecifies that the command is to send its output to the specified file. The file isopened in append mode.

-qspecifies that the command outputs only warning and error messages.

-?causes the usage message to be displayed.

cicscleandce - Remove DCE groups and CDSdirectories

AIX HP-UX Sun Solaris Windows

X X X X

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

12 de 179 03/03/12 14:46

Page 13: Com an Dos

cicscleandce removes the DCE groups and CDS directories created by thecicssetupdce command.

Syntax

cicscleandce [-I] [-v]

cicscleandce -?

Description

Unless you are migrating from a DCE cell environment to a non-DCE cellenvironment,you must destroy the regions and SFSs before using thiscommand.You must be logged on as a user with root or administrator privilegesYou must be authenticated as a DCE principal (such as cell_admin) withsufficient privileges to remove a DCE group, directory or object.

cicscleandce deletes the DCE groups and CDS directories listed below. Deletingthe group cics_users automatically removes all accounts in this group. If one ofthese groups or directories does not exist, cicscleandce continues so you can usethis command to clean up a partially successful execution of cicssetupdce. Errors,such as a failure to delete a CDS directory, forces cicscleandce to terminateabnormally unless the -I flag is used.

The following DCE groups are deleted:

cics_admincics_sfscics_ppcgwycics_regionscics_users

The following CDS directories are deleted:

/.:/cics/.:/cics/sfs/.:/cics/ppc/.:/cics/ppc/gateway/.:/cics/trpc/.:/cics/tmxa/.:/cics/profile

Caution:Do not use cicscleandce if you have any servers or regions configured orrunning.

Options

-I

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

13 de 179 03/03/12 14:46

Page 14: Com an Dos

(Uppercase i) Ignores errors. Error messages are changed to warningmessages and cicscleandce continues.

-v(verbose) gives a detailed output while the command runs.

-?displays help about the command.

Examples

To remove all DCE groups and CDS directories despite possible errors, first log inas root or administrator and then authenticate as cell_admin, and then enter:

cicscleandce -I

cicscopystanza command

AIX HP-UX Sun Solaris Windows

X X X X

Copies a complete stanza, or resource definition file, for a given class from oneregion database to another.

Syntax

cicscopystanza [[-w] -s sourceRegion] -t targetRegion -c className -kresourceName

cicscopystanza -?

Description

The cicscopystanza command is used when an upgrade of CICS contains newdefault entries in the region database, for example, a new supplied transaction or anew model terminal. cicscopystanza adds appropriate default entries to the regiondatabase.

The cicscopystanza commands are generated automatically and are included inthe migration shell script which was created when you ran cicsmigrate. You canedit the cicscopystanza commands in the shell script, if, for example, you did notwant to add a specific default entry to your region, or you do not want to add a newterminal.

Options

-s sourceRegion

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

14 de 179 03/03/12 14:46

Page 15: Com an Dos

specifies the name of the region supplying the resource definition file.

-t targetRegionspecifies the name of the region receiving the resource definition file.

-c classNamespecifies the class of the resource definition file to copy.

-k resourceNamespecifies the name of the resource definition file to copy.

-?causes the usage message to be displayed

Examples

To copy a user definition for user1 from region1 to region2:

cicscopystanza -s region1 -t region2 -c ud -k user1

cicscp - CICS control program

AIX HP-UX Sun Solaris Windows

X X X X

Configures and administers COBOL, DCE, PPC Gateway servers, regions, SFS, SNAnodes, > SNA links, and telnet servers.

Syntax

cicscp [-I] [-l logFile] [-v] command objectType [options]

cicscp -?

cicscp

Description

The CICS control program (cicscp) is a configuration tool to configure CICS regionsand associated servers. It provides an easy-to-use command line interface to a CICSconfiguration which supports a range of users from a new user, who will be able toconfigure a default region without any user input other than the region name, andto an experienced user who will be able to override any default value (where thereis a purpose in overriding a default value) and use model definitions to simplify thecreation of similar configurations.

The commands automate as much as possible of the configuration of a machine torun a CICS region using default values where necessary and imposing some naming

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

15 de 179 03/03/12 14:46

Page 16: Com an Dos

conventions. They also provide some flexibility for customization within thisframework, for example allowing the machine to be configured as a DCE clientrather than a server. They support the use of an existing configuration for greaterflexibility, for example, allowing the use of an existing DCE configuration where aconfiguration such as a secondary CDS server is required.

It is not intended that cicscp be the sole interface to the configuration of theunderlying stack; rather that it can automate simple configurations. You should beaware of this and use the other CICS commands to create more complexconfigurations. This extends to the configuration of CICS itself, as cicscp does nothave an update command, so an existing configuration must always be altered bythe other commands. It is expected that you will begin by doing all theconfiguration necessary for CICS through cicscp until you need a sophisticatedcustom configuration.

You must be logged on as a user with root or administrator privileges. Some tasksrequire you to be authenticated to DCE. If you are using DCE authentication,cicscp prompts you for a password if you are running interactively, you have not setthe cell_admin_pw environment variable, and the cell_admin password is not thedefault password (-dce-). If you are not running interactively, have not set thecell_admin_pw environment variable, and the password is not the default, thecommand fails.

Options

-I(uppercase i) ignore errors.

-l logFileproduce a log of activity in logFile.

-v(verbose) Show output of low-level commands used (see note 1).

commandcicscp accepts the following commands:

all

cobol (for Open Systems)

dce

ppcgwy_server (for Open Systems)

region

sfs_server

sna

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

16 de 179 03/03/12 14:46

Page 17: Com an Dos

sna_link (for Open Systems)

telnet_server

-?is the flag which produces the usage message.

If no arguments are supplied to cicscp it enters an interactive mode in which youcan enter a sequence of commands.

Notes:

In normal operation, cicscp will only issue a single message indicating if thecommand worked or not.

The effects of the -v flag are as follows:

cicscp will send more messages to stderr identifying the step beingperformed, for example creating the DCE configuration.

a.

The standard output of the commands issued will be allowed through tothe standard output of cicscp.

b.

When cicscp calls a CICS command that takes a -v option, cicscp willspecify the -v option on the call.

c.

New users of cicscp commands should always use the -v and -l logFileoptions, in order to understand and keep a record of what is happening.

1.

In the following pages the cicscp commands are grouped by object. Forexample, all the commands that affect the DCE (create, destroy, start, andstop) are together.

2.

Examples

To create SFS sfs1 and ignore all errors, enter:

cicscp -I create sfs_server sfs1

1.

To start SFS sfs1 and produce an activity log on mylog, enter:

cicscp -l mylog start sfs_server sfs1

2.

cicscp - all options

AIX HP-UX Sun Solaris Windows

X X X X

Used with destroy, start and stop commands to apply them to all objects.

Syntax

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

17 de 179 03/03/12 14:46

Page 18: Com an Dos

cicscp destroy all

cicscp start all

cicscp stop all

Description

When the all option is used with the destroy, start or stop commands, the effect isto apply the particular command to all objects that cicscp can currently manage onthe system.

You must be logged on as a user with root or administrator privileges. If you areusing DCE authentication, cicscp prompts you for a password if you are runninginteractively, you have not set the cell_admin_pw environment variable, and thecell_admin password is not the default password (-dce-). If you are not runninginteractively, have not set the cell_admin_pw environment variable, and thepassword is not the default, the command fails.

Attention: Always be aware when using the all option that the command mightdestroy, start or stop the wrong objects.

Examples

To remove all CICS processes from the local system, enter

cicscp destroy all

This will stop all running objects and then destroy them, removing all trace of CICSprocessing from the local system. This includes destroying the DCE configuration,but does not include the removal of the SFS logical volumes or user identifiers.

cicscp - COBOL commands

AIX HP-UX Sun Solaris Windows

X X X

Adds or removes Micro Focus Server Express COBOL libraries and objects.

Syntax

cicscp create cobol

cicscp destroy cobol [-f]

Description

cicscp create cobol

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

18 de 179 03/03/12 14:46

Page 19: Com an Dos

The create command builds the default Micro Focus Server Express COBOLlanguage method file cicsprCOBOL. If you want to include any special objects orlibraries in cicsprCOBOL, you must use cicsmkcobol.

cicscp destroy cobol

The destroy command destroys the Micro Focus Server Express COBOL languagemethod file cicsprCOBOL.

You must be logged on as a user with root or administrator privileges. If you areusing DCE authentication, cicscp prompts you for a password if you are runninginteractively, you have not set the cell_admin_pw environment variable, and thecell_admin password is not the default password (-dce-). If you are not runninginteractively, have not set the cell_admin_pw environment variable, and thepassword is not the default, the command fails.

Options

-fcauses the command to execute without issuing prompts for confirmation. Thisonly applies when using the cicscp destroy cobol command.

Examples

To create the default cicsprCOBOL, enter:

cicscp create cobol

cicscp - DCE commands

AIX HP-UX Sun Solaris Windows

X X X X*

On Open Systems it creates, destroys, starts or stops DCE clients or servers. *OnWindows, the create functionality associated with the cicscp commands isimplemented. Gradient DCE on the Windows platform does not implement theprocedures for destroy, start and stop through the cicscp commands. DCEutilities must be used to perform the destroy, start, and stop functions on theWindows platform.

Syntax

Syntax (for Open Systems)

cicscp create dce { -R | [-n cellName [-s securityServer]] }

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

19 de 179 03/03/12 14:46

Page 20: Com an Dos

cicscp destroy dce [-f]

cicscp start dce

cicscp stop dce

Syntax (for Windows)

cicscp create dce -R

Description

cicscp create dce

The create command creates the basic DCE configuration for either a server (aCDS server and a security server) or a client. -s parameter is supplied with either

the name or the Internet Protocol (IP) address1 of the machine acting as thesecurity server for the cell of which the client is to be part. This is not required ifthe DCE Security Server is on the local host.

In addition to the basic DCE configuration, cicscp runs cicssetupdce (if necessary)and cicssetupclients to configure DCE for CICS.

If a DCE configuration exists before cicscp is run, as long as it is a validconfiguration cicscp will only create the necessary CICS configuration; it will notover-write the existing configuration. Thus, it is possible to configure a machine asonly a CDS server using the DCE configuration tools and then use cicscp to do theCICS-related configuration.

cicscp destroy dce

The destroy command stops DCE and destroys the DCE configuration of themachine. If you run the command on a client machine and the server is unavailable,cicscp will automatically remove the local configuration but the information held inthe cell database regarding the machine will have to be removed manually.

Note:On HP-UX version 11i and Solaris, the cicscp-v destroy dce commandsometimes fails to clean up the DCE configuration. If this occurs, use one ofthe following techniques:

First issue the cicscp -v stop dce command, followed by the cicscp -vdestroy dce command.

1.

Use the DCE native command dce_config to destroy the DCEconfiguration.

2.

cicscp start dce

The start command starts the DCE on the machine, creating the defaultconfiguration first if necessary.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

20 de 179 03/03/12 14:46

Page 21: Com an Dos

cicscp stop dce

On CICS on Open Systems, the stop command stops the DCE on the machine.

On CICS for Windows

The create command configures your machine to run in RPC-only mode, that iswithout using DCE authentication or DCE name services.

To create a DCE server configuration see related information in the CICSAdministration Guide.

To create a DCE client configuration see related information in the CICSAdministration Guide.

You must be logged on as a user with root or administrator privileges. If you areusing DCE authentication, cicscp prompts you for a password if you are runninginteractively, you have not set the cell_admin_pw environment variable, and thecell_admin password is not the default password (-dce-). If you are not runninginteractively, have not set the cell_admin_pw environment variable, and thepassword is not the default, the command fails.

Options

-Rspecifies that DCE is to be configured not to use DCE authentication or DCEname services.

-n cellNamespecifies the name of the cell to be created (with or without "/.../"). The defaultcell name is "dce_cell.hostName.domainName".

-s securityServerspecifies the name or IP address of the security server.

-fcauses the command to execute without issuing prompts for confirmation.

Examples

To create DCE using the default cell name, enter:

cicscp create dce

1.

To destroy DCE without prompts, enter:

cicscp destroy dce -f

2.

To configure DCE for cell /.../test_cell.hursley.ibm.com, enter:

cicscp create dce -n /.../test_cell.hursley.ibm.com

3.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

21 de 179 03/03/12 14:46

Page 22: Com an Dos

cicscp - PPC Gateway server commands

AIX HP-UX Sun Solaris Windows

X X X

Creates, destroys, starts or stops PPC Gateway servers.

Syntax

cicscp create ppcgwy_server gatewayServer [-m modelId][attributeName=attributeValue ... ]

cicscp destroy ppcgwy_server {gatewayServer | all} [-f]

cicscp start ppcgwy_server {gatewayServer | all}[attributeName=attributeValue ... ]

cicscp stop ppcgwy_server {gatewayServer | all} [-f]

Description

CICS must be installed on the same machine as the PPC Gateway server. If CICS isnot installed on the same machine as the PPC Gateway server, refer to the EncinaAdministration Guide Volume 2: Server Administration manual for an alternativeprocedure.

cicscp create ppcgwy_server

The create command creates a PPC Gateway server server on the machine. Ifnecessary, cicsdefaultservers is run automatically. It is an error to attempt tocreate a server that is already defined - the old server definition must be removedfirst.

Each PPC Gateway server server must have a unique ShortName value in theGateway Server Definitions (GSD), so if one is not supplied as an attribute overrideon the create command, cicscp chooses one which is of the form "PbaseName"where baseName is the firstpart of the server name, truncated to seven charactersif necessary.No check is made that this name is unique, therefore the server namemust be unique in the first seven characters if the default ShortName is to beused. As an example, if the PPC Gateway server server "ppcgwysrv1" were created,the default ShortName chosen would be "Pppcgwys" and an attempt to create"ppcgwysrv2" would result in a duplicate ShortName being used and an error.

If the UserID specified in the Gateway Server Definitions (GSD) for the server doesnot exist, cicscp will create it with the appropriate home directory.

If the DCE is not running, cicscp will start it, creating the default configuration if

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

22 de 179 03/03/12 14:46

Page 23: Com an Dos

necessary.

If the logical volume specified in the LogVolume attribute of the Gateway ServerDefinitions (GSD) does not exist, cicscp creates it. If it does exist and is owned bythe correct user, cicscp issues a warning message. If it exists and is owned by adifferent user, cicscp issues an error message. The location and size of the logicalvolume are controlled by environment variables. The location is controlled by theenvironment variable CICS_PPCGWY_VG and the size is controlled by theenvironment variable CICS_PPCGWY_SIZE. There are default values coded intocicscp which means that neither environment variable needs to be set if the defaultvalues are acceptable. The default size of the logical volume created is 4MB. Thedefault location depends on the platform.

If SNA is not configured on the machine, cicscp issues a warning as the server willnot be able to be started until SNA is configured and started.

If the DCE name service is not being used for name resolution cicscp adds an entryfor the server to /var/cics_servers/server_bindings.

cicscp destroy ppcgwy_server

The destroy command stops the server if it is running and removes the serverdefinition from CICS, but does NOT remove the user or the logical volume. If thereserved name all is used, all configured servers are destroyed.

cicscp start ppcgwy_server

The start command starts the server. If necessary, it uses the create command tocreate a default server of the correct name.

Note:Any attribute overrides specified on the start command do not affect the servercreated implicitly by the start command; they are only applied to the start ofthe server. Issuing a start command for a server that does not exist isequivalent to a create command for that server without any overrides, followedby the start command with the overrides. This means that there can in suchsituations be a mismatch between the attributes applied to the gateway bydefault, and the overrides provided with the start command, resulting in thecommand failing to complete successfully.

If SNA is not configured the start command issues an error messages and the PPCGateway server server is not started.

If the reserved name all is used, all configured servers are started and any attributeoverrides specified are passed to each server.

cicscp stop ppcgwy_server

The stop command stops the named PPC Gateway server, or all running servers ifthe reserved name all is used.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

23 de 179 03/03/12 14:46

Page 24: Com an Dos

You must be logged on as a user with root or administrator privileges. If you areusing DCE authentication, cicscp prompts you for a password if you are runninginteractively, you have not set the cell_admin_pw environment variable, and thecell_admin password is not the default password (-dce-). If you are not runninginteractively, have not set the cell_admin_pw environment variable, and thepassword is not the default, the command fails.

Options

gatewayServeris the name of the PPC Gateway server. A name that does not begin with thestring "/.:/cics/ppc/gateway/" will have that string added to the front of the name.

-m modelIdidentifies the existing entry on which the one to be created should be based.

-f (on cicscp destroy ppcgwy_server) causes the command to execute without issuing prompts for confirmation.

attributeName=attributeValue ...are overrides for Gateway Server Definitions (GSD) attributes. For moredetails, see the CICS Intercommunication Guide, which describes whichattributes are suited to modification at startup. See also Gateway ServerDefinitions (GSD).

-f (on cicscp stop ppcgwy_server) forces the server to stop.

Examples

To create a gateway server named /.:/cics/ppc/gateway/GwyThree with attributeoverrides, verbose messaging and a log file recording cicscp processing,enter:

cicscp -v -l /tmp/cicscp.log create ppcgwy_server /.:/cics/ppc/gateway /GwyThree \ShortName=Gate3 ThreadPoolSize=15

Note:UserID defaults to ShortName, so cicscp will create and use the useridGate3 for this gateway.

1.

To start the previously created gateway with an attribute override, enter:

cicscp start ppcgwy_server GwyThree ProtectionLevel=pkt

Note:The simple name is not the same as the ShortName.

2.

cicscp - region commands

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

24 de 179 03/03/12 14:46

Page 25: Com an Dos

AIX HP-UX Sun Solaris Windows

X X X X

Creates, destroys, starts, or stops regions.

Syntax

cicscp create region regionName [-g groupId] [-i fileName] [-l{m|o|c|r}] [-d][-o instanceName -a aliasName [-u userName] [-n|-s] ]

cicscp destroy region {regionName | all} [-f] [-s]

cicscp start region {regionName | all} [-d distributedServers][attributeName=attributeValue ... ]

cicscp stop region {regionName | all} [-f|-c]

Description

cicscp create region

The create command creates the named CICS region. If DCE is not running, cicscpstarts it, creating the default configuration if necessary. If the -i option is specified,cicscp uses the cicsimport command; otherwise, it uses the cicsdefaultcommand. If the -d option is not specified, cicscp checks that the SFS defined asthe default file server for the region is configured, creates a default configuration ifit is not, and starts the server if it is not already running. Finally, cicscp configuresthe server for the region.

Before using the region you have created, consider using a mounted file system forthe CICS log file, as described in the Planning and Installation Guide.

cicscp destroy region

The destroy command stops and then destroys the named region, or all configuredregions if the reserved name all is specified. If the -s option is specified, the fileserver definitions for TD, TS, and local queues are also deleted.

cicscp start region

The start command starts the named region, or all configured regions if thereserved name all is specified. If a single region is started and it is not configured, adefault region of the specified name is created. Any attribute overrides specified onthe start command are not passed through to the region creation.

When the region has been created if necessary, cicscp checks that the necessarySFS and PPC Gateway servers are running, unless the type of server has beendeclared as remote with the -d option.

If SFS servers are not declared as remote, cicscp starts the default file server for

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

25 de 179 03/03/12 14:46

Page 26: Com an Dos

the region and then browses each File Definition entry and examines the serverspecified for the file. If a particular server is not running, cicscp starts it. Eachstart can result in the implicit creation of the server if it does not already exist.

If PPC Gateway servers are not declared as remote, cicscp browses each GatewayDefinition entry and starts the specified server if necessary. Each start can result inthe implicit creation of the server if it does not already exist.

When all of the necessary servers have been started, the region itself is started.

cicscp stop region

The stop command stops the named region, or all running regions if the reservedname all is specified.

You must be logged on as a user with root or administrator privileges. If you areusing DCE authentication, cicscp prompts you for a password if you are runninginteractively, you have not set the cell_admin_pw environment variable, and thecell_admin password is not the default password. If you are not runninginteractively, have not set the cell_admin_pw environment variable, and thepassword is not the default, the command fails.

Options

regionNameis the name of the region.

-g groupIdspecifies the name of the groupID with which all files of the new region arecreated.

-i fileNamespecifies the file name of the archive copy of the resource definitions, in cpioformat. If you do not specify the -i flag, the file is read from standard input.

-l{m|o|c|r} (CICS on Open Systems only)specifies the action that cicscp is to take if it cannot find the target of asymbolic link. The default action is to terminate the restoration abnormally:

-lmMandatory. cicscp abnormally terminates the restoration if it cannot findthe symbolic target.

-loOptional. cicscp produces a warning message, creates the link andcontinues restoration if it cannot find the symbolic target. This allows youto restore further regions that resolve the missing links.

-lcContinue. cicscp overrides any symbolic link requirements defined as

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

26 de 179 03/03/12 14:46

Page 27: Com an Dos

part of the cicsexport command.

-lrResolve. If cicscp cannot find the symbolic target, it restores a physicalcopy of the missing definition, and produces a warning message.

-d (on cicscp create region) indicates a distributed configuration. If this option is used, cicscp does notcheck for the presence of the SFS server. It assumes that the SFS server isdefined on a different machine and that its status cannot be checked.

-d distributedServers (on cicscp start region) indicates a distributed configuration. Valid values for distributedServers are:

all

sfs_server

ppcgwy_server

"ppcgwy_server sfs_server"

-o instanceNamespecifies the name of the instance of DB2.

-a aliasNamespecifies the name of the DB2 database to be used as the file server. This nameis stored in the DefaultFileServer attribute in the Region Definitions (RD).

-u userNamespecifies the name to be used for explicit authentication. If this parameter isspecified, it forms part of the XA open string specified in the XAOpen attributeof the Product Definitions (XAD) entry.

-nspecifies the creation of a system-defined Product Definitions (XAD) entryspecifying non-XA integration.

-s (on cicscp create region) suppresses the creation of a system-defined Product Definitions (XAD) entry.

-s (on cicscp destroy region) causes the deletion of file server definitions for TD, TS, and local queues.

allused with destroy, start, or stop, causes cicscp to apply the command to allconfigured CICS regions.

-f (on cicscp destroy region) causes the command to be executed without issuing prompts for confirmation.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

27 de 179 03/03/12 14:46

Page 28: Com an Dos

-f (on cicscp stop region) forces an immediate shutdown.

-cforces a cancel shutdown. The cicsnotify command is run automatically.

attributeName=attributeValue ...overrides for Region Definitions (RD) attributes. See Region Definitions (RD).

Examples

To create a region called REGION1, copying the definitions from a file calledREGIONFILE, enter:

cicscp create region REGION1 -i REGIONFILE

1.

To start all regions, specifying a distributed SFS server, enter:

cicscp start region all -d sfs_server

2.

To start the region TestReg with verbose messaging and a log file recordingcicscp processing, enter:

cicscp -v -l /tmp/cicscp.log start region TestReg

This creates the region TestReg (using cicsdefault) and configures it for thedefault SFS server. Additional processing is performed for SFS and DCE asnecessary.

3.

cicscp - SFS commands

AIX HP-UX Sun Solaris Windows

X X X X

Creates, destroys, starts or stops SFS.

Syntax

cicscp create sfs_server serverName [-m modelId][attributeName=attributeValue ... ]

cicscp destroy sfs_server {serverName | all} [-f]

cicscp start sfs_server {serverName | all} [attributeName=attributeValue ... ]

cicscp stop sfs_server {serverName | all} [-f]

Description

cicscp create sfs_server

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

28 de 179 03/03/12 14:46

Page 29: Com an Dos

The create command creates a SFS server on the machine. If necessary,cicsdefaultservers is run automatically. It is an error to attempt to create a serverthat is already defined - the old server definition must be removed first.

Each SFS server must have a unique ShortName value in the Structured FileServer Definitions (SSD) so if one is not supplied as an attribute override on thecreate command, cicscp chooses one which is of the form "SbaseName" wherebaseName is the last part of the server name, truncated to the first sevencharacters if necessary. No check is made that this name is unique, therefore theserver name must be unique in the first seven characters if the default ShortNameis to be used. As an example, if the SFS server "sfssrv1" were created, the defaultShortName chosen would be "Ssfssrv1" and an attempt to create "sfssrv11" wouldresult in a duplicate ShortName being used and an error.

If the UserId specified for the server in the Structured File Server Definitions(SSD) does not exist, cicscp will create it with the appropriate home directory.

If the DCE is not running, cicscp will start it, creating the default configuration ifnecessary (on Open Systems). On Windows cicscp starts it only if the DCE isalready configured.

There are two logical volumes associated with each SFS server: the logical volumefor the file data, specified by the Structured File Server Definitions (SSD) attributeDataVolume, and the logical volume holding the recovery information, specified bythe attribute LogVolume.

If either logical volume specified does not exist, cicscp creates it. If either doesexist and is owned by the correct user, cicscp issues a warning message. If eitherexists and is owned by a different user, cicscp issues an error message.

The location and size of each logical volume are controlled by environmentvariables. There is a pair of environment variables that controls both logicalvolumes and there is also a separate pair for each logical volume, allowing each tobe controlled separately. If one of the environment variables corresponding to aparticular logical volume is set, it takes priority over the corresponding generalenvironment variable.

The location is controlled by the general environment variable CICS_SFS_VG andthe separate environment variables CICS_SFS_DATA_VG and CICS_SFS_LOG_VG.The size is controlled by the general environment variable CICS_SFS_SIZE and theseparate environment variables CICS_SFS_DATA_SIZE and CICS_SFS_LOG_SIZE.There are default values coded into cicscp which means that none of theseenvironment variables needs to be set if the default values are acceptable. Thedefault size of both the data and log logical volumes is 64MB. The default locationdepends on the platform, on CICS for AIX it is rootvg and on CICS for HP-UX it isvg00.

If the DCE name service is not being used for name resolution cicscp adds an entryfor the server to /var/cics_servers/server_bindings.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

29 de 179 03/03/12 14:46

Page 30: Com an Dos

cicscp destroy sfs_server

The destroy command stops the server if it is running and removes the serverdefinition from CICS, but does not remove the user or the logical volumes. If thereserved name all is used, all configured servers are destroyed.

cicscp start sfs_server

The start command starts the server, creating a default server of the correct nameif necessary.

Note:Any attribute overrides specified on the start command do not affect the servercreated implicitly by the start command; they are only applied to the start ofthe server. Issuing a start command for a server that does not exist isequivalent to a create command for that server without any overrides followedby the start command with the overrides. This means that there can in suchsituations be a mismatch between the attributes applied to the server bydefault, and the overrides provided with the start command, resulting in thecommand failing to complete successfully.

If the reserved name all is used, all configured servers are started and any attributeoverrides specified are passed to each server.

cicscp stop sfs_server

The stop command stops the named SFS gateway server, or all running servers ifthe reserved name all is used.

You must be logged on as a user with root or administrator privileges. If you areusing DCE authentication, cicscp prompts you for a password if you are runninginteractively, you have not set the cell_admin_pw environment variable, and thecell_admin password is not the default password (-dce-). If you are not runninginteractively, have not set the cell_admin_pw environment variable, and thepassword is not the default, the command fails.

Options

serverNameis the name of the server. A simple name (one without a leading "/.:/cics/sfs/"string) will have the string added to the front of the name.

-m modelIdidentifies the existing entry on which the one to be created should be based. Ifyou do not specify a name, the server is modeled on the default Structured FileServer Definitions (SSD).

attributeName=attributeValue ...are the overrides for Structured File Server Definitions (SSD) attributes. SeeStructured File Server Definitions (SSD).

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

30 de 179 03/03/12 14:46

Page 31: Com an Dos

allused with destroy, start or stop, causes cicscp to apply the command to allconfigured or running servers.

-f (on cicscp destroy sfs_server) causes the command to execute without issuing prompts for confirmation.

-f (on cicscp stop sfs_server) forces an immediate shutdown.

Examples

To create an SFS named /.:/cics/sfs/SrvOne with attribute overrides, verbosemessaging and a log file recording cicscp processing, enter:

cicscp -v -l /tmp/cicscp.log create sfs_server /.:/cics/sfs/SrvOne \ ShortName=Sfs1 BufferPoolSize=1250

1.

To start server /.:/cics/sfs/SrvTwo with an attribute override, enter:

cicscp start sfs_server SrvTwo MRAArchivingEnabled=yes

Note:This example is doing an implicit create, so specifying ShortName=Sfs2 wouldnot work because the ShortName default would have been used duringthe create.

2.

To start all SFSs, assuming that they can all be autostarted, enter:

cicscp start sfs_server all

3.

cicscp - SNA commands

AIX HP-UX Sun Solaris Windows

X X X X

This command starts or stops SNA.

Syntax

cicscp start sna

cicscp stop sna

Description

On CICS for Windows, the cicscp start/stop sna commands try to start or stop theIBM Communications Server. If this server is not found, the commands try to startor stop the Microsoft SNA Server.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

31 de 179 03/03/12 14:46

Page 32: Com an Dos

If you are using DCE authentication and the task you are performing requires youto be logged in as the DCE cell administrator, cicscp prompts you for a password ifyou are running interactively, you have not set the cell_admin_pw environmentvariable, and the cell_admin password is not the default password (-dce-). If you arenot running interactively, have not set the cell_admin_pw environment variable, andthe password is not the default, the command fails.

For more information about problem determination for SNA products see therelevant SNA booklet:

Using IBM Communications Server for AIX with CICSUsing IBM Communications Server for Windows Systems with CICSUsing Microsoft SNA Server with CICSUsing SNAP-IX for Solaris with CICSUsing HP-UX SNAplus2 with CICS

For more information on using the cicscp SNA commands, see the CICSIntercommunication Guide.

cicscp - telnet server commands

AIX HP-UX Sun Solaris Windows

X X X X

Creates or destroys telnet servers.

Syntax

cicscp create telnet_server serverName [-P portName] [-c clientCodeset][-e emulation] [-h hostList][-k keytabFile] [-l localeName] [-m modelId] [-n netName][-p principalName] [-r regionName] [-s serverCodeset] [-t transId]

cicscp destroy telnet_server {serverName | all} [-f]

Description

cicscp create telnet_server

The create command creates a telnet server configuration that can be used withinetd. On Windows, inetd runs as an NT Service. A shell script is automaticallycreated in /var/cics_clients for each telnet server created by cicscp containing thearguments to the cicsteld command.

If a principal is specified using the -p option, it is added to the DCE groupcics_users, if it is not already in the group. If no keytab file is specified using the -koption, cicscp creates one in /var/cics_clients.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

32 de 179 03/03/12 14:46

Page 33: Com an Dos

If no principal is specified, no DCE principal or keytab file will be created. If you arenot using DCE authentication, or if you are using DCE authentication, but you wantto use the default keytab file created in /var/cics_clients by cicssetupclients, thenyou should not specify a principal.

The -m flag allows all parameter values except netName (which must be unique) tobe copied from the telnet server named with the -m parameter. It may not bepossible for cicscp to retrieve the parameter values from the model server if theserver was not created by cicscp, or the shell script has been edited after theserver was created.

cicscp destroy telnet_server

The destroy command destroys a telnet server configuration, but it does notremove the DCE principal.

If you are using DCE authentication and the task you are performing requires youto be logged in as the DCE cell administrator, cicscp prompts you for a password ifyou are running interactively, you have not set the cell_admin_pw environmentvariable, and the cell_admin password is not the default password (-dce-). If you arenot running interactively, have not set the cell_admin_pw environment variable, andthe password is not the default, the command fails.

Options

serverNameis the name of the server. This name must be different from every other nameused in the file /etc/services. cicscp create telnet_server will add an entry to/etc/services for the specified server and cicscp destroy telnet_server willdelete the entry.

-P portNamespecifies the port to be used. This port name must be unique, and will bechosen automatically if omitted.

-c clientCodesetspecifies the client codeset.

-e emulationspecifies the type of 3270 to emulate.

-h hostListspecifies a blank-delimited list of names or addresses of hosts to be searchedfor the specified region. If a list of host names is not specified, the contents ofthe environment variable CICS_HOSTS will be used. If the environmentvariable CICS_HOSTS is not set, the local machine will be searched.

-k keytabFilespecifies the name of the keytab file. -k option is not specified but the -p optionis used, then cicscp will create a keytab file.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

33 de 179 03/03/12 14:46

Page 34: Com an Dos

-l localeNamespecifies the name of the locale.

-m modelIdspecifies the model definition on which the one to be created should be based.

-n netNamespecifies the network name.

-p principalNamespecifies the name of the principal to be used for DCE authentication of thisCICS telnet server.

-r regionNamespecifies the region to connect to. If no region is specified, a menu of regionswill be displayed.

-s serverCodesetspecifies the server codeset.

-t transIdspecifies the initial transaction. The default is CESN.

-fcauses the command to execute without issuing prompts for confirmation.

Examples

To create a telnet server called TELNX1 on port 9001 listening for a request to accessREGION1, enter:

cicscp create telnet_server TELNX1 -P 9001 -r REGION1

cicscvt - Create data conversion table

AIX HP-UX Sun Solaris Windows

X X X X

cicscvt is used to build conversion templates from DFHCNV macro conversion files.

Syntax

cicscvt fileName

cicscvt -?

Description

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

34 de 179 03/03/12 14:46

Page 35: Com an Dos

The cicscvt command is a utility that converts a macro source conversion tablecontaining DFHCNV macros into a conversion template for each resource defined inthe table.

cicscvt creates a conversion template for each DFHCNV macro in the input file.The name of the conversion template created is resourceName.resourceType.cnv, whereresourceName is the name coded as the RNAME parameter, and resourceType isthe type coded as the RTYPE parameter. To use the template it must be moved orcopied to

/var/cics_regions/region_name/database/resourceType/resourceName.cnv

Options

fileNamespecifies the name of the file to be processed.

-?causes the usage message to be displayed.

Returned Values

0The table was successfully converted.

non-zeroThe templates were not created successfully.

Examples

If file TESTCNV contains the macro:

DFHCNV TYPE=ENTRY,RTYPE=PC,RNAME=TEST

it can be converted and installed for region regionName by using the commands:

cicscvt TESTCNVmv TEST.PC.cnv /var/cics_regions/regionName/database/PC/TEST.cnv ORcopy TEST.PC.cnv /var/cics_regions/regionName/database/PC/TEST.cnv

The mv command is used on UNIX platforms. The copy command is used onWindow.

cicsdb2conf - Configure DB2

AIX HP-UX Sun Solaris Windows

X X X X

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

35 de 179 03/03/12 14:46

Page 36: Com an Dos

You use this command to configure CICS resource definitions for DB2 and toconfigure DB2 to manage CICS queues and files.

Syntax

cicsdb2conf [-I] [-m] -r regionName [-l logFileName] { -C -i instanceName-a aliasName [-f] [-n|-s] [-u userName[,password]] [-g] | [ -S] |[ -N] |[ -D] |[ -P] |[ -T]|[ -L] |[ -Q ] ... }

cicsdb2conf -?

Description

You must be logged in with DB2 sysadm authority.

The command cicsdb2conf configures the resource definitions in the CICS regionto meet the requirements of DB2 and adds the necessary tables to the DB2database. You run cicsdb2conf from the operating system command line.

Options

-Icauses non-critical errors to be ignored.

-mspecifies that cicsdb2conf should set the IndexName for each file defined inthe File Definitions (FD) by appending "0" to its key.

-r regionNamespecifies the name of the CICS region for which you are configuring DB2.

-l logFileNamespecifies the name of the file to be used for logging configuration messages. Ifthis parameter is not specified the file regionName/data/cicsdb2conf.log will be used.

-Cspecifies the complete configuration of DB2 for the region and theconfiguration of the region resources for DB2. The flags -i, -a, -n, -f, -s, -u and-l are valid when this option is specified.

-i instanceNamespecifies the name of the instance of DB2.

-a aliasNamespecifies the name of the DB2 database to be used as the file server. This nameis stored in the DefaultFileServer attribute in the Region Definitions (RD).

-fBy default, the Fileserver attribute for all File Definitions (FD) entries is set toNULL and the default specified by the DefaultFileServer attribute in theRegion Definitions (RD) is used. If this option is specified the FileServer

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

36 de 179 03/03/12 14:46

Page 37: Com an Dos

attributes are not set to NULL.

-nspecifies the creation of a system-defined Product Definitions (XAD) entryspecifying integration through the DB2 single-phase commit optimization. Ifthis flag is not specified cicsdb2conf will place a new default entry in the XADthat will allow the region to connect to the aliasName database through the XAinterface.

-ssuppresses the creation of a system-defined Product Definitions (XAD) entry.An XAD entry is required in order to specify a DB2 database that will managethe CICS region's queues and files. If this flag is not specified cicsdb2conf willcreate a new default entry in the XAD that will allow the region to connect tothe aliasName database. The use of this flag allows you to define your own XADentry for the aliasName database.

-u userName[,password]specifies the user name to be used for explicit authentication. If this parameteris specified, it forms part of the XAOpen string in the Product Definitions (XAD)entry. If the password is not specified, CICS prompts you to enter it.

-ggrant minimum privileges. If this flag is specified, cicsdb2conf will grantEXECUTE authority to allow the userid that CICS uses to connect to thedatabase to execute the CICS file and queue management package.

If this flag is not specified, cicsdb2conf will grant DBADM authority to theuserid that CICS uses to connect to the database.

-Sspecifies that a table for recoverable auxiliary TSQs is to be created. The nameof the table will be regionNameREQTSQ#. The table will be recoverable.

-Nspecifies that a table for non-recoverable auxiliary TSQs is to be created. Thename of the table will be regionNameNREQTSQ#. The table will berecoverable since non-recovereable tables are not supported by DB2.

-Dspecifies that a table for logically recoverable TDQs is to be created. The nameof the table will be regionNameLOGTDQ#. The table will be recoverable.

-Pspecifies that a table for physically recoverable TDQs is to be created. Thename of the table will be regionNamePHTDQ#. The table will be logicallyrecoverable since physically recoverable tables are not supported by DB2.

-Tspecifies that a table for non-recoverable TDQs is to be created. The name of

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

37 de 179 03/03/12 14:46

Page 38: Com an Dos

the table will be regionNameNREQTDQ#. The table will be recoverable sincenon-recoverable tables are not supported by DB2.

-Lspecifies that a table for locally queued protected STARTs is to be created. Thename of the table will be regionNameLQPROT#. The table will be recoverable.

-Qspecifies that a table for locally queued unprotected STARTs is to be created.The name of the table will be regionNameLQUE#. The table will berecoverable.

-?causes the usage message to be displayed.

Returned Values

0DB2 has been configured.

non-zeroThe attempt to configure DB2 was unsuccessful.

Examples

To configure DB2 for REGION1 with default parameters, using alias CICSTEST forinstance DB2USER:

cicsdb2conf -r REGION1 -C -i DB2USER -a CICSTEST -n

1.

cicsdb2import - Build metadata for DB2

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to define files to a DB2 database.

Syntax

cicsdb2import -i schemaFileName [-d databaseName] [-u userName [-p passWord]][-I] [-f fileName [-x indexName] ... ]

cicsdb2import -?

You must be logged on as a user with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).You must have a running DB2 database available for connection.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

38 de 179 03/03/12 14:46

Page 39: Com an Dos

You must be authorized to connect to the database.You must have a schema file containing the necessary file definitions. A schemafile can be created by using cicsadd -cscd ... or by using SMIT on CICS for AIXor SAM on CICS for HP-UX.

Description

The cicsdb2import command allows you to create files on a DB2 database basedon the information provided in a schema file. You can specify which database a fileis to be created on, and you can optionally select which files are created from thosedefined within the schema. You can also select which indexes are to be created fromthose defined for a particular file in the schema.

You run cicsdb2import from the operating system command line.

Options

-Icauses non-critical errors to be ignored.

-i schemaFileNamespecifies the name of the file containing the schema definition.

-d databaseNamespecifies the name of the database to which connection is required. If the nameof the database is not specified, the name contained in the environmentvariable DB2DBDFT is used.

-u userNamespecifies the name of the user to be used for explicit authentication. If the username is not specified, implicit authentication is used.

-p passWordspecifies the password to be used for explicit authentication. If the password isnot specified, you will be prompted to enter the password.

-f fileNamespecifies the name of the file to be loaded from the schema. If no file name isspecified, all files in the schema are loaded.

-x indexNamespecifies the name of an index to be loaded. If no index name is specified, allindexes for the specified file are loaded.

-?causes the usage message to be displayed.

Returned Values

0

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

39 de 179 03/03/12 14:46

Page 40: Com an Dos

The file or files were successfully loaded into the database.

non-zeroThe import operation was unsuccessful.

cicsddt - DB2 diagnostic tool

AIX HP-UX Sun Solaris Windows

X X X X

The CICS DB2 diagnostic tool (DDT) provides an interactive interface to DB2.

Syntax

cicsddt [-s databaseName] [-i inputFile] [-o outputFile] [-e] [-r] [-c DDTcommands ...]

cicsddt -?

Description

You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).You must have a running DB2 database available for connection.You must be authorized to connect to the database.

Options

Note:Except for -c, which must be the last parameter, the parameters can be in anyorder.

-s databaseNamespecifies the name of the DB2 database. For example, cicstest. If this option isnot specified, the server name in the environment variable CICS_XDT_SERVERor DB2DBDFTis used.

-i inputFilespecifies a text file containing DDT commands to be read and executed. Thefile can be created either by hand or by using the -o option. Each line of theinput file is treated as if it were typed in interactive mode. The text from theinput file is also displayed as it is processed by cicsddt. Comments can beincluded in the file by starting a line with "/*".

For example, if you create a file called create.input that contains the followinglines:

/*

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

40 de 179 03/03/12 14:46

Page 41: Com an Dos

/* This is a sample file to create a table called qsamtest/*create cics.qsamtestkflchar10f2varchar100

f1a

quit

Then execute cicsddt as follows:

cicsddt -s databaseName -i create.input

A new table called CICS.QSAMTEST is created on the specified database.

-o outputFilecauses commands entered in the DDT session to be written to the specifiedoutput file. This file can then be used as an input file using the -i option.

-erequests DDT to terminate if an error occurs. If -e is specified and DDT isbeing driven from a shell script (-i) or the command line (-c), any errorresulting from a command will exit DDT with a non-zero return code.

-ractivates DDT statistics. Statistics for DDT and DB2 calls are sent to a filecalled ddt.stats in the current directory. This is useful for monitoringperformance.

-c DDTcommands ...specifies a list of commands and text to be used in the DDT session. This isuseful for calling DDT commands from a shell script. This parameter must beused last.

Using the DDT commands: To issue commands in DDT, pass them to DDT usingthe -i or -c option, or type the command at the command prompt. DDT acceptscommand abbreviations. In the command syntax the minimum abbreviation isshown in parentheses; for example, (c)reate. Any command that requires a filename will default to the last name used if nothing is given at the prompt. DDT alsorecognizes any environment variables used at the command prompt.

DDT commands - list

(l)ist [(l)] searchString

Lists all the tables on the database that DDT is accessing. l option is

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

41 de 179 03/03/12 14:46

Page 42: Com an Dos

used,additional information is given for each table. Only tables owned by theuser cics will be shown. A search string can also be given to list specific files. Ifa search string is used, DDT will look for all the filenames that contain thestring. There are no "wild card" characters, so the search string is taken asentered.

cicsddt -s cicstest -c li l jim

Table Name Organisation Primary Index No. Records======================= ==================== ============== ===========CICS.JIM6CICSNLQFILE Key-Sequenced (KSDS) CICSNLQIDX (empty)CICS.JIM6CICSNRECTSQFIL Key-Sequenced (KSDS) CICSNRECTSQIDX (empty)CICS.JIM6CICSPLQFILE Key-Sequenced (KSDS) CICSPLQIDX (empty)CICS.JIM6CICSRECTSQFILE Key-Sequenced (KSDS) CICSRECTSQIDX 2CICS.JIM6CICSTDQLGFILE Key-Sequenced (KSDS) CICSTDQLGIDX 11CICS.JIM6CICSTDQNOFILE Key-Sequenced (KSDS) CICSTDQNOIDX (empty)CICS.JIM6CICSTDQPHFILE Key-Sequenced (KSDS) CICSTDQPHIDX (empty)

DDT commands - create

(c)reate tableName

Creates a new DB2 table. All the table information is prompted for in turn. Toaid usability and eliminate creation errors, DDT will validate as much aspossible and default to sensible values where appropriate. One exception is thetable column name and index column name that use an empty entry to indicatethere are no more columns. If q! is entered at any prompt the create iscancelled.

cicsddt -s cicstest -c create cics.qsamtest

[File Type [Ksds/Esds/Rrds] .: K[sds][Column 01: Name ............: f1[Column 01: Type ............: Error: Invalid column type. Type must be: char, varchar, long varchar or graphic.[Column 01: Type ............: char[Column 01: Size ............: 10[Column 02: Name ............: f2[Column 02: Type ............: varchar[Column 02: Size ............: 100[Column 03: Name ............:[Primary Index Name .........: CICS.QSAMTEST0[Index Part 01: Column Name .: f1[Index Part 01: Ordering ....: a[scending][Index Part 02: Column Name .:

DDT commands - read

(r)ead tableName

Reads rows from a CICS DB2 table. Rows can be read from the beginning ofthe table or from a specific key based on any existing index. Rows can also beread continuously or individually. When a key value is specified it is taken as astring unless it is in the format #n, where n is a numeric value. The following

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

42 de 179 03/03/12 14:46

Page 43: Com an Dos

format can be used for a hexadecimal representation of the key:

0x0a01 ...

If the read is not continuous you have the option to delete or update each rowread. If nothing is entered for a column during an update the column is leftunaltered, otherwise data entry is same as for the write command. The readcommand will only show up to 44 bytes of column data and should thereforenot be used to check the data integrity of tables containing long columns. Thedtof command is more suitable for this.

cicsddt -s cicstest -c r cics.qsamtest

[Index To Use ...............: QSAMTEST0[Read From Beginning ? [Y]/N : Y[Continuous Read ? Y/[N] ....: N

[Read #00000001[F1 ][KEY0001... ][000010] [Hex][4B455930303031000000 ][F2 ][Data providing information about KEY0001 ][000040] [Hex][446174612070726F766964696E6720696E666F726D6174 ]

[Read Another, Delete or Update ? [Y]/N/D/U n

[1 Record(s) Read]

DDT commands - write

(w)rite tableName

Writes rows to a CICS DB2 table. Text or hexadecimal data can be entered ineach column; these cannot be mixed. Hexadecimal is entered in the followingform:

0x010203 ...

If the column is long and you need to enter a large amount of data, a shorthandmethod can be used. For example, to fill the remainder of a column with 33 'A'characters enter:

A>>32

or enter

0x20>>32

for 33 spaces.

You must enter something in at least one of the columns in the row for DDT towrite a complete row; if all are left blank no row will be written. If A>>32would exceed the column length the string "A>>32" is taken literally.

cicsddt -s cicstest -c -w qsamtest

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

43 de 179 03/03/12 14:46

Page 44: Com an Dos

[F1 ][ CHAR ][ Size:00010][KEY0000002[F2 ][ VARCHAR ][ Size:00100][This the data that comes with KEY 2

[Another ? [Y]/N n

[1] Record(s) Added OK.

DDT commands - empty

(e)mpty tableName

Empties a table of all committed rows.

cicsddt -s cicstest -c empty qsamtest

[Empty Table "CICS.QSAMTEST" ? Y/[N] y

DDT commands - delete

(d)elete tableName

Deletes a table from the CICS DB2 database.

cicsddt -s cicstest -c delete qsamtest

[Delete Table "CICS.QSAMTEST" ? Y/[N] y

DDT commands - addindex

(a)ddindex tableName

Adds a secondary index to the CICS DB2 table. Typing q! will cancel thecommand.

cicsddt -s cicstest -c a angus

[Secondary Index Name........: index2[Index Col. 01: Column Name .: f2[Index Col. 01: Ordering ....: a[scending][Index Col. 02: Column Name .:

DDT commands - delindex

(deli)ndex tableName

Deletes a secondary index from the CICS DB2 table.

cicsddt -s cicstest -c delindex angus

[Secondary Index Name........: index2

DDT commands - info

(i)nfo tableName

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

44 de 179 03/03/12 14:46

Page 45: Com an Dos

Shows detailed information about the DB2 table.

cicsddt -s cicstest -c i angus[Information For Table: CICS.ANGUS ]------------------------------------------------------------------[Table Organization ] Key-Sequenced (KSDS)[Primary Index Name ] ANGUS0 (Unique index)[Primary Index Column(s) ] F1[Secondary Index Names ] (None defined)[Number Of Records In Table ] 0[Number Of Columns Per Row ] 3[Column 001: F1 ][CHAR ][Size: 5][Column 002: F2 ][CHAR ][Size: 5][Column 003: F3 ][CHAR ][Size: 5]------------------------------------------------------------------

DDT commands - database

(da)tabase databaseName

Drops the current DDT database connection and attempts to connect to a newDB2 database. If the new connection fails DDT will reconnect to the olddatabase.

cicsddt -s cicstest -c da sample

ERZ037070I/0740: Contacting database ...ERZ037172I/0738: (Database OK)

DDT commands - user

(u)ser userName,password

Reconnects to the current DB2 database with the new user. If connection withthe new user fails, DDT reconnects with the old user and password.

cicsddt -s cicstest -c u acooke,jg8wq9z

ERZ037172I/0738: (Database OK)

DDT commands - qtod

(qt)od QSAMfileName

Transfers and converts a QSAM table to a DB2 table.

cicsddt -s cicstest -c qtod qsam

[Default Code Pages: EBCDIC (IBM-037) -> ASCII (ISO8859-1) ...

[Transferring Records. Record No.][00000022]

DDT commands - dtof

(dt)of DB2tableName

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

45 de 179 03/03/12 14:46

Page 46: Com an Dos

Transfers a CICS DB2 table to a flat table. The format of the flat file can eitherbe DDT format or Asis (the table is transferred byte by byte as it is). In DDTformat the flat file starts with a header containing information on the structureof the table, followed by an end-of-header marker. The remainder of the flat filecontains the actual records that are in the format: a newline character,followed by an eight-byte ASCII number, followed by the actual data. Thenumber is the length of the row excluding the number itself. If the table istransferred Asis, no extra information is contained in the flat file. A singlerecord or a range of records can be dumped. The record number correspondsto the position of the row using the primary index. To dump row 10 enter 10 atthe [Dump Row(s)] prompt. Type 10- to dump rows from 10 onwards andtype 10-12 to dump rows 10 to 12 inclusive.

cicsddt -s cicstest -c dtof CICS.RRDS

[Flat Filename ..............: CICS.RRDS.ddt[Dump table Asis ? .... Y/[N]: N[Dump Row(s) ................: ALL

[Dumping All Rows][Dumping Row #][00000003]

DDT commands - ftof

(f)tod DB2tableName

Transfers a flat table produced from the dtof command to a CICS DB2 table. Ifthe flat table is not in DDT format then dtof will still attempt to transfer thefile as normal text or binary. If the DB2 table does not exist and the flat file isin DDT format, DDT will ask you if you want the file to be created. DDT alsoreads and transfers flat files created by cicssdt (in SDT format).

cicsddt -s cicstest -c f CICS.RRDS

[Flat Filename ..............: CICS.RRDS.ddt

[Loading Record #][00000003]

DDT commands - !

!

Escapes to a system command prompt. Exiting from the command promptreturns control to DDT.

cicsddt -s DB2name -c !

[Exit To Shell. Use <Ctrl-D> To Return .....

ls q* (Open Systems)dir q*.* /w (Windows)qsam qsam.dfh qsamTest qsamcsd.ddt.def qsam.conv qsam.log qsamcsd qsamcsd.ddt.logqsam.def qsam.ddt.def qsamcsd.dfh qtest

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

46 de 179 03/03/12 14:46

Page 47: Com an Dos

DDT commands - quit

Exits DDT and returns control to the calling process.

(q)uit

cicsddt -s cicstest -c q

DDT commands - help or ?

(h)elp (or ?) commandName

Gives general or specific online help for DDT commands.

cicsddt -s cicstest ? create

DDT commands - QSAM to DB2 file transfer

The purpose of this section is to help you understand how to transfer QSAMfiles from a IBM mainframe-based CICS system to a CICS on Open Systemssystem (the target system).

When a file is sent directly to a target system, record boundaries are lost whenit is received. By capturing the file on TSO or CMS in netdata format andsending it as a binary file to the target system using the File Transfer Program(ftp), the original netdata format is preserved.

The cicsnetdata program is used to read the file and re-construct the outputrecords with the count preceding each record, as expected by the cicsddtqtod command.

If a file is in netdata format, you will find that control records INMR01,INMR02, INMR03 precede the data, and INMR06 follows the data; thesenames are in EBCDIC. All input (control records and data) is segmented. Thefirst byte of a segment contains the segment length, including itself. Thesecond byte of the segment contains a flag byte. The flag settings are:

0x80 first segment0x40 last segment0x20 segment is part of a control record

To transmit a file from TSO:

Enter: TRANSMIT (nodeName/userId) DSN(data.file) OUTDSN(data.NETDATA)SEQ

TRANSMIT can be abbreviated to XMIT.

nodeName/userId is required syntactically. Although it is not used whentransmitting to a file, it is validated, so specify a known node and userid.

DSN names the input to XMIT.

1.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

47 de 179 03/03/12 14:46

Page 48: Com an Dos

OUTDSN names the output netdata file. The type NETDATA is suggested.

If the input was a PDS member, then SEQ is required, or the file will not beusable on the target system. The name of utility function must be INMCOPY forcorrect results (see sample messages below).

Enter: ftp systemName

where systemName is the name of the target system.

Enter userid and password when prompted.

2.

Enter: cd directoryName

to change to the target directory if necessary.

3.

Enter: binary

to set the transmission type to I (image).

4.

Enter: put data.NETDATA

The target file name can also be specified, if different from the source. Make anote of the byte count, which should be the same for the file on the targetsystem. The target system keeps the name in lower case, even though it wasupper case in TSO.

5.

To transmit a file from CMS:

Enter: sendfile dataFile TO *

to send the file to your reader in netdata format. Do not RECEIVE it, becauseRECEIVE will decode the netdata. Use CP commands to ORDER it andCHANGE its CLASS to suit the reader. Define a temporary disk if the file islarge.

1.

Enter: read data NETDATA A to read the file and preserve the netdata format.2.Enter: ftp systemName

systemName is the name of the target system.

Enter userid and password when prompted.

3.

Enter: cd directoryName

to change to the target directory if necessary.

4.

Enter: binary

to set the transmission type to I (image).

5.

Enter: put data.NETDATA6.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

48 de 179 03/03/12 14:46

Page 49: Com an Dos

The target file name can also be specified, if different from the source. Make anote of the byte count, which should be the same for the file on the targetsystem. The target system keeps the name in lower case, even though it wasupper case in CMS.

To run the cicsnetdata program:

cicsnetdata < data.netdata > outputFileName

Messages from a sample run of cicsnetdata (origin CMS)

... control record: INMR01

... logical record length 80

... origin node name WINVMB

... origin userid BAILEYM

... target node name WINVMB

... target userid *

... origin time stamp 19931029164640000000

... no of files 1

... control record: INMR02

... file number 1

... file size in bytes 2048

... file organization 4000

... logical record length 80

... name of utility function INMCOPY

... record format 8000

... name of the file A DATA FILE

... filemode number0

... last change date 19920611095242000000

... control record: INMR03

... file size in bytes 2048

... file organization 4000

... logical record length 80

... record format 0001

... control record: INMR06

... 22 input records

... 4 control records

... 18 output records

Definition files used by qtod:

In addition to the QSAM data file produced by the cicsnetdata program there mustbe two other definition files for a successful conversion:

QSAMfileName.ddt.def

This file must be in the same directory as the QSAM data file. It contains thekey and data information about each QSAM record.

The sample file qsam.sdt.def, describes what each tag means. A sample data filecan be found in prodDir/src/examples/sdt. The file must be renamed to qsam.ddt.deffor qtod to pick it up. The tag SFSFile=qsamtest must also be changed toDB2File=CICS.QSAMTEST.

QSAMfileName.dfh

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

49 de 179 03/03/12 14:46

Page 50: Com an Dos

This file must also be in the same directory as the QSAM data file and is theDFHCNV template source for the QSAM records. DDT will not validate this fileso it is recommended that the file is checked using the cicscvt program first.DDT only understands the source, not the compiled output from cicscvt. Thesample file qsam.dfh shows a typical template.

To run qtod:

A sample QSAM data file qsam.netdata has been provided to demonstrate QSAM toDB2 conversion using the qtod command. The following describes the stepsnecessary to convert this example:

Convert qsam.netdata to DDT-readable format using the cicsnetdata program asfollows:

cicsnetdata < qsam.netdata > qsam

to produce a file called qsam in the current directory.

1.

Create a suitable DB2 table to receive the QSAM records. For this example,enter

cicsddt -s DB2name -c create qsamTest

2.

Make sure you have the following files in a directory you can write to:

qsamqsam.dfhqsam.ddt.def

The default code pages for conversion are defined at the top of the tableqsam.dfh; these may have to be changed, depending on your operating system.

3.

Run cicsddt so that it is working with the database that hasCICS.QSAMTEST on it, Enter:

cicsddt -s DB2name -c qtod qsam

The file qsam must be in the current directory. DDT will show a running count ofthe records being transferred. If an error occurs the table must be emptiedbefore it is reloaded.

4.

When the command has finished the DDT prompt should reappear and a logfile will have been created in the current directory. The file will be calledqsam.ddt.log in this example. Check this log file to make sure DDT picked up allthe record types and there were no conversion errors.

5.

cicsdefault - Create a copy of the default region

AIX HP-UX Sun Solaris Windows

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

50 de 179 03/03/12 14:46

Page 51: Com an Dos

X X X X

The purpose of the cicsdefault command is to allow you to restore an archive copyof the resource definitions from the default CICS region.

Syntax

cicsdefault -r regionName [-g groupId] [-v] [-S] [-F]

cicsdefault -?

Description

You must be logged on as a user with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).If you are using DCE authentication you must have a DCE context that hassufficient authority to:

Create a DCE principal and accountCreate a Server Key Table.

Usually this is a DCE cell administrator.

The cicsdefault command restores the resource definitions from the default CICSregion to your new region. You run cicsdefault from the operating systemcommand line. The resource definitions that cicsdefault restores are:

All configuration files except those defining the SFS. These will have to bereconfigured.All resource definitionsConversion templatesAll programsAll mapsAll Java classesThe contents of the region's data directory.

The region environment and region properties files are not restored. You areprompted for your DCE password if you are using DCE authentication.

Options

-r regionis the name of the new region. Do not use underscores or the word "stanza" inthe region name.

-g groupIdis the name of the operating system's groupId with which all files of the newregion are created. The default groupId is cics (Open Systems) or cicsgroup(Windows).

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

51 de 179 03/03/12 14:46

Page 52: Com an Dos

-v(verbose) lists the files as they are restored.

-Scauses the new region to be set up without using DCE servers. The RegionDefinitions (RD) attributes NameService and AuthenticationService will beset to none and CICS respectively.

-Fforces the region to be overwritten if the region already exists, but does notrecreate DCE and the entries in the operating mechanism used for starting andstopping long running processes if they already exist.

-?causes the usage message to be displayed.

Examples

To create region REGION1:

cicsdefault -r REGION1

1.

To overwrite the resource definitions of REGION2, when REGION2 already exists:

cicsdefault -r REGION2 -F

2.

cicsdefaultservers - Create default resource filesfor servers

AIX HP-UX Sun Solaris Windows

X X X X

Creates the default resource files for the SFS, SFS schemas, and PPC gatewayservers (Open Systems), and for the SFS schemas (Windows).

Syntax

cicsdefaultservers [ -s | -c | -p ]

Description

cicsdefaultservers creates the following default resource files for the:

SFS/var/cics_servers/SSD/SSD.stanza

schema/var/cics_servers/SCD/SCD.stanza

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

52 de 179 03/03/12 14:46

Page 53: Com an Dos

gateway/var/cics_servers/GSD/GSD.stanza

These files are owned by cics and, on Open Systems, have the permissions-rw-rw----. If no flags are specified, files are created for the SFS, schemas and, onOpen Systems, gateway servers. Run this command as root or administrator andonce per machine after CICS has been installed for the first time.

Options

-screates the default SFS resource file (SSD.stanza).

-ccreates only the default schema resource file (SCD.stanza).

-pcreates only the default PPC gateway resource file (GSD.stanza).

Examples

To create the SFS and schema resource files on one machine, enter:

cicsdefaultservers -s -c

cicsdelete - Delete CICS resource definitions

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to delete existing CICS resource definitions.

Syntax

cicsdelete -c className [-r regionName] [-P | -R | -B] [-f fileName] resourceName[resourceName ... ]

cicsdelete -?

Description

The Resource Definition Online (RDO) command cicsdelete deletes one or moreresource definitions of a given class from the permanent resources database, andcan delete them from the runtime database.

Caution:Stopping the command before completion can result in a damageddatabase.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

53 de 179 03/03/12 14:46

Page 54: Com an Dos

After you delete a resource definition, you cannot recover it. Each resource deletionis atomic. For example, suppose you try to delete three resource definitions with asingle command. The first two resource definitions are deleted successfully, but thethird resource definition deletion fails. The command abnormally terminates, but ithas still successfully deleted the first two resource definitions. These two definitionsare not recovered. The command returns 0 if the command completes successfully, 1otherwise.

Options

-c classNamedetermines the resource class from which the resource definition is to bedeleted, and is one of these two- or three-character codes:

cdCommunication

fdFiles

gdGateways

gsdGateway Servers

jdJournals

ldListeners

odObjects

pdPrograms

scdSFS Schemas

ssdSFS Servers

tdTransactions

tddTransient Data Queues

tsd

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

54 de 179 03/03/12 14:46

Page 55: Com an Dos

Temporary Storage Queues

udUsers

wdTerminals

xadProducts

Resource classes rd (Region definition) and md (Monitoring definitions) cannotbe deleted.

-r regionNamespecifies the region from which the resource definition is deleted. If you do notspecify a region name, CICS deletes the resource definitions from the regionspecified by the CICSREGION environment variable.

The -r parameter is invalid if you specify gsd, scd, or ssd as the resourceclass, because these classes are associated with a collection of regions ratherthan with a specific one.

-f fileNamespecifies the name of the file that contains the schema definitions. This flag isvalid only when you specify scd (SFS schema definitions) as the resource class.

-Pinstructs the command to delete the resource definitions from the permanentdatabase without uninstalling them from the runtime database. This is thedefault option if you do not specify either the -P, -R, or -B options.

-Rinstructs the command to uninstall the resource definitions from the runningsystem and delete them from the runtime database. If you are using DCEauthentication, you must be authenticated as a DCE principal before runningthe command with this flag.

The -R flag is invalid if you specify gsd, scd, or ssd as the resource class,because these classes are associated with a collection of regions rather thanwith a specific region.

-Binstructs the command to delete the resource definitions from the permanentdatabase, uninstall them from the running system, and delete them from theruntime database. If you are using DCE authentication, you must beauthenticated as a DCE principal before running the command with this flag.

The -B flag is invalid if you specify gsd, scd, or ssd as the resource class,because these classes are associated with a collection of regions rather than

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

55 de 179 03/03/12 14:46

Page 56: Com an Dos

with a specific region.

resourceNameis the name of a resource definition to be deleted.

-?causes the usage message to be displayed.

Examples

To remove terminals T001 and T002 from the runtime database only in regionREGION5:

cicsdelete -c wd -r REGION5 -R T001 T002

1.

To remove transient data queues TDQUEUE1 and TDQUEUE2 from the permanent andruntime databases in region REGION6:

cicsdelete -c tdd -r REGION6 -B TDQUEUE1 TDQUEUE2

2.

cicsdestroy - Destroy a CICS region

AIX HP-UX Sun Solaris Windows

X X X X

The purpose of the cicsdestroy command is to allow you to destroy an existingCICS region.

Syntax

cicsdestroy -r regionName [-s] [-I]

cicsdestroy -?

Description

You must be logged on as a user with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).If you are using DCE authentication you must have a DCE context that hassufficient authority to:

Create a DCE principal and accountCreate a Server Key TableAdminister the file system for the region (if you want to use the -s flag)

Usually this is a DCE cell administrator.

The cicsdestroy command destroys the specified region in the following way:

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

56 de 179 03/03/12 14:46

Page 57: Com an Dos

All operating system files associated with the region are destroyed.

If you specify the -s option, the TSQ, TDQ, and local queue files for the region aredeleted on the relevant file systems.The servers must be available and you must belogged in to DCE with sufficient authority to perform the deletions.

cicssrcdestroy deletes the region used for managing CICS processes. However, ifthe directories and files of the CICS region have been deleted before thecicsdestroy command is issued, the SRC entries for the region are not removed.

If you are using DCE authentication,you are logged in to DCE, and you havesufficient authority, the region principal, region account and CDS directories for theregion are deleted.

Note:Although cicsdestroy deletes the DCE principal and account for the regionuserid, it does not delete the DCE principals and accounts for the users of thisregion. If these users are not required for other regions, the DCE principalsand accounts may be deleted using DCE facilities.

When you use cicsdestroy, you are prompted for your DCE password if you areusing DCE authentication.

Options

-r regionNamespecifies the region to be destroyed.

-sspecifies that region-owned data in the file system used is also to be destroyed.

-Iignore errors.

-?causes the usage message to be displayed.

Examples

To destroy a region without destroying its file system data:

cicsdestroy -r REGION1

1.

To destroy a region together with its file system data:

cicsdestroy -r REGION1 -s

2.

cicsdfmt - Dump formatter

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

57 de 179 03/03/12 14:46

Page 58: Com an Dos

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to extract data from a dump file or files that CICS creates as partof a CICS dump sequence. The command formats the CICS dump into a form thatcan be written to the operating system standard output.

Syntax

cicsdfmt [ [-r regionName] [fileName] | directoryName | fileName |-p [-r regionName] [dumpFileName] ]

cicsdfmt -?

Description

If you do not specify any parameters, the cicsdfmt command lists the dump fileslocated beneath the default region's dump directory, and sends some explanatorytext about how to use the command to the operating system standard errordestination.

If you specify a region and the name of a dump file, the cicsdfmt commandgenerates the full path of the dump directory for the region, extracting a value forthe dump directory from the Region Definitions (RD). It searches in thesubdirectories of the dump directory for the named dump file.

If you specify a filename alone, the cicsdfmt command searches the subdirectoriesof several locations, in the following order, to check whether the named dump fileexists:

The current directory1.The parent of the current directory2.The default region's dump directory3.

If the named dump file does not exist, the cicsdfmt command sends an errormessage to the standard error output. If the named dump file exists, it formats alldump files with this name to standard output.

Note:If a dump produced by cicsdfmt contains lines greater than 2048 bytes, sometext editors cannot be used. For example, on CICS on Open Systems, youcannot use the vi editor to examine such dumps, but you can use:

cat fileName | fold newName (This converts all the lines to 80 characters to allownormal use of vi.)more fileName

pg fileName

emacs, if available

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

58 de 179 03/03/12 14:46

Page 59: Com an Dos

Options

-r regionNamespecifies the region to use. The cicsdfmt command generates the full path ofthe dump directory for the region regionName, extracting a value for the dumpdirectory name from the Region Definitions (RD). The cicsdfmt commandchecks that regionName is valid. If regionName is invalid, it sends an errormessage to the standard error stream. If you specify fileName as well asregionName, the request formats the dump file fileName for the specifiedregion. If you do not specify fileName, the request lists all the dump files forregion regionName.

If you do not specify a region name, CICS processes dumps for the regionspecified by the CICSREGION environment variable.

fileNamespecifies the base name of the file or set of files to be formatted to standardoutput.

If you specify the fileName and -r regionName options, the cicsdfmtcommand formats only the dump files contained in the specified region. Youcan specify filename with a relative or absolute path. A dump can be containedin more than one file, but the files all share the same base name; supply thebase name to this command.

Note:The suffix of the filename must not be entered.

The format of the name of the dump file is aaaannnn, where nnnn is the dumpsequence number that CICS increments each time a dump is performed, andaaaa is a prefix to denote how the dump arose. The prefix takes the followingvalues:

ASRAFrom an ASRA abnormal termination.

ASRBFrom an ASRB abnormal termination.

SYSAFrom a SYSA abnormal termination.

SHUTFrom a shutdown request.

SNAPFrom a CEMT PERFORM SNAP DUMP request.

A four letter dumpcodeFrom an EXEC CICS DUMP command.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

59 de 179 03/03/12 14:46

Page 60: Com an Dos

A four letter abnormal termination codeFrom an EXEC CICS ABEND command or from a transaction abnormaltermination initiated by CICS.

directoryNamelists the dump files located in the subdirectories of a specified directory. Youcan specify directoryName as a full or relative pathname.

-p [dumpFileName]removes all dump files specified by the dumpFileName parameters. ThedumpFileName is the base name of the file or set of files that you want toremove. You can specify dumpFileName with a relative or absolute path. Adump can be contained in more than one file, but the files all share the samebase name; supply the base name to this command.

If you do not specify a dumpFileName parameter, the cicsdfmt command liststhe specified files, requests confirmation that all the files are to be deleted,and, if confirmed, removes the files.

If you specify -p with a dumpFileName parameter, the specified dump files aredeleted without requesting confirmation.

-?provides you with a help facility showing the correct syntax for the command.cicsdfmt also displays the correct syntax if you enter the command syntaxincorrectly.

Examples

To list all dump files located in directory /u/dumpdir:

cicsdfmt /u/dumpdir

1.

To list all dump files for region REGIONA:

cicsdfmt -r REGIONA

2.

To format all dump files with a base name of shut001 that are located in thecurrent directory, the parent of the current directory, or the default region'sdump directory:

cicsdfmt shut001

3.

To remove all dump files with a base name of shut001:

cicsdfmt -p shut001

4.

To format a dump for a specific region:

cicsdfmt -r REGIONA shut001

5.

To remove all of the dump files for a region:

cicsdfmt -r REGIONA -p

6.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

60 de 179 03/03/12 14:46

Page 61: Com an Dos

cicsexport - Export CICS resource definitions

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to make an archive copy of all the resource definitions in anexisting CICS region. Using the cicsexport command with the cicsimportcommand lets you either create a new region as a copy of an existing region, orcreate an archive that you can unpack to create an arbitrarily named region. Thisprocess lets you transfer regions across machines, possibly on distinct networks.

Attention:This command creates a copy of the region in the /var/cics_regions directory (forCICS on Open Systems) or in the \var\cics_regions directory (for CICS forWindows). Before you use this command, verify that you have enough space forthe copy in the directory.

Syntax

cicsexport [-r regionName] [-o outFile] [-l className...]

cicsexport -?

Description

The cicsexport command copies the resource definitions from an existing CICSregion. To run cicsexport from the command line, you must be logged in as a userwith root or administrator privileges and be a member of the group cics (CICS onOpen Systems) or cicsgroup (CICS for Windows). The cicsexport command copiesthe following definitions:

All configuration files except those defining the SFS server. These have to bereconfigured.All resource definitionsConversion templatesAll programsAll mapsAll Java classesThe contents of the region's data directory.

Note:If you install maintenance on CICS or a new version of CICS, the existingDEFAULT archive file is overwritten, including any alterations you made to it.

To migrate an exported region, you must import it, migrate it by using thecicsmigrate -r command, and then reexport it. The region can then be imported

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

61 de 179 03/03/12 14:46

Page 62: Com an Dos

successfully as required.

Options

-r regionNamespecifies the existing region from which the cicsexport command copiesresource definitions. If you do not specify a region name, CICS copies theresource definitions from the region specified by the CICSREGIONenvironment variable.

-l className (CICS on Open Systems only)permits the archive copy to be generated in a form that creates symbolic linksfor the specified resource definition files. The className can be one entry or acomma-delineated string of several entries from the following:

cdCommunication

fdFiles

gdGateways

jdJournals

ldListeners

mdMonitoring

pdPrograms

odObjects

rdRegions

tdTransactions

tddTransient Data Queues

tsdTemporary Storage Queues

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

62 de 179 03/03/12 14:46

Page 63: Com an Dos

udUsers

wdTerminals

xadProducts

-o outFilespecifies the output file to which the cicsexport command writes the archivecopy of the resource definitions, in Copy In and Out (cpio) format. If you do notspecify the -o flag, cicsexport writes the file to standard output.

-?causes the usage message to be displayed.

Examples

To export the region REGION1:

cicsexport -r REGION1

1.

To export the region REGION2, placing symbolic links for the file and programdefinitions:

cicsexport -l fd,pd -r REGION2

2.

cicsget - Get CICS resource definition information

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to inquire about existing CICS resource definitions.

Syntax

cicsget -c className [-r regionName] {-l | -s [resourceName] | [resourceName]}

cicsget -c scd [-f fileName] {-l | -s resourceName | resourceName}

cicsget -?

Description

The Resource Definition Online (RDO) command cicsget retrieves resourceattributes of a specified class from the permanent resources database so that youcan query on their status. Output from cicsget is written to standard output.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

63 de 179 03/03/12 14:46

Page 64: Com an Dos

Do not specify the resourceName for the Region Definitions (RD) and theMonitoring Definitions (MD). However, you must specify it for all other resourcetypes.

The -l and -s options are mutually exclusive.

Options

-c classNamedetermines the resource class from which the resource definition is to beretrieved, and is one of these two- or three-character codes:

cdCommunication

fdFiles

gdGateways

gsdGateway Servers

jdJournals

ldListeners

mdMonitoring

odObjects

pdPrograms

rdRegions

scdSchema File Definitions

ssdSFS Servers

tdTransactions

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

64 de 179 03/03/12 14:46

Page 65: Com an Dos

tddTransient Data Queues

tsdTemporary Storage Queues

udUsers

wdTerminals

xadProducts

-r regionNamespecifies the region from which the command retrieves the resource attributes.If you do not specify a region name, CICS retrieves the resource attributesfrom the region specified by the CICSREGION environment variable.

The -r parameter is invalid if you specify gsd, scd, or ssd as the resourceclass, because these classes relate to the servers rather than to the regions.

-scauses a list of attribute names and attribute values to be written to standardoutput. The information is written as two lines of information. The first line,which begins with a number sign (#), is a list of attribute names separated bycolons (:). The second line contains all the corresponding attribute values, alsoseparated by colons. The cicsget command appends the word region to theend of the first line, and appends the region name to the end of the secondline. Specify the resourceName for all classes except the region andmonitoring classes.

-lcauses a list of all resources and their descriptions for a given class to bewritten to standard output.

resourceNameis the name of the resource definition to be retrieved. You must specify aresourceName for all classes except rd and md. To retrieve the attributes forthe default definition, use "" as the value. This attribute without the -s flagresults in a list of attributeName=attributeValue pairs being written tostandard output.

-f fileNamespecifies the file containing the resource definitions. Use this attribute onlywhen retrieving data for the Schema File Definitions (SCD). The class scd mustbe used when specifying the filename.

-?

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

65 de 179 03/03/12 14:46

Page 66: Com an Dos

causes the usage message to be displayed.

Examples

To inquire about the definition attributes for the temporary storage queueTSQUEUE1 in the region REGION7:

cicsget -c tsd -r REGION7 TSQUEUE1

1.

To inquire about the users in the region REGION8 and write the details as a list tostandard output:

cicsget -c ud -r REGION8 -l

2.

cicsgetbindingstring - Get binding string forregion or Encina server

AIX HP-UX Sun Solaris Windows

X X X X

The purpose of the cicsgetbindingstring command is to display the binding stringused to contact a given CICS region or Encina SFS or PPC Gateway server when theDCE directory service is not being used.

Syntax

cicsgetbindingstring { regionName | serverName }

cicsgetbindingstring -?

Description

The environment variable CICS_HOSTS must have the same value as it does whenCICS components and Encina servers are started. Otherwise the results displayedmay not correctly represent the endpoints used by CICS.

This command searches the DCE RPC daemons for information about regions andservers. It will search the daemons on the machines that are specified by theenvironment variable CICS_HOSTS or those on the current machine if CICS_HOSTSis not set. If none of the daemons on the specified machines has information aboutthe region or server, a final check is made in the file /var/cics_servers/server_bindingsfor any binding that may have been entered there.

Note that cicsgetbindingstring displaying a binding string does not guaranteethat a region or server is currently active and available on the given endpoint.Rather it represents the endpoint that will be used by CICS processes whenattempting to contact the region or server in the absence of the DCE directory

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

66 de 179 03/03/12 14:46

Page 67: Com an Dos

service. Normally however this will indeed be an active process.

In the case of Encina SFS and PPC Gateway servers the binding string returned bycicsgetbindingstring may be used in place of the server name when using Encinafacilities for manipulating the servers. This is especially important when usingtkadmin, sfsadmin or ppcadmin with servers operating without the DCEdirectory service. Specifying the server name in such cases will not enable Encinato locate the server concerned (unless the environment variableENCINA_BINDING_FILE is set to the name of a file containing a mapping betweenthe server name and a binding string, for example, the file /var/cics_servers/server_bindings). On the other hand the string binding may be freely used in place ofthe server name and Encina will then be able to locate the server.

Options

regionNameis the name of a CICS region on one of the machines specified by theenvironment variable CICS_HOSTS or on the current machine if CICS_HOSTSis not set.

serverNameis the name of an Encina SFS or PPC Gateway server on one of the machinesspecified by the environment variable CICS_HOSTS or on the current machineif CICS_HOSTS is not set

-?causes the usage message to be displayed.

Examples

To find the binding string that will be used by CICS to contact the CICS regionREGION1 running on machine BLUE, enter

export CICS_HOSTS=BLUEcicsgetbindingstring REGION1

1.

To find the binding string that will be used by CICS to contact the Encina SFSserver /.:/cics/sfs/SERVER1 running on one of the machines RED, BLUE or GREEN, enter

export CICS_HOSTS="RED BLUE GREEN"cicsgetbindingstring /.:/cics/sfs/SERVER1

2.

To get a list of files on the Encina SFS server /.:/cics/sfs/SERVER1 running onmachine BLUE

export CICS_HOSTS=BLUEsfsadmin list files -server $(cicsgetbindingstring /.:/cics/sfs/SERVER1)

3.

cicsgpid - Get region process identifier

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

67 de 179 03/03/12 14:46

Page 68: Com an Dos

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to determine the process identifier of the main CICS process.

Syntax

cicsgpid [-r regionName]

cicsgpid -?

Description

cicsgpid determines the process identifier of the main CICS process. Only theusers cics and root have the authorization to issue this command.

Options

-r regionNamespecifies the region name. The cicsgpid command checks that regionName isvalid. If regionName is invalid, cicsgpid writes an error message to thestandard error stream.

If you do not specify a region name, CICS determines the process identifier forthe region specified by the CICSREGION environment variable.

-?provides you with a help facility showing the correct syntax for the cicsgpidcommand. If you enter the command syntax incorrectly, the correct syntax isdisplayed.

Examples

To determine the process identifier for the CICS region REGIONB:

cicsgpid -r REGIONB

cicshpterm - 3270 terminal emulator

AIX HP-UX Sun Solaris Windows

X

Invokes the CICS 3270 Terminal Emulator, from the operating system, so that youcan connect to a CICS region.

Note:The syntax for cicshpterm is identical to that of cicsterm (see cicsterm -

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

68 de 179 03/03/12 14:46

Page 69: Com an Dos

Invoke the CICS 3270 terminal emulator). Once cicshpterm performs theconfiguration steps outlined under "Description", it invokes cicsterm. All thedescription given for cicsterm is equally valid for cicshpterm.

Syntax

cicshpterm [-r regionName] [-n netName | -m modelId] [-t transId][-A [animatorTTY] [-T animatorTERM]

cicshpterm -?

Description

You need access to a terminal or window that can access a machine in the DCEcell in which the CICS region is defined. Your terminal must either be suitablefor autoinstall, or have an entry in the NetName attribute in the TerminalDefinitions (WD).

1.

Your window must contain at least 12 lines, so that the terminal emulator candisplay a menu of region names when necessary. A menu of region names isdisplayed if you do not specify a region when you invoke the CICS 3270Terminal Emulator. The 12 lines are needed to display various headers, PF keylegends, blank space, and at least one region name so that you can scrollthrough the list of available regions. If the window contains less than 12 lines,there is an error message and the terminal emulator terminates abnormally. Itis recommended that you use a window with 25 lines.

2.

If you are using DCE authentication, you must be authenticated as a DCEprincipal, as explained under "Description". A DCE ticket is allocated when theDCE principal authenticates with the DCE security service. Tickets have alimited lifetime; 10 hours by default. If a ticket expires while the client isactive, the client is terminated and any in-flight transactions are terminatedabnormally. DCE accounts may have their ticket lifetime changed.

3.

You must be authorized to run the transactions that you specify. That is, the UDentry for the userid you are using must have the TSL and RSL keys listed in itthat allow you to access the transactions that you want to run. This isdescribed in the CICS Administration Guide.

4.

The cicshpterm command is an intelligent cicsterm wrapper that automaticallyexamines your environment and configures cicsterm for the maximum functionalitypossible within your environment. If you use cicsterm alone, you are required toperform these configuration steps manually.

cicsterm command, cicshpterm checks whether or not your environment iscapable of displaying a window on a graphics terminal.

If your environment is capable of displaying a window on a graphics terminal,cicshpterm creates an hpterm window that runs cicsterm. The cicstermcommand is run using a high-function terminal model and a customized hptermwindow that provides 24 programmed softkeys and full color capabilities. Thecharacteristics of the hpterm window created by cicshpterm are defined in the X

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

69 de 179 03/03/12 14:46

Page 70: Com an Dos

resources file /opt/cics/etc/cicshpterm.resources. The key mapping file applied is/opt/cics/etc/3270keys.hpterm.

If your environment is not capable of displaying a window on a graphics terminal,cicshpterm determines whether you are running on a terminal or emulation that itsupports. For the supported terminals and emulations, cicshpterm configures yourenvironment for the maximum functionality possible. In these cases, cicsterm runsin monochrome mode with 8 or 16 programmed soft keys.

The following table lists the terminal models recognized by cicshpterm and the3270 key mapping file located in /opt/cics/etc that is applied for each model:

Terminal type supported Associated keymap file

HP 2392A, HP 2394A, 3270keys.hp

HP 700/92, HP 700/94, HP 700/96, HP700/98

3270keys.hp

hpterm terminal emulator (non-graphicsmode)

3270keys.hp

hpterm terminal emulator (graphicsmode)

3270keys.hpterm

VT100/ VT200 3270keys.vt100

If cicshpterm does not recognize your terminal/emulation, it makes no changes toyour environment. The keymap file applied is /opt/cics/etc/3270keys.

The cicshpterm command defaults the correct cicsterm model (-m) parameter forits supported terminals whenever the cicsterm netname (-n) parameter is notspecified. You can override this default by specifying a terminal model using the -mparameter.

Options

-r regionNamespecifies the name of the CICS region to which you wish to attach. If you donot specify a regionName, CICS displays an interactive menu of availableregions that you can select from. If there are no regions available, CICSdisplays an error message. You must confirm this message by pressing ENTERbefore CICS terminates the CICS 3270 Terminal Emulator.

-t transIdspecifies the transaction identifier of the transaction to run after TerminalEmulator initialization.

-n netNamespecifies the name of the netName to use for installation. To install as aparticular terminal, specify the netName of the required terminal. If you omitthe netName, then cicshpterm autoinstalls, and a unique netName is

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

70 de 179 03/03/12 14:46

Page 71: Com an Dos

generated in the region.

-m modelIdspecifies the name of the DevType to use for autoinstallation. See Processing.

-A animatorTTYspecifies the name of the device for Animator stdin/stdout. If you specify the-A, option without a value, and you are using X Windows, cicshpterm willcreate a window for use as the Animator console.

-T animatorTERMspecifies the name of the TERM type of the Animator terminal.

-?causes the usage message to be displayed.

Examples

To display the syntax for accessing CICS:

cicshpterm -?

1.

To access CICS and log on to the region region1:

cicshpterm -r region1

2.

To start a terminal with the NetName BlueTerm in its Terminal Definitions onregion region1:

cicshpterm -n BlueTerm -r region1

3.

If you want to log on to a different userid after you have started cicshpterm:

cicshpterm -r region1 -t CESN

4.

cicsimport - Import CICS resource definitions

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to restore an archive copy of the resource definitions from anexisting CICS region. Using the cicsimport command with the cicsexportcommand lets you either create a new region as a copy of an existing region, orcreate an archive that you can unpack to create an arbitrarily named region. Thisprocess lets you transfer regions across machines, possibly on distinct networks.

Syntax

cicsimport -r regionName [-g groupName] [-i inFile] [-l{m|o}][-v] [-F] [-S|-D] [-o]

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

71 de 179 03/03/12 14:46

Page 72: Com an Dos

cicsimport -?

Description

You must be logged on as a user with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).If you are using DCE authentication, you must have a DCE context that hassufficient authority to create a DCE principal, account, and server key table.Usually this requires identity as a DCE cell administrator.

The cicsimport command restores the resource definitions from an existing regionto your new region. You run cicsimport from the command line as long as you arelogged in as a user with root or administrator privileges. The definitions thatcicsimport restores are:

All configuration files except those defining the SFS. Even if SFS files alreadyexist for an imported region, you should rerun cicssfsconf to reset the ACLs.All resource definitionsConversion templatesAll programsAll mapsAll Java classesThe contents of the region's data directory

If you are using DCE authentication and there are User Definitions (UD) in theregion archive being imported that do not currently exist in the DCE cell, their DCEprincipals and accounts are created automatically with the following details:

The password is the same as that for the user's id.The group is cics_users.The organization is none.The home directory is "/".The shell is cicsterm.

If you are using DCE authentication, all users, whether or not they exist already, aremade members of the DCE group cics_users.

If you are not using DCE authentication or name services, the option -S must bespecified.

If you install a new region, this command can be used to copy another region whichalready exists.

If you want to migrate an exported region database, you must import usingcicsmigrate -r, and then re-export it again. The region can then be importedsuccessfully as required.

If you are using SFS for CICS queues and files, after running cicsimport, runcicssfsconf to reset the Access Control Lists.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

72 de 179 03/03/12 14:46

Page 73: Com an Dos

Options

-r regionNamespecifies the name of the region to restore.

-g groupNamespecifies the name of the group with which all files of the new region arecreated. The default groupid is cics (CICS on Open Systems) and cicsgroup(CICS for Windows).

-l{m|o} (CICS on Open Systems only)specifies the action that cicsimport is to take if it cannot find the target of asymbolic link:

-lmMandatory. cicsimport terminates the restoration immediately.

-loOptional. cicsimport produces a warning message, creates the link, andcontinues restoration. This allows you to restore further regions thatresolve the missing links.

The default action is to terminate the restoration.

-i inFilespecifies the name of the archive copy of the resource definitions in Copy Inand Out (cpio) format. If you do not specify the -i flag, the file is read fromstdin.

-v(verbose) lists files as they are created.

-Fforces an overwrite of the region if the region already exists, but does notrecreate DCE and the entries in the database of the facility that starts andstops processes if they already exist.

-Scauses the new region to be set up without using DCE servers. It must bespecified if the region from which the archive was created used DCE serversbut the new region does not. The Region Definitions (RD) attributesNameService and AuthenticationService will be set to CICS respectively.

-Dforces DCE servers to be used when migrating a region that did not use DCEservers to a machine that does use them. The Region Definitions (RD)attributes NameService and DCE.

-oDo not create DCE principals and accounts for the CICS users in the region. If

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

73 de 179 03/03/12 14:46

Page 74: Com an Dos

not specified, each user definition in the region will have a DCE principal andaccount added to the DCE registry and the account will be added to the DCEgroup cics_users.

-?produces the usage message.

Examples

To import region REGION1 from archive file /archive/region1:

cicsimport -r REGION1 -i /archive/region1

1.

To import region REGION2 from archive file /archive/region2 producing warningmessages if any symbolic link requirements defined as part of the cicsexportcommand cannot be found:

cicsimport -lo -r REGION2 -i /archive/region2

2.

cicsinstall - Install CICS resource definitions

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to install CICS resource definitions into the runtime database.

Syntax

cicsinstall [-v] [-r regionName] { -a | -g groupName [groupName ... ] }

cicsinstall -?

Description

The Resource Definition Online (RDO) command cicsinstall installs resourcedefinitions into the runtime database for the specified region. The -g and -a optionsare mutually exclusive.

You must be logged on as a user with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).If you are using DCE authentication, you must have a DCE context that hassufficient authority to create a DCE principal and account and create a serverkey table. Usually, this requires an identity as a DCE cell administrator.

Options

-r regionName

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

74 de 179 03/03/12 14:46

Page 75: Com an Dos

specifies the region to which the cicsinstall command is to install the resourcedefinitions. If you do not specify a region name, CICS installs the resourcedefinitions to the region specified by the CICSREGION environment variable.

-g groupName ...specifies the names of the group or groups whose resource definitions thecicsinstall command is going to install. As many as ten group names can bespecified. The -g flag must be the last flag specified on the cicsinstallcommand.

-vrequests that the cicsinstall command produce messages indicating whichresources it has installed, as well as the total number of resources installed. Ifyou do not specify this option, it produces a message only if an error occurs.

-arequests the cicsinstall command to install into the CICS runtime database allresource definitions from the permanent database that have theActivateOnStartup flag set.

-?causes the usage message to be displayed.

Examples

To install all resource definitions from the group GROUP1 in the region REGION9 intothe runtime database:

cicsinstall -r REGION9 -g GROUP1

1.

To install into the runtime database all definitions in the region REGION0 thathave the ActivateOnStartup flag set, plus receive progress messages:

cicsinstall -r REGION0 -a -v

2.

cicsivp - Set up resource definitions forinstallation verification

AIX HP-UX Sun Solaris Windows

X X X X

Sets up the resource definitions required to run the Installation VerificationPrograms (IVPs).

Syntax

cicsivp -r regionName [-s serverName] [-v volumeName] [-l sampleLanguage]

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

75 de 179 03/03/12 14:46

Page 76: Com an Dos

cicsivp -r regionName [-s databaseName][-l sampleLanguage]

Description

On Open Systems you must be logged in as a member of the group cics. OnWindows you must be logged in as a member of the group cicsgroup.If you are using an SFS as a file server:

You must be running an SFS.cicssfsconf must have been run to configure the SFS.You must have authority to create an SFS file. Usually this means that youmust be logged in with the DCE principal, cell_admin.

If you are using DB2 as a file server:You must have a running DB2 database available for connection.You must be authorized to connect to the database.cicsdb2conf must have been run to configure the database.You must have the authority to create a table.

The IVPs are designed to run with a set of pre-defined resource definitions. Thecicsivp command adds these resource definitions to the specified region database.After you've run cicsivp, you must cold start the region for the changes to takeeffect.

Once the region is running, you can run cicsivp again to change the language inwhich the sample transactions are coded.

Options

-r regionNamespecifies the region to be amended.

-s serverNamespecifies the name of the required SFS if the region is using an SFS fileserver(attribute FileSystemType=SFS in the Region Definition). If the serveris not specified then the default server is /.:/cics/sfs/hostName, where hostNameis the name of the machine running CICS and can be found using the commanduname -n.

-s databaseNamespecifies the name of the required DB2 database if the region is using DB2 as afile server (attribute FileSystemType=DB2 in the Region Definition). If thename of the database is not specified then the value of the Region Definitionattribute DefaultFileServer is used as the database name.

-v volumeNamespecifies the name of the required SFS logical volume. If it is not specified, thedefault volume is DataVolume in the Structured File Server Definitions (SSD).

-l sampleLanguagespecifies the language of the sample transactions. The language can be one of:

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

76 de 179 03/03/12 14:46

Page 77: Com an Dos

C- the samples coded in C are to be used.

IBMCOB- the samples coded in IBM COBOL are to be used (CICS for AIX only).

COBOL- the samples coded in Micro Focus COBOL are to be used.

Examples

To add the required resource definitions to a region called REGION1, using thedefault SFS and SFS logical volume, enter:

cicsivp -r REGION1

1.

To add to required resource definitions to a region called REGION1, using thedefault SFS, which has an SFS logical volume called sfs_MINE, enter:

cicsivp -r REGION1 -v sfs_MINE

2.

cicslssrc - Check subsystem status

AIX HP-UX Sun Solaris Windows

X X

The cicslssrc command shows the status of CICS subsystems. By default, allsubsystems are listed. Alternatively, a specific region or SFS may be listed.

Syntax

cicslssrc [ -a | -s subsystem | -g groupName ]

cicslssrc -?

Description

You must be logged in as a member of the group cics.

The following information is provided when the cicslssrc command is used:

The process ID (PID) of the subsystem if it is active or stopping. Otherwise,this field is blank.The current status of the subsystem. The statuses are:

inoperativeThe subsystem is not currently running.

active

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

77 de 179 03/03/12 14:46

Page 78: Com an Dos

The subsystem is running as the process identified by the PID field.

stoppingThe subsystem is processing a shutdown request.

Options

-adisplay the status of all subsystems. This is the default parameter.

-s subsystemdisplay the status of the specified subsystem. A region's subsystem name isformed by appending the region name to cics.; for example cics.region2. AnSFS subsystem name is similarly formed by appending the short name of theSFS to cicssfs.; for example, cicssfs.SHostA.

-g groupNamedisplay the status of all subsystems in the specified group.

-?causes the usage message to be displayed.

Examples

To list all CICS subsystems, use the following:

cicslssrc

On a system with a region named region2 and an SFS named SHostA,something similar to the following is shown:

Subsystem PID Status cics.region2 7444 active cicssfs.SHostA 605 active

If the SFS were not running, then the following is shown:

Subsystem PID Status cics.region2 7444 active cicssfs.SHostA inoperative

1.

To check the status of an SFS named SHostA, use the following:

cicslsrrc cicssfs.SHostA

2.

cicslterm - Invoke the local CICS client 3270terminal emulator

AIX HP-UX Sun Solaris Windows

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

78 de 179 03/03/12 14:46

Page 79: Com an Dos

X

Invokes the local CICS client 3270 terminal emulator so that you can connect to aregion on the local machine.

Syntax

cicslterm [-s=serverName | -r=serverName] [-t=transId] [-k=keyFile] [-c=colorFile][-m=modelId] [-n=netName] [-p=printCommand | -f=printFile] [-q | -w]

cicslterm -?

Description

You need to understand about the 3270 terminal subsystem before you use thecicslterm command. See the CICS Administration Guide for more information.The window in which you start cicslterm must contain at least 12 lines. It isrecommended that you use a window with 25 lines.You must be authorized to run the transactions that you specify. That is, the UDentry for the userid you are using must have the TSL and RSL keys listed in itthat allow you to access the transactions that you want to run. This isdescribed in the CICS Administration Guide.

After you are connected to the region, CICS leaves you with a blank screen that isrunning the IBM 3270 Information Display System emulation. You can then enterthe transaction identifier of the transaction you want to run.

Alternatively, you can run a transaction immediately when cicslterm is initiallyinvoked, by entering

cicslterm -t=transId

where transId is the transaction identifier.

The name of the pipe that is to be used for communication with the region isdetermined from file cicslcli.ini in directory prodDir/bin. The file cicslcli.ini mustcontain a stanza of the form

Server=serverName Protocol=LOCALCLI NamedPipeName=pipeName ...

where serverName is the name of the server specified on the cicslterm command.and pipeName is the 6-character name of the pipe to be used. The last twocharacters of the name of the pipe must be unique on the machine. The pipe namemust match the attribute NamedPipeName (local Named Pipe name) of anentry in the Listener Definitions (LD) for the region. If you change the filecicslcli.ini, you must use the "Stop All Local Terminals" icon to stop all CICS localterminals and the cicslcli client before using cicslterm to restart a CICS localterminal to pick up the change. For a full description of the format of the client

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

79 de 179 03/03/12 14:46

Page 80: Com an Dos

initialization file, see CICS Clients: Administration.

The CICS 3270 Terminal Emulator is associated with a particular region for thelifetime of the cicslterm process. If the region terminates, the cicslterm process isleft running to wait for any current scheduled protected transactions for the giventerminal when the region is restarted. Otherwise, the cicslterm processterminates.

Options

-s=serverName or -r=serverNamespecifies the name of the CICS server you wish to use.

-t=transIdspecifies the identifier of the transaction to run after the terminal emulator hasinitialized.

-k=keyFilespecifies the name of the keyboard mapping file to be used by the emulator. Ifthis parameter is omitted, the environment variable CICSKEY is used toidentify the key mapping file. If CICSKEY is not defined, it is assumed that afile called cicskey.ini in the current directory contains the keyboard mapping.

-c=colorFilespecifies the name of a color mapping file to be used by the emulator. If thisparameter is omitted, the environment variable CICSCOL is used to identifythe color mapping fle. If CICSCOL is not defined, it is assumed that a file calledcicscol.ini in the current directory contains the color mapping.

-m=modelIdspecifies the name of a model terminal definition, defined in the region'sTerminal Definitions (WD), that is to be used to define the characteristics of thewindow in which transactions are to be run. If neither of the -m or -nparameters is specified, then any ModelTerm value from the clientinitialization file is used. If no ModelTerm value has been specified in theinitialization file, or if the -m parameter is specified without a value, theserver's default terminal definition is used.

-n=netNamespecifies the name of a particular terminal definition as defined in the region'sTerminal Definitions (WD).

-p=printCommandspecifies a Windows command used to process the temporary print filegenerated when requests are received by the terminal emulator. Thetemporary print file is processed by executing the command obtained byappending the name of the file to the specified command. CICS does not deletethe temporary print file. The command that is executed is responsible fordeleting the temporary print file, if that is appropriate.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

80 de 179 03/03/12 14:46

Page 81: Com an Dos

If the command contains embedded blanks, then it must be surrounded bydouble quotation marks ("). Any double quotation marks within the commandmust be entered as backslash double quote (\").

If neither of the -f or -p parameters is specified, the PrintCommand orPrintFile parameter in the client initialization file defines the command or fileto be used for print requests.

-f=printFilespecifies the name of a file to which the output of print requests is appended. Ifthe name of the file contains embedded blanks, it must be enclosed in doublequotation marks ("). Any double quotation marks within the name of the filemust be entered as backslash double quote (\").

If neither of the -f or -p parameters is specified, the PrintCommand orPrintFile parameter in the client initialization file defines the command or fileto be used for print requests.

-q(quiet) suppresses the display of any messages generated by the command.

-w(wait) prompts the user to press the Enter key before the command completes,to confirm that messages generated by the command have been read.

-?causes the usage message to be displayed.

Examples

To log on to the server server1 and run transaction CEMT:

cicslterm -s=server1 -t=CEMT

1.

cicsmakelv - Create a logical volume

AIX HP-UX Sun Solaris Windows

X

The cicsmakelv command creates a logical volume for use by an Encina server.

Syntax

cicsmakelv [-I] -v volumeName -s volumeSize -p dataPath

cicsmakelv -?

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

81 de 179 03/03/12 14:46

Page 82: Com an Dos

Description

You must be logged on as a user who has administrative privileges

The cicsmakelv command is used to create an operating system file, at the locationspecified by dataPath, that will be used as an Encina logical volume by an Encinaserver.

A volume created using cicsmakelv should only be removed using thecicsremovelv command since cicsmakelv also adds information to the NT Registryconcerning the location of the logical volume. Removing the volume by other meanscould result in incorrect information being left in the NT Registry.

Options

-IIgnore errors. If an Encina Logical Volume previously existed with this namebut was only partially removed, then this flag may be specified to force theredefinition of the volume.

-v volumeNamespecifies the name of the logical volume as it is to be referenced by the EncinaServer.

-s volumeSizespecifies the size of the logical volume in bytes.

-p dataPathspecifies the location of the logical volume.

Examples

To create a logical volume for server sfs_Server1 of size 16384 Kbytes at D:\var\volumes\sfs_Server1:

cicsmakelv -v sfs_Server1 -s 16384000 -p D:\var\volumes\sfs_Server1

1.

cicsmfmt - Monitoring data formatter

AIX HP-UX Sun Solaris Windows

X X X X

Use cicsmfmt to extract data from a monitoring transient data queue that CICScreates as part of a CICS monitoring sequence. cicsmfmt formats the CICSmonitoring data into a form that can easily be written to standard operating systemoutput. You can replace cicsmfmt with your own customized program. Thisinformation describes the version delivered with CICS and may not correspond to

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

82 de 179 03/03/12 14:46

Page 83: Com an Dos

the version running on your system.

Syntax

cicsmfmt fileName

cicsmfmt -?

Description

If you specify too few or too many parameters, or enter the -? option, cicsmfmtsends some explanatory text to the standard error destination, on how to use thecommand. Otherwise, cicsmfmt checks that the file exists, and formats the filerecords.

cicsmfmt formats several fields for each transient data queue record:

the transaction namethe terminal namethe start and end time stamps for the taskthe time spent waiting for file input and output, and the number of times CICSstarted and stopped the clockthe program namethe total number of file requeststhe data segment memory occupancythe first abnormal termination code, if set.

cicsmfmt is a sample program generated from the sample source file cicsmfmt.c. Itcan be built with the sample makefile in the directory prodDir/src/samples/mfmt usingthe command make -e -f Makefile (on Open Systems) or nmake -e -f Makefile(on Windows).

If you want to replace cicsmfmt with your own program, you must change thesample makefile accordingly.

The following files make up the monitoring data formatter:

Table 2. Monitoring data formatter files

File Type Contents

prodDir/bin/cicsmfmt (CICS on OpenSystems) c:\opt\bin\cicsmfmt.exe (CICSfor Windows)

executable The executable monitoringformatter program

prodDir/src/samples/mfmt/cicsmfmt.c source Sample monitoringformatter program source

prodDir/src/samples/mfmt/Makefile makefile Sample makefile thatbuilds and installs themonitoring formatter

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

83 de 179 03/03/12 14:46

Page 84: Com an Dos

prodDir/lib/libcicsmfmtsa.a (CICS onOpen Systems) prodDir/lib/libcicsmfmtsa.lib (CICS for Windows)

object library Library containing thefunctions for reading andprocessing a MonitoringData file

prodDir/include/cicsmfmt.h include Definitions used by thesample monitoringformatter

prodDir/include/cicsmfmt_msg.h include English messages used bythe sample monitoringformatter

prodDir/msg/en_US/cicsmfmt.cat (CICSfor AIX and Solaris) prodDir/msg/en_US.iso88591/cicsmfmt.cat (CICS forHP-UX)

message text Message catalog forcicsmfmt produced bygencat. Only required byformatter programscompiled with CICSrelease 2.1.1 or earlier.

Options

fileNamean operating system file corresponding to a CICS extrapartition transient dataqueue containing monitoring data from a previous run. Note that the transientdata queue must have a variable length record.

-?provides you with a help facility, showing the correct syntax for the command.cicsmfmt also displays this if you enter the command syntax incorrectly.

Examples

To list file shut001:

cicsmfmt shut001

1.

To obtain help:

cicsmfmt -?

2.

cicsmigrate - Create migration script

AIX HP-UX Sun Solaris Windows

X X X X

Creates a shell script (On Open Systems) or a command file (Windows) whichupdates, or migrates, databases and DCE principal names to accommodate thechanges required by a Program Temporary Fix (PTF) or a new release.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

84 de 179 03/03/12 14:46

Page 85: Com an Dos

Syntax

On Open Systems

cicsmigrate [-r regionName | -s | -c | -p | -m] -g fileName -o outputLog

cicsmigrate -?

On Windows

cicsmigrate regionName

Description

Use the cicsmigrate command after installing a PTF or a new release.cicsmigrate creates a migration shell script (On Open Systems) or a command file(Windows) which you can run to update resource databases and DCE principalnames to provide for the changes required by the PTF or new release. This shellscript (On Open Systems) or a command file (Windows) can:

Add new attributesDelete old attributesAdd new resource classesChange the names for SFSChange an attribute's value, for example, the minimum value, or the defaultAdd new resource definitions, for example a new model terminal or suppliedtransaction.

The shell script (On Open Systems) or a command file (Windows) incorporates thecicsmigrateclass, cicsupdateclass, and cicscopystanza commands which makethe appropriate changes. Although typically, in a standard installation, you do notnormally need to make any modifications, if you want to make any specific changesto the databases, such as changing the default value of a new attribute, edit themigration shell script (On Open Systems) or a command file (Windows) beforerunning it.

The shell script (On Open Systems) or a command file (Windows) updates thepermanent and auto-start images of the databases.

To run the shell script (On Open Systems) or a command file (Windows) generatedby the cicsmigrate command, you must be logged in as root or administrator andauthenticated as cell_admin.

Options

-r regionNamebuilds a migration shell script (On Open Systems) or a command file (Windows)which migrates only the named region (affects all the files in /var/cics_regions/region/database).Note:

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

85 de 179 03/03/12 14:46

Page 86: Com an Dos

For Windows, regionName is sufficient; you do not need the -r option.regionName specifies the CICS region to be migrated. If regionName isnot specified, the command only migrates the SFS resource definitions.

Note:Note:

-sbuilds a migration shell script (On Open Systems) which migrates only the SFSresource database

-cbuilds a migration shell script (On Open Systems) which migrates only thedefault schema database (affects only the /var/cics_servers/SCD/SCD.stanza file).

-pbuilds a migration shell script (On Open Systems) which migrates only the GSDresource database (affects only the files in /var/cics_servers/GSD).

-mbuilds a migration shell script (On Open Systems) that migrates all the regions,SFS, schema and PPC gateway files on the host machine (affects all the files in/var/cics_servers directory and the /var/cics_regions directory). Once thismigration script has been built and run for a new release, it should not berebuilt for that release. Instead, either rerun the original script or migrateitems individually.

-g fileNamespecifies the name of the migration shell script (On Open Systems) to becreated.

-o outputLogspecifies the name of the log file which will contain all the changes made to thesystem when the shell script (On Open Systems) is run. outputLog is emptyuntil the shell script (On Open Systems) is run.

-?displays the usage message.

Examples

On Open Systems

To create a shell script called migratescript that upgrades only the regiondatabase in region1, enter:

cicsmigrate -g /homes/mine/migratescript -o /tmp/logfile -r region1

To run the shell script:

ksh migratescript

1.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

86 de 179 03/03/12 14:46

Page 87: Com an Dos

/tmp/logfile is empty until you run the shell script migratescript.

To create a shell script called migratesfsscript that upgrades only the SFSresource database, enter:

cicsmigrate -g /homes/mine/migratesfsscript -o /tmp/logfile -s

2.

To create a shell script called migrateallscript that upgrades all the regions andSFS on a machine, enter:

cicsmigrate -g /homes/mine/migrateallscript -o /tmp/logfile -m

3.

On Windows

To create a command file called migratescript that upgrades only the regiondatabase in region1, enter:

cicsmigrate region1

1.

cicsmigrateclass - Add and delete resourceattributes

AIX HP-UX Sun Solaris Windows

X X X

Adds new attributes and deletes old attributes from the resource definition file for agiven class.

Syntax

cicsmigrateclass [-r regionName] [-w] -c className[-a attributeName {-n defaultValue | -d | -u newAttributeName} ] [-f fileName]cicsmigrateclass -?

Description

The cicsmigrateclass command adds, updates, or deletes the appropriateattributes in a resource definition file that needs to be changed because of anupgrade to CICS. The cicsmigrateclass commands are generated automaticallyand are included in the migration shell script which was created when you rancicsmigrate. The updates to the attributes are mandatory. You can specify a newvalue using the cicsmigrate command's -n parameter, but you must not delete, orchange cicsmigrateclass commands within the migration shell script. The syntaxis described here so you can understand the shell script that cicsmigrategenerates.

In a migration shell script created by cicsmigrate, all cicsmigrateclasscommands automatically include the -w flag.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

87 de 179 03/03/12 14:46

Page 88: Com an Dos

Options

-r regionNamespecifies the name of the region database being modified. For most classes,you must specify the regionName parameter. It is optional only for the ssd,scd, and gsd classes.

-wupdates the autostart images.

-c classNamespecifies the name of the class being modified. Valid classes are:

cdCommunication definitions

fdFile definitions

gdGateway definitions

gsdGateway server definitions

jdJournal definitions

ldListener definitions

mdMonitoring definitions

odObject definitions

pdProgram definitions

rdRegion definitions

ssdStructured file server definitions

scdSchema file definitions. Must be used with -f fileName.

tdTransaction definitions

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

88 de 179 03/03/12 14:46

Page 89: Com an Dos

tddTransient data definitions

tsdTemporary storage definitions

udUser definitions

wdTerminal definitions

xadProduct definitions.

-a attributeNamespecifies the name of the attribute to add, modify, or delete.

-f fileNamespecifies the path and filename of the schema resource file. This option is validonly if -c scd is specified.

-n defaultValuespecifies the default value of a new attribute to add.

-ddeletes the attribute.

-u newAttributeNamespecifies the new name of the attribute.

-?causes the usage message to be displayed.

Examples

To add the new attribute Salutation, with the value greetings, to every entry,including the default entry, in the User definitions for region1, enter:

cicsmigrateclass -r region1 -w -c ud -a Salutation -n "greetings"

1.

To change the name of the attribute Salutation in the User definitions for region1to Farewell, enter:

cicsmigrateclass -r region1 -w -c ud -a Salutation -u Farewell

2.

To delete the attribute Farewell from every entry in the file for the Userdefinitions in region1, enter:

cicsmigrateclass -r region1 -w -c ud -a Farewell -d

3.

cicsmigrateclients - Reconfigure DCE

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

89 de 179 03/03/12 14:46

Page 90: Com an Dos

AIX HP-UX Sun Solaris Windows

X X

Reconfigures DCE for each host running a CICS client or region. Use this commandonly if you have changed your DCE principal names.

Syntax

cicsmigrateclients [ -I] [ -v]

cicsmigrateclients [-?]

Description

This command creates a new DCE principal and account for the client and deletesthe old principal and account. It sets new passwords for the account in the keytabfile in the /var/cics_clients directory. If you are using DCE authentication you mustbe logged in as root or administrator and authenticated as cell_admin. Run thiscommand on all hosts which run CICS clients or regions.

Options

-I(Uppercase letter "i") Ignores errors.

-vgives a detailed output while the command runs.

-?causes the usage message to be displayed.

Examples

To reconfigure a DCE client after a patch has been installed, first log in as root oradministrator and authenticate as cell_admin, then enter:

cicsmigrateclients

cicsmkcobol - Create the cicsprCOBOL file

AIX HP-UX Sun Solaris Windows

X X X

Syntax

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

90 de 179 03/03/12 14:46

Page 91: Com an Dos

cicsmkcobol [-o outFileName] [-L libraryPathName] ... [objectFileNames][libraryNames]

Description

Creates the COBOL language method file and the COBOL runtime library. Thecicsmkcobol command must be run whenever one of the following is installed:

A new version or release of Micro Focus Server Express COBOLA new version or release of CICS applicable to your operating systemA new version or release of any supported database product

The cicsmkcobol command creates the COBOL language method file and the CICSruntime library for Micro Focus Server Express COBOL support. It combines theobject files containing the CICS COBOL-support routines with the COBOL runtimesystem to create a loadable and executable file, and a shared library containing theCOBOL runtime support. The language method file is placed in the currentdirectory as cicsprCOBOL unless another path and filename are specified using the -ooption. The CICS COBOL runtime library is placed in prodDir/lib aslibcicscobrtsrt.so on CICS for AIX and on CICS for Solaris, and libcicscobrtsrt.slon CICS for HP-UX.

Note:On Windows there is no specific action required to provide a languageenvironment for CICS. The COBOL language method file cicsprCBFNT is providedin the C:\opt\cics\bin directory

Processing

To be used by CICS:

The COBOL language method file must be placed either in prodDir/bin or in/var/cics_regions/region_name/bin with the name cicsprCOBOL. Versions of the fileplaced in /var/cics_regions/region_name/bin take precedence over the file placed inprodDir/bin. This allows you to have different COBOL language method files foreach region.The CICS COBOL runtime library must be placed in a directory that is includedin your library search path specified by the appropriate environment variable.On CICS for AIX the environment variable is LIBPATH; on CICS for HP-UX it isSHLIB_PATH; on CICS for Solaris it is LD_LIBRARY_PATH. The sequence inwhich the directories appear in the environment variable determines whichlibcicscobrtsrt.* file is used by CICS. This allows you to have different COBOLruntime libraries for each region.

To run cicsmkcobol:

Log in as root or administrator.Make prodDir/bin the current directory if you want to create a cicsprCOBOL filefor use by all regions, or make /var/cics_regions/region_name/bin the currentdirectory if you want to create a cicsprCOBOL file for use by region

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

91 de 179 03/03/12 14:46

Page 92: Com an Dos

regionName.Set the appropriate environment variable (LIBPATH on CICS for AIX,LD_LIBRARY_PATH on CICS for Solaris, or SHLIB_PATH on CICS for HP-UX) tocontain /opt/lib/cobol/coblib (or /opt/cobol/cobdir/coblib on CICS for HP-UX) toensure correct linkage to the COBOL libraries.Ensure that the PATH environment variable allows cicsmkcobol to find:

COBOL executable files.

If COBOL is not installed in the standard directory, set the COBDIRvariable in /etc/environment or in the region's environment file.

In the PATH environment variable, the executables directory (for example,$COBDIR/bin) must be before the COBOL driver directory (for example,/usr/bin).

Operating system commands (such as echo, sed, and grep)The executable files for CICS on your operating system.

Options

-o outFileName (on CICS for AIX and CICS for HP-UX only)specifies the name of the generated file. If the command is run without the -oparameter (always on CICS for Solaris), the file is named cicsprCOBOL and isplaced in the directory prodDir/bin.

-L libraryPathNamespecifies a directory you want to add to the library path used by cicsprCOBOL.This is useful where you want to include shared libraries.

objectFileNamesare the names of the object files you want to use (for example, C functions).Ths object files should be put into the $CICS/lib directory.

libraryNamesare the names of the libraries you want to use.

Examples

To create a cicsprCOBOL file in the current directory, enter:

cicsmkcobol

To create a cicsprCOBOL file in the bin directory of a region named regionA, enter:

cicsmkcobol -o /var/cics_regions/regionA/bin/cicsprCOBOL

cicsnotify - Deallocate resources

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

92 de 179 03/03/12 14:46

Page 93: Com an Dos

AIX HP-UX Sun Solaris Windows

X X X

Use the cicsnotify command to deallocate resources left allocated when the regionis no longer running.

Syntax

cicsnotify subsystemName

Description

This command is used to release resources and delete the region lock file when, dueto a non-normal shutdown, resources are left allocated after the region is no longerrunning.

Note:This command should only be used after a stopsrc (on CICS for AIX) orcicsstop (on all other CICS on Open Systems platforms) command has beenused with the -c option, or when the region has failed to complete a shutdownin a logical manner.

Options

subsystemNameis the subsystem name used by the region. This is normally in the formcics.regionName.

Examples

To deallocate resources in a specific CICS region called REGION1:

cicsnotify cics.REGION1

The CICS Administration Guide contains additional information on shutdownprocedures.

cicsoraconf - Configure Oracle

AIX(R) HP-UX Sun Solaris Windows

X X X X

Use the cicsoraconf command to configure CICS(R) resource definitions for Oracle,and to configure Oracle to manage CICS queues and files.

Syntax

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

93 de 179 03/03/12 14:46

Page 94: Com an Dos

cicsoraconf [-I] [-m] -r regionName [-l logFileName] {-C|-S|-N|-D|-P|-T|-L|-Q} [-iinstanceName] [-f] [-g] [-s] -u userName[/password] [-x userName/password] [-ttableSpace]

cicsoraconf -?

Description

Note:To use this command, you must be logged in with Oracle sysadm authority.

This command configures the resource definitions in the CICS region to meet therequirements of Oracle. It also adds the necessary tables to the Oracle database.You run cicsoraconf from the operating system command line. The environmentvariables ORACLE_HOME and ORACLE_SID must be set to appropriate values.

Options

-Icauses noncritical errors to be ignored.

-mspecifies that cicsoraconf should set the IndexName for each file that isdefined in the File Definitions (FD), by appending "0" to its key.

-r regionNamespecifies the name of the CICS region for which you are configuring Oracle.

-l logFileNamespecifies the name of the file that is to be used for logging configurationmessages. If this parameter is not specified, the file regionName/data/cicsoraconf.log is used.

-Cspecifies the complete configuration of Oracle for the region and the

configuration of the region resources for DB2(R). The flags -i, -a, -n, -f, -s, -u,and -l are valid when this option is specified.

-i instanceNamespecifies the name of the instance of Oracle. Default is ORASID

-fBy default, the Fileserver attribute for all File Definitions (FD) entries is set toNULL and the defaultthat is specified by the DefaultFileServer attribute inthe Region Definitions (RD) is used. If this option is specified, the FileServerattributes are not set to NULL.

-nspecifies the creation of a system-defined Product Definitions (XAD) entry thatspecifyies integration through the Oracle single-phase commit optimization. If

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

94 de 179 03/03/12 14:46

Page 95: Com an Dos

this flag is not specified, cicsoraconf puts a new default entry into the XADthat allows the region to connect to the Oracle instance through the XAinterface.

-ssuppresses the creation of a system-defined Product Definitions (XAD) entry.An XAD entry is required in order to specify a Oracle database that willmanage the queues and files of the CICS region. If this flag is not specified,cicsoraconf creates a new default entry in the XAD that allows the region toconnect to the Oracle instance. The use of this flag allows you to define yourown XAD entry for the Oracle instance.

-u userName[,password]specifies the user name that is to be used for explicit authentication. If thisparameter is specified, it forms part of the XAOpen string in the ProductDefinitions (XAD) entry. If the password is not specified, CICS prompts you toenter it.

-ggrants minimum privileges. If this flag is specified, cicsoraconf grantsEXECUTE authority. With this authority, the user ID that CICS uses to connectto the database is allowed execute the CICS file and queue managementpackage.

If this flag is not specified, cicsoraconf grants DBA authority to the user IDthat CICS uses to connect to the database.

-Sspecifies that a table for recoverable auxiliary TSQs is to be created. The nameof the table is regionNameREQTSQ#. The table is recoverable.

-Nspecifies that a table for nonrecoverable auxiliary TSQs is to be created. Thename of the table is regionNameNREQTSQ#. The table is recoverable

-Dspecifies that a table for logically recoverable TDQs is to be created. The nameof the table is regionNameLOGTDQ#. The table is recoverable.

-Pspecifies that a table for physically recoverable TDQs is to be created. Thename of the table is regionNamePHTDQ#. The table is logically recoverable.

-Tspecifies that a table for nonrecoverable TDQs is to be created. The name ofthe table is regionNameNREQTDQ#. The table is recoverable

-Lspecifies that a table for locally queued protected STARTs is to be created. Thename of the table is regionNameLQPROT#. The table is recoverable.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

95 de 179 03/03/12 14:46

Page 96: Com an Dos

-Qspecifies that a table for locally queued unprotected STARTs is to be created.The name of the table is regionNameLQUE#. The table is recoverable.

-?causes the usage message to be displayed.

Returned values

0Oracle has been configured.

non-zeroThe attempt to configure Oracle was not successful.

Examples

To configure Oracle for REGION1 with default parameters, using instance ORASID::

cicsoraconf -r REGION1 -C -u cics/cics

cicsoraimport - Build metadata for Oracle

AIX HP-UX Sun Solaris Windows

X X X NA

Use the cicsoraimport command to define files to an Oracle database.

Syntax

cicsoraimport -i schemaFileName [-u userName[/password]] [-I] [-f file [-x index ... ]] ... [-t tableSpace]

cicsoraimport -?

Description

Note:To use this command:

You must be logged on as a user with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems).You must have a running Oracle database available for connection.You must be authorized to connect to the database.You must have a schema file that contains the necessary file definitions.You can create a schema file by using cicsadd -cscd ... .

This command allows you to create files on an Oracle database, based on the

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

96 de 179 03/03/12 14:46

Page 97: Com an Dos

information that is provided in a schema file. You can optionally select which filesare created from those defined within the schema. You can also select whichindexes are to be created from those defined for a particular file in the schema. Yourun cicsoraimport from the operating system command line.

Options

-Icauses noncritical errors to be ignored.

-i schemaFileNamespecifies the name of the file that contains the schema definition.

-u userNamespecifies the user name that is to be used for explicit authentication. If thisparameter is not specified, implicit authentication is used.

-f fileNamespecifies the name of the file that is to be loaded from the schema. If no filename is specified, all files that are in the schema are loaded.

-x indexNamespecifies the name of an index that is to be loaded. If no index name isspecified, all indexes for the specified file are loaded.

-t tablespacespecifies the tablespace in which to create the files.

-?causes the usage message to be displayed.

Returned values

0The files were successfully loaded into the database.

non-zeroThe import operation was unsuccessful.

cicsodt - Oracle diagnostic tool

AIX HP-UX Sun Solaris Windows

X X X X

The CICS Oracle diagnostic tool (ODT) provides an interactive interface to Oracle.

Syntax

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

97 de 179 03/03/12 14:46

Page 98: Com an Dos

cicsodt [-u user/password] [-i inputFileName] [-o outputFileName] [-e] [-r] [-ccommandName ...]

cicsodt -?

Description

Note:To use this command:

You must be a member of the group cics (CICS on Open Systems).You must have a running Oracle database available for connection.You must be authorized to connect to the database.You must ensure that environment variables ORACLE_HOME andORACLE_SID are set

Options

Note:Except for -c, which must be the last parameter, the parameters can be in anysequence.

-u user/passwordspecifies the Oracle username and password that are used when theconnection is made to the database. You must provide a user/password eitherby using the -u flag, or by setting the environment variableCICS_XDT_USERPASS.

-i inputFilespecifies a text file that contains ODT commands that are to be read andexecuted. The file can be created either by hand or by using the -o option.Each line of the input file is handled as if it were typed in interactive mode.The text from the input file is also displayed while it is processed by cicsodt.You can include comments in the file by starting a line with "/*".

For example, assume that you:

Create a file called create.input that contains the following lines:

/*/* This is a sample file to create a table called qsamtest/*create cics.qsamtestkflchar10f2varchar100

f1a

1.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

98 de 179 03/03/12 14:46

Page 99: Com an Dos

quit

Execute cicsodt as follows:

cicsodt -i create.input

2.

A new table called CICS.QSAMTEST is created on the specified database.

-o outputFilecauses commands that are entered in the ODT session, to be written to thespecified output file. You can then use this file as an input file, by using the -ioption.

-erequests ODT to terminate if an error occurs. If -e is specified and ODT isbeing driven from a shell script (-i) or the command line (-c), any error thatresults from a command exits ODT with a non-zero return code.

-ractivates ODT statistics. Statistics for ODT and Oracle calls are sent to a filecalled odt.stats that is in the current directory. This is useful for monitoringperformance.

-c ODTcommandsspecifies a list of commands and text that are to be used in the ODT session.This parameter is useful for calling ODT commands from a shell script. It mustbe used last.

Using the ODT commands

To issue commands in ODT, pass them to ODT by using the -i or -c option, or typethe command at the command prompt. ODT accepts command abbreviations. In thecommand syntax, the minimum abbreviation is shown in parentheses; for example,(c)reate. Any command that requires a file name defaults to the last name used ifnothing is given at the prompt. ODT also recognizes any environment variables thatare used at the command prompt.

ODT commands - list

(l)ist [(l)] searchString

Lists all the tables on the database that ODT is accessing. If you use the loption, additional information is given for each table. Only tables that areowned by the user cics are shown. You can also give a search string to listspecific files. Ifyou use a search string, ODT looks for all the filenames thatcontain the string. No "wild card" characters are used , so the search string istaken as entered.

cicsodt -c li l jim

Table Name Organisation Primary Index No. Records

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

99 de 179 03/03/12 14:46

Page 100: Com an Dos

======================= ==================== ============== ===========CICS.JIM6CICSNLQFILE Key-Sequenced (KSDS) CICSNLQIDX (empty)CICS.JIM6CICSNRECTSQFIL Key-Sequenced (KSDS) CICSNRECTSQIDX (empty)CICS.JIM6CICSPLQFILE Key-Sequenced (KSDS) CICSPLQIDX (empty)CICS.JIM6CICSRECTSQFILE Key-Sequenced (KSDS) CICSRECTSQIDX 2CICS.JIM6CICSTDQLGFILE Key-Sequenced (KSDS) CICSTDQLGIDX 11CICS.JIM6CICSTDQNOFILE Key-Sequenced (KSDS) CICSTDQNOIDX (empty)CICS.JIM6CICSTDQPHFILE Key-Sequenced (KSDS) CICSTDQPHIDX (empty)

ODT commands - create

(c)reate tableName

Creates a new Oracle table. All the table information is prompted for in turn.To aid usability and eliminate creation errors, ODT will validate as much aspossible and default to sensible values where appropriate. One exception is thetable column name and index column name that use an empty entry to indicatethat no more columns exist. If you enter q! at any prompt, the create iscanceled.

cicsodt -c create cics.qsamtest

[File Type [Ksds/Esds/Rrds] .: K[sds][Column 01: Name ............: f1[Column 01: Type ............: Error: Invalid column type. Type must be: char, varchar, long varchar or graphic.[Column 01: Type ............: char[Column 01: Size ............: 10[Column 02: Name ............: f2[Column 02: Type ............: raw[Column 02: Size ............: 100[Column 03: Name ............:[Primary Index Name .........: CICS.QSAMTEST0[Index Part 01: Column Name .: f1[Index Part 01: Ordering ....: a[scending][Index Part 02: Column Name .:

ODT commands - read

(r)ead tableName

Reads rows from a CICS Oracle table. Rows can be read from the beginning ofthe table or from a specific key based on any existing index. Rows can also beread continuously or individually. When a key value is specified, it is taken as astring unless it is in the format #n, where n is a numeric value. The followingformat can be used for a hexadecimal representation of the key:

0x0a01 ...

If the read is not continuous, you have the option to delete or update each rowthat is read. If nothing is entered for a column during an update, the columnremains unchanged; otherwise, data entry is same as for the write command.The read command shows up to only 44 bytes of column data and shouldtherefore not be used to check the data integrity of tables that contain long

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

100 de 179 03/03/12 14:46

Page 101: Com an Dos

columns. The dtof command is more suitable for this.

cicsodt -c r cics.qsamtest

[Index To Use ...............: QSAMTEST0[Read From Beginning ? [Y]/N : Y[Continuous Read ? Y/[N] ....: N

[Read #00000001[F1 ][KEY0001... ][000010] [Hex][4B455930303031000000 ][F2 ][Data providing information about KEY0001 ][000040] [Hex][446174612070726F766964696E6720696E666F726D6174 ]

[Read Another, Delete or Update ? [Y]/N/D/U n

[1 Record(s) Read]

ODT commands - write

(w)rite tableName

Writes rows to a CICS Oracle table. Text or hexadecimal data can be entered ineach column; these cannot be mixed. Hexadecimal is entered in the followingform:

0x010203 ...

If the column is long and you need to enter a large amount of data, you can usea shorthand method. For example, to fill the remainder of a column with 33 'A'characters, enter:

A>>32

or enter:

0x20>>32

for 33 spaces.

You must enter something in at least one of the columns in the row for ODT towrite a complete row. If all are left blank, no row is written. If A>>32 wouldexceed the column length, the string "A>>32" is taken literally.

cicsodt -c -w qsamtest

[F1 ][ CHAR ][ Size:00010][KEY0000002[F2 ][ VARCHAR ][ Size:00100][This the data that comes with KEY 2

[Another ? [Y]/N n

[1] Record(s) Added OK.

ODT commands - empty

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

101 de 179 03/03/12 14:46

Page 102: Com an Dos

(e)mpty tableName

Empties a table of all committed rows.

cicsodt -c empty qsamtest

[Empty Table "CICS.QSAMTEST" ? Y/[N] y

ODT commands - delete

(d)elete tableName

Deletes a table from the CICS Oracle database.

cicsodt -c delete qsamtest

[Delete Table "CICS.QSAMTEST" ? Y/[N] y

ODT commands - addindex

(a)ddindex tableName

Adds a secondary index to the CICS Oracle table. Type q! if you want to cancelthe command.

cicsodt -c a angus

[Secondary Index Name........: index2[Index Col. 01: Column Name .: f2[Index Col. 01: Ordering ....: a[scending][Index Col. 02: Column Name .:

ODT commands - delindex

(deli)index tableName

Deletes a secondary index from the CICS Oracle table.

cicsodt -c delindex angus

[Secondary Index Name........: index2

ODT commands - info

(i)nfo tableName

Shows detailed information about the Oracle table.

cicsodt -c i angus[Information For Table: CICS.ANGUS ]------------------------------------------------------------------[Table Organization ] Key-Sequenced (KSDS)[Primary Index Name ] ANGUS0 (Unique index)[Primary Index Column(s) ] F1[Secondary Index Names ] (None defined)[Number Of Records In Table ] 0[Number Of Columns Per Row ] 3[Column 001: F1 ][CHAR ][Size: 5]

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

102 de 179 03/03/12 14:46

Page 103: Com an Dos

[Column 002: F2 ][CHAR ][Size: 5][Column 003: F3 ][CHAR ][Size: 5]------------------------------------------------------------------

ODT commands - user

(u)ser userName,password

Reconnects to the current Oracle instance with the new user. If connectionwith the new user fails, ODT reconnects with the old user and password.

cicsodt -c -u acooke/jg8wq9z

ERZ037172I/0766: (Database OK)

ODT commands - qtod

(qt)od QSAMfileName

Transfers and converts a QSAM table to an Oracle table.

cicsodt -c qtod qsam

[Default Code Pages: EBCDIC (IBM-037) -> ASCII (ISO8859-1) ...

[Transferring Records. Record No.][00000022]

ODT commands - dtof

(dt)of OracletableName

Transfers a CICS Oracle table to a flat table. The format of the flat file caneither be ODT format or Asis; that is, the table is transferred byte by byte as itis. In ODT format, the flat file starts with a header that contains informationabout the structure of the table, followed by an end-of-header marker. Theremainder of the flat file contains the actual records that are in the format: anewline character, followed by an eight-byte ASCII number, followed by theactual data. The ASCII number is the length of the row excluding the numberitself. If the table is transferred Asis, no extra information is contained in theflat file. A single record or a range of records can be dumped. The recordnumber corresponds to the position of the row by using the primary index. Todump row 10:

Enter 10 at the [Dump Row(s)] prompt.1.Type 10- to dump rows from 10 onward.2.Type 10-12 to dump rows 10 to 12 inclusive.3.

cicsodt -c dtof CICS.RRDS

[Flat Filename ..............: CICS.RRDS.ddt[Dump table Asis ? .... Y/[N]: N[Dump Row(s) ................: ALL

[Dumping All Rows][Dumping Row #][00000003]

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

103 de 179 03/03/12 14:46

Page 104: Com an Dos

ODT commands - ftod

(f)tod OracletableName

Transfers to a CICS Oracle table, a flat table that was produced from the dtofcommand. If the flat table is not in ODT format, use dtof, which will attempt totransfer the file as normal text or binary. If the Oracle table does not exist andthe flat file is in ODT format, ODT asks you whether you want the file to becreated. ODT also reads and transfers flat files that are created by cicssdt (inSDT format).

cicsodt -c f CICS.RRDS

[Flat Filename ..............: CICS.RRDS.ddt

[Loading Record #][00000003]

ODT commands - !

!

Escapes to a system command prompt. Exiting from the command promptreturns control to ODT.

cicsddt -c !

[Exit To Shell. Use <Ctrl-D> To Return .....

ls q* (Open Systems)qsam qsam.dfh qsamTest qsamcsd.ddt.def qsam.conv qsam.log qsamcsd qsamcsd.ddt.logqsam.def qsam.ddt.def qsamcsd.dfh qtest

ODT commands - quit

(q)uit

Exits ODT and returns control to the calling process.

cicsodt -c q

ODT commands - help or ?

(h)elp (or ?) CommandName

Gives general or specific online help for ODT commands.

cicsodt ? create

ODT commands - QSAM to Oracle file transfer

This section is intended to help you understand how to transfer QSAM files from a

IBM(R) mainframe-based CICS system to a CICS on Open Systems system (thetarget system).

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

104 de 179 03/03/12 14:46

Page 105: Com an Dos

When a file is sent directly to a target system, record boundaries are lost when thatfile is received. If the file is captured on TSO or CMS in netdata format and sent asa binary file to the target system by way of the File Transfer Program (ftp), theoriginal netdata format is preserved.

The cicsnetdata program is used to read the file and reconstruct the outputrecords. The count precedes each record, as expected by the cicsodt qtodcommand.

If a file is in netdata format, control records INMR01, INMR02, INMR03 precedethe data, and INMR06 follows the data; these names are in EBCDIC. All input(control records and data) is segmented. The first byte of a segment contains thesegment length, including itself. The second byte of the segment contains a flagbyte. The flag settings are:

0x80 first segment0x40 last segment0x20 segment is part of a control record

To transmit a file from TSO

Enter:

TRANSMIT (nodeName/userID) DSN(data.file) OUTDSN(data.NETDATA) SEQ

Notes:

You can abbreviate TRANSMIT to XMIT.a.

nodeName/userID is required syntactically. Although it is not used whentransmitting to a file, it is validated, so specify a known node and user ID.

b.

DSN names the input to XMIT.c.

OUTDSN names the output netdata file. The type NETDATA is suggested.d.

SEQ is required if the input was a PDS member; otherwise the file is notusable on the target system. The name of utility function must beINMCOPY for correct results (see Messages from a sample run ofcicsnetdata).

e.

1.

Enter:

ftp systemName

where systemName is the name of the target system.

2.

Enter user ID and password when prompted.3.Enter:

cd directoryName

to change to the target directory if necessary.

4.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

105 de 179 03/03/12 14:46

Page 106: Com an Dos

Enter:

binary

to set the transmission type to I (image).

5.

Enter:

put data.NETDftp systemNameftp systemNameA

You can specify also the target file name, if it is different from the source.Make a note of the byte count, which should be the same for the file on thetarget system. The target system keeps the name in lowercase, although it wasuppercase in TSO.

6.

To transmit a file from CMS

Enter:

sendfile dataFile TO *

to send the file to your reader in netdata format. Do not RECEIVE it, becauseRECEIVE decodes the netdata. Use CP commands to ORDER it and toCHANGE its CLASS to suit the reader. Define a temporary disk if the file islarge.

1.

Enter:

read data NETDATA A

to read the file and preserve the netdata format.

2.

Enter:

ftp systemName

where systemName is the name of the target system.

3.

Enter user ID and password when prompted.4.Enter:

cd directoryName

to change to the target directory if necessary.

5.

Enter:

binary

to set the transmission type to I (image).

6.

Enter:

put data.NETDATA

You can specify also the target file name, if it is different from the source.Make a note of the byte count, which should be the same for the file on thetarget system. The target system keeps the name in lowercase, although it wasuppercase in CMS.

7.

To run the cicsnetdata program

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

106 de 179 03/03/12 14:46

Page 107: Com an Dos

Enter:

cicsnetdata < data.netdata > outputFileName

Messages from a sample run of cicsnetdata (origin CMS)

... control record: INMR01

... logical record length 80

... origin node name WINVMB

... origin userid BAILEYM

... target node name WINVMB

... target userid *

... origin time stamp 19931029164640000000

... no of files 1

... control record: INMR02

... file number 1

... file size in bytes 2048

... file organization 4000

... logical record length 80

... name of utility function INMCOPY

... record format 8000

... name of the file A DATA FILE

... filemode number0

... last change date 19920611095242000000

... control record: INMR03

... file size in bytes 2048

... file organization 4000

... logical record length 80

... record format 0001

... control record: INMR06

... 22 input records

... 4 control records

... 18 output records

Definition files that qtod uses

In addition to the QSAM data file that the cicsnetdata program produces, two otherdefinition files must be present for a successful conversion:

QSAMfileName.ddt.def

This file must be in the same directory as the QSAM data file. It contains thekey and data information about each QSAM record.

The sample file qsam.sdt.def, describes what each tag means. A sample data filecan be found in prodDir/src/examples/sdt. You must rename the file toqsam.ddt.def so that qtod can pick it up. You must change also the tagSFSFile=qsamtest to ORACLEFile=CICS.QSAMTEST.

QSAMfileName.dfh

This file must also be in the same directory as the QSAM data file and is theDFHCNV template source for the QSAM records. DDT does not validate thisfile, so it is recommended that you first check the file by using the cicscvtprogram first. DDT understands only the source; it does not understand the

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

107 de 179 03/03/12 14:46

Page 108: Com an Dos

compiled output from cicscvt. The sample file qsam.dfh shows a typicaltemplate.

To run qtod

A sample QSAM data file qsam.netdata has been provided to demonstrate how use theqtod command to convert QSAM to Oracle. Here are the steps that are necessary toconvert this example:

Use the cicsnetdata program to convert qsam.netdata to ODT-readable format,as follows:

cicsnetdata < qsam.netdata > qsam

This command produces a file called qsam in the current directory.

1.

Create a suitable Oracle table to receive the QSAM records. For this example,enter:

cicsodt -c create qsamTest

2.

Ensure that you have these files in a directory to which you can write:qsamqsam.dfhqsam.ddt.def

The default code pages for conversion are defined at the top of the tableqsam.dfh. You might have to changed them, depending on your operatingsystem.

3.

Run cicsodt so that it is working with the database that has CICS.QSAMTESTon it. Enter:

cicsodt -c qtod qsam

The file qsam must be in the current directory. ODT shows a running count of therecords that are being transferred. If an error occurs, the table must beemptied before it is reloaded.

When the command has finished, the ODT prompt appears again. A log file hasbeen created in the current directory. The file is called qsam.ddt.log in thisexample. Check this log file to ensure that ODT picked up all the record typesand no conversion errors occurred.

4.

cicsppcgwy - Start a PPC Gateway server

AIX HP-UX Sun Solaris Windows

X X X

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

108 de 179 03/03/12 14:46

Page 109: Com an Dos

The purpose of the cicsppcgwy command is to start and initialize an Encina PPCGateway server.

Syntax

cicsppcgwy [-I] [-t component:traceMask [:component:traceMask] ... ] [[-TtraceClass [=traceClass ... ] = [modifier,modifier]outputClass:destination]...][serverName] [attributeName=attributeValue ... ]

cicsppcgwy -?

Description

You must be logged in as a user who can run the startsrc (CICS for AIX) orcicsstart (all other CICS on Open Systems platforms) command.The logical volume and userid for the PPC Gateway server must have beencreated by the user before this command is run.If you are not using DCE servers, you must add an entry to /var/cics_servers/server_bindings after running cicsppcgwycreate.CICS must be installed on the same machine as the PPC Gateway server. IfCICS is not installed on the same machine as the PPC Gateway server, thenrefer to the Encina Administration Guide Volume 2: Server Administration fordescriptions of alternative procedures.

The cicsppcgwy command starts and initializes an Encina PPC gateway server.

If for any reason cicsppcgwy encounters a problem, it leaves the PPC Gatewayserver as it is, to allow investigation of the problem. cicsppcgwyshut can then beused to shut down the PPC Gateway server when required.

The server's details are retrieved from the stanza entry in /var/cics_servers/GSD/GSD.stanza (on cold starts), or /var/cics_servers/GSD/AUTO.stanza (on auto starts), andthen the server is started using an operating system command. On CICS for AIX thisis the startsrc command.

Stanza attributes can be overridden by supplying one (or more) pairs ofattributeName=attributeValue assignments. Note that the specification of aStartType override (cold or auto) determines whether the details are retrievedfrom the server database or its recovery-image. On CICS for AIX only, if thecommand is called from the SMIT panels cicscstartgsd or cicsastartgsd, thisoverride is explicitly added.

The -t and -T options are provided to allow the PPC gateway to be traced using theEncina trace facilities. It is expected that these options will only be used under thedirection of your support organization, so they are not documented here in detail.See the CICS Intercommunication Guide for more information.

Options

-I

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

109 de 179 03/03/12 14:46

Page 110: Com an Dos

causes errors to be ignored.

-t ...specifies Encina trace masks.

-T ...specifies Encina trace output classes. -T can be used more than once.

serverNameis the full name of the server, such as /.:/cics/ppc/gateway/servername.

If a server name is not given cicsppcgwy will use contents of the environmentvariable CICS_PPCGWY_SERVER.

attributeName=attributeValue ...are overrides for database values.

-?causes the usage message to be displayed.

Examples

To start and initialize the PPC Gateway server GATESERV1 with a StartType ofcold, enter

cicsppcgwy /.:/cics/ppc/gateway/GATESERV1 StartType=cold

1.

To autostart the PPC Gateway server GATESERV1, enter

cicsppcgwy /.:/cics/ppc/gateway/GATESERV1

2.

cicsppcgwycreate - Create a PPC Gateway serverserver

AIX HP-UX Sun Solaris Windows

X X X

The purpose of the cicsppcgwycreate command is to create an Encina PPCGateway server.

Syntax

cicsppcgwycreate [-v] [-I] [-S] serverName [-m modelName][attributeName=attributeValue ... ]

cicsppcgwycreate -?

Description

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

110 de 179 03/03/12 14:46

Page 111: Com an Dos

You must be logged in as root or administrator because cicsppcgwycreateadds a new SRC subsystem.If you are using DCE authentication you must be logged in to DCE, withsufficient authority to create a DCE principal, account and keytab - usually theDCE cell administrator.The userid, which is to be used as the gateway ShortName, must have beencreated. It should be defined with a primary group of cics and a homedirectory of /var/cics_servers/GSD/cics/ppc/gateway/userId. You will find how tocreate a userid in the CICS Intercommunication Guide.You must create a logical volume for the userid, called log_userId.CICS must be installed on the same machine as the PPC Gateway server. IfCICS is not installed on the same machine as the PPC Gateway server, thenrefer to the Encina Administration Guide Volume 2: Server Administrationmanual for descriptions of alternative procedures.

cicsppcgwycreate cannot be used to create an Encina PPC Gateway server on aremote machine because the underlying startsrc (CICS for AIX) or cicsstart (allother CICS on Open Systems platforms) command has no host parameter. A remoteEncina PPC Gateway server must be created manually on the remote machine.

The cicsppcgwycreate command is used to add a PPC Gateway server server intothe server database. It also adds an SRC entry, the CDS entry, and registry andkeytab entries.

An invalid option will result in an error message being displayed.

With no options specified cicsppcgwycreate will display the usage message for thiscommand.

If you are not using DCE servers you must add an entry to /var/cics_servers/server_bindings after running cicsppcgwycreate.

Options

-v(verbose) Messages describing the progress of the server creation aredisplayed.

-Icauses errors to be ignored.

-Scauses the PPC Gateway server server to be created without using DCEservers.

serverNameis the name of the PPC Gateway server server (GSD.stanza key).

-m modelNamespecifies the name of a model server.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

111 de 179 03/03/12 14:46

Page 112: Com an Dos

attributeName=attributeValue ...overrides for database values.

-?causes the usage message to be displayed.

Examples

To create the PPC Gateway server server GATESERV1 using the model serverMODELGATE, enter

cicsppcgwycreate /.:/cics/ppc/gateway/GATESERV1 \ -m /.:/cics/ppc/gateway/MODELGATE

1.

To create the PPC Gateway server server GATESERV1 with a short name ofGATESERV1, enter

cicsppcgwycreate /.:/cics/ppc/gateway/GATESERV1 ShortName=GATESERV1

2.

cicsppcgwydestroy - Destroy a PPC Gateway server

AIX HP-UX Sun Solaris Windows

X X X

The purpose of the cicsppcgwydestroy command is to destroy an Encina PPCGateway server.

Syntax

cicsppcgwydestroy [-v] [-S] serverName

cicsppcgwydestroy -?

Description

You must be logged in as root or administrator.If you are using DCE authentication you must have the DCE credentials todelete the principal/account for the principal.CICS must be installed on the same machine as the PPC Gateway server. IfCICS is not installed on the same machine as the PPC Gateway server, thenrefer to the Encina Administration Guide Volume 2: Server Administrationmanual for descriptions of alternative procedures.

The cicsppcgwydestroy command is used to destroy a PPC Gateway server, byremoving the log restart files, all details about the server from the /var/cics_serversdirectory, and the relevant DCE entries.

The SRC entry for the server is also removed.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

112 de 179 03/03/12 14:46

Page 113: Com an Dos

Note:Use this command with care because, although a PPC gateway can berecreated, data associated with the gateway is lost.

Options

-v(verbose) Messages describing the progress of the destruction of the serverare displayed.

-Scauses the PPC Gateway server server to be destroyed without using DCEservers.

serverNameis the name of the PPC Gateway server.

-?causes the usage message to be displayed.

Examples

To destroy the PPC Gateway server GATESERV1, enter

cicsppcgwydestroy /.:/cics/ppc/gateway/GATESERV1

cicsppcgwylock - Lock or unlock a PPC Gatewayserver

AIX HP-UX Sun Solaris Windows

X X X

The purpose of the cicsppcgwylock command is to take or release an Encina PPCGateway server lock.

Syntax

cicsppcgwylock { -l | -u | -t } serverName

cicsppcgwylock -?

CICS must be installed on the same machine as the PPC Gateway server. If CICS isnot installed on the same machine as the PPC Gateway server, then refer to theEncina Administration Guide Volume 2: Server Administration manual fordescriptions of alternative procedures.

The cicsppcgwylock command either takes or releases a lock for a specified PPC

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

113 de 179 03/03/12 14:46

Page 114: Com an Dos

Gateway server. It is used to serialize the create, start, stop, and destroy phases of aPPC Gateway server.

Each PPC Gateway server (/.:/cics/ppc/gateway/serverName) has a lock file called/var/cics_servers/GSD/cics/ppc/gateway/serverName/lock.

Options

-lcicsppcgwylock to wait until the PPC Gateway server that owns the lock file isno longer running and then takes the lock.

-ucauses the lock file for the PPC Gateway server to be released unconditionally.

-tcicsppcgwylock to try to take the lock file but to return immediately if it isunsuccessful.

serverNameis the name of the PPC Gateway server for which the lock is to be taken orreleased.

-?causes the usage message to be displayed.

Returned Values

0Successful

1Unsuccessful

Examples

To take the lock on the PPC Gateway server GATESERV1 and return error if it isnot free, enter

cicsppcgwylock -t /.:/cics/ppc/gateway/GATESERV1

1.

To release the lock on the PPC Gateway server GATESERV1, enter

cicsppcgwylock -u /.:/cics/ppc/gateway/GATESERV1

2.

cicsppcgwyshut - Shut down a PPC Gateway server

AIX HP-UX Sun Solaris Windows

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

114 de 179 03/03/12 14:46

Page 115: Com an Dos

X X X

The purpose of the cicsppcgwyshut command is to shut down an Encina PPCGateway server.

Syntax

cicsppcgwyshut [-f] [-c] serverName

cicsppcgwyshut -?

Description

You must be logged in as a user who can run the stopsrc (on CICS for AIX) orcicsstop (on all other CICS for Open Systems platforms) command.If you are using DCE authentication, you must be logged in to DCE.CICS must be installed on the same machine as the PPC Gateway server. IfCICS is not installed on the same machine as the PPC Gateway server, thenrefer to the Encina Administration Guide Volume 2: Server Administrationmanual for descriptions of alternative procedures.

The cicsppcgwyshut command shuts down a PPC Gateway server for a CICSregion. It also removes the lock on the server after a successful shutdown.

Options

-fforces a shutdown of the PPC Gateway server.

-ccancels the SRC subsystem in which the PPC Gateway server is running.

serverNameis the name of the PPC Gateway server.

-?causes the usage message to be displayed.

Examples

To force a shutdown of the PPC Gateway server GATESERV1, enter

cicsppcgwyshut -f /.:/cics/ppc/gateway/GATESERV1

cicsremovelv - Remove a logical volume

AIX HP-UX Sun Solaris Windows

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

115 de 179 03/03/12 14:46

Page 116: Com an Dos

X

The cicsremovelv command removes a logical volume that was created bycicsmakelv.

Syntax

cicsremovelv -v volumeName

cicsremovelv -?

Description

You must be logged on as a user who has administrative privileges

The cicsremovelv command deletes a logical volume and removes the NT Registryinformation for the volume.

This command destroys all data on the logical volume; the data cannot be recoveredat a later time.

Options

-v volumeNamespecifies the name of the logical volume that is to be deleted.

Examples

To delete the logical volume known as sfs_Server1:

cicsremovelv -v sfs_Server1

1.

cicsrlck - Remove old region lock files

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to remove any lock files for a region left by a CICS process thatterminated in an uncontrolled manner.

Syntax

cicsrlck [-f] { -a | -r regionName}

cicsrlck -?

Description

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

116 de 179 03/03/12 14:46

Page 117: Com an Dos

The cicsrlock command removes any CICS lock files left by a CICS process thatterminated in an uncontrolled manner. You must use this command with great carebecause the -a and -f flags enable you to override CICS locking mechanisms,allowing you to run multiple CICS processes in the same region. The cicsrlckcommand writes a message to the system log for each lock file that it removes.

Options

-fremoves a single lock file from the region whose owning CICS process is stillrunning.

-aunconditionally removes the lock files from all regions. If the region or regionsare still running, the locks are removed regardless of whether or not the -f flagis specified.

-r regionNamespecifies the region name when removing a single lock file. The cicsrlckcommand checks that regionName is valid. If regionName is invalid, cicsrlckwrites an error message to standard error.

If you do not specify a region name, CICS removes the lock files for the regionspecified by the CICSREGION environment variable.

-?displays the usage message that shows the correct syntax for the cicsrlckcommand. If you enter the command syntax incorrectly, the correct usage isdisplayed.

Examples

To remove all CICS lock files:

cicsrlck -a

1.

To remove the CICS lock file for the CICS region REGIONB:

cicsrlck -r REGIONB

2.

cicssdt - SFS diagnostic tool

AIX HP-UX Sun Solaris Windows

X X X X

The CICS SFS Diagnostic Tool (SDT) provides an interactive interface to the SFS.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

117 de 179 03/03/12 14:46

Page 118: Com an Dos

Syntax

cicssdt [-s SFSname] [-i inputFile] [-o outputFile] [-e] [-r] [-c SDTcommands ...]

cicssdt -?

Description

You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).You must have an active SFS.If you are using DCE authentication you must have a DCE context that hassufficient authority to:

Create a DCE principal and account.Create a Server Key Table.

Usually this is a DCE cell administrator.

If you are not using DCE authentication, you must have the environmentvariable ENCINA_BINDING_FILE set.

Options

Note:Except for -c, which must be the last parameter, the parameters can be in anyorder.

-s SFSnamespecifies the name of the SFS. For example, /.:/cics/sfs/SFS1. If this option isnot specified, the server name in the environment variable CICS_XDT_SERVERis used. CICS_XDT_SERVER overrides CICS_SFS_SERVER.

-i inputFilespecifies a text file containing SDT commands to be read and executed. The filecan be created either by hand or by using the -o option. Each line of the inputfile is treated as if it were typed in interactive mode. The text from the inputfile is also displayed as it is processed by cicssdt. Comments can be includedin the file by starting a line with "/*".

For example, if you create an input file called create.input that contains thefollowing lines:

/*/* This is a sample file to create a SFS file called qsamTest/*create qsamTest

bflbyteArray10f2

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

118 de 179 03/03/12 14:46

Page 119: Com an Dos

varLenByteArray100

f1yf1a

1quit

then execute cicssdt as follows:

cicssdt -s SFSname -i create.input

A new file called qsamTest is created on the specified SFS.

-o outputFilecauses commands entered in the SDT session to be written to the specifiedoutput file. This file can then be used as an input file using the -i option.

-erequests SDT to terminate if an error occurs. If -e is specified and SDT is beingdriven from a shell script (-i) or the command line (-c), any error resultingfrom a command will exit SDT with a non-zero return code.

-ractivates SDT statistics. Statistics for SDT and SFS calls are sent to a filecalled sdt.stats in the current directory. This is useful for monitoringperformance.

-c SDTcommands ...specifies a list of commands and text to be used in the SDT session. This isuseful for calling SDT commands from a shell script. This parameter must beused last.

Using the SDT commands: To issue commands in SDT, pass them to SDT usingthe -i or -c option, or type the command at the command prompt. SDT acceptscommand abbreviations. In the command syntax the minimum abbreviation isshown in parentheses; for example, (s)etopen. Any command that requires a filename will default to the last name used if nothing is given at the prompt. SDT alsorecognizes any environment variables used at the command prompt.

SDT commands - setopen

(s)etopen

Defines the characteristics of any open calls used in other SDT commands.Non-transactional opens are used by default. If the open is transactional, SDTwill manage the client transaction for you. This command also lets you definethe locking mode used during a read, (the default is no lock or a dirty read). Ifa value of zero is specified for the OFD operation timeout this effectively

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

119 de 179 03/03/12 14:46

Page 120: Com an Dos

defines no timeout, such as wait forever. Error Isolation can only be inactivefor transactional OFDs.

cicssdt -s SFSname -c setopen

[Type In New Letter To Change Value. Just <ENTER> To Leave Asis ...

[Access Mode - [S]hared/[E]xclusive - (SharedAccess):[Timeout For OFD Operations (In Seconds) - (60 ):[Consistency - [T]ransactional/[N]on-Trans - (Non-Transactional): t[Turn Error Isolation Off ? .............................. Y/[N]: y[Lock Mode - [R]ead/[W]rite/[B]racket/[N]one - (No Lock):

SDT commands - list

(l)ist [(l)] searchString

Lists all the files on the server that SDT is accessing. If the l option is used,additional information is given for each file. If SDT cannot open a file to obtainlong information, processing continues with the next file. A search string canalso be given to list specific files. If a search string is used, SDT will look for allthe filenames that contain the string. There are no "wild card" characters, sothe search string is taken as entered.

cicssdt -s SFSname -c li l AC1cics

File Name Organisation Primary Index No. Records================== ===================== =============== ===========AC1cicsnlqfile btreeClustered (KSDS) cicsnlqidx (empty)AC1cicsnrectsqfil btreeClustered (KSDS) cicsnrectsqidx (empty)AC1cicsplqfile btreeClustered (KSDS) cicsplqidx (empty)AC1cicsrectsqfile btreeClustered (KSDS) cicsrectsqidx (empty)AC1cicstdqlgfile btreeClustered (KSDS) cicstdqlgidx (empty)

SDT commands - create

(c)reate fileName

Creates a new SFS file. All the file information is prompted for in turn. To aidusability and eliminate creation errors, SDT will make sure everything enteredis valid and default to sensible values if nothing is entered. One exception isthe record Field Name and index Field Name that use an empty entry toindicate there are no more fields. Also, some fields may not be able todetermine a default entry and reprompt for input after displaying some help. Ifq! is entered at any prompt the create is cancelled.

cicssdt -s SFSname -c create qsamTest

[SFS Server Volume Name .....: sfs_SFS_SERV[File Organisation [E/R/B] ..: B[treeClustered][Field 01: Name .............: f1[Field 01: Type .............: Error: Invalid field type. Type must be: unsignedInt16, signedInt16, unsignedInt32, signedInt32, unsignedInt64, signedInt64,

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

120 de 179 03/03/12 14:46

Page 121: Com an Dos

float, double, string, nlsString, byteArray, varLenByteArray, shortVarLenByteArray, timestamp or decimal.[Field 01: Type .............: byteArray[Field 01: Size .............: 10[Field 02: Name .............: f2[Field 02: Type .............: varLenByteArray[Field 02: Size .............: 100[Field 03: Name .............:[Maximum Number Of Records ..: SFS_NATURAL_RECORD_LIMIT[Primary Index Name .........: f1[Is Index Unique ? [Y]/N ....: Y[Index Field 01: Field Name .: f1[Index Field 01: Ordering ...: a[scending][Index Field 02: Field Name .:[Number Of Pages To Allocate : 1

Note:When the cicssdt utility is used to create a file that uses a relative-recorddata-set (RRDS), to place a limit on the number of records in the file,calculate the maximum to be the desired limit plus one.

SDT commands - read

(r)ead fileName

Reads records from a file on the SFS. Records can be read from the beginningof the file or from a specific key based on any active index. Records can also beread continuously or individually. When a key value is specified it is taken as astring unless it is in the format #n, where n is a numeric value. The followingformat can be used for a hexadecimal representation of the key:

0x0a01 ...

A key that corresponds to a string field must be entered in the form:

$string

If the read is not continuous you have the option to delete or update eachrecord read. If the record is to be updated the primary index cannot bechanged. If nothing is entered for a field during an update the field is leftunaltered, otherwise data entry is same as for the write command. Thiscommand will not handle , nor will it handle reads using the Entry SequenceNumber for sequential files. It will, however, handle alternate index reads, thatis, reads using the SFS secondary index.

The read command will only show up to 44 bytes of field data and shouldtherefore not be used to check the data integrity of records containing longfields. The stof command is more suitable for this.

cicssdt -s SFSname -c r qsamTest

[Index To Use ...............: f1[Read From Beginning ? [Y]/N : Y

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

121 de 179 03/03/12 14:46

Page 122: Com an Dos

[Continuous Read ? Y/[N] ....: N

[Read #00000001[f1 ][........@@ ][000010] [Hex][01C3D7E2E2C4D4F14040 ][f2 ][@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@.............][000126] [Hex][4040404040404040404040404040404040404040404040 ]

[Read Another, Delete or Update ? [Y]/N/D/U n

[1 Record(s) Read]

SDT commands - write

(w)rite fileName

Writes records to a file on the SFS. Text or hexadecimal data can be entered ineach field; these cannot be mixed. Hexadecimal is entered in the followingform:

0x010203 ...

If the field is long and you need to enter a large amount of data, a shorthandmethod can be used. For example, to fill the remainder of a field with 33 'A'characters enter

A>>32

or enter

0x20>>32

for 33 spaces.

You must enter something in at least one of the fields in the record for SDT towrite it; if all are left blank no record will be written. Partly filled fixed-lengthfields are not automatically padded with spaces. If A>>32 would exceed thefield length the string "A>>32" is taken literally. Automatic writes can beachieved by specifying #N followed by the number of writes in anunsignedInt32 field. For example, use #N10 to add 10 records automatically. If#N or #N0 is specified, writes will continue until an error occurs.

cicssdt -s SFSname -c w recover

[skey1 ][ byteArray ] [Size:00008][001[srecord1 ][ byteArray ] [Size:00042][Some text

[Another ? [Y]/N n

[1] Record(s) Added OK.

SDT commands - empty

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

122 de 179 03/03/12 14:46

Page 123: Com an Dos

(e)mpty fileName

Empties a file of all committed records. SDT provides two types of recordemptying; an exclusive empty and a shared empty. An exclusive empty willattempt to get exclusive access to the file to issue an empty call. If a sharedempty is requested SDT will delete as many records as it can, leaving the onesthat are locked. The exclusive empty is recommended as this guarantees anempty file.

cicssdt -s SFSname -c empty recover

[Exclusive Empty ? [Y]/N ....: Y[Empty File "recover" ? Y/[N] y

SDT commands - delete

(d)elete fileName

Deletes a file from the SFS. This command will time out and fail if the file isstill in use.

cicssdt -s SFSname -c delete recover

[Delete File "recover" ? Y/[N] y

SDT commands - free

(fr)ee fileName

Destroys all the Open File Descriptors (OFDs) associated with a particular file.This command should only be used if the file is not in use. SDT will tell you thetransaction identifiers related to each OFD it destroys. The transactionidentifiers will not necessarily disappear with the OFD. Use tkadmincommands to check the status of the transaction identifiers if the file stillremains locked. For details of tkadmin commands, see the EncinaAdministration Guide Volume 1: Basic Administration.

cicssdt -s SFSname -c free recover

[Are You Sure You Want To Close All OFDS On This File ? Y/[N] y

[Closing All OFDs on File: recover...---------------------------------------------------------[OFD 00000307:(TIDS 03211413) ..... Closed.---------------------------------------------------------

SDT commands - addindex

(a)ddindex fileName

Adds a secondary index to the SFS file. Exclusive access is required for thiscommand, so the file should not be in use. The secondary index will be addedand made active automatically. Typing q! will cancel the command.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

123 de 179 03/03/12 14:46

Page 124: Com an Dos

cicssdt -s SFSname -c a Angus

[Filename ...................: Angus[Secondary Index Name........: index2[Is Index Unique ? [Y]/N ....: n[Alternate Rec. Spec. ? Y/[N]: N[Index Field 01: Field Name .: f2[Index Field 01: Ordering ...: d[escending][Index Field 02: Field Name .:

SDT commands - delindex

(deli)ndex fileName

Deletes a secondary index from the SFS file. Exclusive access is required forthis command, so the file should not be in use.

cicssdt -s SFSname -c delindex Angus

[Secondary Index Name........: index2

SDT commands - info

(i)nfo fileName

Shows detailed information about the SFS file. This command will list all theactive Open File Descriptors (OFDs) and locks held on the file. This isparticularly useful to see if a file is still in use or has unresolved transactionsusing it.

cicssdt -s SFSname -c i Angus

[Information For File: Angus ]----------------------------------------------------------------[File Organisation ] btreeClustered (KSDS)[Primary Index Name ] f1 (Unique index)[Primary Index Field(s) ] f1[Secondary Index Names ] (None Defined)[Number Of Records In File ] 4[Number Of Fields Per Record] 2[Field 001: f1 ][byteArray][Size:10 ][Field 002: f2 ][unsignedInt32][Size: 4 ]----------------------------------------------------------------[OFD: 0000052 DCE Owner: (Not defined) Access: Shared Mode]Type: Transactional TID: (n/a) RPC Count: 00000002Isolation: Cursor Stability Op. Timeout: 60 (Secs)Open TID: 65669 Idle Timeout: 300 (Secs)Label: (null) Open Time: Tue Aug 23 11:16:52 1994[OFD: 0000055 DCE Owner: (Not defined) Access: Shared Mode]Type: Transactional TID: 65681 RPC Count: 00000002Isolation: Cursor Stability Op. Timeout: 60 (Secs)Open TID: 65649 Idle Timeout: 300 (Secs)Label: (null) Open Time: Tue Aug 23 11:17:26 1994[Locks Held Against TID: 65681]Lock 01: File (Null Lock)

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

124 de 179 03/03/12 14:46

Page 125: Com an Dos

Lock 02: Record Write Intent LockLock 03: Record Write Lock held on index f1----------------------------------------------------------------

SDT commands - server

(ser)ver serverName

Changes the current SDT server to the new one specified. The complete servername must be given. If the new server cannot be contacted the old serverremains current.

cicssdt -s SFSname -c ser /.:/cics/sfs/jim

[Contacting new server... (Server OK)]

SDT commands - qtos

(qt)os QSAMfileName

Transfers and converts a QSAM file to an SFS file.

cicssdt -s SFSname -c qtos qsam

[Default Code Pages: EBCDIC (IBM-037) -> ASCII (ISO8859-1) ...

[Transferring Records. Record No.][00000022]

SDT commands - stof

(st)of SFSfileName

Transfers an SFS file to a flat file. The format of the flat file can either be SDTformat or Asis (the file is transferred byte by byte as it is). In SDT format theflat file will start with a header containing information on the structure of thefile, followed by a newline character and an eight-byte number. The number isthe length of the record excluding the number itself. If the file is transferredAsis, no extra information is contained in the flat file. A single record or arange of records can be dumped. The record number corresponds to theposition of the record using the primary index. To dump record 10, enter 10 atthe [Dump Record(s) prompt. Type 10- to dump records from 10 onwardsand type 10-12 to dump records 10 to 12 inclusive.

cicssdt -s SFSname -c stof Angus

[Flat Filename ..............: Angus.sdt[Dump file Asis ? ..... Y/[N]: N[Dump Record(s) .............: ALL

[File "Angus.sdt" Already Exists. Overwrite ? [N]/Y y

[Dumping All Records][Dumping Record #][00000010]

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

125 de 179 03/03/12 14:46

Page 126: Com an Dos

SDT commands - ftos

(f)tos SFSfileName

Transfers a flat file produced from the stof command to an SFS file. The SFSfile must already exist, but does not have to be the file used to create the flatfile. In fact, ftos will transfer anything that will fit into the specified SFS file.See the stof command for the expected flat file format. If the SFS file does notexist and the flat file is in SDT format, SDT will ask if you want the file to becreated. If the flat file is not in a recognised format produced using the stofcommand, ftos will read the flat file as it is and will attempt to fit the data intothe SFS file.

cicssdt -s SFSname -c f Angus

[Filename ...................: Angus

[Flat Filename ..............: Angus.sdt

[Loading Record #][00000010]

SDT commands - !

Escapes to a system command prompt. Exiting the command prompt returnscontrol to SDT.

cicssdt -s SFSname -c !

[Exit To Shell. Use <Ctrl-D> To Return .....

ls q* (Open Systems) or dir q*.* /w (Windows) qsam qsam.dfh qsamTest qsamcsd.sdt.def qsam.conv qsam.log qsamcsd qsamcsd.sdt.log qsam.def qsam.sdt.def qsamcsd.dfh qtest ^D

SDT commands - quit

(q)uit

Exits SDT and returns control to the calling process.

cicssdt -s SFSname -c q

SDT commands - help or ?

(h)elp (or ?) commandName

Gives general or specific online help for SDT commands.

cicssdt -s SFSname ? create

QSAM to SFS file transfer: The purpose of this section is to help you understand

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

126 de 179 03/03/12 14:46

Page 127: Com an Dos

how to transfer QSAM files from a host system to a target system running a CICSfor Open Systems product.

When a file is sent directly to a target system, record boundaries are lost when it isreceived. By capturing the file on TSO or CMS in netdata format and sending it as abinary file to the target system using the File Transfer Program (ftp), the originalnetdata format is preserved.

The cicsnetdata program is used to read the file and re-construct the outputrecords with the count preceding each record, as expected by the cicssdt qtoscommand.

If a file is in netdata format, you will find that control records INMR01, INMR02,INMR03 precede the data, and INMR06 follows the data; these names are inEBCDIC. All input (control records and data) is segmented. The first byte of asegment contains the segment length, including itself. The second byte of thesegment contains a flag byte. The flag settings are:

0x80 first segment0x40 last segment0x20 segment is part of a control record

To transmit a file from TSO:

Enter: transmit (nodeName/userId) DSN (data.file) OUTDSN(data.NETDATA)SEQ

TRANSMIT can be abbreviated to XMIT.

nodeName/userId is required syntactically. Although it is not used whentransmitting to a file, it is validated, so specify a known node and userid.

DSN names the input to XMIT.

OUTDSN names the output netdata file. The type NETDATA is suggested.

If the input was a PDS member, then SEQ is required, or the file will not beusable on the target system. The name of utility function must be INMCOPY forcorrect results (see sample messages below).

1.

Enter: ftp systemName

where systemName is the name of the target system.

Enter userid and password when prompted.

2.

Enter: cd directoryName

to change to the target directory if necessary.

3.

Enter: binary4.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

127 de 179 03/03/12 14:46

Page 128: Com an Dos

to set the transmission type to I (image).

Enter: put data.NETDATA

The target file name can also be specified, if different from the source. Make anote of the byte count, which should be the same for the file on the targetsystem. The target system keeps the name in lower case, even though it wasupper case in TSO.

5.

To transmit a file from CMS:

Enter: sendfile dataFile TO *

to send the file to your reader in netdata format. Do not receive it becausereceive will decode the netdata. Use CP commands to order it and change itsclass to suit the reader. Define a temporary disk if the file is large.

1.

Enter: read data NETDATA A to read the file and preserve the netdata format.2.Enter: ftp systemName

where systemName is the name of the target system.

Enter userid and password when prompted.

3.

Enter: cd directoryName

to change to the target directory if necessary.

4.

Enter: binary

to set the transmission type to I (image).

5.

Enter: put data.NETDATA

The target file name can also be specified, if different from the source. Make anote of the byte count, which should be the same for the file on the targetsystem. The target system keeps the name in lower case, even though it wasupper case in CMS.

6.

To run the cicsnetdata program:

cicsnetdata < data.netdata > outputfile

Messages are sent to the operating system file stream stderr.

Messages from a sample run of cicsnetdata (origin CMS):

... control record: INMR01

... logical record length 80

... origin node name WINVMB

... origin userid BAILEYM

... target node name WINVMB

... target userid *

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

128 de 179 03/03/12 14:46

Page 129: Com an Dos

... origin time stamp 19931029164640000000

... no of files 1

... control record: INMR02

... file number 1

... file size in bytes 2048

... file organisation 4000

... logical record length 80

... name of utility function INMCOPY

... record format 8000

... name of the file A DATA FILE

... filemode number0

... last change date 19920611095242000000

... control record: INMR03

... file size in bytes 2048

... file organisation 4000

... logical record length 80

... record format 0001

... control record: INMR06

... 22 input records

... 4 control records

... 18 output records

Definition files used by qtos:

In addition to the QSAM data file produced by the cicsnetdata program there mustbe two other definition files for a successful conversion:

QSAMfilename.sdt.def

This file must be in the same directory as the QSAM data file. It contains thekey and data information about each QSAM record.

The sample file qsam.sdt.def, describes what each tag means. A sample data filecan be found in prodDir/src/examples/sdt.

QSAMfilename.dfh

This file must also be in the same directory as the QSAM data file and is theDFHCNV template source for the QSAM records. SDT will not validate this fileso it is recommended that the file is checked using the cicscvt program first.SDT only understands the source, not the compiled output from cicscvt. Thesample file qsam.dfh shows a typical template.

To run qtos:

A sample QSAM data file qsam.netdata has been provided to demonstrate QSAM toSFS conversion using the qtos command. The following describes the stepsnecessary to convert this example:

Convert qsam.netdata to SDT-readable format using the cicsnetdata program asfollows:

cicsnetdata < qsam.netdata > qsam

to produce a file called qsam in the current directory.

1.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

129 de 179 03/03/12 14:46

Page 130: Com an Dos

Create a suitable SFS file to receive the QSAM records. For this example, enter

cicssdt -s SFSname -c create qsamTest

2.

Make sure you have the following files in a directory you can write to:

qsamqsam.dfhqsam.sdt.def

The default code pages for conversion are defined at the top of the file qsam.dfh;these may have to be changed, depending on your operating system.

3.

Run cicssdt so that it is working with the server which has qsamTest on it.

Enter

cicssdt -s SFSname -c qtos qsam

The file qsam must be in the current directory. SDT will show a running count ofthe records being transferred. If an error occurs the file must be emptiedbefore it is reloaded, unless the setopen command has been previously used togive a transactional load.

4.

When the command has finished the SDT prompt should reappear and a log filewill have been created in the current directory. The file will be calledqsam.sdt.log in this example. Check this log file to make sure SDT picked up allthe record types and there were no conversion errors.

5.

cicssetupclients - Configure DCE for the CICSclients

AIX HP-UX Sun Solaris Windows

X X X X

If you are using DCE authentication, the command cicssetupclients is used toconfigure a DCE client for a CICS client or region. On AIX only, it is also installs theAIX kernel extensions used by CICS for inter-process communication. You must runthis command once for each host that is to be part of a DCE cell used by CICSbefore you run a terminal or region. If you have configured DCE or a CICS regionthat will use DCE services by using the cicscp command, the cicssetupclientscommand is run automatically by the cicscp command script.

You may also need to use this command if you add or change a network card in yourclient machine since the card number is used to generate the principal name for theclient.

Syntax

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

130 de 179 03/03/12 14:46

Page 131: Com an Dos

cicssetupclients [-I] [-v] [-m] [-d]

cicssetupclients -?

Description

You must be logged in as a user with root or administrator privileges.You must be authenticated as a DCE principal with authority to create otherprincipals (cell_admin, for example).

If you are using DCE authentication use this command to configure a DCE client fora CICS client.This command creates a keytab file containing the client's principaland account. The keytab file is placed in the directory /var/cics_clients. Run thiscommand on all hosts which will run CICS clients or regions.

On CICS for AIX only, use this command to install the AIX kernel extensions used bythe CICS terminal emulator.

If you are not using DCE authentication and you are not running CICS for AIX youdo not need to use this command at all.

Options

-I(Uppercase letter "i") Ignores errors.

-vgives a detailed output while the command runs.

-minstalls the kernel extensions on CICS for AIX only without configuring DCE.

-dconfigures DCE but does not install the kernel extensions on CICS for AIX only.

-?displays the usage message.

Examples

To configure DCE for a newly installed CICS client, first log in as root oradministrator and authenticate your DCE principal, then enter:

cicssetupclients

cicssetupdce - Create directories and groupswithin a DCE cell

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

131 de 179 03/03/12 14:46

Page 132: Com an Dos

AIX HP-UX Sun Solaris Windows

X X X X

Creates directories and groups for CICS within DCE's Cell Directory Service.

Syntax

cicssetupdce [-v] [-C | -I [-a | -o]]

Description

cicssetupdce adds the following directories and groups to DCE's Cell DirectoryService. The directories will eventually contain entries for SFS and regions:

Directories:

/.:/cicsCDS directory

/.:/cics/ppcCDS directory

/.:/cics/ppc/gatewayCDS directory

/.:/cics/trpcCDS directory

/.:/cics/tmxaCDS directory

/.:/cics/profileCDS profile

/.:/cics/sfsCDS directory

Groups:

cics_userscontains principals for CICS processes

cics_admincontains principals for CICS administrators

cics_sfscontains principals for SFS

cics_ppcgwycontains principals for PPC group

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

132 de 179 03/03/12 14:46

Page 133: Com an Dos

cics_regionscontains principals for CICS regions

You need to run cicssetupdce only once per DCE cell, during the configuration of anewly installed CICS system. To run it, you must be authenticated as a DCEprincipal (such as cell_admin) with sufficient privileges to create or view a DCEgroup, directory or object and to set the necessary Access Control Lists (ACLs).

ACLs control the security of directories. Use cicssetupdce to set the ACLs for eachnewly created directory so that the members of the appropriate group, the principalthat is executing the command, the CDS groups subsys/dce/cds-admin andsubsys/dce/cds-server have access to the directory and its objects. Members ofthe other groups are granted more restrictive access to these directories based ontheir needs. cicssetupdce also sets the initial container and initial object ACLs.

cicssetupdce first searches to see if the groups and directories it is about to createcurrently exist. If you specify the -l flag when you invoke cicssetupdce, itoverwrites any existing groups or directories with new ones. You can use the -a or-o option to control how cicssetupdce changes the ACLs of existing directories orgroups. If neither of these flags is specified, then the ACLs for pre-existingdirectories are left unchanged because to alter these ACLs may compromisesecurity. If the -l flag wasn't used, cicssetupdce stops with an error code when itencounters a pre-existing group or directory.

Note:Make sure that your /etc/hosts file contains a valid host name and that itspermissions are set correctly.

Options

-I(Uppercase i) Ignores error messages about pre-existing entries. Errormessages are changed to warning messages and cicssetupdce continues,overwriting existing directories and groups with new ones. Use this flag if aDCE cell has already been partially pre-configured, possibly by a previousinvocation of the command that was interrupted.

-aACLs defining how the groups access the CDS directories are added to theACLs for the existing CDS directories. ACLs defining how any other principalsor groups access these directories are not changed. If you use this option,check that the resulting ACLs meet your security needs. Use this with the -lflag

-oACLs defining how the groups access the CDS directories override the ACLsfor the existing CDS directories. Any pre-existing ACLs for other principals orgroups are removed. This flag can be used only in a cell whose CDS serverprincipals are members of group subsys/dce/cds-server. Use this with the -l

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

133 de 179 03/03/12 14:46

Page 134: Com an Dos

flag.

-Cremoves any existing CICS groups and CDS directories prior to recreatingthem. Accounts that are members of these groups are also deleted. Using thisflag is equivalent to executing cicscleandce before running cicssetupdce.Use this parameter only if you know that none of the entities selected forremoval are required.

-vgives a detailed output while the command runs.

Examples

If you want to permit access to CICS directories by CICS groups withoutrevoking other groups' access, enter:

cicssetupdce -I -a

This creates the required groups and directories. If pre-existing directories arediscovered, cicssetupdce adds to their ACLs, the ACLs defining the accessprivileges for the CICS groups.

1.

If you want cicssetupdce to display what it is doing while it creates therequired groups and directories and to fail if it discovers pre-existing groups ordirectories, enter:

cicssetupdce -v

Because you have not specified the -l flag, cicssetupdce stops with an errorcode if it discovers a pre-existing group or directory.

2.

cicssfmt - Statistics formatter

AIX HP-UX Sun Solaris Windows

X X X X

To extract data from a statistics file or files that CICS creates as part of a CICSstatistics sequence.

Syntax

cicssfmt [-c categoryNames] [-s startTime] [-e endTime] [-l pageLength][-w pageWidth] [-h] [-i] fileName1 ... fileNamen

cicssfmt [-?]

Description

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

134 de 179 03/03/12 14:46

Page 135: Com an Dos

cicssfmt formats the CICS statistics data into a form that can easily be written tooperating system standard output. cicssfmt is requested from the operating systemshell, and can be replaced with your own customized version. This informationdescribes the version delivered with CICS and this may not correspond to theversion running on your system.

If you specify too few or too many parameters, or enter the -? option, cicssfmtsends some explanatory text on how to use the command to the operating systemstandard error output.

If the named statistics file does not exist, cicssfmt outputs an error to the standarderror output. If the named statistics file exists, cicssfmt formats all statisticsrecords to standard output.

cicssfmt is a sample program generated from the source file cicssfmt.c. It can bebuilt with the sample makefile in the directory prodDir/src/samples/sfmt using thecommand make -e -f Makefile (on Open Systems) or nmake -e -f Makefile (onWindows).

If you want to replace cicssfmt with your own program, you must change thesample makefile accordingly.

The following files make up the statistics data formatter:

Table 3. Statistics data formatter files

File Type Contents

prodDir/bin/cicssfmt (CICS on OpenSystems) or prodDir/bin/cicssfmt.exe(CICS for Windows)

executable The executable statisticsformatter program

prodDir/src/samples/sfmt/cicssfmt.c,prodDir/src/samples/sfmt/cicssf_delta.c,prodDir/src/samples/sfmt/cicssf_summ.c,prodDir/src/samples/sfmt/cicssf_supp.c

source Sample statisticsformatter program source

prodDir/src/samples/sfmt/Makefile makefile Sample makefile thatbuilds and installs thestatistics formatter

prodDir/lib/libcicssfmtsa.a (CICS onOpen Systems), prodDir/lib/libcicssfmtsa.lib (CICS for Windows)

object library Library containing thefunctions for reading andprocessing a statisticsdata file

prodDir/include/cicssfmt.h include Definitions used by thesample statistics formatter

prodDir/include/cicssfmt_msg.h include English messages used bythe sample statisticsformatter

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

135 de 179 03/03/12 14:46

Page 136: Com an Dos

/msg/en_US.iso8859/cicssfmt.cat (CICSfor HP-UX) prodDir/msg/en_US/cicssfmt.cat (CICS for AIX and Solaris)

message text Message catalog forcicssfmt produced bygencat. Only required byformatter programscompiled with CICSrelease 2.1.1 or earlier.

Options

-c categoryNamesspecifies a comma-separated list of categories to be formatted. If the -c optionis not specified, all categories are formatted. The categories are as follows:

DUMPDump statistics

FILEFile statistics

ISCMIntersystem Communication Management statistics

JOURJournal statistics

LUWMLogical Unit of Work Management statistics

PROGProgram statistics

RTDBRuntime Database statistics

STORRegion Storage statistics

STOTTask Storage statistics

TASKTask statistics

TERMTerminal statistics

TDQUTransient Data Queue statistics (summary statistics only)

TRAN

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

136 de 179 03/03/12 14:46

Page 137: Com an Dos

Transaction statistics

TSQUTemporary Storage Queue statistics (summary statistics only)

Note:CICS does not collect summary statistics for the TRAN category.However, it does collect details, so to obtain transaction statistics, youmust specify the TRAN category with the -i option.

-s startTimespecifies the start time for the report to be produced. You should specify thetime in the format yymmddhhmmss. The default starting time is the timestampon the first record in the file.

-e endTimespecifies the end time for the report to be produced. You should specify thetime in the format yymmddhhmmss. The default ending time is the timestampon the last record in the file.

-l pageLengthspecifies the length, in lines, of each page of the report. The default value is 24lines on each page.

-w pageWidthspecifies the width, in columns, of each page of the report. The default value is80 columns.

-hsuppresses the printing of page headers. The default is to print page headers.

-iindicates that detailed statistics are required. The default is to producesummary statistics.

fileName1 ... fileNamenspecifies the files containing the CICS-generated statistics.

-?causes the usage message to be displayed. cicssfmt also displays the usagemessage if you enter the command syntax incorrectly.

Examples

To list statistics file shut001:

cicssfmt shut001

1.

To list transaction interval statistics produced from 9 a.m. on January 1st, 1995onwards, from file shut001 with no page headers:

cicssfmt -c TRAN -s 950101090000 -h -i shut001

2.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

137 de 179 03/03/12 14:46

Page 138: Com an Dos

To list file summary statistics produced up to 6 p.m. on January 1st, 1995, fromfile shut001 with no page headers:

cicssfmt -c FILE -e 950101180000 -h shut001

3.

To list statistics file shut001 with a report page width of 70:

cicssfmt -w 70 shut001

4.

See the CICS Administration Guide for additional information.

cicssfs - Start a CICS SFS

AIX HP-UX Sun Solaris Windows

X X X X

You use this command to start an SFS that CICS uses.

Syntax

Syntax (CICS on Open Systems)

cicssfs [serverName] [attributeName=attributeValue ... ] [-a] [-I] [-tcomponent:traceMask [:component:traceMask] ... ] [[-T traceClass[=traceClass ... ] = [modifier,modifier]outputClass:destination]...] [-v]

cicssfs -?

Syntax (CICS for Windows)

cicssfs [serverName] [attributeName=attributeValue ... ] [-a|-nlv] [-I] [-tcomponent:traceMask [:component:traceMask] ... ] [[-T traceClass[=traceClass ... ] = [modifier,modifier]outputClass:destination]...] [-v]

cicssfs -?

Description

You must create the following logical volumes for the SFS:The logical volume used for journal data written by the SFS, as specifiedby the LogVolume attribute for the SFS. The default is log_shortName,where shortName is the server short name.The logical volume used for the SFS file data, as specified by theDataVolume attribute for the SFS. The default is sfs_shortName, whereshortName is the server short name.

When an SFS is created with the cicssfscreate command an operating system

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

138 de 179 03/03/12 14:46

Page 139: Com an Dos

userid is associated with the server. This userid must have read and writeaccess to the logical volumes and associated raw devices.You must be logged on to a userid with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).If you are using DCE authentication you must have a DCE context that has theauthority to read and test the Cell Directory Service (CDS) directory where theCDS object representing the SFS will be created, and to read the object itself.

For example, to start a server named /.:/cics/sfs/SFSserver1, you need read andtest permission for directory /.:/cics/sfs, and you need read permission for/.:/cics/sfs/SFSserver1.

Usually, you must be a DCE cell administrator or a member of the DCE groupcics_users.

If you are not using DCE servers, an entry must be added to /var/cics_servers/server_bindings after running cicssfscreate.If you are restarting the SFS because your machine crashed or terminatedabnormally, the lock file of the server might not be cleaned up. You must usethe cicssfslock command to remove the lock file, which is:

/var/cics_servers/SSD/cics/sfs/modifiedCDSname/lock

Refer to cicssfslock - Release an SFS lock file for more information.

The command cicssfs starts an SFS that CICS uses and waits for it to initializebefore returning. You run cicssfs from the operating system command line.

The output of the SFS is directed to the file whose path is constructed from the CellDirectory Service (CDS) name of the server. CICS removes the /.: or /... from thefront of this name, and substitutes the modified CDS name into:

/var/cics_servers/SSD/cics/sfs/modifiedCDSname/msg

If you are warm starting the SFS, the restart string is held in the same directory asthe output file of the server, for example:

/var/cics_servers/SSD/cics/sfs/modifiedCDSname/res

You can specify the type of start that you require by specifying the attribute valueStartType=cold, or StartType=auto. If you do not specify the start type, the SFSis started as if StartType=auto had been used.

The -t and -T options are provided to allow the SFS to be traced using the Encinatrace facilities. It is expected that these options will only be used under thedirection of your support organization, so they are not documented here in detail.

Options

serverName

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

139 de 179 03/03/12 14:46

Page 140: Com an Dos

is the name of the SFS to be started.If the server is being cold-started thename of the server must be specified. If the server is not being cold-startedand the name of the server is not specified, then the name of the sever isobtained from the environment variable CICS_SFS_SERVER.

attributeName=attributeValueis the value or values that override those in the CICS permanent database forthe server.

-astarts the SFS in administrative mode. You cannot cold start an SFS inadministrative mode, so this flag is ignored for a cold start.

-nlv (CICS for Windows only)starts the SFS in administrative mode and with no logical volumes. This can beused when logical volumes need to be extended after filling up.

-Icauses errors to be ignored.

-t ...specifies Encina trace masks.

-T ...specifies Encina trace output classes. -T can be used more than once.

-vrequests verbose output.

-?is the flag which produces the usage message.

0SFS started.

non-zeroUnsuccessful attempt to start SFS.

To start an SFS SERVER1:

cicssfs /.:/cics/sfs/SERVER1

Additional information is contained in the CICS Administration Guide .

cicssfsconf - Configure a CICS SFS

AIX HP-UX Sun Solaris Windows

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

140 de 179 03/03/12 14:46

Page 141: Com an Dos

X X X X

You use this command to configure an SFS to be used by CICS.

Syntax

cicssfsconf [-I] [-q] wc regionName

cicssfsconf [-I] [-q] {ra | na | lr | pr | nr | lqp | lqu} regionName[attributeName=attributeValue ... ]

cicssfsconf [-I] [-q] -R wc regionName DefaultFileServer=serverName

cicssfsconf -?

Description

The SFS must be running.

You must be logged in as root or administrator on the machine that is running theregion.

The command cicssfsconf configures the SFS to meet the CICS regionrequirements. You run cicssfsconf from the operating system command line.

If the region is not using DCE servers the cicssfsconf command will assume thatthe SFS is also not using DCE servers and that the SFS will be found on one of themachines specified by the environment variable CICS_HOSTS.

Note:You can configure all queues (this is the default) at a time for each use ofcicssfsconf or, if only one queue is specified, only that queue is configured.

Options

-Icauses non-critical errors to be ignored.

-qis used to request "quiet" processing. If -q is specified, no informationmessages will be displayed.

wcconfigures the SFS without changing any Region Definition values.

regionNamespecifies the name of the CICS region for which you are configuring the SFS.

raconfigures the SFS for recoverable auxiliary TS queues.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

141 de 179 03/03/12 14:46

Page 142: Com an Dos

naconfigures the SFS for non-recoverable auxiliary TS queues.

lrconfigures the SFS for logically recoverable TD queues.

prconfigures the SFS for physically recoverable TD queues.

nrconfigures the SFS for non-recoverable TD queues.

lqpconfigures the SFS for locally-queued protected STARTs.

lquconfigures the SFS for locally-queued unprotected STARTs.

attributeName=attributeValue ...specify attribute names and values to override those in the Region Definitions(RD).

-R (CICS for AIX and CICS for Solaris only)resets the region to use Structured File Server (SFS) instead of DB2.

DefaultFileServer=serverNamespecifies the name of the Structured File Server (SFS) to be used. The name ofthe server will be stored in the DefaultFileServer attribute in the RegionDefinitions (RD).

-?causes the usage message to be displayed.

Returned Values

0SFS configured

non-zeroUnsuccessful attempt to configure SFS.

Examples

To configure the SFS for REGION1 without changing any attributes of the RegionDefinition:

cicssfsconf wc REGION1

1.

To configure the SFS for REGION1 for recoverable auxiliary TS queues, logicallyrecoverable TD queues, and protected STARTs:

cicssfsconf ra REGION1

2.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

142 de 179 03/03/12 14:46

Page 143: Com an Dos

cicssfsconf lr REGION1 cicssfsconf lqp REGION1

To configure the SFS for REGION1 and change the maximum number of recordsthat can be held in LocalQFile to 500000:

cicssfsconf lqu REGION1 LocalQMaxRecs=500000

3.

To reset region REGION2 to work with Structured File Server (SFS), using serverSERVER1:

cicssfsconf -R wc REGION2 DefaultFileServer=/.:/cics/sfs/SERVER1

4.

cicssfscreate - Create a CICS SFS

AIX HP-UX Sun Solaris Windows

X X X X

You use this command to create an SFS to be used by CICS.

Syntax

cicssfscreate [-v] [-I] [-S] [-m modelName] serverName[attributeName=attributeValue ... ]

cicssfscreate -?

Description

To use cicssfscreate command to create an sfs server you need to:Issue the command:

cicssfscreate -S /.:/cics/sfs/sfs_servername ShortName=shortname_of_serverUserID=sfs_user_ID

1.

Make an entry in the server_bindings file using a universally uniqueidentifier (UUID) for the SFS Server. Use the uuidgen command togenerate a UUID for the sfs server. To do this, type uuidgen at thecommand prompt. Output similar to the following is generated:

cdd9062a-ded4-11d7-b444-000629c32cf5

Add a single-line entry similar to the following to the server_bindings file:

/.:/cics/sfs/sfs_server cdd9062a-ded4-11d7-b444-000629c32cf5@ncadg_ip_udp:[10056]

where 10056 is replaces by an unused UDP port number.

2.

Manually create the logical volumes for the sfs server (for example, using3.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

143 de 179 03/03/12 14:46

Page 144: Com an Dos

SMIT on AIX). Refer to the information about configuring a file managerand CICS region in the Planning and Installation Guide for your platformfor information about how to do this. Make sure the user is the sfsusername and the group is cics for the logical volumes you create.Start the sfs server using the following cicssfs command:

cicssfs /.:/cics/sfs/sfs_servername

4.

You must be logged in as a user with root or administrator privileges.You must create a user for the SFS, specifying its home directory as

/var/cics_servers/SSD/cics/sfs/ServerName

and setting its primary group as cics (CICS on Open Systems) or cicsgroup(CICS for Windows). For example, on CICS for AIX:

mkuser pgrp=cics home=/var/cics_servers/SSD/cics/sfs/ServerName Userid

The SFS userid must have permission to read and write the SFS logicalvolumes and their associated raw devices. Either make the SFS userid theowner of the volumes, or add the SFS userid to the group that can read andwrite the volumes, so that volumes can be shared.

The user for the SFS must be set up as a local user on the machine. The userdefinitions must not come from the Network Information Service (NIS).

You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).You must have a DCE context that has sufficient authority to:

Create a DCE principal and account.Create a Server Key Table.

Usually, you must be a DCE cell administrator.

The command cicssfscreate creates an SFS and the data necessary to allow CICSto use it. You run cicssfscreate from the operating system command line.

cicssfscreate adds:

An SFS into the CICS server database.Its entry for the operating system mechanism which is used to start and stoplong running processes.If you are using DCE authentication, its DCE principal, its DCE account and itsDCE keytab entry.

You must set the ShortName attribute override to a unique ShortName within allSFS that CICS uses in this DCE cell. On CICS for AIX you can get a list of all thecurrent SFS ShortNames used by CICS by entering the following shell commands:

for i in cicsget -c ssd -l | cut -d' ' -f1 do cicsget -c ssd $i | grep ShortName

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

144 de 179 03/03/12 14:46

Page 145: Com an Dos

done

You must set the UserID attribute in the SSD to the userid for the SFS.

If you are not using DCE servers you must add an entry to /var/cics_servers/server_bindings after running cicssfscreate.

Note:cicssfscreate cannot be used to create an SFS on a remote machine. You mustcreate the remote SFS while logged on to the remote machine.

Options

-vproduces verbose informational output.

-Icontinues processing on non-critical errors

-Scauses the SFS to be created without using DCE servers.

-m modelNamespecifies the name of the SFS to model this server on. If you do not specify aname, the server is modeled on the default SSD entry.

serverNamespecifies the name of the SFS, SSD key, to be created.

attributeName=attributeValue ...specify attribute names and values to override those in the model or defaultserver.

-?produces the usage message.

Returned Values

0SFS created.

non-zeroUnsuccessful attempt to create SFS.

Examples

To create an SFS named SERVER1, with a ShortName of SERVER1 and an SFS userid ofSFSSERVER:

cicssfscreate /.:/cics/sfs/SERVER1 ShortName=SERVER1 UserID=SFSSERVER

See the CICS Administration Guide for additional information.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

145 de 179 03/03/12 14:46

Page 146: Com an Dos

cicssfsdestroy - Destroy a CICS SFS

AIX HP-UX Sun Solaris Windows

X X X X

You use this command to destroy an SFS that CICS uses.

Syntax

cicssfsdestroy [-v] [-S][-I]serverName

cicssfsdestroy -?

Description

Ensure that the SFS is not running before you destroy it.You must be logged in as a user with root or administrator privileges.If you are using DCE authentication you must have a DCE context that hassufficient authority to:

Delete a DCE principal and account.Delete a Server Key Table.

Normally you must be a DCE cell administrator.

You must also destroy the logical volumes of the SFS separately usingoperating system facilities. (You can do this before or after you destroy theSFS.)

The command cicssfsdestroy destroys an SFS that CICS uses. You runcicssfsdestroy from the command line.

cicssfsdestroy deletes:

An SFS from the CICS server database.Its entry in the operating system mechanism used for starting and stoppinglong running processes.If you are using DCE authentication, its DCE principal, its DCE account, and itsDCE keytab entry.

On Windows use the home directory of the SFS userid, if you have theauthority to do so.

The output of the SFS is directed to the file whose path is constructed from the CDSname of the server. CICS removes the /.: or /... from the front of this name, andsubstitutes the modified CDS name into:

/var/cics_servers/SSD/cics/sfs/modifiedCDSname/msg

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

146 de 179 03/03/12 14:46

Page 147: Com an Dos

For example, output from SFS /.:/cics/sfs/myserver goes to the file:

/var/cics_servers/SSD/cics/sfs/myserver/msg

After you have run cicssfsdestroy, it is useful to also carry out the followingoperations:

Remove the operating system user id specified by the UserID attribute in theSSD. (Use the operating system to do this.)Remove the SFS directory:

/var/cics_servers/SSD/cics/sfs/serverName

Remove the logical volume specified in the DataVolume attribute in the SSD.(Use the operating system to do this.)If you are using DCE authentication, reauthenticate the DCE tickets for anydce_login contexts that have accessed the server, either by logging in to theDCE again or by using the DCE command kinit. This will remove any cachedtickets for the old server, and so avoid problems if a new SFS is created usingthe same name as the one just destroyed.

Options

-vproduces verbose informational output.

-Scauses the SFS to be destroyed without using DCE servers.

-Icauses errors to be ignored.

serverNameis the name of the SFS to be destroyed.

-?is the flag that produces the usage message.

Note:cicssfsdestroy cannot be used to destroy an SFS on a remote machine. Youmust destroy the remote SFS on the remote machine itself.

Returned Values

0SFS destroyed.

non-zeroUnsuccessful attempt to destroy SFS.

Examples

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

147 de 179 03/03/12 14:46

Page 148: Com an Dos

To destroy an SFS SERVER1:

cicssfsdestroy /.:/cics/sfs/SERVER1

The CICS Administration Guide and the Planning and Installation Guide containadditional information.

cicssfsimport - Build an SFS's metadata

AIX HP-UX Sun Solaris Windows

X X X X

You use this command to build an SFS's metadata using one or more entries in aschema file.

Syntax

cicssfsimport -i schemaFileName -s serverName [-I] [-f fileName][[-x indexName] ... ]

Description

You must be logged in as a user with root or administrator privileges.The userid must have read/write permission for the schema file as definedexplicitly by the file permissions.You must have sufficient privileges to create SFS files (CICS on Open Systems).You must be a member of the group cicsgroup (CICS for Windows).If you are using DCE authentication you must be logged in to DCE.You must create logical volumes of the same name as those referenced in theschema file before you use cicssfsimport.The userid that the SFS runs under must have read and write access to thesevolumes and their raw devices.If the SFS has been set up to accept only authenticated RPCs, then to apply aSchema File Definitions (SCD) to SFS, you need to be a member of the groupcics_admin.

The cicssfsimport command creates one or more files on an SFS. It builds theSFS's metadata using one or more entries in a Schema File Definitions (SCD).

The server does not need to be present in the Structured File Server Definitions(SSD), so you can build arbitrary SFSs without the overhead of entering theirdetails into the system.

All the files are created before secondary indexes are created. A file that is namedin the list must exist at index creation time. If a file or index named in the lists doesnot exist in the schema file, there will be a warning message, but the importcontinues.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

148 de 179 03/03/12 14:46

Page 149: Com an Dos

Options

-i schemaFileNameis the relative or absolute path to the schema file. The relative path is inrelation to the working directory.

-Iis a flag to force the command to ignore errors. This is useful if a previouscicssfsimport did not complete, for example after a machine crash, but somefiles have been created. If the -I flag is set, you can run cicssfsimport again,and any "file exists" errors generated are ignored.

-s serverNameis the Cell Directory Service (CDS) name of the SFS on which the files andindexes are to be built.

-f fileNameis a file from the schema to be created. To specify a list of files, specify eachfile with a separate -f flag. If you do not specify the -f option, then all files andindexes in the named schema file are created. If you specify the -f option, butdo not specify a -x option, then all the indexes for that file are created.

-x indexNamespecifies an index from the preceding file to add. To specify a list of indexes,specify each index with a separate -x flag. If a set of indexes associated with afile does not include the primary index, a primary index is created. If youspecify the -f option, but do not specify a -x option, then all the indexes for thatfile are created.

Examples

To create two files, FILE1 and FILE2 on a server SERVER1, using the entries fromschema file SCHEMA1. FILE1 has indexes INDEX1, INDEX2, and INDEX3, and FILE2 hasindexes INDEX4 and INDEX5:

cicssfsimport -i SCHEMA1 -s /.:/cics/sfs/SERVER1 -f FILE1 \ -x INDEX1 -x INDEX2 -x INDEX3 -f FILE2 -x INDEX4 -x INDEX5

1.

To create a file FILE3 and all its indexes on a server SERVER1, using the entriesfrom schema file SCHEMA1:

cicssfsimport -i SCHEMA1 -s /.:/cics/sfs/SERVER1 -f FILE3

2.

To create all files and indexes from a schema file SCHEMA2 on SERVER1, ignoringerrors:

cicssfsimport -i SCHEMA2 -s /.:/cics/sfs/SERVER1 -I

3.

See the CICS Administration Guide for additional information.

cicssfslock - Release an SFS lock file

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

149 de 179 03/03/12 14:46

Page 150: Com an Dos

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to release an SFS lock file that may have been left when an SFSterminated in an uncontrolled manner.

Syntax

cicssfslock {-l | -u | -t} serverName

cicssfslock -?

Description

cicssfslock takes or releases a lock for a particular SFS. The lock is used toserialize the create, start, stop and destroy phases of an SFS. The lock file is in:

/var/cics_servers/SSD/cics/sfs/serverName/lock

Options

-lcicssfslock to wait until the SFS that owns the lock file is no longer runningand then takes the lock.

-ucauses the lock file for the SFS to be released unconditionally.

-tcicssfslock to try to take the lock file but to return immediately if it isunsuccessful.

serverNamespecifies the name of the SFS.

-?causes the usage message to be displayed. cicssfslock also displays the usagemessage if you enter the command incorrectly.

Returned Values

0Successful

1Unsuccessful

Examples

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

150 de 179 03/03/12 14:46

Page 151: Com an Dos

To release the lock for SFS sfs_SFS_SERV:

cicssfslock -u /.:/cics/sfs/sfs_SFS_SERV

cicssfsshut - Shut Down a CICS SFS

AIX HP-UX Sun Solaris Windows

X X X X

You use this command to shut down an SFS that CICS uses.

Syntax

cicssfsshut [-f] [-c] serverName

cicssfsshut -?

Description

You must be logged in as a user with root or administrator privileges.You must be a member of the group cics (CICS on Open Systems) orcicsgroup (CICS for Windows).If you are using DCE authentication you must have a DCE context that has theauthority to read and test the Cell Directory Service (CDS) directorycontaining the CDS object representing the SFS, and to read the object itself.

For example, to shut down the server named /.:/cics/sfs/sfs_SFS_SERV, youneed read and test permission on the directory /.:/cics/sfs, and you need readpermission for directory .

Usually, you must be a DCE cell administrator or a member of the DCE groupcics_users.

If the SFS is not using DCE authentication (that is, if NameService=none inthe SSD) you must not be logged into DCE.

The command cicssfsshut shuts down an SFS that CICS uses. You run cicssfsshutfrom the operating system command line.

The output of the SFS is directed to the file whose path is constructed from the CellDirectory Service (CDS) name of the server. CICS removes the /.: or /... from thefront of this name, and substitutes the modified CDS name into:

/var/cics_servers/SSD/modifiedCDSname/msg

For example, output from SFS /.:/cics/sfs/sfs_SFS_SERV goes to the file:

/var/cics_servers/SSD/cics/sfs/sfs_SFS_SERV/msg

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

151 de 179 03/03/12 14:46

Page 152: Com an Dos

Returned Values

-fforces an abnormal shutdown of an SFS. Do not use this flag unless you cannotshut the SFS down without it.

-cCancel the SRC subsystem in which the SFS is running. Do not use this flagunless you need to terminate the server abnormally.

serverNameis the name of the SFS to shut down.

-?is the flag that produces the usage message.

Returned Values

0SFS is shut down.

non-zeroUnsuccessful attempt to shut down SFS.

Examples

To shut down an SFS SERVER1:

cicssfsshut /.:/cics/sfs/SERVER1

See the CICS Administration Guide for related information.

cicsstart - Start a CICS region

AIX HP-UX Sun Solaris Windows

X X X

You use this command to start a CICS on Open Systems region.

Syntax

cicsstart [-c] [-a] [-o attributeName=attributeValue ... ] [regionName]

Description

You must be logged on as a user with root or administrator privileges.

The cicsstart command causes a CICS region to start. Once CICS successfully

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

152 de 179 03/03/12 14:46

Page 153: Com an Dos

starts and runs post-initialization programs, CICS allows transaction processing.

It fails if the region is locked, in which case cicsstop should be used to ensure thatthe region is shutdown.

By default cicsstart performs an AUTO start of cics. This normally involves clearingSFS.

You can run the cicsstart command directly from the command line.

You can override multiple RD parameters on the same command line. To makepermanent changes to the RD, use the CICS resource management commands.

For more information, see the CICS Administration Guide.

Options

-cforces cicsstart to perform a cold start of CICS.

-aforces cicsstart to perform an automatic start of CICS.

-ois used to override Region Definitions (RD) for this region startup.

attributeName=attributeValueis an attribute and its value to be used in this startup. MultipleattributeName=attributeValue pairs can be specified in the -o option. Usedouble quotes to delimit values containing spaces.

regionNameis the name of the region to be started. If you do not specify a region name,CICS starts the region specified by the environment variable CICSREGION.

Examples

To cold start the region named REGION1:

cicsstart -c REGION1

cicsstop - Stop a CICS region

AIX HP-UX Sun Solaris Windows

X X X

You use this command to stop a CICS on Open Systems region.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

153 de 179 03/03/12 14:46

Page 154: Com an Dos

Syntax

cicsstop [-f] [-k] [regionName]

Description

You must be logged on as a user with root or administrator privileges.

The cicsstop command shuts down a CICS region.

A normal shutdown (without the -f or -k options) completes all current processingand releases resources before shutting the region down.

If the -f (force) option is used, cicsstop releases the resources, but does not waitfor processes to stop before shutting down the region.

If the -k (kill) option is used, cicsstop does not attempt to release resources, nordoes it wait for processes to complete before shutting down the region.

You can run the cicsstop command directly from the command line.

Options

-fforces cicsstop to shut the region down after releasing resources.

-kforces cicsstop to shut the region down immediately, killing all CICSprocesses, removing lock files, and cleaning up shared memory.

regionNamespecifies the name of the region to be stopped. If you do not specify a regionname, CICS stops the region specified by the CICSREGION environmentvariable.

Examples

To shut down the region named REGION1 immediately:

cicsstop -k REGION1

For more information about the shutdown process, see the CICS AdministrationGuide.

cicstail - Display the end of a file

AIX HP-UX Sun Solaris Windows

X X X X

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

154 de 179 03/03/12 14:46

Page 155: Com an Dos

Use this command to display the console.nnnnnn and CSMT.out files for a specifiedCICS region, or to display a user-specified file.

Syntax

cicstail [-r regionName] | [-f fileName] [-b numBytes]

cicstail -?

Description

The cicstail command displays the current console.nnnnnn and CSMT.out file for aCICS region and displays new lines as they are added to these files. Alternatively, ifthe name of a file is specified, the output displays that file and any new lines thatare added to the file.

New lines are displayed as they are added to the file or files until the command isinterrupted when CTRL-C is pressed.

Options

-r regionNamespecifies the name of the CICS region whose files are to be displayed. Thecicstail command displays the contents of the region's console.nnnnnn andCSMT.out files in a single output stream. If neither the -r or -f options arespecified, cicstail displays the files for the region whose name is set in theenvironment variable CICSREGION.

-f fileName (CICS for Windows only)specifies the name of a file to be displayed. The name can be absolute orrelative to the current directory.

-b numBytes (CICS for Windows only)specifies that the display of the file (or files) start numBytes before the end ofthe file. If the -b option is omitted, the display starts 2,000 bytes before theend of the file.

-?causes the usage message to be displayed.

Examples

To display files for the region REGION1:

cicstail -r REGION1

1.

To display the file \tmp\file1:

cicstail -f c:\tmp\file1

2.

cicstcpnetname - Display NETNAME for CICS

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

155 de 179 03/03/12 14:46

Page 156: Com an Dos

family TCP/IP connection

AIX HP-UX Sun Solaris Windows

X X X X

cicstcpnetname displays the 1-8 character NETNAME which is used by a CICSregion on a CICS family TCP/IP connection. This NETNAME is derived from theInternet Protocol (IP) address and port used by the region.

Syntax

cicstcpnetname -a [ IPaddress | hostName] -p portNumber

cicstcpnetname -?

Description

This command displays the NETNAME (Logical Unit (LU) name) for a CICS regionusing CICS family TCP/IP connections. A CICS region's NETNAME used for thesetypes of connections is derived from the Internet Protocol (IP) address and port onwhich the CICS region is listening for connection requests.

Options

-a [ IPaddress | hostName ]specifies the name or address of the network adapter used by the region toaccept CICS family TCP/IP connections. The address can be in one of thefollowing forms:

The Internet Protocol (IP) address in dotted decimal notation. Forexample, 1.23.45.67.The IP address in dotted hexadecimal notation. For example,0x01.0x17.0x2D.0x43.The host name defined in the Internet name service. For example,aix5.cicsland.com.

-p portNumberspecifies the Internet port number used by the region to accept CICS familyTCP/IP connections.

-?causes the usage message to be displayed.

Returned Values

0NETNAME returned

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

156 de 179 03/03/12 14:46

Page 157: Com an Dos

non-zeroUnable to convert the value passed on the -a flag into an Internet Protocol (IP)address.

Examples

To print the NETNAME for network adapter 1.23.45.67 on port 1435:

cicstcpnetname -a 1.23.45.67 -p 1435

The NETNAME will be sent to stdout.

1.

To use cicstcpnetname in a shell script:

# # Set up variables # LISTENER="CICSTCP" REMOTE_PORT=1435 REMOTE_ADDRESS="1.23.45.67" REMOTE_NETNAME=$(cicstcpnetname -a $REMOTE_ADDRESS -p $REMOTE_PORT)

# # Create Communications Definition (CD) entry. # cicsadd -c cd -r $CICSREGION TCP1 \ ConnectionType=ppc_tcp \ RemoteTCPAddress=$REMOTE_ADDRESS \ RemoteTCPPort=$REMOTE_PORT \ ListenerName=$LISTENER \ RemoteLUName=$REMOTE_NETNAME

2.

For related information, see the CICS Intercommunication Guide.

cicsteld - Connect telnet clients to regions

AIX HP-UX Sun Solaris Windows

X X X X

You use the cicsteld command to interface telnet clients to regions.

Syntax

cicsteld [-r regionName] [-p principalName] [-P portNumber] [-l locale][-e emulation] [-t initialTransaction] [-c clientCodePage] [-s serverCodePage][-n netName] [-k keytabFile][-h hostList] [-v]

cicsteld -?

Description

You must have run cicssetupclients if you are using DCE authentication.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

157 de 179 03/03/12 14:46

Page 158: Com an Dos

You can run the cicsteld command either as a normal operating system process, oras a child of the inetd daemon that is supplied by the operating system.

If you want to register more than five parameters (including the program name)with inetd, create an operating system shell script or command file which containsthe actual call and parameters for cicsteld, then register the shell script orcommand file with inetd. For more about setting up the cicsteld server (CICSTelnet server), including registering cicsteld with inetd, see the CICSAdministration Guide.

Options

-p principalNamespecifies the DCE principal that cicsteld is to use for authentication, if DCEauthentication is being used.

-P portNumberspecifies the numeric Transmission Control Protocol (TCP) port number thatcicsteld listens on for incoming telnet client requests. If you do not specify aport number, cicsteld takes the port number from service name entry ofcicsteld in the file /etc/services. If you specify a port number that already existsin /etc/services, cicsteld will comment out the existing entry and add a newone. If the port number is not valid, cicsteld issues an explanation message.

If the inetd daemon has started cicsteld, cicsteld ignores this parameterbecause the connection to the telnet client is already established.

-n netNamespecifies the network name that is used by the CICS autoinstall program tocreate the terminal identifier of the terminal. If you specify a network name, itmust exist in the Terminal Definitions (WD) of the region. If no network nameis specified, the CICS region generates a network name when the terminalautoinstalls. If you specify a netName of longer than eight characters, cicsteldtruncates the netName to eight characters, and logs a message.Note:

Alternatively, netName (or LUName) can be passed from a telnet client tothe cicsteld (telnet server). cicsteld reads this netname and passes it aspart of the terminal autoinstall request. The CICS autoinstall programuses this netName to create the terminal identifier. This netname does notneed to exist in the Terminal Definitions (WD) of the region.

When the cicsteld server starts with a netName specified, the netName that ispassed from the telnet client is ignored

-r regionNamespecifies the region for cicsteld to connect with. If you do not specify a region,when the user connects to the port, cicsteld presents a menu of availableregions and allows the user to select one.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

158 de 179 03/03/12 14:46

Page 159: Com an Dos

-t initialTransactionspecifies the transaction to be run at initial connection time after autoinstall.This could be the CESN transaction, to force users to sign on.

-e emulationUse this option to override the model type that is selected by cicsteld.

When a region is connected for a telnet client, cicsteld checks if the telnetclient is using a valid terminal. If the terminal is valid, cicsteld selects a modeltype for that terminal. To override this selection, use the -e option to specify auser defined model type or a CICS supplied model type. The preferred CICSmodel types that can be used for cicsteld are:

hft and mft for terminals with extended data streamlft for terminals that do not have extended data stream.

See the CICS Administration Guide for more information about model typesand Terminal model definitions for the definitions of the autoinstall models.

-l localespecifies the National Language Support (NLS) locale to use for this instanceof cicsteld. If you do not specify this option,

On CICS on Open Systems

cicsteld uses the locale that is named in the environment variable LANG.

On CICS for Windows

cicsteld uses the locale determined by the Language setting in theInternational section of the Control Panel.

-c clientCodePagecicsteld client (for example, the telnet daemon). The client of cicsteld is a3270 emulator that uses an EBCDIC character set, so this must be an EBCDICcode page. If you do not supply this option, cicsteld uses the code page withshortcode 037. This option corresponds to the CLINTCP option of the DFHCNVmacro.

See the table under the -s option.

-s serverCodePagespecifies the code page of the cicsteld server. This requires an ASCII codepage that matches the code page of cicsteld. If you do not supply this option,cicsteld uses the code page with shortcode 8859-1. This option corresponds tothe SRVERCP option of the DFHCNV macro.

You can supply the code page for the -c and -s options as a shortcode which isrecognized and converted by cicsteld as follows:

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

159 de 179 03/03/12 14:46

Page 160: Com an Dos

Table 4. Shortcode and code pages (Open Systems)

ShortcodeCode page

CICS for AIX and CICSfor Solaris

CICS for HP-UX

037 IBM-037 american_e

850 IBM-850 roman8

930 IBM-930 japanese_e

932 IBM-932 japanese

EUCJP IBM-eucJP japanese.euc

8859-1 ISO8859-1 iso8859_1

Table 5. Shortcode and code pages (Windows)

Shortcode Code page

037 IBM-037

850 IBM-850

930 IBM-930

932 IBM-932

EUCJP IBM-eucJP

8859-1 ISO8859-1

If you specify a code page option that does not belong to this set, cicsteld doesnot alter it. For example, the command cicsteld -c ISO8859-7 uses ISO8859-7as the name of the client codepage.

-k keytabFilespecifies the keytab file that cicsteld uses as the servertab file. If you do notspecify this parameter, cicsteld attempts to use the file varDir/cics_clients/krb5/v5srvtab.

-h hostListspecifies a blank-delimited list of names or addresses of hosts to be searchedfor the specified region. If a list of host names is not specified, the contents ofthe environment variable CICS_HOSTS will be used. If the environmentvariable CICS_HOSTS is not set, the local machine will be searched.

-v(verbose) causes all informational messages to be displayed during startup.

-?displays a short help message.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

160 de 179 03/03/12 14:46

Page 161: Com an Dos

Examples

To specify that cicsteld listen on port 9001 for a request to access region REGION1and run transaction CESN:

cicsteld -P 9001 -r REGION1 -t CESN & (Open Systems)

start cicsteld -P 9001 -r REGION1 -t CESN (Windows)

1.

To attach a telnet client to that port:

telnet hostname 9001

2.

To specify the cisteld listen on port 9002 for a request to access REGION2 which isto be found on system BLUE, GREEN, or RED:

cicsteld -P 9002 -r REGION2 -h "BLUE GREEN RED" & (Open Systems)

start cicsteld -P 9002 -r REGION2 -h "BLUE GREEN RED" (Windows)

3.

cicsterm - Invoke the CICS 3270 terminalemulator

AIX HP-UX Sun Solaris Windows

X X X

Invokes the CICS 3270 Terminal Emulator, from the operating system, so that youcan connect to a CICS region.

Syntax

cicsterm [-r regionName] [-n netName] [-m modelId] [-t transId] [-A [animatorTTY][-T animatorTERM]] [-h hostList]

cicsterm -?

Description

You need to understand about the 3270 terminal subsystem before you use thecicsterm command.You need access to a terminal or window that can access a machine in the DCEcell in which the CICS region is defined. Your terminal must either be suitablefor autoinstall (see Terminal autoinstall user program), or have an entry in theattribute NetName in the Terminal Definitions (WD).Your window must contain at least 12 lines, so that the terminal emulator candisplay a menu of region names when necessary. A menu of region names isdisplayed if you do not specify a region when you invoke the CICS 3270Terminal Emulator. The 12 lines are needed to display various headers, PF keylegends, blank space, and at least one region name so that you can scroll

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

161 de 179 03/03/12 14:46

Page 162: Com an Dos

through the list of available regions. If the window contains less than 12 lines,there is an error message, and the terminal emulator terminates abnormally. Itis recommended that you use a window with 25 lines.If you are using DCE authentication and you are connecting to a region thathas the attribute none, then you must run dce_login successfully before usingcicsterm. This causes a DCE ticket to be allocated by the DCE securityservice. Tickets have a limited lifetime; 10 hours by default. If a ticket expireswhile the client is active, the client is terminated. DCE accounts may havetheir ticket lifetime changed.If you are not using DCE authentication then either you should not have rundce_login before using the cicsterm command, or you must have runcicssetupclients with the -d option on the host to which you are connecting inorder to create a keytab file in directory /var/cics_clients.You must be authorized to run the transactions that you specify. That is, the UDentry for the userid you are using must have the TSL and RSL keys listed in itthat allow you to access the transactions that you want to run. This isdescribed in the CICS Administration Guide.

If you do not specify a region with the -r option, a list of regions is displayed so thatyou can select one. Your selection is verified before you are connected to the region.When you use the -r option to specify a region, you are not shown the list andcicsterm connects you to the region you specified.

CICS verifies that your request is valid by checking that the DCE principal maps toa User Definitions (UD) entry for the selected region. (The DCE principal isspecified in a UD entry with the attribute Principal.)

If a UD entry exists for the DCE principal, you are connected to the CICSregion using the key to the UD entry as the userid. You are given access tothose transactions and resources with TSL and RSL keys that match thoselisted in the attributes TSLKeyList and RSLKeyList for that UD entry.If a UD entry does not exist for the DCE principal, you are connected to theregion as the region's default userid. You are given access to thosetransactions and resources with TSL and RSL keys that match those listed inthe TSLKeyList and RSLKeyList in the UD entry for the region's defaultuserid. If a UD entry is not defined for the region's default userid, then you aregiven access only to public transactions and resources.

Note:The region's default userid is specified with the attribute DefaultUserId in theRegion Definitions (RD), as described in Region Definitions (RD).

After you are connected to the region, CICS leaves you with a blank screen that isrunning the IBM 3270 Information Display System emulation. You can enter thetransaction identifier of the transaction you want to run.

Alternatively, you can run a transaction immediately when cicsterm is initiallyinvoked, by entering

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

162 de 179 03/03/12 14:46

Page 163: Com an Dos

cicsterm -r regionName -t transId

where regionName is the region name, and transId is the transaction identifier.

The CICS 3270 Terminal Emulator is associated with a particular region for thelifetime of the cicsterm process. If the region terminates, the cicsterm process isleft running to wait for any current scheduled protected transactions for the giventerminal when the region is restarted. Otherwise, the cicsterm process terminates.

When cicsterm receives a user interrupt signal SIGINT, it terminates immediately.If a transaction is running, it is purged. The purge happens only at the start or endof an EXEC CICS call, so the transaction does not terminate if it is waiting for aresource, or if it is in a loop that does not involve EXEC CICS calls. If a transactionin this situation needs to terminate, the systems administrator must purge it. Referto the FORCEPURGE parameter description in CEMT INQ/SET TASK.

You can specify a particular terminal to install by using the -n option with theNetName of the terminal from its Terminal Definitions (WD).

You can explicitly specify a model type to autoinstall by using the -m option, asdescribed below. See Processing.

Options

-r regionNamespecifies the name of the CICS region to which you want to attach. If you donot specify a regionName, CICS displays an interactive menu of availableregions that are available for you to select. If there are no regions available,CICS displays an error message.

-t transIdspecifies the identifier of the transaction to run after Terminal Emulatorinitialization.

-n netNamespecifies the netName to use for installation. To install as a particular terminal,specify the netName of the required terminal. If you omit the netName,cicsterm autoinstalls, and a unique netName is generated in the region.

-m modelIdspecifies the name of the model device type (DevType) to use forautoinstallation. See Processing.

-A animatorTTYspecifies the name of the device for Animator stdin/stdout. If you specify the -Aoption without a value, and you are using X Windows, cicsterm will create awindow for use as the Animator console.

-T animatorTERMspecifies the name of the TERM type of the Animator terminal.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

163 de 179 03/03/12 14:46

Page 164: Com an Dos

-h hostListspecifies a blank-delimited list of names or addresses of hosts to be searchedfor the specified region. If a list of host names is not specified, the contents ofthe environment variable CICS_HOSTS is used. If the environment variableCICS_HOSTS is not set, the Cell Directory Service (CDS) is searched for aregion with the specified name. If there is no CDS the local machine issearched.

-?causes the usage message to be displayed.

Examples

To display the syntax for accessing CICS:

cicsterm -?

1.

To access CICS and log on to the region region1:

cicsterm -r region1

2.

To start a terminal using the definition for a high function terminal withmulti-byte character support on a region region1:

cicsterm -m hft-mb -r region1

3.

To start a terminal with the NetName BlueTerm in its Terminal Definitions on regionregion1:

cicsterm -n BlueTerm -r region1

4.

If you want to log on to a different userid after you have started cicsterm:

cicsterm -r region1 -t CESN

5.

To get a list of regions or set of machines:

cicsterm -h"red green blue"

6.

Processing

Suggested Setup: Instead of running cicsterm interactively at the command line,you can set up cicsterm to run as part of the /etc/passwd configuration for aparticular user authentication or from a profile or shell script. This is helpful whenyou always connect to the same region, and you always invoke the same transactionwhen you are connected to it.

Selecting Suitable Autoinstall Models: The autoinstall program is passed anumber of model entries in the Terminal Definitions (WD). The models that areselected are:

The models with a DevType that matches the model parameter specified in the-m option. For example, when -m hft is specified, the definitions in the WDstanza that has DevType=hft are used.

1.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

164 de 179 03/03/12 14:46

Page 165: Com an Dos

If the -m option is not specified, the models selected are those with a DevTypethat matches the environment variable CICSTERM.

2.

If CICSTERM is not set, the models selected are those with a DevType thatmatches the environment variable TERM. The default autoinstall program willselect the first of the models that are passed to it.

3.

See the CICS Administration Guide for descriptions of autoinstall models that aresupplied with CICS.

How cicsterm selects the Locale: cicsterm uses the locale that is held in theenvironment variable LANG. The value of LANG is passed from cicsterm to theregion. Therefore, definitions for the locale that is specified in LANG must exist inthe system on which the region resides.

cicstermp - Printer emulation

AIX HP-UX Sun Solaris Windows

X X X

The cicstermp command performs a fixed-size printer emulation of 64 lines by 132columns and ignores print attributes such as highlight, underline, high intensity andcolor.

Syntax

cicstermp -n netName -r regionName [-h hostList] [-t transId] [-P printCommand][-S][-p printerType [-f font] [-M paperType] [-s fontSize] [-R]]

cicstermp -?

Description

If you are using DCE authentication you must be authenticated as a DCEprincipal to run this command. A DCE ticket is given when the DCE principalauthenticates with the DCE security service. Tickets have a limited lifetime,and the default lifetime is 10 hours. If a ticket expires while the client is active,the client is terminated and any in-flight transactions are abended. DCEaccounts can have their ticket lifetime changed.Printers cannot be autoinstalled, so there must be an entry in the TerminalDefinitions (WD) whose attribute NetName matches the netName specified onthe command before a printer can be attached to a region.You need to understand about the 3270 terminal subsystem before using thecicstermp command.

CICS 3270 Terminal Emulators associated with printer devices are identical tonormal user CICS 3270 Terminal Emulators, except that printer CICS 3270

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

165 de 179 03/03/12 14:46

Page 166: Com an Dos

Terminal Emulators are not connected to an interactive device, so they can neverreceive keyboard input. Either CICS must create these printer CICS 3270 TerminalEmulators when the region starts up, using the Terminal Definitions (WD), or youcan enter cicstermp with the -P printCommand option.

The -P option or its default, is used to process the data when a print control isdetected in the data stream sent to the terminal. The data is placed in a temporaryfile and the print command is issued with the name of the temporary file appendedas a parameter. The temporary file is then erased.

Note that there is no requirement for the print command actually to print the data.It could, for example, copy the data so that it can be incorporated intodocumentation. Also, note that, since the temporary file is immediately erased, theprint command must finish processing the file before returning. This precludes theuse of a command such as the AIX qprt command (without the -c option) thatsimply records the name of the file for later processing.

Those parameters that are only associated with a PostScript printer type (-f, -M, -sand -R), must have valid values. If not, incorrect printer output may occur. If any ofthese parameters are used when PostScript printer type isnot used, an errormessage will be sent and cicstermp will terminate.

Options

-n netNamespecifies the network name, which is mandatory. The network namedetermines which printer terminal emulator is selected from the TerminalDefinitions.

-r regionNamespecifies the name of the CICS region to which you wish to attach.

-h hostListspecifies a blank-separated list of names or addresses of hosts to be searchedfor the specified region. If a list of host names is not specified, the contents ofthe environment variable CICS_HOSTS will be used. If CICS_HOSTS is not set,the local machine will be searched.

-t transIdspecifies the transaction identifier of the transaction to run after printer CICS3270 Terminal Emulator initialization.

-P printCommandspecifies the command used by CICS to process the data sent to the terminal.The command is appended with the name of the temporary file before it isissued. The default is the operating system lp -c command, which in turn usesthe default print destination.

-Ssuppresses the insertion of a blank character between single- and double-byte

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

166 de 179 03/03/12 14:46

Page 167: Com an Dos

characters.

-p printerTypespecifies the type of printer. The valid printer types are "postscript" and"ps55". These types are valid in either upper or lower case.

-f fontspecifies the default font. The default values are:

Courier (for single-byte characters)GothicBBB-Medium-RKSJ-H (for Ja_JP)GothicBBB-Medium-EUC-H (for ja_JP)

This option is valid only if the printer type is "postscript".

-M paperTypespecifies the paper size. Valid paper types are:

LETTER, FOLIO, EXECUTIVE, LEGAL, LEDGER, TABLOID,A0, A1, A2, A3, A4, A5, A6, A7, A8, A9,B0, B1, B2, B3, B4, B5, B6, B7, B8, B9 and B10.

The default value is A4. This option is valid only if the printer type is"postscript".

-s fontSizespecifies the default font size. The default value is 11. This option is valid onlyif the printer type is "postscript".

-Rrotates the printed output through 90 degrees. This option is valid only if theprinter type is "postscript".

-?causes the usage message to be displayed.

Examples

To display the syntax:

cicstermp -?

1.

To use the default printer for CICS region wessex and netname Printer1:

cicstermp -r wessex -n Printer1

2.

To use a specific printer (lp0) on CICS region wessex and netname Printer1:

cicstermp -r wessex -n Printer1 -P "lp -ddest lp0"

3.

To print DBCS data with outlines onto PS/55 printers whose queue name is dbcson CICS region wessex and netname DBCSPRT with codepage 932 (LANG=Ja_JP):

cicstermp -r wessex -n DBCSPRT -p ps55 -P "qprt -c \ -Pdbcs -l0 -x2 -L! -XIBM-932"

4.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

167 de 179 03/03/12 14:46

Page 168: Com an Dos

cicstfmt - Trace formatter

AIX HP-UX Sun Solaris Windows

X X X X

Use this command to format trace data that was specified as unformatted when itwas collected. Unformatted trace data must be formatted before it can be read. Theformatted trace report is written either to standard operating system output or toan operating system file if you provide a filename.

Syntax

cicstfmt [-o output_directory] input_files

Because the trace system can create a large number of separate files, you can listmany files (using wild cards or explicit names) on a single command line as input tothe trace formatter. If the output directory is not specified, the formatted trace filesare written to the current working directory. The formatted trace files are named byadding the extension '.fmt' to the existing filename.

Description

The CICS trace facility can generate formatted or unformatted trace data. If thetrace facility formats the data when upon collection, the data requires no furtherformatting. The CICS trace formatter, cicstfmt, formats unformatted trace data andgenerates readable trace output of the form described in the CICS ProblemDetermination Guide. The cicstfmt command can be used to:

Format a region's system trace filesFormat a user trace fileList a user's trace filesDelete all of a user's trace filesDelete some of a user's trace filesFormat a specific file

If you enter the command syntax incorrectly or specify invalid parameters, thecicstfmt command writes a message to standard error. It does not produce an errormessage if a trace file contains invalid data.

The cicstfmt command formats trace files that contain only CICS trace. On AIX,you can format trace files that contain non-CICS trace by using the operatingsystem trace formatting utility trcrpt.

Because the trace system can create a large number of separate files, you can listmany files (using wild cards or explicit names) on a single command line as input tothe trace formatter. If the output directory is not specified, the formatted trace files

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

168 de 179 03/03/12 14:46

Page 169: Com an Dos

are written to the current working directory. The formatted trace files are named byadding the extension '.fmt' to the existing filename.

Options

-o output_directoryspecifies the directory to which the formatted trace files are written. If theoutput directory is not specified, the formatted trace files are written to thecurrent working directory.

-i input_filesspecifies the names of one or more trace files that you wish to format. Becausethe trace system can create a large number of separate files, you can list manyfiles (using wild cards or explicit names) on a single command line as input tothe trace formatter. The formatted trace files are named by adding theextension '.fmt' to the existing filename.

Examples

To format trace entries in the trace data file TraceFile in the current directory toa file called TraceFile.fmt:

cicstfmt TraceFile

1.

To format trace entries in all trace data files whose names start with cicstr andthe trace data file TraceFile in the current directory to formatted trace files inthe output directory called usr/cics/traceout:

cicstfmt -o usr/cics/traceout cicstr* TraceFile

2.

See the CICS Administration Guide and CICS Application Programming Guide forrelated information.

cicstracefilter - Trace filter

AIX HP-UX Sun Solaris Windows

X X X X

The cicstracefilter command filters a CICS trace file to select or remove specifiedtrace entries. The trace entries to be selected or removed can be specified by hookidentifier or by CICS module identifier or both. On CICS for AIX only, this commandmay also be used to filter an AIX EPTF-format file.

Syntax

cicstracefilter [-h [!]hookIdList] [-m [!]moduleIdList]

cicstracefilter -?

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

169 de 179 03/03/12 14:46

Page 170: Com an Dos

Description

cicstracefilter reads standard input, which is assumed to be in the format of aCICS trace file. Each trace entry is echoed to standard output or is discardeddepending on the values of the -h and -m options. The output from cicstracefilter isalso in the format of a CICS trace file and can be formatted using the CICS programcicstfmt. using the CICS program cicstfmt or, on AIX only, using the AIX programtrcrpt.

Options

-h [!]hookIdListspecifies a comma-separated list of hook identifiers of those trace entries thatare to be echoed to standard output or, if '!' is specified, the entries that are tobe discarded. Each hook identifier must be a hexadecimal number between000 and FFF. A range of hook identifiers can be specified by using a '-'character. The hook identifiers used by CICS are listed in the CICS ProblemDetermination Guide.

-m [!]moduleIdListspecifies a comma-separated list of names or identifiers of modules whosetrace entries are to be echoed to standard output or, if '!' is specified, whoseentries that are to be discarded. An asterisk can be used as a wild character ina module name. Each CICS module has a five-character name and a numericidentifier. The names and identifiers are listed in the CICS ProblemDetermination Guide.

-?causes the usage message to be displayed.

Examples

To select only hook entries for identifiers 581 to 583 and 586 the CICS traceentries not made by modules StoTA or StoRE in the trace file trace1 placing theoutput in file filteredtrace, enter:

cicstracefilter -h581-583,586 -m!stota,store <trace1 >filteredtrace

1.

To remove EXEC CICS interface entry and exit traces from the trace file trace2,enter:

cicstracefilter -h!582,583 <trace2

2.

See the CICS Administration Guide for related information.

cicsupdate - Modify CICS resource definitions

AIX HP-UX Sun Solaris Windows

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

170 de 179 03/03/12 14:46

Page 171: Com an Dos

X X X X

Use this command to modify existing CICS resource definitions.

Syntax

cicsupdate -c className [-r regionName] [-P | -R | -B] [-f fileName] [resourceName][attributeName=attributeValue ... ]

cicsupdate -?

Description

The Resource Definition Online (RDO) command cicsupdate updates a resourcedefinition of a specified class in the permanent resources database, or installs theresource definition into the runtime database, or both.

The cicsupdate command initializes the data structures for the resource with thecurrent values before overwriting them with your specified values. Stopping thecommand before completion can result in a damaged database. The commandreturns 0 if the command runs successfully, 1 otherwise.

You can use the cicsupdate command to update the reserved resource defaultassociated with each resource class.

Options

-c classNamedetermines the resource class to which the resource definition is to beupdated, and is one of these two- or three-character codes:

cdCommunication

fdFiles

gdGateways

gsdGateway Servers

jdJournals

ldListeners

md

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

171 de 179 03/03/12 14:46

Page 172: Com an Dos

Monitoring

odObjects

pdPrograms

rdRegions

scdSFS Schemas

ssdSFS Servers

tdTransactions

tddTransient Data Queues

tsdTemporary Storage Queues

udUsers

wdTerminals

xadProducts

-r regionNamespecifies the region whose resource definition is to be updated. If you do notspecify a region name, CICS updates the resource definition in the regionspecified by the CICSREGION environment variable.

The -r parameter is invalid if you specify gsd, scd, or ssd as the resourceclass, because these classes are associated with a collection of regions ratherthan with a specific one.

-f fileNamespecifies the file that contains the schema definitions. Use this flag only whenyou specify scd (SFS schema definitions) as the resource class.

-Pinstructs the command to update the resource definition in the permanentdatabase without installing it into the runtime database. This is the default

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

172 de 179 03/03/12 14:46

Page 173: Com an Dos

option if you do not specify the -P, -R, or -B options.

-Rinstructs the command to update the runtime database and install the resourcedefinition in a running system. If you are using DCE authentication, you mustbe authenticated as a DCE principal before running the command with thisflag.

The -R flag is invalid if you specify rd or md as the resource class becausethese classes cannot be updated in a running system, or if you specify gsd,scd, or ssd as the resource class, since these classes are not associated with aspecific region.

-Binstructs the command to update the resource definition in the permanentdatabase, update the runtime database, and install the resource definition in arunning system. The second part of this operation fails if there is already anentry in the runtime database, so you must use cicsdelete -R to delete anyexisting entry first. If you are using DCE authentication, you must beauthenticated as a DCE principal before running the command with this flag.

The -B flag is invalid if you specify rd or md as the resource class becausethese classes cannot be updated in a running system, or if you specify gsd,scd, or ssd as the resource class since these classes are not associated with aspecific region.

resourceNameis the name of the resource definition to be updated. You must enter aresourceName for all classes except rd and md. To update the reserved defaultresource definition, enter resourceName as two double quotation marks ("").

attributeName=attributeValue ...are the names and values of attributes belonging to the class className thatyou wish to change.

If you are using cicsupdate from the command line and you want to use ametacharacter such as double asterisks (**), backslash (\), or pipe (|) within anattribute value, you must use a shell escape mechanism. For example, if youwant to use ** as a value, you must enter one of the following:

"**"\*\*'**'

You must use the pipe (|) character as the separator for multiple entries intoTransaction Security Level (TSL) and Resource Security Level (RSL) key lists.

Note:The term metacharacter refers to the following special characters: dollar($), at sign (@), period (.), slash (/), dash (-), underscore (_), percent (%),

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

173 de 179 03/03/12 14:46

Page 174: Com an Dos

ampersand (&), question mark (?), exclamation (!), vertical bar or pipe (|),double quotation ("), comma (,), semicolon (;), less than (<), greater than(>).

The set of attributeName=attributeValue pairs depends on the class of theresource.

-?causes the usage message to be displayed.

Examples

To update the program name for the transaction TEST in the region REGION3 in thepermanent database only:

cicsupdate -c td -r REGION3 -P TEST ProgName=PROG2

1.

To update the path name for the program PROG1 in the region REGION4 in thepermanent database and install it in the runtime database:

cicsupdate -c pd -r REGION4 -B PROG1 \ PathName=/var/cics_regions/REGION4/bin/prog1

2.

See the CICS Administration Guide for related information.

cicsupdateclass command

AIX HP-UX Sun Solaris Windows

X X X X

Selectively changes the value of an attribute for a given class.

Syntax

cicsupdateclass [-r regionName] [ -w ] -c className -a attributeName{-n newValue | -b fromAttribute} [ [ -lt | -gt | -eq ] oldValue ] [ -k key ] [ -f filename ]

cicsupdateclass -?

Description

The cicsupdateclass command is used when an upgrade of CICS on Open Systemscauses a change to the value of an attribute in the default resource definition file,for example, the default value, or a change in the range of values that the attributecan take. cicsupdateclass globally modifies the value of each specified attributefor all the resource definition files in that class.

These commands are generated automatically and are included in the migrationshell script which was created when you ran cicsmigrate. If you ran cicsmigrate

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

174 de 179 03/03/12 14:46

Page 175: Com an Dos

to update the warm start region images, the cicsupdateclass commands aregenerated with a -w flag.

You can edit the cicsupdateclass commands in the shell script, for example, if youwanted to change the default value of an attribute for your system. You canexplicitly specify the new value using the -n parameter, or you can copy a new valuefrom an existing attribute using the -b parameter.

You can also specify that the attribute value changes only under certain conditions.For example, you can specify that a change occurs only if the current value is lessthan, or greater than, a numerical value that you specify. If you use the conditionthat the attribute value changes only if the current value is equal to a specifiedvalue, you can specify either a numerical value, or a valid character value. You canalso specify that a change occurs only for a certain stanza by naming its key.

Options

-r regionNamespecifies the name of the region being modified. It is optional only for thefollowing resources: ssd, gsd, and scd.

-wupdates the warm start region images.

-c classNamespecifies the name of the class being modified. Valid classes are:

cdCommunication definitions

fdFile definitions

gdGateway definitions

gsdGateway server definitions

jdJournal definitions

ldListener definitions

mdMonitoring definitions

odObject definitions

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

175 de 179 03/03/12 14:46

Page 176: Com an Dos

pdProgram definitions

rdRegion definitions

scdSchema file definitions

ssdStructured file server definitions

tdTransaction definitions

tddTransient data definitions

tsdTemporary storage definitions

udUser definitions

wdTerminal definitions

xadProduct definitions.

-a attributeNamespecifies the name of the attribute being modified.

-n newValuespecifies the new value for the attribute.

-b fromAttributespecifies the name of an attribute whose value is used as the new value for theattribute being modified.

-lt oldValuechanges the value of the attribute only if its current value is less than anumerical value, oldValue, that you specify.

-gt oldValuechanges the value of the attribute only if its current value is greater than anumerical value, oldValue, that you specify.

-eq oldValuechanges the value of the attribute only if its current value is equal to a value,oldValue, that you specify. The value you specify can be numerical or valid

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

176 de 179 03/03/12 14:46

Page 177: Com an Dos

characters.

-k keychanges the value of the stanza only with the key specified.

-f filenamespecifies the path and filename of the schema resource file. This option is validonly if -c scd is specified.

-?causes the usage message to be displayed.

Examples

To change the value of the Priority attribute to 99 for every user in region1:

cicsupdateclass -r region1 -c ud -a Priority -n 99 -w

1.

To change the value of the InDoubt attribute to wait_commit if it previously had thevalue wait_backout for every entry in the Transaction Definitions (TD) in region2:

cicsupdateclass -r region2 -c td -a InDoubt -n wait_commit \ -eq wait_backout -w

2.

To change the value of the RegionPoolSize attribute in the Region Definitions (RD)for region3 to 24679 if the existing value is less than 2050:

cicsupdateclass -r region3 -c rd -a RegionPoolSize -n 24679 \ -lt 2050 -w

3.

To change the value of the TSLCheck attribute to the value of the RSLCheck attributefor every transaction in the Transaction Definitions (TD) in region4:

cicsupdateclass -r region4 -c td -a TSLCheck -f RSLCheck -w

4.

To set the attribute NameService to NONE for a specified Structured FileService Definition (SSD) entry:

cicsupdateclass -w -c ssd -a NameService -n NONE \ -k "/.;/cics/sfs/serverName"

5.

cicsusedceservers - Migrate CICS regions andEncina servers to use DCE

AIX HP-UX Sun Solaris Windows

X X X X

The purpose of the cicsusedceservers command is to migrate CICS regions andEncina SFS and PPC Gateway servers to make use of the DCE CDS and Securityservices after originally being created not to use these services.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

177 de 179 03/03/12 14:46

Page 178: Com an Dos

Syntax

cicsusedceservers { -A [-I] | -R regionName | -S serverName | -G gatewayName }[-v]

cicsusedceservers -?

Description

The DCE directory and security services must have been installed on the machine.

You must be logged in to DCE with credentials to create DCE principals andaccounts.

This command will migrate CICS regions and Encina servers from operatingwithout the use of the DCE directory and security services to operate using theseservice. It is intended to ease the migration to a more complex configuration or toone that requires the use of DCE security.

The command may be used to migrate all regions and servers on the machine atonce or to migrate individual regions and servers. All Encina servers should bemigrated before attempting to use any migrated regions that make use of theirfacilities.

cicsusedceservers will create the necessary DCE principals and keytab files whichare normally created by cicsdefault or by cicsimport, cicssfscreate andcicsppcgwycreate (CICS on Open Systems only) when those commands areused in the presence of the DCE servers. It will also change the settings of theNameService and AuthenticationService attributes for the regions and serversto DCE. The various attributes specifying RPC protection levels will all be left set tonone, however, so, if higher protection levels are required, it will be necessary touse SMIT (on CICS for AIX), SAM (on CICS for HP-UX) or cicsupdate andcicsupdateclass to change these settings after you have run cicsusedceservers.

Options

-Acauses cicsusedceservers to migrate all CICS regions and all Encina serversdefined on the local machine.

-Icauses cicsusedceservers -A to continue migration of other CICS regions andEncina servers if a failure is encountered in migrating one of them.

-R regionNamespecifies the name of a single region on the local machine that is to bemigrated.

-S serverNamespecifies the name of a single Encina SFS server to be migrated.

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

178 de 179 03/03/12 14:46

Page 179: Com an Dos

-G gatewayNamespecifies the name of a single Encina PPC gateway server to be migrated.

-vcauses cicsusedceservers to display more information about the progress ofthe migration.

-?causes the usage message to be displayed.

Examples

To migrate all CICS regions and Encina servers on the local machine even if anerror is encountered with one or more of them, enter

cicsusedceservers -AI

1.

To migrate region Region1 on the local machine, enter

cicsusedceservers -R Region1

2.

To migrate SFS server /.:/cics/sfs/SERVER1 on the local machine, enter

cicsusedceservers -S /.:/cics/sfs/SERVER1

3.

Footnotes:

1

Internet Protocol (IP) is the protocol that provides the packet delivery servicefor TCP, UDP, and ICMP.

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

Resource definition commands and offline utilities http://publib.boulder.ibm.com/infocenter/txformp/v5r1/to...

179 de 179 03/03/12 14:46