7. Interface command reference

This chapter describes the following:

7.1. Configuration commands

Note:

The commands described in this section apply specifically to the 7705 SAR-Hm series nodes. All other applicable commands supported on the nodes are described in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide and the 7450 ESS, 7750 SR, 7950 XRS, and VSR Clear, Monitor, Show, and Tools Command Reference Guide.

7.1.1. Configuration command hierarchies

7.1.1.1. Ethernet commands

The following commands are supported on 7705 SAR-Hm series nodes. Refer to the 7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide for the command descriptions.

Note:

Not all commands that are visible in the CLI, and described in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide and the 7450 ESS, 7750 SR, 7950 XRS, and VSR Clear, Monitor, Show, and Tools Command Reference Guide, are supported on 7705 SAR-Hm series nodes. Only the commands that are listed below are supported.

config
[no] port {port-id}
— ethernet
— autonegotiate [limited]
— no autonegotiate
— dot1q-etype value
— no dot1q-etype
— down-on-internal-error [tx-disable]
— no down-on-internal-error
duplex {full | half}
— egress-scheduler-override [create]
— no egress-scheduler-override
— level priority-level rate pir-rate [cir cir-rate]
— level priority-level percent-rate pir-percent [percent-cir cir-percent]
— no level priority-level
— max-rate rate
— max-rate percent percent-rate
— no max-rate
— egress-scheduler-policy port-scheduler-policy-name
— no egress-scheduler-policy
— encap-type {dot1q | null}
— no encap-type
— hold-time {[up hold-time up] [down hold-time down] [seconds | centiseconds]}
— no hold-time
— mac ieee-address
— no mac
— min-frame-length byte-length
— mode {access | network | hybrid}
— no mode
— mtu mtu-bytes
— no mtu
— speed {10 | 100}

7.1.1.2. Ethernet access and network commands

config>port>ethernet
— access
— bandwidth bandwidth
— no bandwidth
— booking-factor factor
— no booking-factor
— egress
— ingress
— network
— accounting-policy policy-id
— no accounting-policy
[no] collect-stats
— egress
— queue-policy name
— no queue-policy

7.1.1.3. Cellular MDA and cellular port configuration commands

config
— card 1
— mda 1
— cellular
active-sim {1 | 2 | auto}
b125-max-tx-power power-level
down-recovery-criteria criterion [criterion...(up to two)]
max-tx-power maximum-tx-power
preferred-sim {1 | 2}
sim sim-card-number
description description-string
— no description
pin
pin pin-value [hash | hash2]
— no pin
[no] port-oper-state
failure-duration minutes
config
port port-id
description description-string
— no description
— cellular
antenna-gain gain
— no antenna-gain
category {a | b}
client-tls-profile tls-profile-name
sas-server-primary url-string
sas-server-secondary url-string
[no] shutdown
userid userid-string
— no userid
pdn
pdn-profile pdn-profile-id
— no pdn-profile
[no] shutdown

7.1.1.4. Cellular PDN profile configuration commands

config
— system
— cellular
pdn-profile pdn-profile-number [create]
— no pdn-profile
apn apn-name
— no apn
authentication {pap | chap}
description description-string
— no description
password password [hash | hash2 | custom]
— no password
protocol {ipv4 | ipv6}
username user-name
— no username

7.1.1.5. GNSS receiver configuration commands

config
— card 1
— mda 1
— gnss
constellation {gps | gps-glonass}
nmea
sentence-types sentence-type [sentence-type...(up to 4 max)]
sentence-interval interval
[no] shutdown
[no] shutdown

7.1.1.6. Serial interface configuration commands

config
[no] port port-id
serial
rs232
character-length {6 | 7 | 8}
control-lead {input | output}
input
dtr-dsr {high | low}
rts-dcd {high | low}
dtr-dsr off
rts-dcd off
output
cts-alb {high | low}
dcd-rts {high | low}
ri-rdl {high | low}
hold-time {[up hold-time-up] [down hold-time-down]}
— no hold-time
loopback bidir-e
— no loopback
parity {odd | even | mark | space}
— no parity
[no] shutdown
speed {600 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200}
stop-bits {1 | 2}

7.1.1.7. Serial raw socket interface configuration commands

Note:

To enable the serial transport over raw socket functionality on 7705 SAR-Hm series nodes, configure an RS-232 raw socket serial port and create an IP transport subservice within a VPRN service. For information on how to configure an IP transport subservice within a VPRN, refer to the 7705 SAR-Hm and SAR-Hmc Main Configuration Guide, Layer 2 and Layer 3 Services chapter, “Serial raw socket IP transport configuration commands hierarchy”.

config
[no] port port-id
serial
[no] rs232
socket
rx
eop
idle-timeout milliseconds
length bytes
special-char value
squelch-delay seconds
unsquelch-delay seconds
tx
inter-session-delay milliseconds

7.1.1.8. WLAN MDA radio configuration commands

config
— card 1
— mda 4
[no] shutdown
bandwidth {20MHz | 40MHz}
beacon-interval milliseconds
channel {auto | channel-id}
[no] country-code country-string
frequency-band {2400 | 5000}
[no] shutdown

7.1.1.9. WLAN port configuration commands

config
port
description description-string
— no description
[no] shutdown
wlan
[no] broadcast-ssid
client-limit clients
client-timeout seconds
— dhcp
[no] shutdown
dot1x
radius-plcy policy-name
— no radius-plcy
re-auth-period seconds
mode {access | network}
network network-id ssid ssid-name [create]
— no network
wlan-security [type {wpa2-psk | wpa2-enterprise}]
station
authentication {eap-ttls | eap-fast | eap-peap}
password password-string [hash | hash2]
— no password
username username-string
— no username
wpa-encryption [tkip | aes]
wpa-passphrase ascii-passphrase [hash | hash2]

7.1.2. Configuration command descriptions

The commands described in this section apply specifically to 7705 SAR-Hm series nodes. All other applicable commands supported on the nodes are described in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide and the 7450 ESS, 7750 SR, 7950 XRS, and VSR Clear, Monitor, Show, and Tools Command Reference Guide.

7.1.2.1. Common configuration commands

description

Syntax 
description description-string
no description
Context 
config>card>mda>cellular>sim
config>port
config>system>cellular>pdn-profile
Description 

This command creates a text description for a configuration context to help identify the content in the configuration file.

The no form of this command removes the description string from the context.

Default 

n/a

Parameters 
description-string—
a description character string. Allowed values are any string up to 80 or 160 characters long (depending on the command), composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

shutdown

Syntax 
[no] shutdown
Context 
config>port
config>port>serial>rs232
Description 

This command administratively disables an entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they can be deleted.

The no form of this command administratively enables an entity.

Default 

no shutdown

7.1.2.2. Cellular MDA and cellular port configuration commands

port

Syntax 
port port-id
Context 
config
Description 

This command configures an identifier for a cellular port on the node. Up to two cellular ports can be configured and each cellular port is associated with a SIM. Cellular port 1/1/1 is associated with SIM 1 and cellular port 1/1/2 is associated with SIM 2. The relationship between the ports and the SIMs cannot be changed.

Default 

1/1/1

Parameters 
port-id—
the cellular port identifier
Values—
1/1/1 or 1/1/2, in the format slot/mda/port

 

active-sim

Syntax 
active-sim {1 | 2 | auto}
Context 
config>card>mda>cellular
Description 

This command assigns a SIM to be the active SIM.

When the system powers up or reboots, it uses the active-sim setting to determine which SIM is the active SIM. Selecting 1 or 2 makes the selected SIM permanently active. The active SIM can be manually switched by changing the active-sim setting from 1 to 2 or from 2 to 1.

Caution:

Changing the active SIM from 1 to 2 or vice versa is considered a manual switchover and is service-affecting. The recovery time after making the change can range from a few seconds to up to a few minutes. Ensure that there is service on the other SIM before changing the active SIM.

If a SIM is specified but is not physically installed in the associated SIM slot, the cellular port remains operationally down. The operator must either install the SIM in the appropriate slot or change the configuration in order to bring up the service.

Selecting auto enables automatic failover in a dual SIM deployment. An automatic failover occurs when activity switches from one SIM to the other. The settings configured for the failover-criteria command determine when an automatic failover will occur.

When the auto parameter is set in a dual SIM deployment, the node must be configured with a preferred SIM. The preferred-sim command specifies whether SIM 1 or SIM 2 is used for a cellular port after a system reset.

If the active-sim value is changed from auto to 1 or from auto to 2 and the active SIM is the same as the new configuration, there is no change to service of the active SIM.

Caution:

Changing the active-sim setting so that the newly active SIM is different from the currently active SIM is service-affecting. The recovery time after making this change could range from a few seconds to up to a few minutes.

If the active-sim value is changed from 1 to auto or from 2 to auto, there is no service outage. The system keeps the currently active SIM up and does not perform any switchover.

When active-sim is set to auto, operators can use the tools>perform>mda> cellular>force-sim-switch command to manually force a SIM switch.

The auto parameter can be set even if there is only one SIM installed in the system. In this case, the system keeps the currently active SIM up and does not perform any switchover.

Default 

1

Parameters 
1—
sets the active SIM to SIM 1
2—
sets the active SIM to SIM 2
auto—
enables automatic failover between the two SIMs in a dual SIM deployment

b125-max-tx-power

Syntax 
b125-max-tx-power power-level
no b125-max-tx-power
Context 
config>card>mda>cellular
Description 

This command configures the maximum transmit power level of the B125 radio module. The B125 power level depends on the installation height of the B125 variant antenna, and the value must be set based on the guidelines provided in the SAR-Hm and SAR-Hmc Chassis Installation Guide for B125 antenna locations.

For more information, refer to the SAR-Hm and SAR-Hmc Chassis Installation Guide.

Default 

1

Parameters 
power-level —
the B125 antenna power level
Values—
1 to 20

 

down-recovery-interval

