The command line interface can be used to configure global settings, allowing you to set default and alternate hosts, set gateways and metrics, set the name service used by the PortMaster, and set the administrative password of the PortMaster.

Displaying Global Information

• show all-see page 2-21

• show global-see page 2-27

  For general information about using the command line interface, refer to Chapter 1, "Introduction."

Summary of Global Commands

Global Commands

set assigned_address

This command sets the base IP address of the assigned address pool.

set assigned_address Ipaddress

Ipaddress

Base IP address assigned. Set Ipaddress to 0.0.0.0 to deselect the assigned address.

Usage

Note ¯ You must use the command save all and reboot the PortMaster after setting or changing the base IP address.

Example

See Also

set user destination - page 13-6

set call-check

This command provides the choice of supporting or disabling the call-check feature on PortMaster products that support ISDN PRI or in-band signaling.

set call-check on|off

on	Enables the call-check feature on the PortMaster connected to the PRI or in-band signaling interface.
off	Disables the call-check feature. This is the default.

Caution ¯ To support the call-check feature, you must configure RADIUS Call-Check-User entries; otherwise, the PortMaster issues a busy signal to every call.

For more information about enabling RADIUS call-check features, refer to ComOS 3.8 Release Notes.

Usage

If the call-check feature is set to on, the PortMaster sends a ringing message to the switch while the service information is being looked up in RADIUS.

RADIUS either rejects the message with a busy signal, acknowledges the call and allows the call to be completed with no special service type determined during the call, or, allows the creation of a netdata clear channel TCP connection to the destination specified in the RADIUS accept record.

Example

Call Check changed from off to on

Command> show global

Alt. Acct. Server: 0.0.0.0

PPP Authentication: PAP: on CHAP: off

ISDN Switch Type: (Call Check Enabled)

End Point Disc: None

set chap

This command provides the choice of supporting or disabling the Challenge Handshake Authentication Protocol (CHAP) authentication for dial-in users.

set chap on|off

on	If PPP is detected on a port, the PortMaster prompts the user to authenticate with CHAP. This is the default.
off	CHAP authentication is disabled.

Usage

Example

See Also

set pap - page 3-15

show global - page 2-27

set dhcp-server

This command configures a PortMaster to forward a Dynamic Host Configuration Protocol (DHCP) request from a dial-in client of a cable modem to be forwarded to the specified DHCP server.

set dhcp-server Ipaddress

Ipaddress

IP address or 39-character hostname.

Usage

ComOS modifies the received DHCP request by removing the broadcast address and replacing it with the DHCP server's address. This enables the DHCP server to direct the response to the dial-in client of the cable modem. The DHCP server sends configuration information to the dial-in client of the cable modem to be used to configure the cable interface.

ComOS does not add routes to its table when forwarding or returning DHCP requests. It transparently forwards and returns DHCP requests from dial-in clients to the specified server.

For more information about using this command, refer to the PortMaster Configuration Guide.

To view DHCP relaying information, use the command set console, followed by the command set debug 0x81.

To disable DHCP reply information, set the IP address to 0.0.0.0.

Note ¯ This command does not support DHCP requests from the Ethernet or requests from a PortMaster 2Ei or Office Router OR-U.

Note ¯ The PortMaster router does not allow for the forwarding of a packet to the broadcast address 255.255.255.255.

See Also

set debug Hex - page 17-5

set domain

This command sets the domain name to use with hostname lookups.

set domain String|none

String	Domain name. Maximum of 31 characters.
none	Disables the domain feature.

Usage

Example

See Also

set nameserver - page 3-12

set ipx

This command enables or disables PortMaster support for the Novell Internet Packet Exchange (IPX) protocol.

set ipx on|off

on	Enables support for the IPX protocol.
off	Disables support for the IPX protocol. This is the default.

Usage

Example

See Also

set Ether0 ipxnet - page 4-8

set location ipxnet - page 14-14

set S0 ipxnet - page 5-26

set W1 ipxnet - page 6-14

show modules - page 2-31

set ipxgateway

This command sets a static default route for all IPX packets not routed by a more specific route.

set ipxgateway Network|Node Metric

Network	32-bit hexadecimal address of the IPX network of the gateway router.
Node	48-bit hexadecimal node address of the gateway router. This is usually the MAC address of the gateway router.
Metric	An integer with a value between 1 and 15 that determines the hop count.

Usage

Example

IPX Gateway set to tyche:010101010101, metric = 1

Command> set ipxgateway 00000000:000000000000

IPX gateway reset

set loghost

This command sets the IP address or name of the host to which the PortMaster sends syslog messages.

set loghost Ipaddress

Ipaddress

Loghost IP address or 39-character hostname. Set Ipaddress to 0.0.0.0 to deselect the host.

Usage

• Facility-auth

