REMOVE

Remove a CICSPlex® SM or CICS® definition from the data repository.

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

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

Description

This commands removes a CICSPlex SM or CICS definition from the data repository. For definitions that have a CICSplex as their context (such as workload management or real-time analysis definitions), the definition is also removed from the data repositories of all CMASs involved in managing the CICSplex.

Related commands

CREATE
UPDATE

Options

CONTEXT(data-value)

Identifies the context for this command. The context must be the 1- to 8-character name of a CMAS or CICSplex.

If you do not specify the CONTEXT option, the default context for the thread is assumed.

FROM(data-area)

Identifies a buffer containing a resource table record that represents the definition to be removed. The record must include all of the attributes for the resource table specified on the OBJECT option.

LENGTH(data-value)

A fullword value that specifies the length of the FROM buffer.

OBJECT(data-value)

Identifies the resource table that represents the definition being removed. This value must be the 1- to 8-character name of a valid CICSPlex SM Definition or CICS Definition resource table. For a list of the CICSPlex SM resource tables by type, see An overview of the CICSPlex SM API.

PARM(data-area)

Identifies a buffer containing the parameter expression to be used in removing the definition.

For details on how to use a parameter expression with the REMOVE command, see An overview of the CICSPlex SM API. For a description of the parameters that are valid for a given resource table, see the CICSPlex SM resource tables.

PARMLEN(data-value)

A fullword value that specifies the length of the PARM buffer.

REASON(data-ref)

Names a variable to receive the fullword reason value returned by this command.

RESPONSE(data-ref)

Names a variable to receive the fullword response value returned by this command.

SCOPE(data-value)

Identifies the scope for this command.

If the current context (as set by this command or a previous CONNECT or QUALIFY command) is a CICSplex and the OBJECT option identifies a CICS definitional resource and the PARM option includes the CSD parameter, a valid scope can be specified.

The scope can be a CICS system within the CICSplex. If the current context is a CMAS or the OBJECT option identifies any other type of resource table, or the CSD parameter is not specified on a CICS definitional resource, this option has no meaning and is ignored.

If SCOPE applies to the command and you do not specify the SCOPE option, the default scope for the thread is assumed. If the current context is a CICSplex and no default scope has been set on a CONNECT or QUALIFY command, you receive an INVALIDPARM response for the SCOPE option.

THREAD(cpsm-token)

Identifies the API thread to be used for this operation. The cpsm-token value that identifies a thread is returned by the CONNECT command.

Conditions

The following is a list of the RESPONSE values that can be returned by the REMOVE command. The description of each RESPONSE includes a list of associated REASON values, if appropriate.

1024 OK

The command completed processing successfully.

1028 INVALIDPARM

An invalid parameter was detected. The parameter that is invalid is returned as the reason value:

1280 THREAD
1281 OBJECT
1282 CONTEXT
1285 LENGTH
1296 FROM
1315 PARM
1316 PARMLEN

Check the command description for valid parameter syntax.

1029 FAILED

The command failed for one of the following reasons:

1331 ABENDED: Command processing abended.
1359 EXCEPTION: Command processing encountered an exceptional condition.

1030 ENVIRONERROR

An environment error occurred for one of the following reasons:

1321 SOCRESOURCE: A required resource that is owned by the CMAS is not available.
1342 REQTIMEOUT: One of the CMASs to which the request was directed did not respond.
1357 NOSTORAGE: The application stub program could not obtain the necessary storage in the address space where the processing thread is running.
1358 NOSERVICE: The application stub program could not load the API service module.
1378 NOTPROCESSED: For CSD requests only, one of the MASs to which the request was directed could not process the request.

1031 NOTPERMIT

A not permitted condition occurred for the following reason:

1345 USRID: The user ID associated with the processing thread does not have the required security authorization.

1033 SERVERGONE

The CMAS to which the processing thread was connected is no longer active.

1034 NOTAVAILABLE

A not available condition occurred for one of the following reasons:

1323 MAINTPOINT: The maintenance point for the current context is not available.
1334 CPSMAPI: The CMAS to which the processing thread is connected is not available for API processing.
1340 APITASK: The API control subtask is not active.
1362 CMAS: A CMAS to which the request was directed is not available.
1375 CSDAPI: Support for the CICSPlex SM API to access the CICS CSD is not available.

1035 VERSIONINVL

A version conflict occurred for one of the following reasons:

1335 NOTSUPPORTED: The version of the application stub program used for this command is not supported.
1336 NOTVSNCONN: The version of the application stub program used for this command is not the same as the version used with the CONNECT command.

1036 INVALIDCMD

The command is invalid for the following reason:

1285 LENGTH: The total length of all the options on the command exceeds the maximum limit.

1038 TABLEERROR

A resource table record is invalid for one of the following reasons:

1337 INVALIDATTR: One of the resource table attributes is invalid.
1354 INVALIDVER: The specified version of the resource table is not supported by CICSPlex SM.
1361 DATAERROR: The value associated with one or more resource table attributes is invalid. This error can occur if the resource table is missing required attributes, contains one or more conflicting attributes, or does not exist. Use the FEEDBACK command to retrieve additional data about this error.