CFACCESS Parameters

Parameter	Description
`USERID`	Defines the user ID that is associated with the file transfer. This parameter can be used along with the `NODE` or `IPADDR` parameters to further qualify the CFACCESS matching scan. Note: If the `NODE` and `IPADDR` parameters are not defined, then this parameter must be defined. You can specify a special user ID called `DEFAULT`. With this setting, CFACCESS scanning detects a match for the user ID in this CFACCESS configuration entry. If this parameter is not entered, no checking is performed on the user ID for this entry.
`NODE`	Defines the node that is associated with the file transfer. Nodes are defined within the Platform Server CONFIG DD statement. This parameter can be used along with the `USERID` parameter to further qualify the CFACCESS matching scan. Note: If the `USERID` and `IPADDR` parameters are not defined, then this parameter must be defined. This parameter is mutually exclusive with the `IPADDR` parameter. You can specify a special node called `DEFAULT`. With this setting, CFACCESS scanning detects a match for the node in this CFACCESS configuration entry. If this parameter is not entered, no checking is performed on the node for this entry.
`IPADDR`	Defines the IP address that is associated with the file transfer. This parameter can be used along with the `USERID` parameter to further qualify the CFACCESS matching scan. Note: If the `USERID` and `NODE` parameters are not defined, this parameter must be defined. This parameter is mutually exclusive with the `NODE` parameter. If this parameter is not entered, no checking is performed on the IP address for this entry.
`SEND_OPTION`	Defines the options for sending files. This parameter has no default value, which indicates that no restrictions are placed on a user/node. Valid values are: `ROOT`: Any file names defined in the file transfer request are appended to the file name defined by the `SEND_HLQ` parameter. If `ROOT` is specified, then the `SEND_HLQ` parameter must also be defined. `FORCE`: If the transfer file name starts with the HLQ defined in the `SEND_HLQ` parameter, then no changes are made to the transfer file name. Otherwise, any file names defined in the file transfer request are appended to the HLQ defined by the `SEND_HLQ` parameter. If `FORCE` is specified, then the `SEND_HLQ` parameter must also be defined. `NEVER`: The user/node defined in this entry cannot send files. All send requests are terminated with errors. `USE`: The user is authorized to send files to this system. The file name is not changed when `USE` is specified.
`RECEIVE_OPTION`	Defines the options for receiving files. This parameter has no default value, which indicates that no restrictions are placed on a user/node. Valid values are: `ROOT`: Any file names defined in the file transfer request are appended to the file name defined by the `RECEIVE_HLQ` parameter. If `ROOT` is specified, then the `RECEIVE_HLQ` parameter must also be defined. `FORCE`: If the transfer file name starts with the HLQ defined in the `RECEIVE_HLQ` parameter, then no changes are made to the transfer file name. Otherwise, any file names defined in the file transfer request are appended to the HLQ defined by the `RECEIVE_HLQ` parameter. If `FORCE` is specified, then the `RECEIVE_HLQ` parameter must also be defined. `NEVER`: The user/node defined in this entry cannot receive files. All send requests are terminated with errors. `USE`: The user is authorized to receive files to this system. The file name is not changed when `USE` is specified.
`COMMAND_OPTION`	Defines the options for executing commands. This parameter has no default value, which indicates that no restrictions are placed on a user/node. The command options are checked under the following two circumstances: When a file transfer `TYPE=COMMAND` request is received. When Post Processing Actions (PPA) are executed. Valid values are: `ALLOW`: Users can execute commands on this system. `NEVER`: The user/node defined in this entry cannot execute commands. Any command requests are terminated with errors.
`SUBMIT_OPTION`	Defines the options for submitting jobs to the z/OS internal reader. This parameter has no default value, which indicates that no restrictions are placed on a user/node. Valid values are: `ROOT`: The file name defined in the file transfer request is actually a member name. The dataset name is defined by the `SUBMIT_HLQ` parameter. Parentheses are placed around the member name, and the member name is appended to the DSN defined by the `SUBMIT_HLQ` parameter. This processing is performed only on PPA submit requests. When `ROOT` is specified, file name cannot be changed in file transfer submit requests. `NEVER`: The user/node defined in this entry cannot submit jobs into the internal reader. Any submit requests including PPA submit requests are terminated with errors. `ALLOW`: The user is authorized to submit jobs into the internal reader. The file name is not changed when `ALLOW` is specified.
`SEND_HLQ`	Defines the HLQ to which the file name of the sent file is appended to create the new file transfer file name. This parameter is required when `SEND_OPTION` is configured as `ROOT` or `FORCE`. It is ignored otherwise. You can restrict the file names that users can use.
`RECEIVE_HLQ`	Defines the HLQ to which the file name of the received file is appended to create the new file transfer file name. This parameter is required when `RECEIVE_OPTION` is configured as `ROOT` or `FORCE`. It is ignored otherwise. You can restrict the file names that users can use.
`SUBMIT_HLQ`	Defines the HLQ to which the file name of the transfer request is appended to create the new file transfer file name. This parameter is required when `SUBMIT_OPTION` is configured as `ROOT`. It is ignored otherwise. You can restrict the file names that users are allowed to use. The new file transfer name is read and the data records are written to the z/OS internal reader. Note: This parameter is only used for PPA submit requests.

