Compaq TCP/IP Services for OpenVMS
Management Command Reference

SET CONFIGURATION SNMP

Configures SNMP on an individual host.
SET CONFIGURATION NOSNMP does not require any qualifiers.
After making changes to the SNMP configuration, shut down and restart the master agent and any subagents. Issue the following commands:
$ @SYS$STARTUP:TCPIP$SNMP_SHUTDOWN $ @SYS$STARTUP:TCPIP$SNMP_STARTUP
Related command: SHOW CONFIGURATION SNMP

Format

SET CONFIGURATION [NO]SNMP [ /[NO]ADDRESS=host ]
[ /[NO]COMMUNITY="name" ]
[ /[NO]CONFIRM ]
[ /CONTACT=name ]
[ /FLAGS=options]
[ /LOCATION=options ]
[ /TYPE=options ]

restrictions

Requires SYSPRV or BYPASS privilege.
If you add a new community and do not specify the /TYPE qualifier, the value of /TYPE defaults to read only.
If you add a new community and do not specify the /ADDRESS qualifier, the default address is 0.0.0.0.

Qualifiers

/ADDRESS=(IP_address)

/NOADDRESS=(IP_address)
Optional. Default: 0.0.0.0
Specifies hosts that belong to a particular community. You can specify multiple addresses.
This qualifier is meaningful only if you include the /COMMUNITY qualifier. A remote host cannot access information from this host unless its address appears in one or more communities of type READ or WRITE. For communities of type TRAP, the addresses specify the hosts that receive trap messages. For more information, see the /TYPE qualifier.
If you add a new community and do not specify this qualifier, the new entry's address is 0.0.0.0.
If you use the /ADDRESS qualifier with a community that already exists, these addresses are added to the existing address list.
/NOADDRESS deletes addresses from an existing list. If the deleted address is the only address listed for the community name, this qualifier also deletes the community.
/COMMUNITY="name"

/NOCOMMUNITY="name"
Optional. Default: To enable the standard "public" community, you can run the TCPIP$CONFIG procedure.
Used with the /ADDRESS qualifier. Name of the community that the SNMP agent recognizes. Optionally, specify a type of access and a list of host addresses. Enclose the name in quotation marks to preserve lowercase characters. See the /TYPE and /ADDRESS qualifiers for more information.
[NO]COMMUNITY="name" removes a community name.
/CONFIRM

/NOCONFIRM
Optional. Default: /CONFIRM with wildcards; otherwise, /NOCONFIRM
When you delete communities (with the /NOCOMMUNITY qualifier), first asks for your confirmation.
/CONTACT=name
Optional. Default: None.
Name of the system administrator (or other contact person) of the host on which the SNMP agent runs. The name field has a maximum length of 235.
/FLAGS=options
Optional.
The options include:

SETS
Lets the master agent process SET commands from SNMP clients.
AUTHEN_TRAPS
Lets the master agent send trap messages in response to unauthorized community strings from SNMP clients.

/LOCATION=options
Optional. Default: None.
Location of the system on which the SNMP agent runs. Maximum total length is 215 characters.
The options include:

[NO]FIRST=text
Specifies the first part of the location. Maximum length of text is 200 characters.
[NO]SECOND=text
Specifies the last part of the location. Maximum length of text is 200 characters.

If you specify two options, they are appended when sent to a client in response to an SNMP request for syslocation . For example, if FIRST is abc and SECOND is def, the value of the location is abcdef with no spaces. The total number of characters must not exceed 215.

/TYPE= {[NO]READ | [NO]TRAP | [NO]WRITE}
Optional. Default: READ.
Sets the type of access (to your local MIB data) to allow for a specified community.

Type READ allows the master agent to accept GET, GETNEXT, and GETBULK commands from clients (management stations).
Type TRAP allows the local master agent to issue traps to members of a specified community. Members of a trap community receive SNMP Trap-PDUs for significant events, including coldStart traps when the agent is initialized, and authenticationFailure traps when the agent receives an SNMP request that specifies an unauthorized community string.
Type WRITE allows the master agent to accept SET commands from clients (management stations).

READ access is present by default when specifying TRAP or WRITE. Also, you can remove the read access without affecting the way the agent responds to a read request. For example:
$ SET CONFIGURATION SNMP /COMMUNITY="name" /TYPE=NOREAD

