Remove

Removes objects from a container object.

You can use the Remove command to:

See the related Add command.

Request format

Removing resource definitions from a ResGroup:

<CCV210>
  <Remove>
    <LocationCriteria>
      <LocationName> location_name </LocationName>
      <LocationType> CConfig | Context | CSD </LocationType>
    </LocationCriteria>
 
    <ObjectCriteria>  1 
      <ListCount> element_count </ListCount>
      <ListElement>
        <DefA>
          <ObjGroup> resource_group </ObjGroup>  2 
          <ObjType> resource_type </ObjType>
          <ObjName> resource_name </ObjName>
        </DefA>
      </ListElement>
    </ObjectCriteria>
 
    <InputData>  3 
      <ContainerName> object_name </ContainerName>
      <ContainerType> ResGroup </ContainerType>
    </InputData>
  </Remove>
</CCV210>

Removing ResGroups from a ResDesc:

<CCV210>
  <Remove>
    <LocationCriteria>
      <LocationName> location_name </LocationName>
      <LocationType> CConfig | Context | CSD </LocationType>
    </LocationCriteria>
 
    <ObjectCriteria>  1 
      <ListCount> element_count </ListCount>
      <ListElement>
        <GrpA>
          <ObjType> ResGroup </ObjType>
          <ObjName> resource_name </ObjName>
        </GrpA>
      </ListElement>
    </ObjectCriteria>
 
    <InputData>  3 
      <ContainerName> object_name </ContainerName>
      <ContainerType> ResDesc </ContainerType>
    </InputData>
  </Remove>
</CCV210>

Removing resource definitions from a change package:

<CCV210>
  <Remove>
    <LocationCriteria>
      <LocationName> location_name </LocationName>
      <LocationType> Repository </LocationType>
    </LocationCriteria>
    <ObjectCriteria>  1 
      <CConfig> CICS_configuration </CConfig>  4 
      <ListCount> element_count </ListCount>
      <ListElement>
        <ObjName> resource_name </ObjName>
        <ObjGroup> resource_group </ObjGroup>
        <ObjType> resource_type </ObjType>
      </ListElement>
 
      More list elements…
 
    </ObjectCriteria>
 
    <InputData>  3 
      <ContainerType> ChgPkg </ContainerType>
      <ContainerName> change_package_ID </ContainerName>
    </InputData>
 
  </Remove>
</CCV210>

Removing commands from a change package:

<CCV210>
  <Remove>
    <LocationCriteria>
      <LocationType> Repository </LocationType>
    </LocationCriteria>
    <ObjectCriteria>  1 
      <CConfig> CICS_configuration </CConfig>  4 
      <ListCount> element_count </ListCount>
      <ListElement>
        <CmdAPost>
          <Command> Add | Remove | Delete </Command>
          <ObjGroup> resource_group </ObjGroup>
          <ObjType> resource_type </ObjType>
          <ObjName> resource_name </ObjName>
          <ObjDefVer> definition_version </ObjDefVer>  2 
          <TContainer> resource_group </TContainer>  5 
        </CmdAPost>
      </ListElement>
 
      More list elements…
 
    </ObjectCriteria>
 
    <InputData>  3 
      <ContainerName> change_package_ID </ContainerName>
      <ContainerType> ChgPkg </ContainerType>
    </InputData>
 
  </Remove>
</CCV210>
 1 
<ObjectCriteria> identifies the objects that you want to remove from the container.
You can specify the object criteria in several ways:
  • To identify a single object, specify the contents of a single <ListElement>, but omit the <ListElement> start tag and the </ListElement> end tag. Omit the <ListCount> element. In the <Obj...> element values, do not use masking (wildcards).
  • To identify one or more objects, either:
    • Specify <ListCount> followed by one or more <ListElement>. Each <ListElement> must identify a object, with no masking.

      or

    • Specify the contents of a single <ListElement>, but omit the <ListElement> start tag and the </ListElement> end tag. Omit the <ListCount> element. In the <Obj...> element values, do not use masking (wildcards).

When removing from a ResGroup or a ResDesc, <LocationCriteria> refers to the location of the resource definitions. However, when removing resource definitions or commands from a change package,, <LocationCriteria> refers to the CICS® Configuration Manager repository, which is where the change package is stored. To specify the location of the resource definitions, or the CICS configuration associated with the commands, you use <CConfig> in <ObjectCriteria>.

 2 
When adding a ResGroup to a ResDesc, omit <ObjGroup>.
 3 
<InputData> identifies the container object.
 4 
<CConfig> identifies the CICS configuration of the resource definitions that you want to remove. (A change package can contain resource definitions from multiple CICS configurations.)

Response format

<CCV210>
  <Remove>
    <OutputData>
      <ReturnCode> return_code </ReturnCode>
      <ReasonCode> reason_code </ReasonCode>
      <TaskNo> CICS_task_number </TaskNo>
    </OutputData>
  </Remove>
</CCV210>

Security key

API command (READ access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.REM.object_type.location_type.location_name----------><

Resource definitions (ALTER access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.target_CICS_config.group.type.name-------------------><