Syntax 
down-recovery-interval interval
no down-recovery-interval
Context 
config>card>mda>cellular
Description 

This command configures the length of time in which the cellular MDA must establish cellular service for a SIM before the node resets. It is used in conjunction with the down-recovery-criteria command.

When configured, this option provides a hardware reset to unblock any potential hardware lockup conditions related to the cellular radio modem or to guard against persistent cycling of automatic switchovers between SIMs in a dual SIM deployment. If the cellular MDA has not successfully achieved service based on the down-recovery-criteria value set for either SIM 1 or SIM 2 within the specified length of time, the node resets.

Prior to resetting, the node will issue a log event stating that the node will reset within 60 seconds. This interval can be used to collect information for further debugging and analysis.

The no form of the command disables the down-recovery-interval, and the state of the cellular MDA is not monitored other than for dual SIM operation and criteria configured for automatic failover (see failover-criteria for more information).

Default 

no down-recovery-interval

Parameters 
interval —
the length of time, in minutes, before a down-recovery condition is declared
Values—
1 to 240

 

down-recovery-criteria

Syntax 
down-recovery-criteria criterion [criterion...(up to two)]
no down-recovery-criteria
Context 
config>card>mda>cellular
Description 

This command configures criteria used to detect a problem with the cellular radio modem. It is used in conjunction with the down-recovery-interval command. The criteria are port and bgp.

When the command is set to port, the node detects if any cellular port has connected to a wireless network and is operationally up within the configured down-recovery-interval. When a port connects successfully, the down-recovery timer stops. The down-recovery timer restarts when all PDN interfaces are operationally down.

When the command is set to bgp, the node detects if any BGP session whose local-address is configured to a PDN interface name has come up within the configured down-recovery-interval. When a BGP session comes up, the down-recovery timer stops. The down-recovery timer restarts when all BGP sessions associated with PDN interfaces (associated with the configured local-address) are down.

Both port and bgp can be set concurrently as criteria.

Default 

port

Parameters 
criterion —
specifies the criterion to use for detecting a problem with the cellular radio modem
Values—
port —all cellular ports are monitored
bgp—all BGP sessions associated with PDNs are monitored

 

max-tx-power

Syntax 
max-tx-power maximum-tx-power
Context 
config>card>mda>cellular
Description 

This command configures the maximum transmit power used by the cellular interface on the MDA of the 7705 SAR-Hmc. For information about supported variants, refer to the 7705 SAR-Hm/Hmc Software Release Notes. This command is not supported on the 7705 SAR-Hm.

The command is used when higher gain antennas are deployed using spectrum where maximum power must be reduced to accommodate for the added gain.

The command adjusts the upper range of transmit power on the cellular interface. The transmit power range of the cellular interface on the MDA is -44 dBm to 23 dBm. The command can adjust this power range down by as much as 22 dB when the parameter is set within the supported range of 1 to 23 dBm.

Default 

23 dBm

Parameters 
maximum-tx-power—
the transmit power
Values—
1 to 23 dBm (in 1 dBm increments)

 

preferred-sim

Syntax 
preferred-sim {1 | 2}
no preferred-sim
Context 
config>card>mda>cellular
Description 

This command configures which SIM to use when the node resets. The configuration is used in a dual SIM deployment when the active-sim command is set to auto. When the node resets, the system uses the preferred SIM to bring up the associated cellular port.

Note:

Before setting the preferred SIM, the operator must ensure that the corresponding SIM is installed and configured.

Default 

1

Parameters 
1 —
sets the preferred SIM to SIM 1
2 —
sets the preferred SIM to SIM 2

sim

Syntax 
sim sim-card-number
Context 
config>card>mda>cellular
Description 

This command enables the context to configure parameters for the specified SIM.

Parameters 
sim-card-number —
identifies the SIM
Values—
1 or 2

 

pin

Syntax 
pin
pin pin-value [hash | hash2]
no pin
Context 
config>card>mda>cellular>sim
Description 

This command stores the SIM PIN in the system configuration file. This command does not change the PIN on the SIM.

Use the pin command to enter the PIN in the system configuration file from an interactive CLI session. The system prompts you to enter the PIN twice. If the two entered PINs do not match, the system rejects the configuration.

Use the pin command with a specified PIN value and the hash or hash2 keyword to load the PIN in encrypted form in the configuration file.

The no form of this command removes the PIN from the system configuration.

Default 

n/a

Parameters 
pin-value—
the 4-to-8 digit PIN code
hash—
specifies that the PIN is entered in an encrypted form. If the hash or hash2 keyword is not used, the PIN is assumed to be in an unencrypted, clear text form. For security, all PINs are stored in encrypted form in the configuration file with the specified hash or hash2 parameter.
hash2—
specifies that the PIN is entered in a more complex, encrypted form that involves more variables than the PIN value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 keyword is not used, the PIN is assumed to be in an unencrypted, clear text form. For security, all PINs are stored in encrypted form in the configuration file with the specified hash or hash2 parameter.

failover-criteria

Syntax 
failover-criteria
Context 
config>card>mda>cellular>sim
Description 

This command enables the context to configure the criteria that will cause an automatic SIM switchover in a dual SIM deployment.

The failover-criteria parameters are used when the active-sim command is set to auto. The parameters are configured per SIM, so each SIM can have different failover criteria. The system uses the criteria configured on the currently active SIM to determine when a switchover should occur.

Default 

n/a

port-oper-state

Syntax 
[no] port-oper-state
Context 
config>card>mda>cellular>sim>failover-criteria
Description 

This command sets the operational status of the cellular port as a failover criterion for the specified SIM.

If the operational status of the cellular port remains down for the failure-duration interval, the SIM is considered to be in a failed state and the system performs an automatic switch from the currently active SIM to the other SIM.

The no form of the command disables the port-oper-state from being used as a failover criterion.

Default 

port-oper-state

bgp-neighbor-state

Syntax 
[no] bgp-neighbor-state
Context 
config>card>mda>cellular>sim>failover-criteria
Description 

This command sets the operational status of BGP sessions as a failover criterion for the specified SIM.

The BGP sessions monitored by the system are those that are configured with the local-address set to the PDN interface name that uses the associated SIM cellular port-id.

If the operational status of BGP sessions remain down for the failure-duration interval, the SIM is considered to be in a failed state and the system performs an automatic switch from the currently active SIM to the other SIM.

The no form of the command disables the bgp-neighbor-state from being used as a failover criterion.

Default 

no bgp-neighbor-state

failure-duration

Syntax 
failure-duration minutes
Context 
config>card>mda>cellular>sim>failover-criteria
Description 

This command configures the length of time before the SIM is considered to be in a failed state based on the specified failover criteria. The value is used for both configured failover criteria.

When the node detects a down state for the failure-duration time, the SIM is considered to be in a failed state and the node performs an automatic switch from the currently active SIM to the other SIM.

Note:

It is recommended that the failure-duration be set to a high value so that the system does not perform frequent switches between SIMs.

Default 

5

Parameters 
minutes—
the length of time, in minutes, before the SIM is considered to be in a failed state
Values—
1 to 60
 

 

cbsd-authorization

Syntax 
cbsd-authorization
Context 
config>port>cellular
Description 

This command enables the context to enable the authorization process on the PDN router interface so that the node can operate as a Category A or Category B Citizens Broadband Radio Service Device (CBSD) in the Citizens Broadband Radio Service (CBRS) B48 spectrum.

When this command is issued, all other functions on the PDN interface are blocked until the Spectrum Access System (SAS) authorizes the node to transmit on B48. This command is available only for the 7705 SAR-Hmc NA (3HE12472AA) and the 7705 SAR-Hmc NA variant 2 (3HE12473AA).

Default 

n/a

antenna-gain

Syntax 
antenna-gain gain
no antenna-gain
Context 
config>port>cellular>cbsd-authorization
Description 

This command sets the antenna gain of the CBSD. The value configured for this command is added to the configured max-tx-value to calculate the maximum EIRP value used in the grant request to the SAS server.

The no form of the command resets the antenna gain to the default.

Default 

0

Parameters 
gain—
the antenna gain in dBm
Values—
0 to 14

 

category

Syntax 
category {a | b}
Context 
config>port>cellular>cbsd-authorization
Description 

This command sets the category of the CBSD to either Category A or Category B. This value is used in the registration request to the SAS server and must match the value expected by the SAS.

Default 

a

Parameters 
a—
defines the CBSD as Category A
b—
defines the CBSD as Category B

client-tls-profile

Syntax 
client-tls-profile tls-profile-name
no client-tls-profile
Context 
config>port>cellular>cbsd-authorization
Description 

This command names the client TLS profile that is used to authenticate the CBSD with the SAS server.

The TLS client profile must first be configured in the config>system>security>tls context. Refer to the 7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide for the command description.

This command must be configured before issuing the no shutdown command in the cbsd-authorization context.

The no form of the command deletes the client TLS profile.

Default 

n/a

Parameters 
tls-profile-name—
the name of an existing TLS client profile

sas-server-primary

Syntax 
sas-server-primary url-string
no sas-server-primary
Context 
config>port>cellular>cbsd-authorization
Description 

This command sets the location of the primary SAS server. The URL is provided by the SAS administrator. The location of the primary SAS server must be configured before issuing the no shutdown command in the cbsd-authorization context.

The no form of this command deletes the primary SAS server location.

Default 

n/a

Parameters 
url-string—
the link to the SAS primary server; it contains either the SAS server name or IP address
Values—
login:pswd@]remote-locn/path: up to 255 characters
login: the username
pswd: the user password
remote-locn: {hostname | ipv4-address | [ipv6-address]}[:port]
hostname: the hostname for the server
ipv4-address: a.b.c.d
ipv6-address:

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255] D

interface - the interface for the link local address, up to 32 characters

port: 0 to 65535
path: the path to the specific resource being accessed

 

sas-server-secondary

Syntax 
sas-server-secondary url-string
no sas-server-secondary
Context 
config>port>cellular>cbsd-authorization
Description 