Examples

#1
TCPIP> SET CONFIGURATION SNMP /COMMUNITY="public" - _TCPIP> /CONTACT="Sam Spade" - _TCPIP> /LOCATION=(FIRST="Falcon Building",SECOND="Los Angeles, California")

Configures SNMP with the standard public community, taking the default type (READ) and address (0.0.0.0) for that community. Both contact and location are specified.
The first and second parts of the location text are concatenated when displayed by an SNMP client. For example:
Falcon BuildingLos Angeles, California
If no update to the location text is done by an SNMP client, the display produced by SHOW CONFIGURATION SNMP is as follows:
Location First: Falcon Building Second: Los Angeles, California
If the text is updated by an SNMP client (for example, to change "Falcon" to "Falconi"), the original formatting is not preserved and the display produced by SHOW CONFIGURATION SNMP is as follows:
Location First: Falconi BuildingLos Angeles, California

#2
TCPIP> SET CONFIGURATION SNMP /COMMUNITY="rw" /TYPE=WRITE - _TCPIP /ADDRESS=136.20.100.10 /FLAGS=SETS

Configures a community with only read/write access to the host with the address specified. Other hosts still have read access through the public community. Also sets the SETS flag to enable the SNMP agents to process write requests from SNMP clients on host 136.20.100.10.

#3
TCPIP> SET CONFIGURATION SNMP /NOCOMMUNITY="rw"

Removes the rw (read/write) community (set in example 2.)

#4
TCPIP> SET CONFIGURATION SNMP /COMMUNITY="trapit" /TYPE=TRAP - _TCPIP> /ADDRESS=136.20.0.10

Configures SNMP so that agents can send trap messages to the well-known UDP port 162 on the host identified with the address 136.20.0.10.

#5
TCPIP> SET CONFIGURATION SNMP /FLAGS=AUTHEN_TRAPS - _TCPIP> /COMMUNITY="trapit2" /TYPE=TRAP - _TCPIP> /ADDRESS=(136.20.0.12,136.20.0.15)

Configures SNMP with the AUTHEN_TRAPS flag so that the master agent sends trap messages when it detects a client request containing an invalid community name. Also configures an additional trap community. Trap messages, including authentication traps, go to all three addresses specified in the trap communities configured in this example and in example 4.

#6
TCPIP> SET CONFIGURATION SNMP /COMMUNITY="rw2" /TYPE=WRITE - _TCPIP> /ADDRESS=(136.20.0.15,136.20.0.100)

Configures community rw2 , which gives read/write access to two hosts. Note that one address can appear for more than one community, although a given address cannot be specified more than once for a single community.

SET CONFIGURATION START ROUTING

Enters information into the configuration database to start dynamic routing when TCP/IP Services starts.
Related commands: SHOW CONFIGURATION START ROUTING, START ROUTING

Format

SET CONFIGURATION START [NO]ROUTING [ /GATED ]
[ /LOG ]
[ /SUPPLY[=DEFAULT] ]

Qualifiers

/GATED
Optional.
Enables the gateway routing daemon (GATED).
If you enable dynamic GATED routing, you will be able to configure this host to use any combination of the following routing protocols to exchange dynamic routing information with other hosts on the network:

RIP (Routing Information Protocol), Versions 1 and 2
RDISC (Router Discovery Protocol)
OSPF (Open Shortest Path First)
EGP (Exterior Gateway Protocol)
BGP (Border Gateway Protocol), BGP-4
Static routes

/LOG
Optional. Default: No logging.
Applies to ROUTED. Do not use with /GATED.
Logs routing activity to
SYS$SYSDEVICE:[TCPIP$ROUTED]TCPIP$ROUTED.LOG.
/SUPPLY[=DEFAULT]
Optional. Applies only to ROUTED. Do not use with /GATED.
Broadcasts routing information to other hosts in 30-second intervals.
If you specify /SUPPLY=DEFAULT, the local host supplies the default network route.

Examples

#1
TCPIP> SET CONFIGURATION START ROUTING /SUPPLY

Starts ROUTED dynamic routing when TCP/IP Services is started. The local host both broadcasts and receives network routing information.

SET GATED

