Cisco Service module and network interface modules

The router supports Cisco Services modules and Cisco network interface modules. The modules are inserted into the router using an adapter, or carrier card, into various slots. For more information, see the documents:

Cisco service modules and network interface modules

The module management facility is an integrated feature in Cisco routers that centralizes the configuration, management, and control of various supported modules. The key points are:

  • The router uses a built-in module management facility to configure, manage, and monitor all supported Cisco Service Modules, Network Interface Modules, and Pluggable Interface Modules, providing a unified approach regardless of module type or application.

  • All Cisco Enhanced Service and Network Interface Modules communicate with the host router using standard IP protocols, ensuring interoperability and consistent management.

  • Cisco IOS software utilizes alien data path integration to efficiently switch data between the different modules and the host router.

  • For a list of supported modules, see .

  • For details about network interface modules, see .

Network interface and enhanced service modules

For more information about the supported Network Interface Modules and Service Modules, refer to the Cisco Catalyst 8300 Series Edge Platforms datasheet.

Implement SMs and NIMs on your platforms

Module firmware process

Module firmware refers to the specialized software that must be loaded onto a router’s service module to enable its intended functionality. The process involves the following steps:

  • The service module connects to the router’s Route Processor using the internal eth0 interface to initiate the firmware download process.

  • The module acquires an IP address through BOOTP, which also supplies the address of the TFTP server from which the firmware image is downloaded.

  • When the firmware image is loaded and the module is booted, DHCP assigns an IP address for the running image, so the module can operate within the network.

Console and telnet connections

Console and telnet (along with Secure Shell, SSH) connections are network access methods used to establish communication with a host router. These methods enable administrators to remotely or locally access the router’s CLI to manage and configure network modules.

  • Connection method: Access is initiated by connecting to the host router either locally via the console port or remotely via telnet or SSH. These methods provide the initial network access channel to the router.

  • Interface configuration: After establishing the connection to the router, an IP address must be configured on the Gigabit Ethernet interface that connects to the module. This step ensures proper network communication between the router and the module.

  • Session establishment: Once the interface is configured, a session to the specific module is opened using the hw-module session slot/subslot command in privileged EXEC mode on the router. This command creates a direct management session to the module, allowing configuration and monitoring.

Examples

Use the following configuration examples to establish a connection:

  • The example shows how to open a session from the router using the hw-module session command: 

    Router# hw-module session slot/card
Router# hw-module session 0/1 endpoint 0
					
Establishing session connect to subslot 0/1

  • The example shows how to exit a session from the router, by pressing Ctrl-A followed by Ctrl-Q on your keyboard: 

    
type ^a^q
picocom v1.4
					
port is        : /dev/ttyDASH2
flowcontrol    : none
baudrate is    : 9600
parity is      : none
databits are   : 8
escape is      : C-a
noinit is      : no
noreset is     : no
nolock is      : yes
send_cmd is    : ascii_xfr -s -v -l10
receive_cmd is : rz -vv

Online insertion and removal capabilities

The router supports online insertion and removal of Cisco Enhanced Services Modules and Cisco Network Interface Modules. You can perform the following tasks using the OIR function:

Online module removals

The router supports the OIR of a module, independent of removing another module installed in your router. This means that an active module can remain installed in your router, while you remove another module from one of the subslots. If you are not planning to immediately replace a module, ensure that you install a blank filler plate in the subslot.

Module deactivation

Module deactivation is a process recommended before physically removing a module from a router to ensure a graceful shutdown and avoid potential issues. It involves stopping the module and its interfaces in a controlled manner. The key points of module deactivation are:

  • Use the hw-module subslot slot/subslot stop command in EXEC mode to perform a graceful deactivation.

  • When deactivating a module with this command, it is not necessary to manually shut down each interface. The command automatically deactivates all interfaces associated with the module

  • Prepares the module for an Online Insertion and Removal procedure.

When you are preparing for an OIR of a module, it is not necessary to independently shut down each of the interfaces before deactivating the module. The hw-module subslotslot/subslot stop command in EXEC mode automatically stops traffic on the interfaces and deactivates them along with the module in preparation for OIR. Similarly, you do not have to independently restart any of the interfaces on a module after OIR.