This command sets the location of the optional secondary SAS server. The URL is provided by the SAS administrator. The location of the secondary SAS server must be configured before issuing the no shutdown command in the cbsd-authorization context.

The no form of this command deletes the secondary SAS server location.

Default 

n/a

Parameters 
url-string—
the link to the SAS secondary server; it contains either the SAS server name or IP address
Values—
login:pswd@]remote-locn/path: up to 255 characters
login: the username
pswd: the user password
remote-locn: {hostname | ipv4-address | [ipv6-address]}[:port]
hostname: the hostname for the server
ipv4-address: a.b.c.d
ipv6-address:

x:x:x:x:x:x:x:x[-interface]

x:x:x:x:x:x:d.d.d.d[-interface]

x - [0 to FFFF]H

d - [0 to 255] D

interface - the interface for the link local address, up to 32 characters

port: 0 to 65535
path: the path to the specific resource being accessed

 

shutdown

Syntax 
[no] shutdown
Context 
config>port>cellular>cbsd-authorization
Description 

This command shuts down the CBSD authorization process. If the node is already registered with the SAS server, this command deregisters the 7705 SAR-Hmc from the SAS.

The no form of the command enables the CBSD authorization process with the SAS server.

Default 

n/a

userid

Syntax 
userid userid-string
no userid
Context 
config>port>cellular>cbsd-authorization
Description 

This command sets the CBSD user ID that is used in the registration request to the SAS server. The CBSD user is the entity that has operational responsibility for the CBSD.

The no form of the command deletes the user ID.

Default 

n/a

Parameters 
userid—
the user ID of the CBSD

pdn

Syntax 
pdn
Context 
config>port>cellular
Description 

This command enables the context to configure PDN parameters for the cellular port.

Default 

n/a

pdn-profile

Syntax 
pdn-profile pdn-profile-id
no pdn-profile
Context 
config>port>cellular>pdn
Description 

This command assigns a PDN profile to the cellular port. The PDN profile must be configured at the system level before this command can be used; see Cellular PDN profile configuration commands for information.

The no form of this command assigns the default PDN profile to the PDN.

Default 

no pdn-profile

Parameters 
pdn-profile-id—
the PDN profile identifier
Values—
1 to 15

 

sync-system-time

Syntax 
[no] sync-system-time
Context 
config>port>cellular
Description 

This command enables the cellular interface to obtain the system time. When enabled, the time received over the cellular interface is used to synchronize the node system time.

The no form of this command disables the cellular interface from acquiring the system time.

Default 

no sync-system-time

7.1.2.3. Cellular PDN profile configuration commands

pdn-profile

Syntax 
pdn-profile pdn-profile-number [create]
no pdn-profile
Context 
config>system>cellular
Description 

This command creates a PDN profile with an associated ID when used with the create keyword.

The system supports a default PDN profile and up to 15 user-created PDN profiles.

The default PDN profile is used during the ADP-Hm process and cannot be modified.

The no form of this command deletes the PDN profile if the profile is not in use. If the profile is in use, the no form of the command cannot be executed.

Default 

n/a

Parameters 
pdn-profile-number—
the PDN profile identifier
Values—
1 to 15

 

create—
the keyword used to create the PDN profile

apn

Syntax 
apn apn-name
no apn
Context 
config>system>cellular>pdn-profile
Description 

This command configures the Access Point Name (APN) for the PDN profile.

The no form of this command removes the APN.

Default 

no apn

Parameters 
apn-name—
a character string up to a maximum of 100 characters

authentication

Syntax 
authentication {pap | chap}
no authentication
Context 
config>system>cellular>pdn-profile
Description 

This command configures the authentication type used by the PDN profile.

The no form of this command removes authentication from the PDN profile.

Default 

n/a

Parameters 
pap—
sets the authentication type to PAP
chap—
sets the authentication type to CHAP

password

Syntax 
password password [hash | hash2 | custom]
no password
Context 
config>system>cellular>pdn-profile
Description 

This command configures the password for PAP or CHAP authentication of the PDN profile. The password must be confirmed by entering it twice.

The no version of this command removes the authentication password from the PDN profile.

Default 

no password

Parameters 
password—
a character string up to a maximum of 64 characters
hash—
specifies that the key is entered in an encrypted form. If the hash parameter is not used, the key is assumed to be in a non-encrypted, clear text form For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
hash2—
specifies that the key is entered in a more complex encrypted form that involves more variables than the key value alone. This means that a hash2 encrypted variable cannot be copied and pasted. If the hash2 parameter is not used, the key is assumed to be in a non-encrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
custom—
specifies the custom encryption to management interface

protocol

Syntax 
protocol {ipv4 | ipv6}
Context 
config>system>cellular>pdn-profile
Description 

This command configures the address type, either IPv4 or IPv6, that is learned by the PDN router interface during the PDN attachment process. When set to IPv4, the PDN router interface can operate in static cellular system mode, static cellular interface mode, or dynamic cellular interface mode. When set to IPv6, the PDN router interface can operate in either static cellular interface mode or dynamic cellular interface mode. For more information on the PDN router interface modes, refer to “PDN Router Interfaces” in the 7705 SAR-Hm and SAR-Hmc Main Configuration Guide.

Default 

ipv4

Parameters 
ipv4 —
sets the IP address type for the PDN connection to IPv4
ipv6 —
sets the IP address type for the PDN connection to IPv6

username

Syntax 
username user-name
no username
Context 
config>system>cellular>pdn-profile
Description 

This command configures the user name for PAP or CHAP authentication of the PDN profile.

The no form of this command removes the user name.

Default 

n/a

Parameters 
user-name—
a character string up to a maximum of 255 characters

7.1.2.4. Ethernet configuration commands

duplex

Syntax 
duplex (full | half}
Context 
config>port>ethernet
Description 

This command configures the duplex mode of a Fast Ethernet port when autonegotiation is disabled. If the port is configured to autonegotiate, this parameter is ignored.

The 7705 SAR-Hm only supports full-duplex mode.

Default 

full

Parameters 
full—
sets the link to full-duplex mode
half—
sets the link to half duplex mode

7.1.2.5. GNSS receiver configuration commands

constellation

Syntax 
constellation {gps | gps-glonass}
Context 
config>card>mda>gnss
Description 

This command configures which GNSS system or systems will be used by the GNSS receiver. The configuration can be modified only when the GNSS service is shut down.

Default 

gps

Parameters 
gps—
configures the GNSS receiver to use the American GPS GNSS system
gps-glonass—
configures the GNSS receiver to use both the American GPS GNSS system and the Russian GLONASS GNSS system

nmea

Syntax 
nmea
Context 
config>card>mda>gnss
Description 

This command enables the context for configuring NMEA parameters.

sentence-types

Syntax 
sentence-types sentence-type [sentence-type...(up to 4 max)]
Context 
config>card>mda>gnss>nmea
Description 

This command configures NMEA sentence types that are sent from the GNSS receiver over the associated IP transport service when the service is configured for NMEA streaming. The following sentence types are supported: GGA, RMC, VTG, and GNS. For information about the sentence types, refer to NMEA 0183, Standard For Interfacing Marine Electronic Devices.

At least one sentence type must be specified, up to a maximum of four. Different sentence types can be specified concurrently so that multiple sentences can be streamed per NMEA sentence interval.

Default 

gga

Parameters 
sentence-type—
an NMEA sentence type to be streamed
Values—
gga — this sentence is for time, position, and fix-related data for a GNSS receiver
rmc — this sentence is for time, date, position, course, and speed data provided by the GNSS receiver
vtg — this sentence is for vector track and speed relative to the ground
gns — this sentence is for time, position, and fix-related data for single or combined constellations for a GNSS receiver.

 

sentence-interval

Syntax 
sentence-interval interval
Context 
config>card>mda>gnss>nmea
Description 

This command configures the intervals at which NMEA sentences are retrieved from the GNSS receiver and sent over the associated IP transport service configured for NMEA streaming.

Default 

5 s

Parameters 
interval—
time, in seconds, between the sending of NMEA sentences
Values—
1 to 3600

 

shutdown

Syntax 
[no] shutdown
Context 
config>card>mda>gnss>nmea
Description 

This command enables or disables NMEA streaming from the GNSS receiver. The no form of the command enables NMEA streaming. Using the shutdown command disables NMEA streaming.

The node uses an IP transport service to send NMEA sentences from the GNSS receiver to remote hosts. For information about enabling IP transport for NMEA sentences, refer to the 7705 SAR-Hm and SAR-Hmc Main Configuration Guide, “GNSS NMEA data IP transport service”.

Default 

shutdown

shutdown

Syntax 
[no] shutdown
Context 
config>card>mda>gnss
Description 

This command enables or disables the GNSS service on the GNSS receiver. Enabling the GNSS receiver causes MDA 1/1 to reset under the following conditions:

  1. when the configuration of the constellation command changes
  2. the first time the GNSS receiver is enabled after a firmware update of the cellular MDA

The no form of the command enables the GNSS service. Using the shutdown command disables the GNSS receiver and resets the position fix and associated information.

Default 

shutdown

7.1.2.6. Serial interface configuration commands

serial

Syntax 
serial
Context 
config>port
Description 

This command enables the context to configure parameters for an RS-232 serial port on the node.

Default 

n/a

rs232

Syntax 
rs232
Context 
config>port>serial
Description 

This command enables the context to configure RS-232 parameters for a serial port.

Default 

n/a

character-length

Syntax 
character-length {6 | 7 | 8}
Context 
config>port>serial>rs232
Description 

This command configures the number of data bits used to transmit a character. The value for this command cannot be 8 if the value for parity is anything other than no parity (that is, anything other than none) and the value for stop-bits is 2.

Default 

8

Parameters 
6—
specifies six bits in a character
7—
specifies seven bits in a character
8—
specifies eight bits in a character

control-lead

Syntax 
control-lead {input | output}
Context 
config>port>serial>rs232
Description 

