DIGITAL TCP/IP Services for OpenVMS
Management Command Reference


Previous Contents Index


SET ROUTE

Defines a routing path in either the permanent or volatile routes database.

Routes in the permanent, on-disk routes database are static. Static routes can be supplemented by routes that the dynamic routing server receives. Defaults are as follows:

When you issue SET NOROUTE, you are running dynamic routing. You have the following restrictions:

Related commands: SHOW ROUTE, STOP ROUTING

Note

Compaq strongly recommends that you do not specify alias names with the destination parameter or the /GATEWAY=host qualifier.

Format

SET [NO]ROUTE destination
{ /[NO]CONFIRM
/DEFAULT_ROUTE
/GATEWAY=host
/MASK=mask_length
/NETWORK
/PERMANENT }

restrictions

Requires OPER privileges if:

Parameters

destination

Required unless you specify /DEFAULT_ROUTE.

Host or network through which to route packets. Specify one:

Not valid with /ADDRESS or /DEFAULT_ROUTE.


Qualifiers

/CONFIRM

NOCONFIRM

Optional. Default: /CONFIRM if you use a wildcard.

Prompts you to confirm the change.

/DEFAULT_ROUTE

Optional. Default: 0.0.0.0.

Defines a second route to use if the first try to route a packet fails.

You must also specify a value for /GATEWAY.

Not valid with the destination parameter.

/GATEWAY=host

Optional. Default: None.

Gateway for the route. Necessary to send packets to a host on another network.

/MASK=mask_length

Optional. Default: None.

Defines the Classless Inter-Domain Routing (CIDR) mask length. (The mask length is sometimes referred to as the prefix length.)

CIDR is a method of associating blocks of Internet addresses through the use of mask. With CIDR, a route is a combination of IP address and a value describing the length of the leftmost contiguous set of bits.

/NETWORK

Optional. Defaults:

Defines the route as a network route.

Required when you also specify /ADDRESS and the route is a network route.

Use this qualifier if the network number could be misinterpreted as an IP host address, for example, if a network mask is nonstandard or the IP address is abbreviated.

/PERMANENT

Optional. Defaults:

If the network is not active, the permanent routes database is changed. If the network is active, the volatile routes database is changed.

Changes only the permanent routes database.


Examples

#1

TCPIP> SET ROUTE DODO /GATEWAY=RHEA   
      

Defines a route for local host DODO to send packets.

#2

TCPIP> SET ROUTE 101.81 /GATEWAY=100.42   
      

Defines a gateway for routing packets for the host with IP address 101.81.

#3

TCPIP> SET ROUTE 100.45.0 /GATEWAY=REMOTE /NETWORK   
      

Sets a route through the network whose IP address is 100.45.0.

#4

TCPIP> SET ROUTE /DEFAULT /GATEWAY=DEFGATE /PERMANENT   
      

Sets a default route with host DEFGATE as the default gateway. Adds the definition to the permanent routes database.


SET SERVICE

Defines a new entry in the services database or modifies an existing entry.

Related command: SHOW SERVICE


Format

SET [NO]SERVICE service*
{ /FILE=startup_file*
/PORT=n*
/PROCESS_NAME=process*
/USER_NAME=vms_user_account* }
[ /ACCEPT=options ]
[ /ADDRESS=IP_address ]
[ /FLAGS=options ]
[ /INACTIVITY_TIMER=n ]
[ /LIMIT=n ]
[ /LOG_OPTIONS=options ]
[ /PROTOCOL=protocol=options ]
[ /REJECT=options ]
[ /RPC=values ]
[ /SEPARATOR=option ]
[ /SOCKET_OPTIONS=options ]

* Required for SET SERVICE; optional for SET NOSERVICE.

restrictions

You cannot modify the following fields in an existing entry:

To make changes to these fields, delete the record with SET NOSERVICE and then recreate it.

Note

There is no RCP service. RCP uses the RSH server process.

Compaq strongly suggests that, for the serivces provided by DIGITAL TCP/IP Services for OpenVMS product, you do not use this command to reset:

SET NOSERVICE without a specified service or specified qualifiers deletes all entries for all services.

Requires write access to the directory with the services database.


Parameters

service

Required.

Service you want to enter into the services database. Specify a string of up to 10 characters.


Qualifiers

/ACCEPT {=[NO]HOSTS=(hosts) | =[NO]NETWORKS=(networks)}

Optional. Default: Offers the service to all hosts on all networks.

You can use wildcards. The following options are available:
Option Meaning
HOSTS= hosts Makes the service available to the specified hosts.
Denies to all other hosts access to the service.

Maximum is 32.

Example:

/ACCEPT=HOSTS=(
host1_name,
host2_name,
host3_address)

NOHOSTS= hosts Removes the specified hosts from the accept list so they cannot gain access to the service.

Maximum is 32.

Example:

/ACCEPT=NOHOSTS=(
host1_name,
host2_name,
host3_address)

NETWORKS= networks Makes the service available to the specified networks. Denies access to the service to all other networks.

Maximum is 16.

For each network, you can optionally specify the network mask. The default network mask equals network's class number. For example, for the network 11.200.0.0., the default mask is 255.0.0.0.

Example:

/ACCEPT=NETWORKS=(
net1_name,
net2_address,
net3:
net3mask)

NONETWORKS[= networks] Removes the specified networks from the accept list so they cannot gain access to the service.

Maximum is 16.

For each network, you can optionally specify the network mask. The default net mask equals network's class number. For example, for network 11.200.0.0., the default mask is 255.0.0.0.

Example:

/ACCEPT=NONETWORKS=(
net1_name,
net2_address ,
net3:
net3mask)

/ADDRESS=IP_address

Optional. Default: 0.0.0.0 (all local interfaces receive incoming requests for the service).

If you have multiple internet interfaces and, therefore, more than one IP address, /ADDRESS specifies the particular address on which incoming requests are received.

To define a service name more than once, use /ADDRESS with different values for each instance. A reason to duplicate a service name, for example, is that your local host has three interfaces, and you want to make a service available on two of them. Each service-interface pair must be unique.

/FILE=startup_file

Required.

Name of the service's startup command file.

/FLAGS= {[NO]APPLICATION_PROXY | [NO]MULTITHREAD | [NO]PROXY | [NO]CASE_INSENSITIVE}

Optional.

The flag options are:

/INACTIVITY_TIMER=n

Optional.

Number of minutes that the service can be idle, at which time it is terminated.

Valid for services not marked as LISTEN.

/LIMIT=n

Optional.

Maximum number of copies of the requested service allowed to run on the system. If the maximum number is reached, any additional requests for the service are rejected.

/LOG_OPTIONS=
([FILE=file], [ [NO]ACCEPT ] [ [NO]ACTIVATE ] [ [NO]ADDRESS ] [ [NO]ALL ] [ [NO]CONNECT ] [ [NO]DEACTIVATE ] [ [NO]ERROR ] [ [NO]EXIT_CLEANUP ] [ [NO]LOGIN ] [ [NO]LOGOUT ] [ [NO]MODIFY ] [ [NO]REJECT ] [ [NO]TIMEOUT ] )

Optional.

The options have the following meanings:
Option Function
[NO]ACCEPT Message is logged when a request is accepted.
[NO]ACTIVATE Message is logged when the service is activated.
[NO]ADDRESS For auxiliary server messages and OpenVMS security events, the message displays the IP address as a host name. If host names are not relevant, Compaq recommends that you specify [NO]ADDRESS.
[NO]ALL Messages are logged for all events.
[NO]CONNECT Message is logged when the auxiliary server issues a connect request back to the client. The services that usually make this request (on a second socket) are Remote Shell and Remote Execute.
[NO]DEACTIVATE Message is logged when the service is being deactivated.
[NO]ERROR Message is logged when an error is detected while processing a request to the service.
[NO]EXIT_CLEANUP Message is logged when the service fails to complete all the steps required for its startup.
  • For services not marked as LISTEN, the service did not accept the connection request (issue a TCP accept or a UDP receive).
  • For services marked LISTEN, the server did not assign the BG device, with logical name SYS$NET, or did not issue a C socket before exiting.
[NO]LOGIN Message is logged when a connected terminal server accepts a Remote Login request.
[NO]LOGOUT Message is logged when a connected terminal server terminates a connection.
[NO]MODIFY Message is logged when the active service is being modified.
[NO]REJECT Message is logged when a request is rejected.
[NO]TIMEOUT Message is logged when the service times out. For services not marked as LISTEN.

/PORT=n

Required.

Port number that the service will use. Specify a number from 1 to 65535.

/PROCESS_NAME=process

Required.

Name of the service's process.

Specify a character string up to 15 characters long, truncated to 15 bytes, if necessary.

/PROTOCOL=protocol [=options]

Optional. Default: TCP.

Protocol, and its parameters, that the service will use. To set these parameters, use the following options.

Protocol Option Meaning
IP TYPE_OF_SERVICE= n Type of service, expressed as a value between 0 and 255.
  TIME_TO_LIVE= n Maximum number of hops that packets can traverse before being dropped.
TCP
(Stream
socket
type)
[NO]DELAY_ACK Delays the sending of acknowledge (ACK) packets.
Default: DELAY.
  DROP_COUNT= seconds TCP connection-request timeout interval for the service.