Example

The following example shows how to use the show facility-alarm status command to verify if any critical alarm is generated when a module is removed from the system: 

Router# show facility-alarm status
System Totals  Critical: 18  Major: 0  Minor: 0
			
Source                     Time                   Severity      Description [Index]
------                     ------                 --------      -------------------
			
Power Supply Bay 1         Sep 28 2020 10:02:34   CRITICAL      Power Supply/FAN Module Missing [0]
POE Bay 0                  Sep 28 2020 10:02:34   INFO          Power Over Ethernet Module Missing [0]
POE Bay 1                  Sep 28 2020 10:02:34   INFO          Power Over Ethernet Module Missing [0]
GigabitEthernet0/0/2       Sep 28 2020 10:02:46   INFO          Physical Port Administrative State Down [2]
GigabitEthernet0/0/3       Sep 28 2020 10:02:46   INFO          Physical Port Administrative State Down [2
xcvr container 0/0/4       Sep 28 2020 10:02:46   INFO          Transceiver Missing - Link Down [1]
TenGigabitEthernet0/0/5    Sep 28 2020 10:02:54   CRITICAL      Physical Port Link Down [1]
TenGigabitEthernet0/1/0    Sep 28 2020 10:03:26   INFO          Physical Port Administrative State Down [2]
GigabitEthernet1/0/0       Sep 28 2020 10:07:35   CRITICAL      Physical Port Link Down [1]
GigabitEthernet1/0/1       Sep 28 2020 10:07:35   CRITICAL      Physical Port Link Down [1]
GigabitEthernet1/0/2       Sep 28 2020 10:07:35   CRITICAL      Physical Port Link Down [1]
GigabitEthernet1/0/3       Sep 28 2020 10:07:35   CRITICAL      Physical Port Link Down [1]
GigabitEthernet1/0/4       Sep 28 2020 10:07:35   CRITICAL      Physical Port Link Down [1]
GigabitEthernet1/0/5       Sep 28 2020 10:07:35   CRITICAL      Physical Port Link Down [1]
TwoGigabitEthernet1/0/16   Sep 28 2020 10:07:35   INFO          Physical Port Administrative State Down [2]
TwoGigabitEthernet1/0/17   Sep 28 2020 10:07:35   INFO          Physical Port Administrative State Down [2]
TwoGigabitEthernet1/0/18   Sep 28 2020 10:07:35   INFO          Physical Port Administrative State Down [2]
TwoGigabitEthernet1/0/19   Sep 28 2020 10:07:35   INFO          Physical Port Administrative State Down [2]
xcvr container 1/0/20      Sep 28 2020 10:04:00   INFO          Transceiver Missing - Link Down [1]
xcvr container 1/0/21      Sep 28 2020 10:04:00   INFO          Transceiver Missing - Link Down [1]1]

Note

A critical alarm (Active Card Removed OIR Alarm) is generated even if a module is removed after performing graceful deactivation.

Deactivate a module and its interfaces in command modes

Use this task to safely shut down hardware modules in a router through either global configuration or EXEC mode, depending on your operational needs.

To deactivate a module and its interfaces, follow these steps:

Before you begin

Ensure you have determined the slot and subslot numbers for the target module.

Procedure

Step 1

If you choose to deactivate your module and its interfaces by executing the hw-module subslot slot/subslotshutdown unpowered command in global configuration mode, you are able to change the configuration in such a way that no matter how many times the router is rebooted, the module does not boot. This command is useful when you need to shut down a module located in a remote location and ensure that it does not boot automatically when the router is rebooted.

Step 2

If you choose to use the hw-module subslot slot/subslot stop command in EXEC mode, you cause the module to gracefully shut down. The module is rebooted when the hw-module subslot slot/subslot start command is executed.

Step 3

To deactivate a module and all of its interfaces before removing the module, use one of the following commands in global configuration mode.

Step 4

hw-module subslot slot/subslot shutdown unpowered

Example:
Router# hw-module subslot 0/2 shutdown unpowered

Deactivates the module located in the specified slot and subslot of the router, where:

  • slot—Specifies the chassis slot number where the module is installed.

  • subslot—Specifies the subslot number of the chassis where the module is installed.

  • shutdown—Shuts down the specified module.

  • unpowered—Removes all interfaces on the module from the running configuration and the module is powered off.