This command enables access to the context to configure the input and output leads that carry control signals. Control signals provide the handshaking for call setup, teardown, and synchronization.

Default 

n/a

input

Syntax 
input
Context 
config>port>serial>rs232>control-lead
Description 

This command enables access to the context to configure the input control leads.

Default 

n/a

dtr-dsr

Syntax 
dtr-dsr {high | low}
Context 
config>port>serial>rs232>control-lead>input
Description 

This command configures the Data Terminal Ready (DTR) or Data Set Ready (DSR) input control lead. For a DCE device, the input signal is DTR. For a DTE device, the input signal is DSR. This command is supported on the 7705 SAR-Hm only.

Default 

high

Parameters 
high—
the input control lead is assumed to be on
low—
the input control lead is assumed to be off

rts-dcd

Syntax 
rts-dcd {high | low}
Context 
config>port>serial>rs232>control-lead>input
Description 

This command configures the Request To Send (RTS) or Data Carrier Detect (DCD) input control lead. For a DCE device, the input signal is RTS. For a DTE device, the input signal is DCD. This command is supported on the 7705 SAR-Hm only.

Default 

high

Parameters 
high—
the input control lead is assumed to be on

monitor

Syntax 
monitor
Context 
config>port>serial>rs232>control-lead
Description 

This command enables access to the context to monitor the input control leads. When monitoring is enabled on a control lead, the node polls the status of the control lead every second. Any change in state of the control lead causes an alarm to be raised. This functionality provides an indication to the operator of a problem in the DTE-to-DCE path; for example, it can indicate that the far-end device is disconnected.

Monitoring is enabled on a per-lead basis.

Default 

n/a

dtr-dsr

Syntax 
dtr-dsr off
Context 
config>port>serial>rs232>control-lead>monitor
Description 

This command enables monitoring on the Data Terminal Ready (DTR) or Data Set Ready (DSR) input control lead. For a DCE device, the input control lead is DTR. For a DTE device, the input control lead is DSR. This command is supported on the 7705 SAR-Hm only.

Default 

off

Parameters 
off—
monitoring is disabled on the lead

rts-dcd

Syntax 
rts-dcd off
Context 
config>port>serial>rs232>control-lead>monitor
Description 

This command enables monitoring on the Request To Send (RTS) or Data Carrier Detect (DCD) input control lead. For a DCE device, the input control lead is RTS. For a DTE device, the input control lead is DCD. This command is supported on the 7705 SAR-Hm only.

Default 

off

Parameters 
off—
monitoring is disabled on the lead

output

Syntax 
output
Context 
config>port>serial>rs232>control-lead
Description 

This command enables access to the context to configure the output control leads.

Default 

n/a

cts-alb

Syntax 
cts-alb {high | low}
Context 
config>port>serial>rs232>control-lead>output
Description 

This command configures the Clear To Send (CTS) or Analog Loopback (ALB) output control lead. For a DCE device, the output signal is CTS. For a DTE device, the output signal is ALB.

Default 

high

Parameters 
high—
the output control lead is forced on
low—
the output control lead is forced off

dcd-rts

Syntax 
dcd-rts {high | low}
Context 
config>port>serial>rs232>control-lead>output
Description 

This command configures the Data Carrier Detect (DCD) or Request To Send (RTS) output control lead. For a DCE device, the output signal is DCD. For a DTE device, the output signal is RTS. This command is supported on the 7705 SAR-Hm only.

Default 

high

Parameters 
high—
the output control lead is forced on
low—
the output control lead is forced off

ri-rdl

Syntax 
ri-rdl {high | low}
Context 
config>port>serial>rs232>control-lead>output
Description 

This command configures the Ring Indicator (RI) or Remote Digital Loopback (RDL) output control lead. For a DCE device, the output signal is RI. For a DTE device, the output signal is RDL. This command is supported on the 7705 SAR-Hm only.

Default 

high

Parameters 
high—
the output control lead is forced on
low—
the output control lead is forced off

hold-time

Syntax 
hold-time {[up hold-time-up] [down hold-time-down]}
no hold-time
Context 
config>port>serial>rs232
Description 

This command configures the serial link dampening timers in 100s of milliseconds, which guards against reporting excessive interface transitions. Once implemented, subsequent transitions of the interface from one state to another are not advertised to upper layer protocols until the configured timer has expired.

Default 

no hold-time

Parameters 
hold-time-up—
the hold-timer for link-up event dampening. A value of zero (0) indicates that an up transition is reported immediately.
Values—
0 to 100 (in 100s of milliseconds)

 

hold-time-down—
the hold-timer for link-down event dampening. A value of zero (0) indicates that a down transition is reported immediately.
Values—
0 to 100 (in 100s of milliseconds)

 

loopback

Syntax 
loopback bidir-e
no loopback
Context 
config>port>serial>rs232
Description 

This command puts the specified interface into a loopback mode. The corresponding interface must be in a shutdown state in order for the loopback mode to be enabled.

In the serial context, it is possible to configure a a bidirectional loopback E. A bidirectional loopback is a circuit loopback that loops traffic from the line back to the line. Bidirectional loopback E takes place on the data device side of the adapter card, and is closer to the line.

This command is not saved in the system configuration between boots.

The no form of this command disables the loopback on the interface.

Default 

no loopback

Parameters 
bidir-e—
configures a bidirectional loopback E

parity

Syntax 
parity {odd | even | mark | space}
no parity
Context 
config>port>serial>rs232
Description 

This command configures the parity bit in a character. Parity is an error detection method that adds an extra bit to each character, based on the number of 0s or 1s in the character.

The value for this command must be no parity (that is, none) if the character-length value is 8 and the stop-bits value is 2.

The no form of this command disables the parity bit in a character.

Default 

no parity

Parameters 
odd—
the parity bit is set to 0 or 1 to make the total number of 1s in the set of bits odd
even—
the parity bit is set to 0 or 1 to make the total number of 1s in the set of bits even
mark—
the parity bit is present but not used and is always set to 1
space—
the parity bit is present but not used and is always set to 0

speed

Syntax 
speed {600 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200}
Context 
config>port>serial>rs232
Description 

This command configures the speed of the interface. The speed also determines the DS0 timeslots assigned to the channel group.

Default 

9600

Parameters 
600—
sets the link speed to 600 b/s
1200—
sets the link speed to 1200 b/s
2400—
sets the link speed to 2400 b/s
4800—
sets the link speed to 4800 b/s
9600—
sets the link speed to 9600 b/s
19200—
sets the link speed to 19 200 b/s
38400—
sets the link speed to 38 400 b/s
57600—
sets the link speed to 57 600 b/s
115200—
sets the link speed to 115 200 b/s

stop-bits

Syntax 
stop-bits {1 | 2}
Context 
config>port>serial>rs232
Description 

This command configures the number of stop bits used to signify the end of a character.

This command cannot have a value of 2 if the character-length value is 8 and the parity value is anything other than no parity (that is, anything other than none).

Default 

1

Parameters 
1—
specifies one stop bit in a character
2—
specifies two stop bits in a character

7.1.2.7. Raw socket configuration commands

7.1.2.7.1. Raw socket port configuration commands

Note:

The speed command must be set to a value that supports raw sockets; see Serial interface configuration commands for the required information.

socket

Syntax 
socket
Context 
config>port>serial>rs232
Description 

This command creates a raw socket on an RS-232 port.

The no form of the command deletes the socket from the serial port.

Default 

n/a

rx

Syntax 
rx
Context 
config>port>serial>rs232>socket
Description 

This command enables the context to configure parameters for data packets received over a serial port’s raw socket.

Default 

n/a

eop

Syntax 
eop
Context 
config>port>serial>rs232>socket>rx
Description 

This command enables the context to configure end of packet (EOP) parameters for data packets received over the raw socket.

Note:

An EOP will be declared by whichever EOP condition is encountered first.

idle-timeout

Syntax 
idle-timeout milliseconds
Context 
config>port>serial>rs232>socket>rx>eop
Description 

This command specifies how long a serial port can remain idle before an EOP is declared and the packet is sent over the raw socket.

Default 

50 ms

Parameters 
milliseconds—
the length of time, in milliseconds, that a serial port can remain idle before an EOP is declared
Values—
10 to 5000

 

length

Syntax 
length bytes
Context 
config>port>serial>rs232>socket>rx>eop
Description 

This command specifies the number of characters (converted to bytes) received on the serial port that triggers the node to encapsulate the characters in an IP transport packet and send it over a VPRN service.

Default 

1500

Parameters 
bytes—
the number of characters (in bytes) to trigger sending an IP transport packet
Values—
1 to 1500

 

special-char

Syntax 
special-char value
no special-char
Context 
config>port>serial>rs232>socket>rx>eop
Description 

This command specifies a special character that, if received on the serial port, declares EOP and triggers the node to encapsulate previously received queued characters in an IP transport packet and send it over a VPRN service.

Note:

Other than declaring the EOP, the special character is otherwise treated as regular data; that is, it is added to the packet.

The no form of the command disables checking for a special character.

Default 

no special-char

Parameters 
value—
specifies the special character, in a decimal or hexadecimal format, that triggers end of packet
Values—
0 to 255, or 0x00 to 0xFF

 

squelch-delay

Syntax 
squelch-delay seconds
no squelch-delay
Context 
config>port>serial>rs232>socket>rx
Description 

This command specifies how long a serial port can receive a continuous data stream before an alarm is raised indicating that the serial port has locked up and triggering the squelching function.

The no form of the command disables the squelching function on the serial port.

Default 

no squelch-delay

Parameters 
seconds—
the number of seconds that a serial port can receive data before the squelching function is triggered
Values—
1 to 120

 

squelch-reset

Syntax 
squelch-reset
Context 
config>port>serial>rs232>socket>rx
Description 

This command allows an operator to manually clear squelching on a serial port’s raw socket without having to configure a time limit on the squelching function.