USERID

Defines the user ID that is associated with the file transfer.

This parameter can be used along with the NODE or IPADDR parameters to further qualify the CFACCESS matching scan.

Note: If the NODE and IPADDR parameters are not defined, then this parameter must be defined.

You can specify a special user ID called DEFAULT. With this setting, CFACCESS scanning detects a match for the user ID in this CFACCESS configuration entry. If this parameter is not entered, no checking is performed on the user ID for this entry.

NODE

Defines the node that is associated with the file transfer.

Nodes are defined within the Platform Server CONFIG DD statement. This parameter can be used along with the USERID parameter to further qualify the CFACCESS matching scan.

Note:

If the USERID and IPADDR parameters are not defined, then this parameter must be defined.
This parameter is mutually exclusive with the IPADDR parameter.

You can specify a special node called DEFAULT. With this setting, CFACCESS scanning detects a match for the node in this CFACCESS configuration entry. If this parameter is not entered, no checking is performed on the node for this entry.

IPADDR

Defines the IP address that is associated with the file transfer.

This parameter can be used along with the USERID parameter to further qualify the CFACCESS matching scan.

Note:

If the USERID and NODE parameters are not defined, this parameter must be defined.
This parameter is mutually exclusive with the NODE parameter.

If this parameter is not entered, no checking is performed on the IP address for this entry.

SEND_OPTION

Defines the options for sending files.

This parameter has no default value, which indicates that no restrictions are placed on a user/node.

Valid values are:

ROOT: Any file names defined in the file transfer request are appended to the file name defined by the SEND_HLQ parameter.
If ROOT is specified, then the SEND_HLQ parameter must also be defined.
FORCE: If the transfer file name starts with the HLQ defined in the SEND_HLQ parameter, then no changes are made to the transfer file name. Otherwise, any file names defined in the file transfer request are appended to the HLQ defined by the SEND_HLQ parameter.
If FORCE is specified, then the SEND_HLQ parameter must also be defined.
NEVER: The user/node defined in this entry cannot send files. All send requests are terminated with errors.
USE: The user is authorized to send files to this system. The file name is not changed when USE is specified.

RECEIVE_OPTION

Defines the options for receiving files.

This parameter has no default value, which indicates that no restrictions are placed on a user/node.

Valid values are:

ROOT: Any file names defined in the file transfer request are appended to the file name defined by the RECEIVE_HLQ parameter.
If ROOT is specified, then the RECEIVE_HLQ parameter must also be defined.
FORCE: If the transfer file name starts with the HLQ defined in the RECEIVE_HLQ parameter, then no changes are made to the transfer file name. Otherwise, any file names defined in the file transfer request are appended to the HLQ defined by the RECEIVE_HLQ parameter.
If FORCE is specified, then the RECEIVE_HLQ parameter must also be defined.
NEVER: The user/node defined in this entry cannot receive files. All send requests are terminated with errors.
USE: The user is authorized to receive files to this system. The file name is not changed when USE is specified.

COMMAND_OPTION

Defines the options for executing commands.

This parameter has no default value, which indicates that no restrictions are placed on a user/node. The command options are checked under the following two circumstances:

When a file transfer TYPE=COMMAND request is received.
When Post Processing Actions (PPA) are executed.

Valid values are:

ALLOW: Users can execute commands on this system.
NEVER: The user/node defined in this entry cannot execute commands. Any command requests are terminated with errors.

SUBMIT_OPTION

Defines the options for submitting jobs to the z/OS internal reader.

This parameter has no default value, which indicates that no restrictions are placed on a user/node.

Valid values are:

ROOT: The file name defined in the file transfer request is actually a member name. The dataset name is defined by the SUBMIT_HLQ parameter. Parentheses are placed around the member name, and the member name is appended to the DSN defined by the SUBMIT_HLQ parameter.
This processing is performed only on PPA submit requests. When ROOT is specified, file name cannot be changed in file transfer submit requests.
NEVER: The user/node defined in this entry cannot submit jobs into the internal reader. Any submit requests including PPA submit requests are terminated with errors.
ALLOW: The user is authorized to submit jobs into the internal reader. The file name is not changed when ALLOW is specified.

SEND_HLQ

Defines the HLQ to which the file name of the sent file is appended to create the new file transfer file name.

This parameter is required when SEND_OPTION is configured as ROOT or FORCE. It is ignored otherwise.

You can restrict the file names that users can use.

RECEIVE_HLQ

Defines the HLQ to which the file name of the received file is appended to create the new file transfer file name.

This parameter is required when RECEIVE_OPTION is configured as ROOT or FORCE. It is ignored otherwise.

You can restrict the file names that users can use.

SUBMIT_HLQ

Defines the HLQ to which the file name of the transfer request is appended to create the new file transfer file name.

This parameter is required when SUBMIT_OPTION is configured as ROOT. It is ignored otherwise.

You can restrict the file names that users are allowed to use. The new file transfer name is read and the data records are written to the z/OS internal reader.

Note: This parameter is only used for PPA submit requests.