Step 5

hw-module subslot slot/subslot [reload | stop | start]

Example:
Router# hw-module subslot 0/2 stop

Deactivates the module in the specified slot and subslot, where:

  • slot—Specifies the chassis slot number where the module is installed.

  • subslot—Specifies the subslot number of the chassis where the module is installed.

  • reload—Stops and restarts the specified module.

  • stop—Removes all interfaces from the module and the module is powered off.

  • start—Powers on the module similar to a physically inserted module in the specified slot. The module firmware reboots and the entire module initialization sequence is executed in the IOSd and Input/Output Module daemon (IOMd) processes.

The selected module and its interfaces are powered off and removed from the router configuration as specified by the chosen command and mode. The module will not boot until reactivated (if shutdown unpowered was used).

Deactivate and reactivate the SSD/HDD Carrier Card NIM

Perform these steps when you need to reseat, replace, or troubleshoot an SSD/HDD Carrier Card NIM in supported Cisco hardware.

Follow these steps to deactivate and reactivate an SSD/HDD Carrier Card NIM:

Before you begin

Ensure an SSD or HDD is installed in the Carrier Card NIM.

Only one Carrier Card NIM (SSD or HDD) is supported per bay. Installing another may cause file system corruption or module shutdown.

Deactivation may result in data loss; back up important data before proceeding.

Procedure

Step 1

virtual-service name

Example:
Router(config)# virtual-service my-kwaas-instance

Identifies the kWAAS service (by name), supported on your router, in preparation for the router to be shut down by the no activate command. We recommend that you use this command before reseating or replacing an SSD or HDD.

Step 2

no activate

Example:
Router(config-virt-serv)# no activate

Shuts down the kWAAS instance on your router. kWAAS services remain installed. The service will have to be reactivated after the HDD/SSD NIM (module) is restarted.

Step 3

hw-module subslot slot/subslot [reload | stop | start]

Example:
Router# hw-module subslot 0/2 stop
Proceed with stop of module? [confirm]
Router#
*Mar 6 15:13:23.997: %SPA_OIR-6-OFFLINECARD: SPA (NIM-SSD) offline in subslot 0/2

Deactivates or reactivates the module in the specified slot and subslot.

  • slot—The chassis slot number where the module is installed.

  • subslot—The subslot number of the chassis where the module is installed.

  • reload—Deactivates and reactivates (stops and restarts) the specified module.

  • stop—Removes all interfaces from the module and the module is powered off.

  • start—Powers on the module similar to a physically inserted module in the specified slot. The module firmware reboots and the entire module initialization sequence is executed in the IOSd and IOMd processes.

Step 4

Wait for the EN (Enable) LED to turn off, and then remove the SSD/HDD Carrier Card NIM.

The SSD/HDD Carrier Card NIM is safely deactivated and can be physically removed or replaced, then reactivated for continued operation.

Module reactivation

After deactivating a module using the hw-module subslot slot/subslot stop command, you want to reactivate it without performing an OIR, use one of the following commands (in privileged EXEC mode):

  • hw-module subslotslot/subslot start

  • hw-module subslot slot/subslot reload

Verify deactivation and activation of a module

This section outlines whether a module has been successfully deactivated or activated on the system.

Before you begin

Deactivating a module also deactivates its interfaces. As a result, these interfaces will not appear in the output of the show interface command.

Procedure

Step 1

Enter the show hw-module subslot all oir command in privileged EXEC mode to display the current operational status of all modules.

Example:

In the output, check the "Operational Status" field for the module of interest. If the status is "administratively down," the module is deactivated; if it shows "ok," the module is active.

Example:
Router# show hw-module subslot all oir

 Module                  Model                Operational Status
----------------------- -------------------- ------------------------
subslot 0/0             4x1G-2xSFP+          ok
subslot 0/1             C-NIM-1X             ok
subslot 1/0             SM-X-16G4M2X         ok

RadiumPP#

Step 2

To verify activation and proper operation of a module, enter the show hw-module subslot all oir command and observe "ok" in the Operational Status field as shown in the following example:

Example:
Router# show hw-module subslot all oir

 Module                  Model                Operational Status
----------------------- -------------------- ------------------------
subslot 0/0             4x1G-2xSFP+          ok
subslot 0/1             C-NIM-1X             ok
subslot 1/0             SM-X-16G4M2X         ok

RadiumPP#
Router# show platform hardware backplaneswitch-manager R0 status
slot  bay   port   enable   link status   speed(Mbps)   duplex   autoneg   pause_tx   pause_rx   mtu
------------------------------------------------------------------------------------------------------------
0      0     CP     True      Up           1000          Full    ENABLED    ENABLED    ENABLED   10240
1      0     GE1    True      Up           1000          Full    DISABLED   ENABLED    ENABLED   10240
1      0     GE0    True      Up           1000          Full    DISABLED   ENABLED    ENABLED   10240
2      0     GE1    True      Up           1000          Full    DISABLED   ENABLED    ENABLED   10240
2      0     GE0    True      Up           1000          Full    DISABLED   ENABLED    ENABLED   10240
0      1     GE1    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      1     GE0    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      2     GE1    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      2     GE0    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      3     GE1    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      3     GE0    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      4     GE1    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      4     GE0    True     Down          1000          Full    DISABLED   ENABLED    ENABLED   10240
0      0     FFP    True       Up         10000          Full    ENABLED    DISABLED   DISABLED  10240
slot  bay   port            mac    vid   modid     flags - Layer 2
------------------------------------------------------------------------------
0      0    FFP  2c54.2dd2.661b   2351       1              0x20  
0      0    FFP  2c54.2dd2.661b   2352       1              0x20  
0      0     CP  2c54.2dd2.661e   2351       0              0xC60  
0      0     CP  2c54.2dd2.661e   2352       0              0x20  
1      0    GE0  58bf.ea3a.00f6   2350       0              0x460  
0      0    FFP  2c54.2dd2.661b   2350       1              0x20  
1      0    GE0  58bf.ea3a.00f6   2352       0              0x20  
0      0     CP  2c54.2dd2.661e   2350       0              0x20  
1      0    GE0  58bf.ea3a.00f6   2351       0              0xC60
Port block masks: rows=from port, columns=to port, u=unknown unicast, m=unknown multicast, b=broadcast, A=all

           CP    FFP  1/0/1  1/0/0  2/0/1  2/0/0  0/1/1  0/1/0  0/2/1  0/2/0  0/3/1  0/3/0  0/4/1 0/4/0 drops
-------------------------------------------------------------------------------------------------------------
CP          -     A     um     um     um     um     um     um     um     um     um     um     um     um     1
FFP         A     -     -       -      -      -      -      -      -      -      -      -      -      -     0
1/0/1      um    umb    -     umb    umb    umb    umb    umb    umb    umb    umb    umb    umb    umb     0
1/0/0      um    umb   umb     -     umb    umb    umb    umb    umb    umb    umb    umb    umb    umb     6
2/0/1      um    umb   umb    umb     -     umb    umb    umb    umb    umb    umb    umb    umb    umb     0
2/0/0      um    umb   umb    umb    umb     -     umb    umb    umb    umb    umb    umb    umb    umb     6
0/1/1      um    umb   umb    umb    umb    umb     -     umb    umb    umb    umb    umb    umb    umb     0
0/1/0      um    umb   umb    umb    umb    umb    umb      -    umb    umb    umb    umb    umb    umb     0
0/2/1      um    umb   umb    umb    umb    umb    umb    umb     -     umb    umb    umb    umb    umb     0
0/2/0      um    umb   umb    umb    umb    umb    umb    umb    umb    -      umb    umb    umb    umb     0
0/3/1      um    umb   umb    umb    umb    umb    umb    umb    umb    umb     -     umb    umb    umb     0
0/3/0      um    umb   umb    umb    umb    umb    umb    umb    umb    umb    umb     -     umb    umb     0
0/4/1      um    umb   umb    umb    umb    umb    umb    umb    umb    umb    umb    umb     -     umb     0
0/4/0      um    umb   umb    umb    umb    umb    umb    umb    umb    umb    umb    umb    umb     -      0

