cicscp - Region commands

AIX® HP-UX Linux Sun Solaris Windows
X X X X X

Creates, destroys, starts, or stops regions.

Syntax

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

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

cicscp start region {regionName | all} [attributeName=attributeValue … ]

cicscp status region {regionName | all}

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

Description

You must be logged on as a user with root or administrator privileges.

cicscp create region

The create command creates the named CICS® region. If the -i option is specified, cicscp uses the cicsimport command; otherwise, it uses the cicsdefault command. cicscp checks whether the SFS that is defined as the default file server for the region is configured, creates a default configuration if it is not, and starts the server if it is not already running. Finally, cicscp configures the server for the region.

Before using the region that you have created, consider using a mounted file system for the CICS log file, as described in Installing.

cicscp destroy region

The destroy command stops then destroys the named region, or all configured regions if the reserved name all is specified. If the -s option is specified, the file server 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 the reserved name all is specified. If a single region is started and it is not configured, a default region of the specified name is created. Any attribute overrides that are specified on the start command are not passed through to the region creation.

When the region has been created, if necessary, cicscp checks whether the necessary SFS and PPC Gateway servers are running.

If SFSs are not declared as remote, cicscp starts the default file server for the region then browses each File Definition entry and examines the server that is specified for the file. If a particular server is not running, cicscp starts it. Each start 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 Gateway Definition entry and starts the specified server if necessary. Each start can result in the implicit creation of the server if it does not already exist.

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

cicscp status region

The status command shows the status of the named region, or all regions if the reserved name all is specified.

You must be logged on as a user with root or administrator privileges.

The status could be one of the following:
  • Not defined
  • Stopping
  • Stopped
  • Starting
  • Recovering
  • Started
Note: The states Stopping, Starting and Recovering are transient; the life of these states is very short, and they cannot easily be reproduced.

cicscp stop region

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

Options

regionName
The name of the region.
-g groupId
Specifies the name of the group ID with which all files of the new region are created.
-i fileName
Specifies the file name of the archive copy of the resource definitions, in cpio format. 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 a symbolic link. The default action is to terminate the restoration abnormally:
-lm
Mandatory. cicscp abnormally terminates the restoration if it cannot find the symbolic target.
-lo
Optional. cicscp produces a warning message, creates the link and continues restoration if it cannot find the symbolic target. This allows you to restore more regions that resolve the missing links.
-lc
Continue. cicscp overrides any symbolic link requirements that are defined as part of the cicsexport command.
-lr
Resolve. If cicscp cannot find the symbolic target, it restores a physical copy of the missing definition, and produces a warning message.
-o instanceName
Specifies the name of the instance of DB2.
-a aliasName
Specifies the name of the DB2 database that is to be used as the file server. This name is stored in the DefaultFileServer attribute in the Region Definitions (RD).
-u userName
Specifies the name that is to be used for explicit authentication. If this parameter is specified, it forms part of the XA open string that is specified in the XAOpen attribute of the Product Definitions (XAD) entry.
-n
Specifies the creation of a system-defined Product Definitions (XAD) entry that specifies 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.
all
Used with destroy, start, status, or stop, causes cicscp to apply the command to all configured CICS regions.
-f (on cicscp destroy region)
Causes the command to be executed without issuing prompts for confirmation.
-f (on cicscp stop region)
Forces an immediate shutdown.
-c
Forces a cancel shutdown. The cicsnotify command is run automatically.
-w
Use a secure XA password for the system-defined Product Definitions (XAD) entry. If –w option is specified, the password is stored in a secure format in the XAOpen string.
attributeName=attributeValue
Overrides for Region Definitions (RD) attributes (See Region Definitions).

Examples

  1. To create a region called REGION1, and copy the definitions from a file called REGIONFILE, enter:
        cicscp create region REGION1 -i REGIONFILE
  2. To start the region TestReg with verbose messaging and a log file that records cicscp processing, enter:
        cicscp -v -l /tmp/cicscp.log start region TestReg

    This creates the region TestReg (using cicsdefault) and configures it for the default SFS server. Additional processing is performed for SFS as necessary.

  3. To display the status of all regions enter:
    cicscp status region all 
  4. To display the status of a particular region, enter:
    cicscp status region region_name