• Priority-info

  Setting the IP address to 0.0.0.0 disables syslog at the PortMaster.

  Note ¯ You must use the command save all and reboot PortMaster after making changes to the loghost address. You can also use the reset nHandle command to reset the UDP port 514 connection.

  RADIUS accounting provides a more complete method for logging usage information. Refer to the RADIUS Administrator's Guide for more information.

  Note ¯ Do not use a loghost at a location configured for on-demand connections, because doing so will keep the connection up or bring up the connection each time a syslog message is queued for the syslog host.

Example

See Also

set maximum pmconsole

This command sets the maximum number of concurrent connections for management applications allowed into the PortMaster.

set maximum pmconsole Number

Number

The maximum number of concurrent connections to allow. Default is 1; maximum is 10.

Usage

If you use ChoiceNet to download filters dynamically, the maximum number of connections should be set to 10.

Note ¯ If two or more GUIs are used to configure the PortMaster at the same time, each might not see the change made by the others.

All 1643 network connections must disconnect from the PortMaster for the new settings to take effect. Use the reset nHandle command to reset network handles. To view open network connections, use the show netconns command.

Example

See Also

set telnet - page 3-22

set nameserver

This command sets the name server IP address.

set nameserver [1|2] Ipaddress

1	Sets the primary name server. This is the default.
2	Sets an alternate name server.
Ipaddress	IP address. Set Ipaddress to 0.0.0.0 to deselect the name server.

Usage

Example

See Also

set namesvc - page 3-13

set namesvc

This command sets the service (NIS or DNS) used for resolving hostnames.

set namesvc dns|nis

dns	Uses the Domain Name System (DNS) for hostname lookups.
nis	Uses the Network Information Service (NIS) for hostname lookups.

Usage

Example

See Also

set nameserver - page 3-12

set netbios

This command sets the NetBIOS parameter for use with IPX.

set netbios on|off

on	The PortMaster broadcasts type 20 packets.
off	Type 20 packets are not broadcast across the router. The default is off.

Usage

Example

See Also

set pap

This command provides the choice of accepting either Password Authentication Protocol (PAP) or CHAP authentication for dial-in users, or CHAP only.

set pap on|off

on	If PPP is detected on a port, the PortMaster prompts the user to authenticate with PAP. If PAP is refused, the user is prompted to authenticate with CHAP. This is the default.
off	The PortMaster does not request or accept PAP authentication.

Usage

Example

See Also

show global - page 2-27

set password

This command sets the PortMaster administrative password.

set password [Password]

Password

String of up to 15 characters. Default is no password.

Usage

The password string cannot start with a question mark.

Example

set pool

This command explicitly sets the size of the assigned pool of IP addresses.

set pool Number

Number

The number of IP addresses to allocate to the pool. The valid range is from 0 to 64.

Usage

Example

See Also

set pots

This command enables or disables the analog PHONE port on the Office Router
OR-ST-AP and OR-U-AP.

set pots [on|off

on	Enables the analog PHONE port. This is the default.
off	Disables the analog PHONE port.

]

Usage

To display the status of the analog PHONE port, enter the command set pots with no parameters.

Example

Pots port disabled

Command> set pots on

Pots port enabled

set reported_ip

This command reports an IP address different from the Ether0 address used during PPP negotiation and Serial Line Internet Protocol (SLIP) startup.

set reported_ip Ipaddress

Ipaddress

IP address. Set Ipaddress to 0.0.0.0 to disable the command.

Usage

Setting Ipaddress to 0.0.0.0 cancels the setting.

Example

See Also

set user local-ip-address - page 13-14

set serial-admin

This command enables or disables administrative logins on the serial ports of the PortMaster.

set serial-admin on|off

on	Enables administrative logins on serial ports. This is the default.
off	Disables administrative logins on serial ports.

Usage

Example

set syslog

This command changes the syslog settings for logged events.

set syslog Logtype {[disabled] [Facility.Priority]}

Logtype	Sets logging for the following five areas. Use the following keywords:
	admin-logins	!root and administrative logins.
	user-logins	Nonadministrative logins. You might want to disable this type of logging if you already use RADIUS accounting.
	packet-filters	Packets that match filter rules with the log keyword.
	commands	Every command entered at the command line interface.
	termination	More detailed information on how user sessions terminate.
disabled	Turns off logging for the Logtype specified.
Facility.Priority	Sets the facility and priority to be assigned to syslog messages. See Table 3-2 on page 3-21 and Table 3-3 on page 3-21 for Facility and Priority keywords. Enter the Facility and Priority keywords separated by a period with no spaces.

Usage

syslog Facility Keywords

Facility	Facility Number	Facility	Facility Number
kern	0	cron	15
user	1	local0	16
mail	2	local1	17
daemon	3	local2	18
auth	4	local3	19
syslog	5	local4	20
lpr	6	local5	21
news	7	local6	22
uucp	8	local7	23