Port VLAN membership: [untagged vlan] U=untagged T=tagged <VLAN range begin>-<VLAN range end>

CP [2352] U:0001-0001 T:0002-2351 U:2352-2352 T:2353-4095
FFP [2352] T:0001-4095
1/0/1 [2352] T:0002-2351 U:2352-2352 T:2353-4095
1/0/0 [2352] T:0002-2351 U:2352-2352 T:2353-4095
2/0/1 [2352] T:0002-2351 U:2352-2352 T:2353-4095
2/0/0 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/1/1 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/1/0 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/2/1 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/2/0 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/3/1 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/3/0 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/4/1 [2352] T:0002-2351 U:2352-2352 T:2353-4095
0/4/0 [2352] T:0002-2351 U:2352-2352 T:2353-4095

You have verified the current operational state of the module, confirming deactivation or activation as required.

To verify interface connectivity for an active module, enter the show platform hardware backplaneswitch-manager R0 status command. 

Router# show platform hardware backplaneswitch-manager rp active ffp statistics
Broadcom 10G port(e.g: FFP) status:
                          Rx pkts         Rx Bytes          Tx Pkts         Tx Bytes
-----------------------------------------------------------------------------------------
All                           0                0                0                0
=64                           0                                 0
65~127                        0                                 0
128~255                       0                                 0
56~511                        0                                 0
512~1023                      0                                 0
1024~1518                     0                                 0
1519~2047                     0                                 0
2048~4095                     0                                 0
4096~9216                     0                                 0
9217~16383                    0                                 0
Max                           0                                 0
Good                          0                                 0
  CoS 0                                                           0                0
  CoS 1                                                           0                0
  CoS 2                                                           0                0
  CoS 3                                                           0                0
  CoS 4                                                           0                0
  CoS 5                                                           0                0
  CoS 6                                                           0                0
  CoS 7                                                           0                0
  Unicast                       0                                 0
  Multicast                     0                                 0
  Broadcast                     0                                 0
  Control                       0
Errored
  FCS                           0                                 0
  Undersize                     0
  Ether len                     0
  Fragment                      0                                 0
  Jabber                        0
  MTU ck, good                  0
  MTU ck, bad                   0
  Tx underflow                                                                     0
  err symbol                    0
  frame err                     0
  junk                          0
Drops
  CoS 0                                                           0                0
  CoS 1                                                           0                0
  CoS 2                                                           0                0
  CoS 3                                                           0                0
  CoS 4                                                           0                0
  CoS 5                                                           0                0
  CoS 6                                                           0                0
  CoS 7                                                           0                0
  STP                           0
  backpress                     0
  congest                       0                0
  purge/cell                    0
  no destination                0
Pause PFC                       0                                 0
  CoS 0                         0
  CoS 1                         0
  CoS 2                         0
  CoS 3                         0
  CoS 4                         0
  CoS 5                         0
  CoS 6                         0
  CoS 7                         0

Modules and interface management

Module management in a router refers to the process of:

  • Identifying and verifying modules to ensure only authorized hardware or software components are activated.

  • Expanding the router’s capabilities by providing additional network connections.

  • Detecting modules, authenticating and configuring them for clients, monitoring status, and performing recovery actions to ensure optimal functionality.

Module interfaces

After a module is in service, you can control and monitor its module interface. Interface management includes configuring clients with shut or no shut commands. It also involves reporting on the state of the interface and the interface-level statistics.

Module configurations

A module configuration is a process that

  • defines how modules are activated or deactivated,

  • controls power allocation to the module, and

  • manages module interface status within a chassis.

Examples

Deactivating a module configuration

You can deactivate a module to perform OIR of that module. The following example shows how to deactivate a module (and its interfaces) and remove power to the module. In this example, the module is installed in subslot 0 of the router. 

Router(config)# hw-module slot 1 subslot 1/0 shutdown unpowered

Activating a module configuration

You can activate a module if you have previously deactivated it. If you have not deactivated a module and its interfaces during OIR, then the module is automatically reactivated upon reactivation of the router.

The following example shows how to activate a module. In this example, the module is installed in subslot 0, located in slot 1 of the router: 

Router(config)# hw-module slot 1 subslot 1/0 start