Remove
Removes objects from a container object.
You can use the Remove command to:
- Remove resource definitions or commands from a change package.
- Remove resource definitions in a CICSPlex® SM data repository from a ResGroup (resource group).
- Remove ResGroups from a ResDesc (resource description).
See the related Add command.
Request format
Removing resource definitions from a ResGroup:
<CCV530>
<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>
</CCV530>
Removing ResGroups from a ResDesc:
<CCV530>
<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>
</CCV530>
Removing resource definitions from a change package:
<CCV530>
<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>
</CCV530>
Removing commands from a change package:
<CCV530>
<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>
</CCV530>
- 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 only one set of <ObjName>, <ObjGroup>, and <ObjType>, with no masking (wildcards). Do not specify <ListCount> or <ListElement>.
- To identify one or more objects, either:
- Specify <ListCount> followed by one or more
<ListElement>. Each <ListElement> must identify a
single object, with no masking.
or
- only one set of <ObjName>, <ObjGroup>, and
<ObjType> with masked values. Do not specify
<ListCount> or <ListElement>. The values can be any
combination of:
- Mask or specific value for the object name
- Mask or specific value for the object group
- Specific object type, or the value * or All to identify all object types (you cannot use masking to identify a subset of object types)
For example, to identify all program resource definitions beginning with the characters PAY, from all groups beginning with the characters FIN, specify:
<ObjectCriteria> <ObjName>PAY*</ObjName> <ObjGroup>FIN*</ObjGroup> <ObjType>PROGDEF</ObjType> </ObjectCriteria>
- Specify <ListCount> followed by one or more
<ListElement>. Each <ListElement> must identify a
single object, with no masking.
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
<CCV530>
<Remove>
<OutputData>
<ReturnCode> return_code </ReturnCode>
<ReasonCode> reason_code </ReasonCode>
<TaskNo> CICS_task_number </TaskNo>
</OutputData>
</Remove>
</CCV530>