Squelching can also be set to clear automatically after a time limit has been reached with the unsquelch-delay command.

Default 

n/a

unsquelch-delay

Syntax 
unsquelch-delay seconds
no unsquelch-delay
Context 
config>port>serial>rs232>socket>rx
Description 

This command clears squelching on a raw socket by setting a limit on the amount of time that squelching can remain active on the port. When the time limit is reached, the auto-clear function is enabled and the serial port’s raw socket is put back into a normal state.

Squelching can also be cleared manually with the squelch-reset command.

The no form of the command disables the auto-clear function on a serial port.

Default 

no unsquelch-delay

Parameters 
seconds—
the number of seconds before the auto-clear function is activated
Values—
1 to 120

 

tx

Syntax 
tx
Context 
config>port>serial>rs232>socket
Description 

This command enables the context to configure parameters for data packets transmitted over a serial port’s raw socket.

inter-session-delay

Syntax 
inter-session-delay milliseconds
Context 
config>port>serial>rs232>socket>tx
Description 

This command specifies a time delay that the node inserts between a session’s data that is being transmitted over a serial port and the next queued session’s data. The next session's data is not sent until the current session's data is sent and the inter-session-delay is reached.

Default 

10 ms

Parameters 
milliseconds—
the time delay, in milliseconds, between a session’s data that is being transmitted over a serial port and the next queued session’s data
Values—
0 to 5000

 

7.1.2.8. WLAN MDA radio configuration commands

wlan-radio

Syntax 
wlan-radio
Context 
config>card>mda
Description 

This command enables the context to configure WLAN radio commands.

Default 

n/a

bandwidth

Syntax 
bandwidth {20MHz | 40MHz}
Context 
config>card>mda>wlan-radio
Description 

This command sets the channel bandwidth of the WLAN radio.

Default 

20MHz

Parameters 
20MHz—
sets the channel bandwidth to 20 MHz
40MHz—
sets the channel bandwidth to 40 MHz

beacon-interval

Syntax 
beacon-interval milliseconds
Context 
config>card>mda>wlan-radio
Description 

This command sets the beacon interval for the WLAN radio. The interval is the frequency with which an AP broadcasts a packet in order to synchronize with the wireless network.

Default 

200

Parameters 
milliseconds—
the interval at which an AP broadcasts a packet that is used to synchronize with the wireless network
Values—
75 to 999

 

channel

Syntax 
channel {auto | channel-id}
Context 
config>card>mda>wlan-radio
Description 

This command sets the channel of the WLAN radio. The channel-id values that are available for this command depend on the configured country-code and frequency-band. See the Appendix for the available values.

When the WLAN radio channel is set to auto, the node scans the frequency bands supported by the configured county-code for the most appropriate channel.

To configure a WLAN station, the channel must be set to auto; otherwise, a network SSID cannot be configured. The channel cannot be changed from auto if a station already exists. The station network SSID must first be removed in order to change the channel setting from auto.

Default 

auto

Parameters 
auto—
specifies that the WLAN radio selects the most appropriate channel
channel-id
see the Appendix

country-code

Syntax 
[no] country-code country-string
Context 
config>card>mda>wlan-radio
Description 

This command configures the country code for the WLAN radio. Because the values configured for the channel and bandwidth commands depend on the country-code configuration, the country code must be configured before any other MDA parameters. The country-code must be configured in order to enable the radio; otherwise, executing a no shutdown command returns an error.

The no form of the command removes the specified country code from the WLAN radio and resets the MDA frequency-band, channel, and bandwidth commands to their default values. The no form can only be executed when the WLAN radio is shut down.

Default 

n/a

Parameters 
country-string—
the name of the country
Values—
australia, belgium, bolivia, brazil, canada, chile, colombia, france, germany, india, iran, italy, japan, malaysia, mexico, new-zealand, peru, russia, singapore, south-africa, usa, venezuela

 

frequency-band

Syntax 
frequency-band {2400 | 5000}
Context 
config>card>mda>wlan-radio
Description 

This command sets the frequency band for the WLAN radio.

Default 

2400

Parameters 
2400—
sets the frequency band to 2.4 GHz
5000—
sets the frequency band to 5.0 GHz

shutdown

Syntax 
[no] shutdown
Context 
config>card>mda
config>card>mda>wlan-radio
Description 

In the config>card>mda>wlan-radio context, this command shuts down the WLAN radio. When the radio is turned off, a configured AP or station becomes operationally down. The no form of this command enables the WLAN radio, and any configured WLAN ports that are operationally down can begin operating.

In the config>card>mda context, this command shuts down the WLAN MDA and puts the WLAN radio into reset mode. Any WLAN ports configured under the MDA become operationally down. The no form of this command brings the WLAN radio out of reset.

Default 

shutdown

7.1.2.9. WLAN port configuration commands

port

Syntax 
port port-id
Context 
config
Description 

This command configures a WLAN port. The WLAN port identifiers for the WLAN MDA are fixed and represent either the access point (AP) or the station, with the following configuration:

  1. port 1/4/1 is always AP 1
  2. port 1/4/4 is always station 1

WLAN ports 1/4/2 and 1/4/3 are not available.

Default 

n/a

Parameters 
port-id—
specifies the physical port ID in the format slot/mda/port, where the slot ID is always 1, the MDA is always 4, and the port ID is 1 or 4

description

Syntax 
description description-string
no description
Context 
config>port
Description 

This command creates a text description for a configuration context to help identify the content in the configuration file.

The no form of this command removes any description string from the context.

Default 

n/a

Parameters 
description-string—
description character string. Allowed values are any string up to 80 or 160 characters long (depending on the command) composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

shutdown

Syntax 
[no] shutdown
Context 
config>port
Description 

This command administratively disables the specified WLAN port. When disabled, no configurations can be changed or removed and no statistics can be reset. The operational state of the port is also disabled.

When the WLAN AP on the node is shut down, the following occurs.

  1. All WLAN clients connected to the AP are released.
  2. If the AP is configured as a SAP toward the WLAN gateway, the SAP and associated service become operationally down.

When the WLAN station on the node is shut down, the following occurs.

  1. The station disconnects from the AP.
  2. The station stops trying to connect to the network.

Issuing the no shutdown command enables the specified port when the WLAN MDA is also enabled; however, both ports cannot be enabled at the same time. The shutdown command must first be issued on the enabled port before the no shutdown command can be issued to enable the other port.

The no form of this command administratively enables the specified port.

Default 

shutdown

wlan

Syntax 
wlan
Context 
config>port
Description 

This command enables the context to configure WLAN port parameters.

Default 

n/a

access-point

Syntax 
access-point
Context 
config>port>wlan
Description 

This command enables the context to configure WLAN AP port parameters.

broadcast-ssid

Syntax 
[no] broadcast-ssid
Context 
config>port>wlan>access-point
Description 

This command enables the WLAN AP to broadcast the network SSID.

The no form of the command disables the broadcast of the network SSID.

Default 

no broadcast-ssid

client-limit

Syntax 
client-limit clients
Context 
config>port>wlan>access-point
Description 

This command configures the maximum number of clients that can connect to the WLAN AP concurrently.

Default 

24

Parameters 
clients—
the number of concurrent clients that can connect to the WLAN AP
Values—
1 to 24

 

client-timeout

Syntax 
client-timeout seconds
Context 
config>port>wlan>access-point
Description 

This command configures the timeout period for inactive clients. If a client does not send or receive data over the WLAN connection within the specified period, the client is disconnected from the WLAN AP.

Default 

300

Parameters 
seconds—
the length of time, in seconds, that the WLAN AP waits before disconnecting an inactive client
Values—
60 (1 minute) to 86400 (24 hours)

 

shutdown

Syntax 
[no] shutdown
Context 
config>port>wlan>access-point>dhcp
Description 

This command disables the DHCP relay function for the WLAN AP.

The no form of the command enables the DHCP relay function on the AP. When a DHCP request is received by a client trying to connect to the AP, the node inserts Option 82 with specific information needed to connect to the WLAN gateway. If an Option 82 sub-option is already present in the DHCP request, it is replaced with the version expected by the WLAN gateway.

Default 

shutdown

dot1x

Syntax 
dot1x
Context 
config>port>wlan>access-point
Description 

This command enables the context to configure dot1X parameters for the WLAN AP port.

radius-plcy

Syntax 
radius-plcy policy-name
no radius-plcy
Context 
config>port>wlan>access-point>dot1x
Description 

This command specifies a RADIUS policy for the WLAN AP to use when network WLAN security is set to wpa2-enterprise.

The RADIUS policy name must have already been configured under the config>system>security>dot1x context before executing this command. For information about configuring a RADIUS policy name, refer to the 7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide.

The no form of the command clears the RADIUS policy name from the WLAN AP.

Default 

n/a

Parameters 
policy-name—
the RADIUS policy to use for the WLAN AP

re-auth-period

Syntax 
re-auth-period seconds
Context 
config>port>wlan>access-point>dot1x
Description 

This command configures the reauthentication period when network LAN security for the WLAN AP is set to wpa2-enterprise. Clients that are connected to the WLAN AP must reauthenticate after the reauthentication period expires.

Default 

300

Parameters 
seconds—
the intervals at which clients that are connected to the WLAN AP must reauthenticate
Values—
1 to 9000

 

mode

Syntax 
mode {access | network}
Context 
config>port>wlan
Description 

This command sets the mode of a WLAN port to access or network. All WLAN ports can operate either as access ports or network ports. By default, WLAN port 1/4/1 operates in access mode and WLAN port 1/4/4 operates in network mode.

Default 

access for WLAN port 1/4/1, network for WLAN port 1/4/4

Parameters 
access—
sets the WLAN port mode to access
network—
sets the WLAN port mode to network

network

Syntax 
network network-id ssid ssid-name [create]
no network
Context 
config>port>wlan
Description 

This command configures the network identifier and the network service set identifier (SSID). The network SSID can be changed only when the WLAN port is shut down.

