Configuration command descriptions

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 (#, $, or spaces), the entire string must be enclosed within double quotes.

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

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

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.

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 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.

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

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, see the SAR-Hm and SAR-Hmc Chassis Installation Guide.

Default

1

Parameters

power-level

the B125 antenna power level

Values

1 to 20

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 or the length of time in which a BGP session must be established on the node 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 or a BGP session has not been established on the node based on the configured down-recovery-criteria value within the specified length of time, the node resets.

Before 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-criteria and the state of the cellular MDA or the BGP sessions on the node are 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

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 options 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 configured on the node 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 are down.

Both port and bgp can be set concurrently.

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

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, see 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)

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.

Default

1

Parameters

1

sets the preferred SIM to SIM 1

2

sets the preferred SIM to SIM 2

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

Context

config>card>mda>cellular>sim

Description

This command specifies a list of cellular bands that the cellular interface uses when searching for a cellular network to attach to. The list is configured per SIM. A band list can be configured for one or both SIMs in a dual SIM deployment and they can be different.

The bands that are available depend on the MDA variant on which the list is being configured; see the 7705 SAR-Hm and SAR-Hmc Software Release Notes for information.

A band list is considered invalid and will be rejected by the CLI if it contains more than the maximum number of bands allowed or if any band in the list is not supported by the MDA.

If the list contains bands that are not supported by the firmware for a specific carrier, the node will use only the bands that are supported by the firmware. For example, if the firmware supports bands B2, B5, B7, B13, and B66 but the band-list is configured with bands B2, B42, B48, and B71, the node will only allow B2 to be configured on the MDA because it is the only band on the list that is supported by the firmware.

If none of the bands on the list are supported by the firmware, the node ignores the configured band-list and reverts to enabling all bands on the MDA that are supported by the firmware. Enabling all supported bands ensures that the node can connect to the network if further actions are required to manage the node.

In a dual SIM deployment, a SIM switchover causes the MDA to reset, which enables the band list on the newly active SIM.

Up to three LTE bands and one 3G band can be included on the band list. The no form of the command removes the list from the SIM.

Default

no band-list

Parameters

band-num

the band number to be added to the list, up to three LTE bands and one 3G band

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.

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

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.

If the operational status of all BGP sessions remain down for the failure-duration interval, 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

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.

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

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

Context

config>card>mda>cellular>sim>failover-criteria

Description

This command enables the RSSI threshold as a failover criterion for the specified SIM in a dual SIM deployment.

When the rssi-threshold command under the config>card>mda>cellular>sim context is enabled, if the RSSI signal level falls below the configured value for the RSSI threshold for the failure-duration time, the node performs an automatic switchover from the currently active SIM to the other SIM.

The no form of the command disables the RSSI threshold from being used as a failover criterion.

Default

no rssi-threshold

Context

config>card>mda>cellular>sim

Description

This command sets the length of time that the node waits before raising or clearing an RSSI system alarm on the specified SIM.

If the RSSI signal level falls below the configured rssi-threshold value for the specified wait time, an alarm is raised. The alarm is raised only once, even if the RSSI signal level remains below the configured threshold indefinitely. After the alarm is raised, if the RSSI signal level rises to the configured rssi-threshold value or higher and remains at that level for the duration of the specified alarm wait time, the alarm is cleared.

The RSSI alarm wait time cannot be unset; the wait time always has a value.

Default

60 s

Parameters

wait-time

the length of time that the RSSI signal must be below or above the configured rssi-threshold before an alarm is raised or cleared

Values

1 s to 300 s

Context

config>card>mda>cellular>sim

Description

This command sets the RSSI threshold value.

If the RSSI signal level falls below this threshold for the duration of the rssi-alarm-wait-time, an alarm is raised. If the RSSI signal level then rises to or above the threshold value and remains at that level for the duration of the rssi-alarm-wait-time, the alarm is cleared.

The no form of the command removes the RSSI threshold value.

Default

no rssi-threshold

Parameters

rx-power

the RSSI threshold value

Values

-113 dBm to -51 dBm

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

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

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

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. See 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

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

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

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

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

Context

config>port>cellular

Description

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

Default

n/a

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

Context

config>port>cellular

config>card>mda>gnss

Description

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

The cellular interface and the GNSS receiver can be configured concurrently to obtain the system time. When the sync-system-time command is enabled concurrently on the cellular interface and on the GNSS receiver, the GNSS receiver takes priority when it establishes a lock.

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

Default