Configures the Gateway Routing Daemon (GATED). GATED obtains information from several routing protocols and selects the best routes based on that information. These protocols are configured in the file TCPIP$GATED.CONF.
Related commands: START ROUTING /GATED, STOP ROUTING /GATED

Format

SET GATED [ /CHECK_INTERFACES ]
[ /FILE=file ]
[ /SAVE_STATE ]
[ /TOGGLE_TRACE ]

Qualifiers

/CHECK_INTERFACES
Optional.
Instructs GATED to scan the kernel interface list for changes.
/FILE=file
Optional.
Specifies the name of the GATED configuration file. Use with the /SAVE_STATE qualifier.
/SAVE_STATE
Optional.
Causes GATED to save the current state of all tasks, timers, protocols, and tables to the file SYS$SYSDEVICE:[TCPIP$GATED]TCPIP$GATED.DMP (default).
Use the /FILE qualifier to specify a file name other than the default.
/TOGGLE_TRACE
Optional.
Use to close the trace file. A subsequent set GATED /TOGGLE_TRACE command reopens the trace file. This allows the file to be copied regularly. Valid only when a trace file is specified in the GATED configuration file.

Examples

#1
TCPIP> SET GATED /SAVE_STATE

This example causes GATED to save its current state to the file SYS$SYSDEVICE:[TCPIP$GATED]TCPIP$GATED.DMP.

#2
TCPIP> SET GATED /SAVE_STATE /FILE=STATE.DMP

This example causes GATED to save its current state to the file named STATE.DMP.

SET HOST

Defines or deletes an entry in the hosts database.
Equivalent to maintaining the /etc/hosts file on UNIX hosts.
Related command: SHOW HOST, CONVERT/VMS HOST

Format

SET [NO]HOST host /ADDRESS=IP_address
[ /[NO]ALIAS=alias ]
[ /[NO]CONFIRM ]

restrictions

Requires read, write, and delete access to the hosts database.

Parameters

host
Required.
Name of a host that is a source or destination of internet communications.

Note
To define a name in lowercase or mixed case, enclose it in quotation marks.

If you define a mixed-case name, also define an alias in either all uppercase or all lowercase characters.

You cannot delete a host by specifying its alias.

Qualifiers

/ADDRESS=IP_address
Required for SET HOST.
Host's IP address.
/ALIAS=alias

/NOALIAS=alias
Optional.
Add or remove an alternate name for a host.
Do not use with SET NOHOST.
/CONFIRM

NOCONFIRM
Optional. Default: /CONFIRM if you use a wildcard.
Used with the SET NOHOST command, prompts you to confirm the delete request. For example:
TCPIP> SET NOHOST MOA /ADDRESS=11.33.33.8 /CONFIRM LOCAL database Host address Host name 11.33.33.8 MOA Remove? [N]:

Examples

#1
TCPIP> SET HOST MOA /ADDRESS=11.33.33.8 - _TCPIP> /ALIAS=("moa","bigbrd","nofly")

Sets the IP address of host MOA to 11.33.33.8 and establishes moa, bigbrd, and nofly as aliases for host MOA.

#2
TCPIP> SET HOST MOA /ALIAS="MOA_2"

Establishes MOA_2 as an alias for host MOA.

#3
TCPIP> SET HOST MOA /ADDRESS = 128.33.33.9

Establishes a second IP address for host MOA.

#4
TCPIP> SET HOST MOA /ADDRESS = 128.33.33.9 /ALIAS="MOA_3"

Establishes MOA_3 as an alias for host MOA's second IP address 128.33.33.9.

#5
TCPIP> SET HOST MOA /NOALIAS="MOA_2"

Deletes MOA_2 as an alias for host MOA.

#6
TCPIP> SET NOHOST MOA /NOCONFIRM

Deletes MOA and all of its associated aliases.

SET INTERFACE

Defines one of the following:

An Internet interface
A serial line IP (SLIP) or point-to-point (PPP) connection
A pseudointerface (a data structure that extends subnet routing)

Before you issue SET INTERFACE, do the following to identify the name of an interface:

Issue the LIST COMMUNICATION_CONTROLLER command to find your system's controller.
Use the first character of the associated interface name.
See the Compaq TCP/IP Services for OpenVMS Management manual for more information about specifying an interface name.

SET NOINTERFACE deletes a record. No qualifiers are required.
Related commands: SHOW INTERFACE, SET CONFIGURATION INTERFACE