The SSID defines the name of the WLAN network. The WLAN AP port uses this name to allow WLAN clients to connect to its offered WLAN network. Operators can optionally configure security parameters for the configured network SSID.

The WLAN station port uses the network ID and associated SSID to connect to a remote AP. Only one network number and associated SSID can be configured for the WLAN station port. Operators can optionally configure security parameters for the specified network SSID.

The network ID is always 1.

The no form of this command removes the network and all the configurations within the network context.

Default 

n/a

Parameters 
network-id—
the network identifier, always 1
ssid-name—
a 32-character string that defines the SSID
create—
keyword used to create the network SSID

wlan-security

Syntax 
wlan-security [type {wpa2-psk | wpa2-enterprise}]
no wlan-security
Context 
config>port>wlan>network
Description 

This command configures the network security type for the specified WLAN interface.

When no security type is set, the WLAN interface is considered to be open. When the security type is set to wpa2-psk, the WPA2-PSK passphrase must be configured.

When the WLAN AP port is configured for WPA2-Enterprise security, operators must configure a RADIUS policy under the config>system>security>dot1x context in the CLI. For information about configuring a RADIUS policy in this context, refer to the 7450 ESS, 7750 SR, 7950 XRS, and VSR System Management Guide. The dot1x RADIUS policy ID used to configure the RADIUS policy is then configured on the WLAN AP port using the config>port>wlan>access-point> dot1x>radius-plcy command, in order to authenticate clients connecting to the WLAN AP.

When the WLAN station port is configured for WPA2-Enterprise security, operators must configure the authentication type as one of EAP-TTLS, EAP-FAST, or EAP-PEAP using the authentication command.

The no form of the command disables security and the WLAN interface is considered to be open.

Default 

no wlan-security

Parameters 
type —
keyword used to select the security type
wpa2-psk—
the WLAN interface uses WPA2-PSK security
wpa2-enterprise—
the WLAN interface uses WPA2-Enterprise security

wpa-encryption

Syntax 
wpa-encryption [tkip | aes]
no wpa-encryption
Context 
config>port>wlan>network>wlan-security
Description 

This command sets the WPA2 encryption type when network WLAN security is configured as either wpa2-psk or wpa2-enterprise.

When WLAN security is set to either wpa2-psk or wpa2-enterprise, the encryption type defaults to aes.

The no form of the command removes the configured encryption type.

Default 

aes

Parameters 
tkip —
sets the encryption type to TKIP
aes—
sets the encryption type to AES

wpa-passphrase

Syntax 
wpa-passphrase ascii-passphrase [hash | hash2]
no wpa-passphrase
Context 
config>port>wlan>network>wlan-security
Description 

This command configures the WPA2-PSK passphrase when network WLAN security is configured as wpa2-psk. The passphrase is a pre-shared alphanumeric string that is used to connect potential clients to the AP.

The no form of the command clears the passphrase. The default setting is the string passphrase.

Default 

passphrase

Parameters 
ascii-passphrase—
a 63-character alphanumeric string that identifies the passphrase to use for WPA2-PSK security
hash —
specifies that the hash key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the specified hash or hash2 parameter.
hash2—
specifies that the hash key is entered in a more complex, encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the specified hash or hash2 parameter.

station

Syntax 
station
Context 
config>port>wlan>network>wlan-security
Description 

This command enters the context to configure WLAN station port parameters.

Default 

n/a

authentication

Syntax 
authentication {eap-ttls | eap-fast | eap-peap}
no authentication
Context 
config>port>wlan>network>wlan-security>station
Description 

This command configures the type of network authentication to be used by the WLAN station when the wlan-security parameter is set to WPA2-enterprise.

Default 

none

Parameters 
eap-ttls—
sets the authentication type for the WLAN station to EAP-TTLS
eap-fast—
sets the authentication type for the WLAN station to EAP-FAST
eap-peap—
sets the authentication type for the WLAN station to EAP-PEAP

password

Syntax 
password password-string [hash | hash2]
no password
Context 
config>port>wlan>network>wlan-security>station
Description 

This command configures the password that the station uses to access the network when the authentication method requires a password.

Default 

n/a

Parameters 
password-string—
the password to be authenticated
hash —
specifies that the hash key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the specified hash or hash2 parameter.
hash2—
specifies that the hash key is entered in a more complex, encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the specified hash or hash2 parameter.

username

Syntax 
username username-string
no username
Context 
config>port>wlan>network>wlan-security>station
Description 

This command configures the name that the station uses to access the network when the authentication method requires a user name.

Default 

n/a

Parameters 
username-string—
the user name to be authenticated, up to 64 characters

7.2. Show, clear, and tools commands

Note:

The commands described in this section apply specifically to 7705 SAR-Hm series nodes. All other applicable commands supported on the nodes are described in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Classic CLI Command Reference Guide and the 7450 ESS, 7750 SR, 7950 XRS, and VSR Clear, Monitor, Show, and Tools Command Reference Guide.

7.2.1. Command hierarchies

7.2.1.1. Show commands

7.2.1.1.1. Cellular MDA commands

show
mda port-id [detail]

7.2.1.1.2. Cellular port commands

show
port port-id [detail]

7.2.1.1.3. GNSS receiver commands

show
mda 1/1
gnss

7.2.1.1.4. Serial and raw socket commands

show
port 1/3/1

7.2.1.1.5. WLAN radio commands

show
mda 1/4 [detail]
port port-id [statistics] [detail]

7.2.1.2. Clear commands

7.2.1.2.1. Cellular port commands

clear
port port-id statistics

7.2.1.2.2. Socket statistics commands

clear
port 1/3/1 statistics

7.2.1.2.3. WLAN statistics commands

clear
port port-id statistics

7.2.1.3. Tools commands

7.2.1.3.1. Tools ADP commands

tools
auto-discovery {complete | retry | terminate}

7.2.1.3.2. Tools perform commands

tools
— perform
— mda 1/1
— cellular
at-command at-command
— sim {1 | 2}
update-firmware firmware-file
update-firmware firmware-file sim 1 | 2
tools
— perform
— port 1/1/{1 | 2}
— cellular
— cbsd-authorization
reset

7.2.1.3.3. Tools dump command

tools
— dump
— port 1/1/{1 | 2}
— cellular

7.2.2. Command descriptions

7.2.2.1. Show commands

Note:

The command outputs shown in this section are examples only; actual displays may differ depending on supported functionality and user configuration.

7.2.2.1.1. Show cellular MDA commands

mda

Syntax 
mda mda-id [detail]
Context 
show
Description 

This command displays information about the cellular MDA.

Parameters 
mda-id—
the identifier for the cellular MDA
Values—
1/1

 

Output 

The following output is an example of cellular MDA information.

Output Example
A:Dut-E# show mda 1/1 detail 
===============================================================================
MDA 1/1 detail
===============================================================================
Slot  Mda   Provisioned Type                            Admin     Operational
                Equipped Type (if different)            State     State
-------------------------------------------------------------------------------
1     1     i2-cellular                                 up        up
MDA Specific Data
    Maximum port/connector count  : 2
    Num ports/connectors equipped : 2
    Capabilities                  : Wireless, Cellular
    Fail On Error                 : Disabled
Hardware Data
    Platform type                 : 7705
    Part number                   : 3HE12472AA010104
    CLEI code                     : INM7H00CRA
    Serial number                 : NS190310019
    Manufacture date              : 01242019
    Manufacturing deviations      : (Not Specified)
    Manufacturing assembly number : 
    Administrative state          : up
    Operational state             : up
    Temperature                   : 40C
    Temperature threshold         : 89C
    Software boot (rom) version   : (Not Specified)
    Software version              : (Not Specified)
    Time of last boot             : 2020/10/18 14:13:30
    Current alarm state           : alarm cleared
    Base MAC address              : 1c:ea:1b:db:27:f1
    Firmware version              : CAT4_GS_BYPASS_0.3.3.9_ATT_V1.12
Cellular MDA Information
   Specified Firmware            : CAT4_GS_BYPASS_0.3.3.9_ATT_V1.12
    Configured active SIM card    : SIM 1
    Actual active SIM card        : SIM 1
    Automatic SIM switch status   : N/A
    No service reset interval     : disabled
    No service reset status       : N/A
    Maximum transmit power        : 10 dBm
===============================================================================

7.2.2.1.2. Show cellular port commands

port

Syntax 
port port-id [detail]
Context 
show
Description 

This command displays operational state information for a cellular port, including information for the cellular PDN interface, the installed SIM, and the packet data network (PDN). It also displays port statistics.

The CBSD information is available only for the 7705 SAR-Hmc NA (3HE12472AA) and the 7705 SAR-Hmc NA variant 2 (3HE12473AA) when the PDN router interface is configured to operate as a CBSD.

Parameters 
port-id—
the identifier for the cellular port
Values—
1/1/1 or 1/1/2

 

Output 

The following output is an example of cellular interface information.

