PGCR gate, MOVE_CONTAINER function
The MOVE_CONTAINER function of the PGCR gate is used to move a container from one container pool to another. Both pools must already have been created. If the TO_POOL_TOKEN is not specified, the container is not moved to a different pool but is renamed to the value of AS_CONTAINER_NAME.
Input Parameters
- AS_CONTAINER_NAME
- Optional Parameter
- is the name by which the copied container is to be known in the target container pool.
- CALLER
- Optional Parameter
- is the call part of an API call.
- Values for the parameter are:
- EXEC
- SYSTEM
- CONTAINER_NAME
- Optional Parameter
- is the name of the container to be copied.
- CONTAINER_TOKEN
- Optional Parameter
- is a token referencing the container to be copied.
- POOL_TOKEN
- Optional Parameter
- is a token (returned on a CREATE_CONTAINER_POOL request) that identifies the container pool to be copied.
- TO_POOL_TOKEN
- Optional Parameter
- is a token referencing the target container pool (that is, the pool to which the container is to be copied).
- TYPE
- Optional Parameter
- whether the container is visible only to CICS, or to user programs as well.
- Values for the parameter are:
- CICS
- USER
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CONTAINER_NOT_FOUND
- INVALID_AS_CONTAINER_NAME
- READONLY_AS_CONTAINER
- READONLY_CONTAINER
- The following values are returned when RESPONSE is INVALID:
- INVALID_CONTAINER_TOKEN
- INVALID_PARAMETERS
- INVALID_POOL_TOKEN
- INVALID_TO_POOL_TOKEN
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- CONTAINER_TOKEN_OUT
- Optional Parameter
- is a token representing the new copy of the container.
- GENERATION_NUMBER
- Optional Parameter
- Every time a container in a container pool is changed or created the pool generation number is incremented. This number is the number for the container when the container was last changed.
- INITIAL_GENERATION
- Optional Parameter
- Every time a container in a container pool is changed or created the pool generation number is incremented. This number is the number for the container when the container was created.