Format

SET [NO]INTERFACE interface
[ /[NO]ARP ]
[ /[NO]AUTO_START ]
[ /BROADCAST_MASK=IP_address ]
[ /C_BROADCAST_MASK=IP_address ]
[ /C_NETWORK=IP_address ]
[ /[NO]CLUSTER=host ]
[ /COMPRESS=options ]
[ /DESTINATION=IP_address ]
[ /DHCP ]
[ /FLOWCONTROL ]
[ /HOST=host ]
[ /[NO]LOOPBACK ]
[ /NETWORK_MASK=IP_address ]
[ /PRIMARY ]
[ /SERIAL_DEVICE=device ]

restrictions

Before you issue the SET INTERFACE command, disable the interface by using the SET NOINTERFACE command.
This command requires:

OPER privilege
Read access to the hosts database
Read access to the networks database
Read, write, and delete access to the routes database

Every host on the same network must have the same network mask.

Parameters

interface
Required.
Specifies an interface name for the communication controller, such as RF1, RT1, ZE0, XE0, SL0, SL1, SL2, PP0, PP1, PP2.

Qualifiers

/ARP

/NOARP
Optional. Default: /ARP.
Enables IP address-to-hardware address (Ethernet or FDDI) mapping.
/ARP is valid when you create an interface but not when you modify an existing interface.
/AUTO_START

/NOAUTO_START
Optional. Default: /AUTO_START.
Valid for a SLIP or PPP interface. Automatically creates the interface when TCP/IP Services starts.
/BROADCAST_MASK=IP_address
Optional.
Sets the Internet interface to receive all broadcast messages.
TCP/IP Services calculates the default by:

Using the network number from the network mask
Setting all bits in the host number field to 1

/C_BROADCAST_MASK=IP_address
Optional.
Sets the cluster broadcast mask to receive all broadcast messages.
The software calculates the default by:

Using the network number from the network mask
Setting all bits in the host number field to 1

/C_NETWORK=IP_address
Optional.
Sets the network mask of the cluster network. This mask is specific to the cluster host network.
The software calculates the default by:

Setting the bits representing the network fields to 1
Setting the bits representing the host field to 0

/CLUSTER=host

/NOCLUSTER
Optional. Default: None.
Specifies the cluster host name (alias host identifier).
Before using this qualifier, first define the same name in the hosts database.
/CLUSTER=host associates the alias host identifier with each interface in a cluster.
/NOCLUSTER disables internet cluster processing on the specified interface.

Caution
When you specify /NOCLUSTER, active communication is aborted for applications bound to the cluster alias name.

/COMPRESS= {ON | OFF | AUTOMATIC}
Optional. Default: For PPP interface: /COMPRESS=ON; for SLIP interface: /COMPRESS=OFF
Valid for SLIP and PPP interfaces.
Enables or disables TCP header compression.
/COMPRESS=AUTOMATIC turns off compression unless the remote end begins to use it.
/DESTINATION=IP_address
Optional.
Valid for a PPP interface.
Used on the local host to provide dialup access to remote systems. The value specified is the IP address to be given to remote clients for use while PPP connection is active. If you use /DESTINATION, you must provide the address of the local host with the /HOST qualifier.
/DHCP
Optional.
Designates the interface as a DHCP-controlled interface in the volatile database. This qualifier affects only the currently running interface.
Before you enter the SET INTERFACE command, be sure to enter the SET NOINTERFACE command first and specify the interface you are changing.
/FLOWCONTROL
Optional. Default: No flow control.
Valid for a SLIP interface. Enables the handling of XON and XOFF characters to properly interoperate with modems that are configured to interpret these characters locally.
Specify /FLOWCONTROL only if the host at the other end of the line is another host running TCP/IP Services.
/HOST=host
Required when first setting the interface; optional if the interface is already defined. Always required for a SLIP interface. Optional for a PPP interface unless you are setting up the local host as a dialup provider by using the /DESTINATION qualifier.
Local host name or IP address using the interface. If this information is not specified for a PPP interface, PPP obtains the correct address from the remote host.
If your host is multihomed, specify an address.
/LOOPBACK