Output Example
*A:Dut-A# show port 1/1/1 detail
===============================================================================
Cellular PDN Interface
===============================================================================
Description       : Cellular
Interface         : 1/1/1                IfIndex           : 35684352
Admin State       : up                   Oper State        : up
State Change Count: 1                    
IMEI              : 35-241842-015157-1
Sync System Time  : Disabled
Network Status    : registered-home      Radio Mode        : lte
Band              : 48                   Channel           : 55990
RSSI              : >= -51 dBm           RSRP              : -52 dBm
RSRQ              : >= -3 dB             SINR              : +30.0 dB
Tracking Area Code: 0001                 Cell Identity     : 01a2d001
-------------------------------------------------------------------------------
SIM Card 1
-------------------------------------------------------------------------------
Description       : (Not Specified)
Specified Firmware: GENERIC 01.14.03.00 002.036_001
Equipped          : yes
Locked            : no                   PIN status        : ready
PIN retries left  : 3                    PUK retries left  : 10
ICCID             : 8988211000000484017  IMSI              : 001001000048401
-------------------------------------------------------------------------------
Packet Data Network
-------------------------------------------------------------------------------
PDN Profile       : 1                    Protocol          : IPv4
Configured APN    : internet
PDN State         : connected
IP Address        : 10.30.28.11
Primary DNS       : 8.8.8.8
Secondary DNS     : 8.8.4.4
IP MTU            : 1500                 
APN               : internet
-------------------------------------------------------------------------------
CBSD
-------------------------------------------------------------------------------
Admin State             : enabled
Oper State              : up
User ID                 : V8User5
Antenna Gain            : 7 dBm
Category                : A
Client TLS              : sas_harness_client_tls_profile
Primary SAS Server      : https://10.0.4.102:8080/v1.2
Secondary SAS Server    : 
SAS Server in Use       : primary
SAS Server IP           : 10.0.4.102
FCC ID                  : AS57705SARHMC-2A
CBSD ID                 : 1004
Grant ID                : 2006
Registration State      : registered
Grant State             : authorized
Grant Expiry Time       : 2022/09/18 05:03:30 UTC
Tx Expiry Time          : 2022/09/17 05:03:31 UTC
Heartbeat Interval      : 60 seconds
Channel Type            : pal
-------------------------------------------------------------------------------
CBSD Statistics
-------------------------------------------------------------------------------
Type                Requests            Successes           Failures
-------------------------------------------------------------------------------
Registration        1                   1                   0
Grant               1                   1                   0
Heartbeat           1                   1                   0
-------------------------------------------------------------------------------
===============================================================================
==================================================================
Bearer Information
==================================================================
Bearer Id   Bearer Type   QCI   UL GBR   UL MBR   DL GBR   DL MBR
------------------------------------------------------------------
        5       default     9                                    
==================================================================
===============================================================================
Port Statistics
===============================================================================
                                                   Input                 Output
-------------------------------------------------------------------------------
Packets                                               81                     99
Discards                                               0                      0
Unknown Proto Discards                                 0 
===============================================================================
 
A:Dut-A# 

7.2.2.1.3. Show GNSS receiver commands

gnss

Syntax 
gnss
Context 
show>mda
Description 

This command displays detailed GNSS information, including position and satellite information.

If a GNSS fix is acquired and then subsequently lost by the node, the last known GNSS fix data continues to be displayed in the CLI. When a GNSS fix is re-acquired, the GNSS data will then update to match the new fix.

The last GNSS fix data is not preserved after a power-cycle, admin reboot, clear mda 1/1, or shutdown command is issued for GNSS.

Output 

The following output is an example of GNSS information.

Output Example
*A:Dut-A#: show mda 1/1 gnss 
===============================================================================
GNSS Information
===============================================================================
Admin State                        : Enabled
Oper State                         : Up
Satellite  Constellation           : gps-glonass
NMEA Sentence Streaming            : Enabled
  Sentences                        : gga rmc vtg gns  
  Sentence Interval (seconds)      : 5
-------------------------------------------------------------------------------
Acquired Fix                       : Yes
Time                               : 2018/07/27 12:59:47 UTC
Position (degrees)                 : 45.34810, -75.92147
Position (degrees minutes seconds) : 45 20'53.1"N, 75 55'17.2"W
Altitude above mean sea level      : 124.8 meters
Heading                            : 0.0 degrees
Speed                              : 0.0 kph
===============================================================================
 
==========================================
Visible Satellites
==========================================
   #    type  elevation  azimuth  SNR(dB)
------------------------------------------
   1     gps         22      158       43
   7     gps         73      229       53
   8     gps         64       54       57
   9     gps          8      209       44
  11     gps         48      165       49
  13     gps          9      324       40
  16     gps          2       90       40
  18     gps         38      135       54
  27     gps         27       50       49
  28     gps         29      284       46
  30     gps         52      296       51
  69 glonass          7      302       31
  70 glonass          4      352       43
  77 glonass         49      113       44
  78 glonass         68      343       53
  79 glonass         28      316       47
  81 glonass         18      199       42
  86 glonass          0       28       45
  87 glonass         54       43       44
  88 glonass         66      177       43
------------------------------------------
No. of visible satellites: 20
==========================================
*A:Dut-A#

7.2.2.1.4. Show serial and raw socket commands

port

Syntax 
port 1/3/1
Context 
show
Description 

This command displays serial and raw socket information.

Output 

The following output is an example of serial and raw socket information.

Output Example
*A:Dut# show port 1/3/1
===============================================================================
Serial RS-232 Interface
===============================================================================
Description        : RS-232 Serial
Interface          : 1/3/1                   Port IfIndex         : 39878656
Admin Status       : down                    Oper Status          : down
Physical Link      : no                      Mode                 : access
Device Mode        : asynchronous            Speed                : 9600
Character Length   : 8                       Parity               : none
Stop Bits          : 1
Device Gender      : dce                     Duplex               : full
Last State Change  : 07/17/2017 17:20:13
Loopback           : none
Hold time up       : 0 milliseconds
Hold time down     : 0 milliseconds
=============================================
Serial Control Leads
=============================================
Inputs          Cfg         Netw  Line  Mon
---------------------------------------------
dtr-dsr [DTR] : high              0     off
rts-dcd [RTS] : high              0     off
Outputs         Cfg         Netw  Line
---------------------------------------------
dcd-rts [DCD] : high              1
cts-alb [CTS] : high              1
ri-rdl  [RI]  : high              1
===============================================================================
===============================================================================
Serial Socket
===============================================================================
EOP Length         : 1500                    Squelch Delay        : Disabled
EOP Idle Timeout   : 50                      Unsquelch Delay      : Disabled
EOP Special Char   : Disabled                Inter-Session Delay  : 10
Squelch Status     : off
===============================================================================
=============================================================
Socket Statistics
=============================================================
                                                       Count
-------------------------------------------------------------
Characters received                                        0
Characters transmitted                                     0
End of packet idle timeout                                 0
End of packet length                                       0
End of packet special character                            0
Ingress forwarded packets                                  0
Egress forwarded packets                                   0
Ingress dropped packets                                    0
Egress dropped packets                                     0
Squelch activated                                          0
=============================================================
*A:Dut#

7.2.2.1.5. Show WLAN radio commands

mda

Syntax 
mda 1/4 [detail]
Context 
show
Description 

This command displays WLAN radio MDA information.

Output 

The following output is an example of WLAN radio MDA information.

Output Example
*A:Dut# show mda 1/4 detail
===============================================================================
WLAN Radio Data
===============================================================================
    Radio                         : 1
    Type                          : Wifi Dualband 2.4/5.0 GHz
    Administrative state          : up
    Operational state             : up
    Country                       : canada
    Beacon Interval               : 200 msecs
    Cfg.  Band/Channel/Width      : 2400 MHz/Ch.1/20 MHz
    Oper. Band/Channel/Width      : 2400 MHz/Ch.1/20 MHz
    Oper. Center Frequency        : 2412 MHz
=============================================================
*A:Dut#

port

Syntax 
port port-id [statistics] [detail]
Context 
show
Description 

This command displays WLAN radio port statistics and RADIUS configuration information.

Parameters 
port-id—
specifies the physical port identifier in the format slot/mda/port, where slot is always 1, mda is always 4, and port is 1 or 4
statistics—
shows ingress and egress statistics for the port
detail—
shows detailed information about the WLAN port
Output 

The following output is an example of WLAN radio port information.

Output Example
*A:Dut# show port 1/4/1
===============================================================================
Wireless LAN Interface
===============================================================================
Description        : Wireless LAN
Interface          : 1/4/1                   Port IfIndex         : 41975808
Admin Status       : up                      Oper Status          : up
Oper Flags         :                         
Last State Change  : 05/14/2021 08:52:32     
 
Hardware Address   : cc:66:b2:0a:dd:05       
 
Mode               : WLAN Access Point       
 
-------------------------------------------------------------------------------
RF Interface
-------------------------------------------------------------------------------
Frequency          : 2437 MHz                
Band/Channel       : 2400 MHz/Ch.6           Channel Width        : 20 MHz
 
-------------------------------------------------------------------------------
Network Parameters
-------------------------------------------------------------------------------
SSID               : kansarhmrtb5
Security           : wpa2-psk                
Passphrase         : **********
Encryption         : aes                     
 
 
SSID Broadcast     : enabled                 
Client Idle Timeout: 300 secs                Client Limit         : 24
DHCP Relay         : disabled                DHCP Action          : replace
Auth Radius Policy : N/A
  Re-Auth Period   : 3600 secs               
 
-------------------------------------------------------------------------------
Connected Clients
-------------------------------------------------------------------------------
Client             Authorized                          Connect Time
-------------------------------------------------------------------------------
00:23:a7:f0:8f:8b  Yes                                 05/14/2021 08:54:35
-------------------------------------------------------------------------------
Count: 1 (Limit: 24)
-------------------------------------------------------------------------------
 
===============================================================================
=============================================================
Access Point Statistics
=============================================================
                                                       Count
-------------------------------------------------------------
Client attaches                                            1
Client detaches                                            0
Successful authentications                                 1
Failed authentications                                     0
=============================================================
===============================================================================
Port Statistics
===============================================================================
                                                   Input                 Output
-------------------------------------------------------------------------------
Packets                                                2                      2
Discards                                               0                      0
Unknown Proto Discards                                 0 
===============================================================================
A:Dut-A>config>port# show port 1/4/4 
===============================================================================
Wireless LAN Interface
===============================================================================
Description        : Wireless LAN
Interface          : 1/4/4                   Port IfIndex         : 42074112
Admin Status       : up                      Oper Status          : up
Oper Flags         :                         
Last State Change  : 05/14/2021 08:54:36     
 
Hardware Address   : cc:66:b2:0a:da:1a       
 
Mode               : WLAN Station            
 
