Previous Topic: DCMT VARY PTERM SyntaxNext Topic: DCMT VARY PTERM Usage


DCMT VARY PTERM Parameters

broadcast-parms

Indicates to execute the DCMT command on all or a list of data sharing group members.

Note: For more information about broadcasting and broadcast-parms syntax, see the section How to Broadcast System Tasks.

PTErminal physical-terminal-id

Specifies the physical terminal to vary.

Physical-terminal-id must be the ID of a physical terminal defined with the system generation PTERM statement.

BACKLOG backlog

The value defines the maximum length for the queue of pending connections TCP/IP allows before rejecting new connection requests. backlog is a positive number between 1 and 1,147,483,647.

The value specified for backlog is not necessarily the value accepted by the LISTEN call. Each TCP/IP implementation has a limit of its own. CA IDMS uses the lesser of the implementation's limit and the value specified for the backlog parameter.

CONnect

For connect-type terminals, enables the named physical terminal. New connection requests are accepted, and, if applicable, automatic connection is established for VTAM ACQUIRE and TTY AUTODIAL terminals.

telephone-number

For dial-up terminals only, specifies a telephone number that DC/UCF is to dial automatically for the named terminal. Telephone-number is a 16-character telephone number made up from digits, hyphens, and/or blanks. The hyphens and blanks are counted as characters when you specify a telephone number. These characters are not stored along with the number in the physical terminal element (PTE) for the terminal.

Default Print Class

Varies the default print class for the physical terminal.

printer-class

The new default print class: an integer in the range 1 through 64.

DISconnect

For connect-type terminals, terminates the current terminal session; however, new connection requests are accepted, and, if applicable, automatic connection is established.

IDLe INTerval idle-interval

Defines the time interval a non-permanent connection stays in an idle state after the corresponding DDS request has finished. This allows the same connection to be reused if a new DDS request comes in before the timeout expires.

idle-interval is a positive number between 0 and 32767. The default value is 0.

MAXimum CONnections max-number-conn

For a DDSTCPIP type PTERM, defines the maximum number of active connections allowed from the local system. For a LISTENER type PTERM, defines the maximum number of active BULK PTERM that can be started from that listener.

max-number-conn is a positive number between 1 and 65535. The default value is OFF, indicating that the maximum number of connections is unlimited.

Note: The maximum number of connections depends on the number of free BULK PTERMs in the SOCKET line on the target (remote) system.

MODE

Indicates the mode in which the task that is attached to the listener runs. Valid options are:

SYStem

The task attached to the listener runs in SYSTEM mode. This mode is only available for application programs written in assembler.

USER

The task attached to the listener runs in USER mode. This is the default.

ONline

Enables the physical terminal, permitting I/O requests to be directed to it. This action may be necessary in the following cases:

New connection requests are accepted for a connect-type terminal (that is, a UCF, VTAM, TCAM, BSC2, or start/stop terminal associated with a line defined as CONNECT at system generation time). However, automatic connection is not established.

telephone-number

Specifies a telephone number that DC/UCF is to dial automatically for the named BSC autocall terminal. Telephone-number is a 16-character telephone number made up from digits, hyphens, and/or blanks. The hyphens and blanks are counted as characters when you specify a telephone number. These characters are not stored along with the number in the physical terminal element (PTE) for the terminal.

OFfline

Disables the named physical terminal, terminating all I/O activity on it and disallowing new I/O requests. A connect-type terminal is disconnected, and new connection requests are disallowed.

PARM 'string'

A character string that is passed to the task attached by generic listening. String is limited to 80 characters and must be enclosed in single quotes.

PERmanent CONnections perm-conn-number

Defines the number of permanent connections that can exist between the host and the target systems.

perm-conn-number is a positive number between 0 and 65535. The default value is 0, indicating that permanent connections are not needed. In this case, the connections are always established dynamically when a new DDS request arrives.

PORT listener-port-identifier

Specifies the number of the listener port or a service name. If listener-port-identifier is a port number, it must be a positive number between 1 and 65535. If listener-port-identifier is a service name, it is limited to 32 characters and must be the name of a service in the services file with an associated protocol of TCP.

PORt RANge start-port-number and end-port-number

Defines a range of port numbers that are used to BIND the local sockets explicitly. Each time a new connection is established, the first free port from the range is selected and associated (bound) with the corresponding socket. If no free port is found, the request is aborted.

The default value is OFF, indicating that the operating system will select a free port from the pool and bind the socket implicitly during the connect processing. start-port-number and end-port-number are positive numbers between 1 and 65535. start-port-number must be lower than or equal to end-port-number.

QUIesce

For connect-type terminals, disallows new connection requests for the named physical terminal. However, the current terminal session is permitted to continue until the BYE task is invoked.

TARget ADDress target-ip-address

Specifies the IP address of the target system enclosed in single quotes. The IP address limit depends on whether IPv4 or IPv6 is used: IPv4 is 15 characters; IPv6 is 45 characters.

TARget NAMe target-host-name

Specifies the host name of the target system. The maximum host name length is 64 characters.

TARget PORt target-port-identifier

Specifies the number of the target port or a service name. If target-port-identifier is a is a port number, it must be a positive number between 1 and 65535. If target-port-identifier is a service name, it is limited to 32 characters and must be the name of a service in the services file with an associated protocol of TCP.

TASK task-code

Name of the task code to invoke when a connection request arrives.

TCP/IP

Assigns a specific TCP/IP stack affinity to the corresponding listener program.

Note: Assigning stack affinity is most appropriate when multipleTCP/IP stacks are implemented in the environment.

Valid options are:

STACK stack-ip-name

The job name of the TCP/IP stack. The name is limited to 8 characters.

Specifying *ALL on a multi-homed system (z/OS only) causes listening to all active TCP/IP stacks. Specifying *DEFAULT causes listening to the default TCP/IP stack.

ADDRess stack-ip-address

IP address of the host. The limit of an IP address depends on whether IPv4 or IPv6 is used: the limit in IPv4 is 15 characters; in IPv6 it is 45 characters. The stack-ip-address value must be enclosed in single quotes.

NAMe stack-host-name

Name of the host. The maximum length of the host name is 64 characters. The stack-host-name value must be enclosed in single quotes.

Values starting with an asterisk (*) can be used to remove any TCP/IP stack affinity.

TRAce

Activates the trace facility. Valid options are:

GOODio

Instructs DC/UCF to take a snap dump following the completion of successful I/O operations.

BADio

Instructs DC/UCF to take a snap dump following the completion of unsuccessful I/O operations.

ALLio

Instructs DC/UCF to take a snap dump following all I/O operations.

trace-options-byte

An unquoted two-digit hexadecimal value that activates physical I/O tracing. This value specifies memory areas for the physical terminal to be included in the dump. See the table provided in Usage for information on specifying the trace options byte.

The trace-options-byte value is stored in the PTE. One trace options byte is stored for each type of I/O operation (GOODIO, BADIO, ALLIO). A different memory area can be snapped for each I/O operation.

OFF

Deactivates physical I/O tracing. This specification sets the appropriate trace option bits in the PTE to 0 (zero).

WEIGHT weight-factor

For DDS lines, specifies the weight factor for the line.

Note: Changing the weight factor dynamically is supported but does notaffect processing, which is determined by the initial weight factor established by system generation.