/NOLOOPBACK
Optional. Default: /NOLOOPBACK.
Sets loopback mode.
/NETWORK_MASK=IP_address
Required if you use subnets.
The part of the host field of the IP address identified as the subnet.
The software calculates the default by:

Setting the bits representing the network fields to 1
Setting the bits representing the host field to 0

An IP address consists of a network number and a host number. You can also divide the host field into a site-specific subnetwork and host field.
/PRIMARY
Optional.
For DHCP-controlled interfaces, designates the interface from which system-wide configuration options (such as the IP address of the BIND server) are used.
/SERIAL_DEVICE=device
Required for SLIP and PPP interfaces; otherwise not used.
Identifies the OpenVMS terminal device used as a serial device. Specify an arbitrary terminal device name. (Unlike Ethernet, FDDI, and Token Ring interface names, a serial interface name is not related to the OpenVMS device name.)

Examples

#1
TCPIP> SET INTERFACE SL5 /HOST=LARK /NETWORK_MASK=255.255.255.0 - _TCPIP> /SERIAL_DEVICE=TTA3: /COMPRESS=ON /FLOWCONTROL

Configures SLIP interface SL5, using the local IP address assigned to host LARK, with a subnet mask of 255.255.255.0.
The interface uses the terminal device TTA3:.
The /COMPRESS qualifier enables TCP header compression (CSLIP).
The /FLOWCONTROL qualifier enables special handling of XON and XOFF characters, to ensure proper interoperation with modems that are configured to interpret these characters locally.

#2
TCPIP> SET INTERFACE FF0 /HOST=KESTREL /NETWORK_MASK=255.255.0.0 - _TCPIP> /BROADCAST_MASK=128.30.255.255 /ARP

For new interface FF0 on host KESTREL, sets the network mask to 255.255.0.0, sets the broadcast mask to 128.30.0.0, enables ARP, and activates the interface.

#3
TCPIP> SET INTERFACE PP0 /SERIAL_DEVICE=TTA0: - _TCPIP> /HOST=10.10.1.2 /DESTINATION=10.10.1.3

Configures the interface as a PPP serial device. This command specifies that the local host is a dialup provider. The address specified with the /DESTINATION qualifier (10.10.1.3) is the address assigned to the client system requesting an address.
See Compaq TCP/IP Services for OpenVMS Management manual for more information on setting up interfaces for SLIP and PPP communication.

#4
TCPIP> SET NOINTERFACE DE2 TCPIP> SET INTERFACE DE2 /LOOPBACK . . . TCPIP> SET INTERFACE DE2

Deletes interface DE2, sets loopback mode for testing this interface, and, after testing, reactivates it.

Contents

Index

Compaq TCP/IP Services for OpenVMSManagement Command Reference

SET CONFIGURATION SNMP

Format

restrictions

Qualifiers

/ADDRESS=(IP_address)

/NOADDRESS=(IP_address)

/COMMUNITY="name"

/NOCOMMUNITY="name"

/CONFIRM

/NOCONFIRM

/CONTACT=name

/FLAGS=options

/LOCATION=options

/TYPE= {[NO]READ | [NO]TRAP | [NO]WRITE}

Examples

SET CONFIGURATION START ROUTING

Format

Qualifiers

/GATED

/LOG

/SUPPLY[=DEFAULT]

Examples

SET GATED

Format

Qualifiers

/CHECK_INTERFACES

/FILE=file

/SAVE_STATE

/TOGGLE_TRACE

Examples

SET HOST

Format

restrictions

Parameters

host

Qualifiers

/ADDRESS=IP_address

/ALIAS=alias

/NOALIAS=alias

/CONFIRM

NOCONFIRM

Examples

SET INTERFACE

Format

restrictions

Parameters

interface

Qualifiers

/ARP

/NOARP

/AUTO_START

/NOAUTO_START

/BROADCAST_MASK=IP_address

/C_BROADCAST_MASK=IP_address

/C_NETWORK=IP_address

/CLUSTER=host

/NOCLUSTER

/COMPRESS= {ON | OFF | AUTOMATIC}

/DESTINATION=IP_address

/DHCP

/FLOWCONTROL

/HOST=host

/LOOPBACK

/NOLOOPBACK

/NETWORK_MASK=IP_address

/PRIMARY

/SERIAL_DEVICE=device

Examples

Compaq TCP/IP Services for OpenVMS
Management Command Reference