Priority	Priority Number	Typical Use
emerg	0	System is unusable.
alert	1	Action must be taken immediately.
crit	2	Critical messages.
err	3	Error messages.
warning	4	Warning messages.
notice	5	Normal but significant message.
info	6	Informational message.
debug	7	Debug-level messages.

syslog Priority Keywords

Example

See Also

set telnet

This command sets the Telnet administrative port.

set telnet Tport

Tport

Telnet administrative port-a decimal 16-bit number from 0 to 65535. Default is 23.

Usage

Example

See Also

set serial-admin - page 3-19

telnet - page 2-41

show pots

This command displays the status of the analog PHONE port and the B channel associated with it.

show pots

Usage

Example

Command> show pots

Pots port status

Pots port enabled

State idle

See Also

RADIUS Client Commands

The following commands configure the PortMaster as a RADIUS client. For RADIUS server configuration information, see the RADIUS Administrator's Guide.

set accounting

This command designates a host as the primary or alternate RADIUS accounting server.

set accounting [1|2] Ipaddress [Uport]

1	Designates the primary RADIUS server. This is the default.
2	If present, designates a host as the alternate accounting server.
Ipaddress	IP address or 39-character hostname running a RADIUS accounting server on UDP port 1646. Set Ipaddress to 0.0.0.0 to deselect the accounting server.
Uport	Integer between 0 and 65535 that specifies the UDP port to be used for RADIUS accounting. Setting the port number to 0 or not specifying a port number, sets the UDP port to 1646.

Usage

Note ¯ Do not assign the authentication server and the alternate authentication server to the same IP address.

A PortMaster uses one of the following criteria to determine whether to send accounting packets to a secondary accounting server instead of the primary accounting server:

• The primary RADIUS accounting server does not respond within 10 minutes. The PortMaster retries the accounting server once every 45 seconds.

• The primary RADIUS accounting server does not respond, and 50 accounting packets are waiting to be sent.

Examples

Accounting Server changed from 0.0.0.0 1646 to 10.0.0.3 1646

Command> set accounting 10.0.0.3 1813

Accounting Server changed from 10.0.0.3 1646 to 10.0.0.3 1813

Command> set accounting 2 10.0.0.4 1813

Alternate Accounting Server changed from 0.0.0.0 1646 to 10.0.0.4 1813

See Also

set secret - page 3-28

set alternate_auth_server

This command sets the alternate RADIUS authentication server, which is used if the primary server does not respond.

set alternate_auth_server Ipaddress [Uport]

Ipaddress	RADIUS alternate authentication server IP address or 39-character hostname. Set Ipaddress to 0.0.0.0 to deselect the alternate authentication server.
Uport	Integer between 0 and 65535 that specifies the UDP port to be used for RADIUS accounting. Setting the port number to 0 or not specifying a port number, sets the UDP port to 1645.

Usage

Example

Alternate Authentication Server changed from 0.0.0.0 1645 to 10.0.0.4 1645

Command> set alternate 10.0.0.4 1812

Alternate Authentication Server changed from 10.0.0.4 1645 to 10.0.0.4 1812

See Also

set authentication_server

This command sets the primary RADIUS authentication server.

set authentication_server Ipaddress

Ipaddress	IP address or 39-character hostname for a host running a RADIUS authentication server on UDP port 1645. Set Ipaddress to 0.0.0.0 to deselect the primary authentication server.
Uport	Integer between 0 and 65535 that specifies the UDP port to be used for RADIUS accounting. Setting the port number to 0 or not specifying a port number, sets the UDP port to 1645.

[Uport]

Usage

Example

Authentication Server changed from 0.0.0.0 1645 to 10.0.0.3 1645

Command> set authentication 10.0.0.3 1812

Authentication Server changed from 10.0.0.3 1645 to 10.0.0.3 1812

See Also

set alternate_auth_server - page 3-26

set secret - page 3-28

set S0 security - page 5-42

set secret

This command sets the RADIUS shared secret.

set secret String

String

Shared secret, which has a maximum of 15 printable, nonspace ASCII characters. The string cannot begin with a question mark.

Usage

Example

See Also

set S0 security - page 5-42

ChoiceNet Client Commands

The following commands configure the PortMaster as a ChoiceNet client. For ChoiceNet server configuration, see the ChoiceNet Administrator's Guide.

set choicenet

This command designates a host as the primary or alternate ChoiceNet server.

set choicenet [1|2] Ipaddress [Uport]