no sync-system-time

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

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

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

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 form 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

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 about the PDN router interface modes, see "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

Context

config>system>cellular>pdn-profile

Description

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

The no form of this command removes the username.

Default

n/a

Parameters

user-name

a character string up to a maximum of 255 characters

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

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

Context

config>card>mda>gnss

Description

This command enables the context for configuring NMEA parameters.

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, see 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.

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

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, see "GNSS NMEA data IP transport service" in the 7705 SAR-Hm and SAR-Hmc Main Configuration Guide.

Default

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:

• when the configuration of the constellation command changes

• 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

Context

config>port

Description

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

Default

n/a

Context

config>port>serial

Description

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

Default

n/a

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

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

Context

config>port>serial>rs232>control-lead

Description

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

Default

n/a

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

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

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

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

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

Context

config>port>serial>rs232>control-lead

Description

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

Default

n/a

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

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

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

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. When 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)

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

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

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

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

Context

config>card>mda

Description

This command enables the context to configure WLAN radio commands.

Default

n/a

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

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

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 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 for the most appropriate channel.

Default

auto

Parameters

auto

specifies that the WLAN radio selects the most appropriate channel

channel-id

see the Appendix

Context

config>card>mda>wlan-radio

Description

This command configures the country name for the WLAN radio. Because the values configured for the channel and bandwidth commands depend on the country configuration, the country name must be configured before any other MDA parameters. The country name 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 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

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

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

Context

config

Description

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

• port 1/4/1 is always AP 1

• port 1/4/2 is always AP 2

• port 1/4/3 is always AP 3

• port 1/4/4 is always station 1

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 to 4

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 (#, $,or spaces), the entire string must be enclosed within double quotes.

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 a WLAN AP on the node is shut down, the following occurs.

• All WLAN clients connected to the AP are released.

• 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.

• The station disconnects from the AP it was connected to.

• The station stops trying to connect to the networks in its network list.

• If any WLAN APs are configured on the node and they are not shut down, they will stay up and continue using the channel that was in use before the shutdown of the station.

Issuing the no shutdown command enables the specified port when the WLAN MDA is also enabled.

When the WLAN station port is enabled, the following occurs.

• The WLAN APs on the node that were operationally up go down and only come back up when the station connects to a remote AP. The channel selected by the station is then used by the WLAN APs.

• The station scans for an available network from its list of candidate networks.

• When it connects to a valid network, the AP on the node will also use the channel that was used to connect the station (when the channel command is set to auto).

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

Default

shutdown

Context

config>port

Description

This command enables the context to configure WLAN port parameters.

Default

n/a

Context

config>port>wlan

Description

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

Context

config>port>wlan>access-point

Description

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

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

Default

no broadcast-ssid

Context

config>port>wlan>access-point

Description

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

Default

24

Parameters

clients

the number of concurrent clients that can connect to a WLAN AP

Values

1 to 24

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 a WLAN AP waits before disconnecting an inactive client

Values

60 (1 minute) to 86400 (24 hours)

Context

config>port>wlan>access-point>dhcp

Description

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

The no form of the command enables the DHCP relay function on an 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

Context

config>port>wlan>access-point

Description

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

Context

config>port>wlan>access-point>dot1x

Description

This command specifies a RADIUS policy for a 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, see 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 a WLAN AP port.

Default

n/a

Parameters

policy-name

the RADIUS policy to use for a WLAN AP

Context

config>port>wlan>access-point>dot1x

Description

This command configures the reauthentication period when network LAN security for a 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 a WLAN AP must reauthenticate

Values

1 to 9000

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 ports 1/4/1 to 1/4/3 operate in access mode and WLAN port 1/4/4 operates in network mode.

Default

access for WLAN ports 1/4/1 to 1/4/3, network for WLAN port 1/4/4

Parameters

access

sets the WLAN port mode to access

network

sets the WLAN port mode to 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 ports use this name to allow WLAN clients to connect to their offered WLAN network.

The WLAN station port uses the network ID and associated SSID to connect to a remote AP. Up to 10 network numbers and associated SSID can be configured for the WLAN station port; however, only one network can be active and connected to the station at a time.

Operators must configure security parameters for each network SSID specified.

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, from 1 to 10

ssid-name

a 32-character string that defines the SSID

create

keyword used to create the network SSID

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 a 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, see 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

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

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 an AP on the node.

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.

Context

config>port>wlan>network>wlan-security

Description

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

Default

n/a

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

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.

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 username.

Default

n/a

Parameters

username-string

the username to be authenticated, up to 64 characters