-------------------------------------------------------------------------------
RF Interface
-------------------------------------------------------------------------------
Frequency          : 2437 MHz                
Band/Channel       : 2400 MHz/Ch.6           Channel Width        : 20 MHz
 
-------------------------------------------------------------------------------
Network Parameters
-------------------------------------------------------------------------------
SSID               : kansarhmrtb5
Security           : wpa2-psk                
Passphrase         : **********
Encryption         : aes                     
Connected          : yes                     
Connection Time    : 2021/05/14 08:54:36     Duration             : 0d 00:00:43
BSSID              : 00:23:a7:f0:8f:10       Channel Number       : 6
Rx Signal Level    : -43 dBm                 Frequency            : 2437 MHz
 
===============================================================================
===============================================================================
Port Statistics
===============================================================================
                                                   Input                 Output
-------------------------------------------------------------------------------
Packets                                                2                      2
Discards                                               0                      0
Unknown Proto Discards                                 0 
===============================================================================

7.2.2.2. Clear commands

7.2.2.2.1. Clear cellular port commands

port

Syntax 
port port-id statistics
Context 
clear
Description 

This command clears statistical information for a cellular interface port.

Parameters 
port-id—
specifies the cellular port, from 1/1/1 to 1/1/2
statistics—
clears statistical information

7.2.2.2.2. Clear raw socket statistics commands

port

Syntax 
port 1/3/1 statistics
Context 
clear
Description 

This command clears raw socket statistical information for a serial port.

Parameters 
statistics—
clears statistical information

7.2.2.2.3. Clear WLAN statistics commands

port

Syntax 
port port-id statistics
Context 
clear
Description 

This command clears WLAN statistical information for a WLAN port.

Parameters 
port-id—
the WLAN port identifier
Values—
1/4/1 or 1/4/4

 

statistics—
clears statistical information

7.2.2.3. Tools commands

7.2.2.3.1. Tools ADP commands

auto-discovery

Syntax 
auto-discovery {complete | retry | terminate}
Context 
tools
Description 

This command is used to configure the status of the ADP-Hm process running on the node.

Parameters 
complete—
specifies that the ADP-Hm process is complete
retry—
specifies that the ADP-Hm process is being retried
terminate—
specifies that the ADP-Hm process has been terminated

7.2.2.3.2. Tools perform commands

at-command

Syntax 
at-command at-command
Context 
tools>perform>mda>cellular
Description 

This command executes an ATtention (AT) command on the cellular port. AT commands are instruction commands that are used to control a modem. The commands are issued to the modem, and responses to the commands from the modem are displayed directly on the CLI console.

These commands can also be used to view operational information about the cellular port.

Warning:

Risk of service outage. Do not change any at-command settings.

Note:

.

  1. The commands are reserved for use by Nokia personnel only.
  2. Some commands may take up to several minutes to complete.
Parameters 
at-command—
a supported AT command
Values—
up to 256 characters; must be preceded by the string “at”

 

force-sim-switch

Syntax 
force-sim-switch
Context 
tools>perform>mda>cellular
Description 

This command manually forces a SIM activity switch. This command is used in a dual SIM deployment when the active-sim command is set to auto.

update-firmware

Syntax 
update-firmware firmware-file
update-firmware firmware-file sim 1 | 2
Context 
tools>perform>mda>cellular
Description 

This command preloads the correct firmware onto the cellular modem when specific firmware is needed to attach to a cellular network.

The 7705 SAR-Hm supports the update-firmware firmware-file sim 1 | 2 command. The command updates the firmware for the specified SIM. This form of command is supported only on the 7705 SAR-Hm, and specifying either sim 1 or sim 2 is mandatory. The firmware is updated only after the system reboots. When the command is executed, a prompt appears asking the operator whether to proceed with a reboot in order to update the firmware. Entering y at the prompt reboots the system immediately and the firmware is updated. Entering n at the prompt postpones the reboot and the firmware is updated the next time the system is rebooted.

For the 7705 SAR-Hm, in a dual SIM deployment, to update the firmware on both SIMs at the same time, the operator must execute the update-firmware command for the first SIM and enter n at the reboot prompt. The operator must then execute the update-firmware command for the second SIM and enter y at the reboot prompt in order to proceed with a system reboot. The firmware for both SIMs is updated when the reboot is complete. If the operator enters n at the second reboot prompt, the reboot is postponed and the firmware for both SIMs is updated the next time the system is rebooted.

The command can be executed on the SIMs in either order, SIM 1 first or SIM 2 first.

The firmware for both SIMs can be updated individually, but this requires the system to be rebooted twice.

If the update-firmware command is executed multiple times for the same SIM but with different firmware files and no reboot occurs at the time the command is executed, when a system reboot does occur, the firmware is updated with the last firmware file specified in the command.

The 7705 SAR-Hmc supports the update-firmware firmware-file command.

The firmware that is bundled with SR OS is considered the default firmware for the radio module on the 7705 SAR-Hmc. If the update-firmware command is not used, the radio module uses the default firmware and system upgrades to a newer version of SR OS will automatically use the firmware version that is bundled in SR OS. If the update-firmware command is used, the radio module uses the version of firmware specified in the command and when the system upgrades to a newer version of SR OS, the radio module continues using the version of firmware specified in the command and ignores the bundled version of firmware in SR OS.

The update-firmware command is used to specify the version of firmware that will be used by the radio module on both SIMs (the firmware cannot be updated per SIM). The command overwrites the firmware currently used by the radio module, which can be the default firmware automatically loaded by SR OS or another specified version of firmware. When the system is rebooted, this updated firmware is used by the radio module.

To return to the default firmware, the operator must execute the update-firmware command using “default” as the specified firmware file. Using “default” informs the system that the current version of firmware must be discarded and replaced with the firmware version that is bundled with SR OS.

When this command is executed, a prompt appears asking the operator whether to proceed with a reboot in order to update the firmware. Entering y at the prompt reboots the system immediately and the firmware is updated. Entering n at the prompt postpones the reboot and the firmware is updated the next time the system is rebooted.

Parameters 
firmware-file—
specifies a cellular radio firmware file located on the cf3: file system. If “default” is specified, the firmware is updated to use the bundled version of firmware in SR OS.

change-pin

Syntax 
change-pin
Context 
tools>perform>mda>cellular>sim
Description 

This command launches an interactive CLI session to change the PIN on the SIM.

Note:

  1. Ensure that the specified SIM is the currently active SIM.
  2. It is not possible to change the PIN on a SIM unless the SIM is locked. See the lock-sim command.

When a SIM is procured from a carrier, the SIM PIN is set to a default value. When this command is issued, the CLI prompts the user to enter the current PIN once and then correctly enter the new PIN twice in order to change it.

Warning:

  1. When an operator successfully locks a SIM, unblocks a SIM, or changes a SIM PIN, the system updates the PIN value in the system configuration. However, the system does not automatically save the system configuration containing the new PIN. The operator must perform an admin>save command immediately after changing the PIN in order to save the new PIN in the system configuration file and avoid potential service interruptions such as the node becoming unreachable.
  2. If the SIM becomes blocked when setting the PIN remotely using in-band management over a cellular port, the node will be unreachable. Physical access to the node will be required to unblock the SIM.

lock-sim

Syntax 
lock-sim
Context 
tools>perform>mda>cellular>sim
Description 

This command enables the PIN verification function on the SIM and locks the SIM. When locked, the SIM can only be accessed if the operator enters the PIN stored in the configuration file.

Note:

Ensure that the specified SIM is the currently active SIM.

When this command is issued, the CLI prompts the user to enter the current PIN in order to lock the SIM.

Warning:

  1. When an operator successfully locks a SIM, unblocks a SIM, or changes a SIM PIN, the system updates the PIN value in the system configuration. However, the system does not automatically save the system configuration containing the new PIN. The operator must perform an admin>save command immediately after changing the PIN in order to save the new PIN in the system configuration file and avoid potential service interruptions such as the node becoming unreachable.
  2. If the SIM becomes blocked when setting the PIN remotely using in-band management over a cellular port, the node will be unreachable. Physical access to the node will be required to unblock the SIM.

unblock-sim

Syntax 
unblock-sim
Context 
tools>perform>mda>cellular>sim
Description 

This command unblocks a SIM that is currently blocked as a result of too many attempts being made to access the SIM using an incorrect PIN.

Note:

Ensure that the specified SIM is the currently active SIM.

When this command is issued, the CLI prompts the user to enter the personal unblocking key (PUK) for the SIM and then enter a new PIN value twice. The PUK is acquired from the service provider or administrator and is also stored on the SIM. The lock/unlock state of the SIM does not change when it becomes unblocked.

Warning:

  1. When an operator successfully locks a SIM, unblocks a SIM, or changes a SIM PIN, the system updates the PIN value in the system configuration. However, the system does not automatically save the system configuration containing the new PIN. The operator must perform an admin>save command immediately after changing the PIN in order to save the new PIN in the system configuration file and avoid potential service interruptions such as the node becoming unreachable.
  2. If the SIM becomes blocked when setting the PIN remotely using in-band management over a cellular port, the node will be unreachable. Physical access to the node will be required to unblock the SIM.

unlock-sim

Syntax 
unlock-sim
Context 
tools>perform>mda>cellular>sim
Description 

This command disables the PIN verification function on the SIM and unlocks the SIM. When unlocked, the PIN is not required in order to access the SIM.

Note:

Ensure that the specified SIM is the currently active SIM.

When this command is issued, the CLI prompts the user to enter the current PIN in order to unlock the SIM.

reset

Syntax 
reset
Context 
tools>perform>port>cellular>cbsd-authorization
Description 

This command resets the CBSD authorization process so that it restarts from the beginning.

7.2.2.3.3. Tools dump command

cbsd-authorization

Syntax 
cbsd-authorization
Context 
tools>dump>port>cellular
Description 

This command shows detailed information about the CBSD authorization process by displaying the contents of the following messages:

  1. last received registration response
  2. last received grant request response
  3. last received heartbeat response
  4. last transmitted grant request