1	Designates the primary ChoiceNet server. This is the default.
2	If present, designates a host as the alternate ChoiceNet server.
Ipaddress	IP address or 39-character hostname of the host running a ChoiceNet server on UDP port 1647. Set Ipaddress to 0.0.0.0 to deselect the ChoiceNet server.
Uport	Integer between 0 and 65535 that specifies the UDP port to be used for RADIUS accounting. Setting the port number to 0 or not specifying a port number, sets the UDP port to 1647.

Usage

Example

ChoiceNet Server changed from 0.0.0.0 1647 to 10.0.0.5 1647

Command> set choicenet 10.0.0.5 6047

ChoiceNet Server changed from 10.0.0.5 1647 to 10.0.0.5 6047

set choicenet-secret

set choicenet-secret String

String

Shared secret. Maximum length is 15 printable, nonspace ASCII characters. The string cannot begin with a question mark.

Usage

Example

See Also

SNMP Commands

add snmphost

This command allows you to control SNMP security by specifying the addresses of the read or write hosts that are permitted to access SNMP information.

add snmphost reader|writer any|none|Ipaddress

reader	Adds a read host.
writer	Adds a write host.
any	All hosts using the correct read or write community string are permitted to read or write SNMP information.
none	No SNMP reads or writes are accepted by the PortMaster.
Ipaddress	The IP address or hostname-up to 39 characters-of the read or write host.

Usage

Example

See Also

save snmp - page 3-34

set snmp - page 3-35

show table snmp - page 3-38

clear alarm

This command deletes recorded instances of SNMP traps-notifications of certain events.

clear alarm Alarm-id|all

Alarm-id	Number that identifies a specific instance of an alarm. Use the show alarms command to display alarm IDs.
all	All alarms.

Usage

Command> clear alarm 4763864
Command> show alarms
Alarm Id	Age	Severity	Alarm Message
--------	------	---------	------------------------------------
4764168	19:11	0	Modem failure: card(0) modem(8)
4772816	19:11	0	Modem failure: card(0) modem(9)

Examples  

Command> clear alarm all
Command> show alarms
Alarm Id	Age	Severity	Alarm Message
--------	------	-------	----------------------------------------

See Also

delete snmphost

This command deletes read or write hosts that are allowed to access SNMP information.

delete snmphost reader|writer Ipaddress

reader	Use to delete a read host.
writer	Use to delete a write host.
Ipaddress	The IP address or hostname of the read or write host.

Example

See Also

save snmp

This command saves the settings of the SNMP parameters in the SNMP table.

save snmp

Usage

Example

See Also

set snmp

This command allows you to enable or disable PortMaster support for SNMP monitoring.

set snmp on|off

on	Enables support for SNMP.
off	Disables support for SNMP. This is the default.

Usage

Note ¯ After enabling or disabling SNMP, you must use the save snmp or save all command and reboot the PortMaster before the change takes effect.

Example

See Also

save snmp - page 3-34

show modules - page 2-31

show table snmp - page 3-38

set snmp readcommunity|writecommunity

This command sets the read and write community strings used for SNMP security.

set snmp readcommunity|writecommunity String

readcommunity	Sets the read community.
writecommunity	Sets the write community.
String	String up to 16 characters long. Default for read is public; default for write is private.

Note ¯ Use of the default write community string (private) is strongly discouraged. Because it is the default, it is known to all users and therefore provides no security. You should use some other value for the write community string.

Usage

A host must know the read community string to read the MIB information, and must know the write community string to set information on the SNMP agent.

Example

See Also

save snmp - page 3-34

set snmp - page 3-35

show table snmp - page 3-38

show alarms

This command displays instances of SNMP traps-notifications of certain events-that have occurred.

show alarms|[Alarm-id]

Alarm-id

Number that identifies a specific instance of an alarm.

Usage

Examples

For Line0 or Line1:
Command> show alarms
Alarm Id	Age	Severity	Alarm Message
--------	------	---------	--------------------------------------
4763864	19:11	0	T1 line(0) down
4764168	19:09	0	Modem failure: card(0) modem(8)
4772816	19:09	0	Modem failure: card(0) modem(9)

 

Command> show alarms 4763864
------------------------ Alarm Details --------------------------
Alarm Id: 4763864	Alarm Message: T1 line(0) down
Age in minutes: 19:11	Alarm repeated: 1 times
Severity: 0	Reported: SNMP

For line2, on the T1 expansion card:
Command> show alarms
Alarm Id	Age	Severity	Alarm Message
--------	------	---------	------------------------------------------
2851352	0	0	T1 line(2) down

Command> show alarm 2851352
------------------------ Alarm Details --------------------------
Alarm Id: 2851352	Alarm Message: T1 line(2) down
Age in minutes: 0	Alarm repeated: 1 times
Severity: 0	Reported: SNMP

See Also

show table snmp

This command shows the settings in the SNMP table.

show table snmp

Usage

Example

See Also

set snmp - page 3-35