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

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

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

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

band-list

Syntax

band-list band-num [band-num...(up to 4 max)]

no band-list

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

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

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.

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

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

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

rssi-threshold

Syntax

[no] rssi-threshold

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

rssi-alarm-wait-time

Syntax

rssi-alarm-wait-time wait-time

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

rssi-threshold

Syntax

rssi-threshold rx-power

no rssi-threshold

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

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

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

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.

Note:

If NTP or SNTP is configured when the sync-system-time command is enabled, there is no time source precedence and either process can update the system time at its own discretion. Do not enable NTP or SNTP when the sync-system-time command is enabled unless NTP (or SNTP) and the cellular interface or GNSS receiver are using the same time source.

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

Default

no sync-system-time