(Maximum number of seconds to probe for idle TCP connections before such a connection times out and closes.)
  PROBE_TIMER= seconds Number of seconds between probes for idle connections.
UDP None Datagram socket type

/REJECT =
{ [NO]HOSTS=(hosts ) [NO]NETWORKS=(networks ) } [ [NO]MESSAGE="text"]

Optional. Default: No rejections if /ACCEPT is set to its default (service all hosts).
Option Meaning
HOSTS= hosts Makes the service unavailable to the specified hosts.

Maximum is 32.

Examples:

/REJECT=HOSTS=( host1_name, host2_name, host3_address)

/REJECT=HOSTS=*

NOHOSTS= hosts Removes the specified hosts from the reject list.

Maximum is 32.

Examples:

/REJECT=NOHOSTS=( host1_name, host2_name, host3_address)

/REJECT=NOHOSTS=*

NETWORKS= networks Makes the service unavailable to the hosts on the specified networks.

Maximum is 16.

For each network, you can optionally specify the network mask. The default net mask equals network's class number. For example, for network 11.200.0.0., the default mask is 255.0.0.0.

Example:

/REJECT=NETWORKS=( net1_name, net2_address, net3: net3mask)

NONETWORKS[= networks] Removes the specified networks from the reject list.

Maximum is 16.

For each network, you can optionally specify the network mask. The default net mask equals network's class number. For example, for network 11.200.0.0., the default mask is 255.0.0.0.

Example:

/REJECT=NONETWORKS=( net1_name, net2_address, net3: net3mask)

[NO]MESSAGE= text
NOMESSAGE
Message sent to "reject-list" clients when DIGITAL TCP/IP Services for OpenVMS rejects their request for the service.

Optional.
Specify a character string up to 63 characters.
Enclose the string in quotation marks.
Use this option only for a service whose clients require and support reject messages.

Messages are sent with a carriage return/line feed at the end.

For RLOGIN, RSH, and REXEC, this message is preceded by a byte with a value of 1 and terminated with a byte with a value of 0.

/REJECT=NOMESSAGE deletes the stored message text.

/RPC=(PROGRAM_NUMBER=n, VERSION_NUMBER=(LOW=n, HIGH=n))

Required for services that use the Portmapper; otherwise, not valid. Defaults:

Information that identifies the service to the Portmapper. Use this qualifier for all applications that use RPCs.

/SEPARATOR=option=character

Optional. Default: 0 (null).

Character that separates the following fields in received packets:

/SOCKET_OPTIONS=(options)

Optional.

The following socket options are available.
Option Description Default
BROADCAST

NOBROADCAST
Sockets are UDP broadcast.
Sockets are not UDP broadcast.
Null character (hexadecimal 00)
KEEPALIVE

NOKEEPALIVE
Sockets are TCP keepalive.
Sockets are not TCP keepalive.
Null character (hexadecimal 00)
RECEIVE Receive socket quota. Null character (hexadecimal 00)
SEND Send socket quota. Null character (hexadecimal 00)

/USER_NAME=vms_user_account

Required.

OpenVMS account information for users working on client systems. Required for a user to access the DIGITAL TCP/IP Services for OpenVMS service.

The user must also be defined in the system user authorization file (SYSUAF.DAT).


Examples

#1

TCPIP> SET SERVICE TOE /USER_NAME=LITTLE_PIGGY -   
_TCPIP /PROCESS_NAME=TOEd /PORT=1050 /PROTOCOL=UDP -   
_TCPIP /FILE=SYS$COMMON:[SYSMGR]TOE_STARTUP.COM   
  
      

Defines the service TOE, which implements UDP on port 1050. This service has the OpenVMS process context of user LITTLE_PIGGY.

After you issue an ENABLE SERVICE TOE command, the auxiliary server executes TOE_STARTUP.COM when a request comes in for service TOE.

#2

TCPIP> SET SERVICE LPD -   
_TCPIP> /REJECT=NETWORK=(11.30.0.0:255.255.0.0, 11.40.0.0)   
  
      

Sets the LPD service to be inaccessible to the two specified networks.

#3

TCPIP> SET SERVICE FTP -   
_TCPIP> /LOG_OPTIONS=(FILE=SYS$SYSDEVICE:[TCPIP$FTP]MY_FTPD_LOG.LOG, NOACCEPT,CONNECT)   
  
      

For the FTP service:

#4

TCPIP> SET SERVICE RSH /FLAGS=(PROXY,CASE_INSENSITIVE)   
      

Sets the proxy and case-sensitivity flags for the RSH service.


Previous Next Contents Index