Cisco Video Management and Storage System Command Reference


Last Updated: April 22, 2010

This section documents commands for the Cisco Video Management and Storage System application and commands for Cisco IOS software:

Common Cisco Video Management and Storage System Module Commands

Cisco IOS Commands

Common Cisco Video Management and Storage System Module Commands

disk add

disk remove

event poll-interval

format storages local

show event poll-interval

show disk stats

show storages all filesystem

show storages nfs

show storages nfs filesystem

show storages nfs status

show video-surveillance

state (storages nfs)

state (storages nfs)

storages nfs

switch-on-fail (storages nfs)

target-ip (storages nfs)

video-surveillance

disk add

To add a replacement RAID 1, Linear RAID, or RAID 0 local disk drive, use the disk add command in global configuration mode.

disk add {0 | 1}

Syntax Description

0

Local disk drive 0.

1

Local disk drive 1.


Command Modes

Global configuration mode

Command History

Version
Modification

6.2.1

This command was introduced.


Usage Guidelines

The CLI keeps track of which drive has failed. If the selected drive (0 or 1) is not the failed drive, the CLI does not allow the command to take effect and an error appears.

If a local disk drive fails and the incorrect disk drive is selected in the CLI, the CLI displays error messages as shown in the following example:

cvmss-module# disk add 1
You are about to add disk 1 (sdb) back to the RAID array and SCSI
Do you wish to continue [y/n]? y
sdb is already active, can't add it back again.

cvmss-module# disk add 0
You are about to add disk 0 (sda) back to the RAID array and SCSI
Do you wish to continue [y/n]? y
sda still exists in the RAID array.  Please issue a "disk remove" first.

Examples

Linear Disk Drive Swap and Recovery

After the failed local disk drive 0 on the Cisco SM-SRE module is physically removed, a new replacement disk drive is swapped and plugged into the module. The following example shows the Linear RAID disk drive hot swap disk add 0 command and the show disk stats command to display the drive's recovery progress. If the disk add 0 command succeeds, the following is displayed:

cvmss-module# disk add 0
You are about to add disk 0 (sda) back to the RAID array and SCSI
Do you wish to continue [y/n]? y
!!!WARNING!!!
!!!WARNING!!!  You are about to start a serious operation on the
!!!WARNING!!!  local media.  Adding a new drive requires the
!!!WARNING!!!  linear storage partition to be rebuilt and formatted.
!!!WARNING!!!
!!!WARNING!!!  During this operation, your console is locked and
!!!WARNING!!!  unavailable for use.
!!!WARNING!!!
!!!WARNING!!!  If you are not sure what to do, answer no to the
!!!WARNING!!!  following question and then exit.
!!!WARNING!!!
Do you wish to proceed [y/n]? : y
Checking that no-one is using this disk right now ...
OK

Disk /dev/sda: 60801 cylinders, 255 heads, 63 sectors/track
Old situation:
Units = cylinders of 8225280 bytes, blocks of 1024 bytes, counting from 0

   Device Boot Start     End   #cyls    #blocks   Id  System
/dev/sda1          0+    365     366-   2939863+  fd  Linux raid autodetect
/dev/sda2        366     609     244    1959930   fd  Linux raid autodetect
/dev/sda3        610    1826    1217    9775552+  fd  Linux raid autodetect
/dev/sda4          0       -       0          0    0  Empty
New situation:
No partitions found

sfdisk: no partition table present.
Checking that no-one is using this disk right now ...
OK

Disk /dev/sda: 60801 cylinders, 255 heads, 63 sectors/track
Old situation:
Units = cylinders of 8225280 bytes, blocks of 1024 bytes, counting from 0

   Device Boot Start     End   #cyls    #blocks   Id  System
/dev/sda1          0+    365     366-   2939863+  fd  Linux raid autodetect
/dev/sda2        366     609     244    1959930   fd  Linux raid autodetect
/dev/sda3        610    1826    1217    9775552+  fd  Linux raid autodetect
/dev/sda4          0       -       0          0    0  Empty
New situation:
Units = sectors of 512 bytes, counting from 0

   Device Boot    Start       End   #sectors  Id  System
/dev/sda1            63   5879789    5879727  fd  Linux raid autodetect
/dev/sda2       5879790   9799649    3919860  fd  Linux raid autodetect
/dev/sda3       9799650  29350754   19551105  fd  Linux raid autodetect
/dev/sda4             0         -          0   0  Empty
Warning: no primary partition is marked bootable (active)
This does not matter for LILO, but the DOS MBR will not boot this disk.
Successfully wrote the new partition table

Re-reading the partition table ...

If you created or changed a DOS partition, /dev/foo7, say, then use dd(1)
to zero the first 512 bytes:  dd if=/dev/zero of=/dev/foo7 bs=512 count=1
(See fdisk(8).)
mdadm: added /dev/sda1
mdadm: added /dev/sda2
mke2fs 1.35 (28-Feb-2004)
Filesystem label=
OS type: Linux
Block size=4096 (log=2)
Fragment size=4096 (log=2)
1224000 inodes, 2443888 blocks
122194 blocks (5.00%) reserved for the super user
First data block=0
Maximum filesystem blocks=2503999488
75 block groups
32768 blocks per group, 32768 fragments per group
16320 inodes per group
Superblock backups stored on blocks:
        32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632

Writing inode tables: done
Creating journal (8192 blocks): done
Writing superblocks and filesystem accounting information: done

This filesystem will be automatically checked every 29 mounts or
180 days, whichever comes first.  Use tune2fs -c or -i to override.
mdadm: chunk size defaults to 64K
mdadm: /dev/sda3 appears to contain an ext2fs file system
    size=9775552K  mtime=Wed Dec 31 16:00:00 1969
mdadm: /dev/sdb3 appears to contain an ext2fs file system
    size=9775552K  mtime=Tue Feb  2 10:57:14 2010
mdadm: /dev/sdb3 appears to be part of a raid array:
    level=linear devices=2 ctime=Tue Feb  2 15:19:04 2010
Continue creating array? mdadm: array /dev/md2 started.
vmss-25-210-30# lin sh
Saving session script in: linux_session.log

cvmss-module# cat /proc/mdstat
Personalities : [linear] [raid1]
md1 : active raid1 sda2[0] sdb2[1]
      1959808 blocks [2/2] [UU]

md2 : active linear sdb3[1] sda3[0]
      19550976 blocks 64k rounding

md0 : active raid1 sda1[0] sdb1[1]
      2939776 blocks [2/2] [UU]

unused devices: <none>

As the new Linear RAID drive recovers, use the show disk stats command to display the recovery as a progress bar and percentage recovered. The show disk stats command can be repeated to monitor the drive recover.

cvmss-module# show disk stats
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[2] sda2[0]
      1959808 blocks [2/1] [U_]
        resync=DELAYED

md2 : active raid1 sdb3[2] sda3[0]
      9775488 blocks [2/1] [U_]
        resync=DELAYED

md0 : active raid1 sdb1[2] sda1[0]
      2939776 blocks [2/1] [U_]
      [==>..................]  recovery = 13.4% (396288/2939776) finish=0.8min 
speed=49536K/sec

unused devices: <none>

cvmss-module# show disk stats
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[2] sda2[0]
      1959808 blocks [2/1] [U_]
        resync=DELAYED

md2 : active raid1 sdb3[2] sda3[0]
      9775488 blocks [2/1] [U_]
      [===============>.....]  recovery = 77.6% (7589248/9775488) finish=0.7min 
speed=50901K/sec

md0 : active raid1 sdb1[1] sda1[0]
      2939776 blocks [2/2] [UU]

unused devices: <none>

cvmss-module# show disk stats
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[1] sda2[0]
      1959808 blocks [2/2] [UU]

md2 : active raid1 sdb3[1] sda3[0]
      9775488 blocks [2/2] [UU]

md0 : active raid1 sdb1[1] sda1[0]
      2939776 blocks [2/2] [UU]

unused devices: <none>

cvmss-module# ext3_abort called.
EXT3-fs error (device md2): ext3_journal_start_sb: Feb  2 16:27:03 Detected aborted 
journal
localhost kernelRemounting filesystem read-only
: ext3_abort called.
Feb  2 16:27:03 localhost kernel: EXT3-fs error (device md2): ext3_journal_start_sb: 
Detected aborted journal
Feb  2 16:27:03 localhost kernel: Remounting filesystem read-only
Buffer I/O error on device md2, logical block 1

cvmss-module# cat /proc/mdstat
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[1] sda2[0]
      1959808 blocks [2/2] [UU]

md2 : active linear sdb3[1] sda3[0]
      19550976 blocks 64k rounding

md0 : active raid1 sdb1[1] sda1[2](F)
      2939776 blocks [2/1] [_U]

unused devices: <none>

cvmss-module# cat /proc/mounts | grep md2
/dev/md2 /media0 ext3 ro,data=ordered 0 0
cvmss-module# exit
exit

Related Commands

Command
Description

disk remove

Removes a failed RAID 1 local disk drive device.


disk remove

To remove a failed RAID 1, Linear RAID, or RAID 0 local disk drive device, use the disk remove command in global configuration mode.

disk remove {0 | 1}

Syntax Description

0

Local disk drive 0.

1

Local disk drive 1.


Command Modes

Global configuration mode

Command History

Version
Modification

6.2.1

This command was introduced.


Usage Guidelines

The CLI keeps track of which drive has failed. If the selected drive (0 or 1) is not the failed drive, the CLI does not allow the command to take effect and an error appears.

If a local disk drive fails and the incorrect disk drive is selected in the CLI, the CLI displays error messages as shown in the following example:


cvmss-module# disk remove 1
You are about to remove disk 1 (sdb) from the RAID array and SCSI
Do you wish to continue [y/n]? y
sdb is the only active drive, can't be removed

Examples

Linear Raid Disk Drive Removal

The following example shows the Linear RAID disk drive hot swap disk remove 0 command. If the disk remove 0 command succeeds, the following CLI output is displayed:

cvmss-module# disk remove 0
You are about to remove disk 0 (sda) from the RAID array and SCSI
Do you wish to continue [y/n]? y
raid1: Disk failure on sda2, disabling device.
Feb  2 16:30:25 localhost kernel: raid1: Disk failure on sda2, disabling device.
mdadm: set /dev/sda1 faulty in /dev/md0
mdadm: set /dev/sda2 faulty in /dev/md1
mdadm: hot removed /dev/sda1
mdadm: hot removed /dev/sda2
/dev/md2 /media0 ext3 ro,data=ordered 0 0
Buffer I/O error on device md2, logical block 1116
mdadm: stopped /dev/md2

cvmss-module# lin sh
Saving session script in: linux_session.log
bash-2.05b# cat /proc/mdstat
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[1]
      1959808 blocks [2/1] [_U]

md0 : active raid1 sdb1[1]
      2939776 blocks [2/1] [_U]

The failed local disk drive 1 on the Cisco SM-SRE module is physically removed and a new replacement disk drive swapped. The following example shows the Linear RAID disk drive hot swap disk add 1 command:

cvmss-module# disk add 1
You are about to add disk 1 (sdb) back to the RAID array and SCSI
Do you wish to continue [y/n]? y

Disk /dev/sdb: 60801 cylinders, 255 heads, 63 sectors/track
Old situation:
Units = cylinders of 8225280 bytes, blocks of 1024 bytes, counting from 0

   Device Boot Start     End   #cyls    #blocks   Id  System
/dev/sdb1          0+    365     366-   2939863+  fd  Linux raid autodetect
/dev/sdb2        366     609     244    1959930   fd  Linux raid autodetect
/dev/sdb3        610    1826    1217    9775552+  fd  Linux raid autodetect
/dev/sdb4          0       -       0          0    0  Empty
New situation:
Units = sectors of 512 bytes, counting from 0

   Device Boot    Start       End   #sectors  Id  System
/dev/sdb1            63   5879789    5879727  fd  Linux raid autodetect
/dev/sdb2       5879790   9799649    3919860  fd  Linux raid autodetect
/dev/sdb3       9799650  29350754   19551105  fd  Linux raid autodetect
/dev/sdb4             0         -          0   0  Empty
Successfully wrote the new partition table

Re-reading the partition table ...

mdadm: added /dev/sdb1
mdadm: added /dev/sdb2
mdadm: added /dev/sdb3

As the new Linear RAID disk drive recovers, the show disk stats command can be repeated periodically to display the recovery as an incremental progress bar that indicates the percentage completion of disk recovery, as shown in the following example:

cvmss-module# show disk stats
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[2] sda2[0]
      1959808 blocks [2/1] [U_]
        resync=DELAYED

md2 : active raid1 sdb3[2] sda3[0]
      9775488 blocks [2/1] [U_]
        resync=DELAYED

md0 : active raid1 sdb1[2] sda1[0]
      2939776 blocks [2/1] [U_]
      [==>..................]  recovery = 13.4% (396288/2939776) finish=0.8min 
speed=49536K/sec

unused devices: <none>

cvmss-module# show disk stats
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[2] sda2[0]
      1959808 blocks [2/1] [U_]
        resync=DELAYED

md2 : active raid1 sdb3[2] sda3[0]
      9775488 blocks [2/1] [U_]
      [===============>.....]  recovery = 77.6% (7589248/9775488) finish=0.7min 
speed=50901K/sec

md0 : active raid1 sdb1[1] sda1[0]
      2939776 blocks [2/2] [UU]

unused devices: <none>

cvmss-module# show disk stats
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[1] sda2[0]
      1959808 blocks [2/2] [UU]

md2 : active raid1 sdb3[1] sda3[0]
      9775488 blocks [2/2] [UU]

md0 : active raid1 sdb1[1] sda1[0]
      2939776 blocks [2/2] [UU]

unused devices: <none>

Related Commands

Command
Description

disk add

Adds a replacement RAID 1 or Linear RAID local disk drive.


event poll-interval

To set the HTTP trigger event polling interval in seconds, use the event poll-interval command in global configuration mode.


Note The event polling interval configures the sensitivity of the system for event detection. However, it does not specify the exact amount of time it takes until an event is detected.


Use the no form of the command to return the event polling interval to its default value.

event poll-interval seconds

no event poll-interval

Syntax Description

seconds

Number of seconds to set the event polling interval.

Note Event polling interval can only be within the range of 2 to 30 seconds.


Command Default

2 seconds

Command Modes

Global configuration

Command History

Version
Modification

6.2.1

This command was introduced.


Usage Guidelines

The default HTTP trigger event polling interval (2 seconds) optimizes performance as well as triggered event responses.

However, if performance issues arise because the event polling is too frequent, then you can increase the polling interval at the expense of delayed event detection.

Examples

If the times of the polling interval are not within the valid 2 to 30 second range, the CLI returns "Event polling interval can only be 2-30 sec," and does not accept any interval that is not within this range:

cvmss-module(config)# event poll-interval 32
Event polling interval can only be 2-30 sec.

In the next example, the poll interval of 11 seconds is accepted:

cvmss-module(config)# event poll-interval 11
Event polling interval changed. New value will take effect after restarting video 
application.

To verify that the CLI has accepted the new event polling interval, use the show event poll-interval command, as shown in the following example:

cvmss-module(config)# end
cvmss-module# show event poll-interval
Event polling interval is 11 seconds.

For the new HTTP trigger event polling interval to take effect, you must restart the video using the video-surveillance task restart command. This command restarts all Cisco video services, as shown in the following example:

cvmss-module# video-surveillance task restart
Restarting all Cisco Video Surveillance services, please wait ...
snmpd:/usr/BWhttpd/sbin/snmpd:status...Running
snmptrapd:/usr/BWhttpd/sbin/snmptrapd:status...Running
Checking for vsrecorder
    Checking for xvcrmanMonitor... Running.
    Checking for xvcrman... Running.
    Checking for xvcrconfig... Running.
Checking for vsms daemons... running.
Checking for mediaout... Running.
Checking for httpd... running.
Checking for service MRTG mrtg:/usr/BWhttpd/bin/mrtg:status...Running
Checking for backup server... Running.
Checking for sys config agent... Running.

To verify that the video services are now running, use the show video-surveillance task status 
command.

Related Commands

Command
Description

show event poll-interval

Displays the HTTP trigger event polling interval.


format storages local


Note Use the following command for version 2.0 and later of the Cisco Video Management and Storage System.


To format a local storage device, use the format storages local command in format storages local configuration mode.


Note For the changes to take effect, the media must first be disabled and then reenabled.


format storages local media-tag

Syntax Description

media-tag

Unique string identifier for the LOCAL mass storage device in the range of media1 to media9.


Command Default

The local storage device contains software applications.

Command Modes

Format storages local configuration

Command History

Version
Modification

2.0

This command was introduced.


Usage Guidelines

The media tag for the local storage device is media0.

Examples

The following example shows the command to format the local storage device media0:

cvmss-module> format storages local media0

!!!WARNING!!!
!!!WARNING!!!  You are about to start a destructive sequence of
!!!WARNING!!!  operations. All data on the storage device media0 
!!!WARNING!!!  will be lost and unrecoverable. 
!!!WARNING!!!  The device formatting can take up to a few minutes. 
!!!WARNING!!!  During formatting, your console is locked and
!!!WARNING!!!  unavailable for use. Before you proceed further, back
!!!WARNING!!!  up the contents of the storage device media0.
!!!WARNING!!!
!!!WARNING!!!  If you are not sure what to do, answer "no" to the
!!!WARNING!!!  following question and then exit.
!!!WARNING!!!

Do you wish to proceed [y/n]? : 

Related Commands

Command
Description

show storages all filesystem

Displays the configuration parameter summary for all storage file systems.


show event poll-interval

To display the HTTP trigger event polling interval, use the show even poll-interval command user EXEC configuration mode.

show event poll-interval

Syntax Description

This command has no arguments or keywords.

Command Modes

User EXEC

Command History

Version
Modification

6.2.1

This command was introduced.


Examples

The following example shows the display output for the show event poll-interval command:

cvmss-module# show event poll-interval
Event polling interval is 11 seconds.

Related Commands

Command
Description

event poll-interval

Sets the HTTP trigger event polling interval in seconds.


show disk stats

To display the statistics of the active disk drives, use the show disk stats command user EXEC configuration mode.

show disk stats

Syntax Description

This command has no arguments or keywords.

Command Modes

User EXEC

Command History

Version
Modification

6.2.1

This command was introduced.


Examples

The following example shows the statistics display output for the show disk stats command:

cvmss-module# show disk stats
Personalities : [linear] [raid1]
md1 : active raid1 sdb2[1] sda2[0]
      1959808 blocks [2/2] [UU]

md2 : active raid1 sdb3[1] sda3[0]
      9775488 blocks [2/2] [UU]

md0 : active raid1 sdb1[1] sda1[0]
      9775424 blocks [2/2] [UU]

unused devices: <none>

The show disk stats command can be entered repeatedly to monitor disk recovery after a disk drive 
swap.

Related Commands

Command
Description

disk add

Adds a replacement RAID 1 or Linear RAID local disk drive.

disk remove

Removes a failed RAID 1 local disk drive device.


show storages all filesystem

To display a configuration parameter summary for all storage file systems, use the show storage all filesystem command in user EXEC configuration mode.

show storages all filesystem

Syntax Description

This command has no arguments or keywords.

Command Modes

User EXEC

Command History

Version
Modification

1.0

This command was introduced.


Examples

To view a summary of all configured file systems, use the show storages all filesystem command. For example:

cvmss-module# show storages all filesystem 
Filesystem            1K-blocks      Used  Available Use% Mounted on
==================== ===========  ======= ========== ==== ==========
rootfs                 9775184   1081480   8693704    12% /
/dev/root              9775184   1081480   8693704    12% /
none                   1036520         0   1036520     0% /dev/shm
/dev/sda3            142284500     32828 135024032     1% /media0
/dev/sdb             2307162084 1172169844 1017795172 54% /media1_0
/dev/sdc             576789800    106560 547384004     1% /media1_1

Table 7 lists and describes the output fields of the show storages all filesystem command.

Table 7 show storages all filesystem Field Descriptions 

Field
Description

Filesystem

Lists the file system and devices.

1K-blocks

Displays the available number of 1-kilobyte blocks for each of the target devices.

Used

Displays the used number of 1-kilobyte blocks for each of the target devices.

Available

Displays the available remaining number of 1-kilobyte blocks for each of the target devices.

Use%

Displays the used percentage of 1-kilobyte blocks for each of the target devices.

Mounted on

Displays the target device name on which the file system is mounted.


Related Commands

Command
Description

show storages nfs filesystem

Displays the parameter summary for currently configured NFS file systems.


show storages nfs

To display the summary of the current NFS mount details, use the show storages nfs command in user EXEC configuration mode.

show storages nfs


Note This command might not reflect the actual state of the NFS mount because the configuration only occurs at mount time. You must unmount and then mount the device again for the configuration to take effect. To confirm the current mount values, use the show storages nfs status command.


Syntax Description

This command has no arguments or keywords.

Command Modes

User EXEC

Command History

Version
Modification

2.2

This command was introduced.


Examples

To view the values of the current NFS configuration, use the show storages nfs command. For example:

cvmss-module# show storages nfs
Tag     Target IP     Mount Name   IO Error Handling
======= ===========   ==========   =================
Media1  10.10.10.60   /var/nfs     hard

Table 8 lists and describes the output fields of the show storages nfs command.

Table 8 show storages nfs Field Descriptions 

Field
Description

Tag

Displays the unique string identifier for the NFS mount from an NFS server in the range of media1 to media9.

Target IP

Displays the NFS device IP address.

Mount Name

Displays the NFS device mount directory name.

IO Error Handling

Displays the type of input/output error handling of the NFS mount.


Related Commands

Command
Description

state (storages nfs)

Mounts or unmounts an NFS export.

switch-on-fail (storages nfs)

Configures whether the archives can be switched to the local hard drive when the NFS media device is not available.

target-ip (storages nfs)

Configures the IP address and name of an NFS export target.


show storages nfs filesystem

To display the parameter summary for currently configured NFS file systems, use the show storage nfs filesystem command in user EXEC configuration mode.

Syntax Description

This command has no arguments or keywords.

Command Modes

User EXEC

Command History

Version
Modification

2.2

This command was introduced.


Examples

To view a summary of the currently configured NFS file systems, use the show storages nfs filesystem command. For example:

cvmss-module# show storages nfs filesystem 
Filesystem            1K-blocks   Used    Available  Use% Mounted on
==================== ===========  ======= ========== ==== ==========
10.10.10.60/var/nfs  206424760    3999716 191939284  3%   /media1

Table 9 lists and describes the output fields of the show storages nfs filesystem command.

Table 9 show storages nfs filesystem Field Descriptions 

Field
Description

Filesystem

Lists the file system and devices.

1K-blocks

Displays the available number of 1-kilobyte blocks for each of the corresponding NFS mounts.

Used

Displays the used number of 1-kilobyte blocks for each of the NFS mounts.

Available

Displays the available remaining number of 1-kilobyte blocks for each of the NFS mounts.

Use%

Displays the used percentage of 1-kilobyte blocks for each of the NFS mounts.

Mounted on

Displays the NFS mount name on which the file system is mounted.


Related Commands

Command
Description

storages nfs

Configures NFS file system parameters.


show storages nfs status

To display the status of the settings of the specified NFS mount, use the show storages nfs status command in user EXEC configuration mode.

show storages nfs status {summary | detail}

Syntax Description

summary

Displays a general summary of the status of configured NFS mount.

detail

Displays a detailed summary of the status of configured NFS mount.


Command Modes

User EXEC

Command History

Version
Modification

2.2

This command was introduced.


Examples

To view the status summary of the NFS mount settings of the specified NFS mount, use the show storages nfs status command. For example:

cvmss-module# show storages nfs status summary
Tag    Filesystem            Mounts   Port       Receive-  Write- Version  Proto  IO Error 
                                      Reachable  Buffer-   Buffer-                Handling
                                                 Size      Size
====== ====================== ======  ========== ========= ====== ========  ====  ========
Media1 10.10.10.60:/var/mfs  /media1  Yes        65536     65536  3        UDP    hard

Table 10 lists and describes the output fields of the show storages nfs status command.

Table 10 show storages nfs status summary Field Descriptions 

Field
Description

Tag

Displays the unique string identifier for the NFS mount from an NFS server in the range of media1 to media9.

Filesystem

Displays the NFS file system device IP address and directory.

Mounts

Displays the NFS mounts.

Port Reachable

Displays whether or not the NFS mount port is reachable.

Receive Buffer Size

Displays the NFS device receive buffer size.

Write Buffer Size

Displays the NFS device write buffer size.

Version

Displays the version number of the NFS protocol currently being used.

Proto

Displays the transport protocol currently being used.

IO Error Handling

Displays the type of input/output error handling of the NFS mount.


Related Commands

Command
Description

state (storages nfs)

Mounts or unmounts an NFS export.

switch-on-fail (storages nfs)

Configures whether the archives can be switched to the local hard drive when the NFS media device is not available.

target-ip (storages nfs)

Configures the IP address and name of an NFS export target.


show video-surveillance

To display video surveillance configurations, logs, reports, and tasks, use the show video-surveillance command in user EXEC configuration mode.

show video-surveillance [archive | config | configs | log | logs | reports | tasks]


Note The show video-surveillance tasks command removed in version 2.0 and later versions.


Syntax Description

archive

Displays a list of the running archives and their corresponding destinations along with the IP address and export point.

config

Displays the content of a configuration file.

configs

Displays all the configuration file names.

log

Displays the content of a log file.

logs

Displays all log file names.

reports

Displays all report file names.

tasks

Displays predefined tasks.


Command Modes

User EXEC

Command History

Version
Modification

1.0

This command was introduced.

2.0

This command was modified. The tasks command option is removed in version 2.0 and later versions.


Examples

To view predefined tasks, use the show video surveillance tasks command. For example:

cvmss-module# show video-surveillance tasks
TASK                   DESCRIPTION
restart         Restarting all Cisco Video Surveillance services, please wait
start           Starting all Cisco Video Surveillance services, please wait
status          Report on status of Cisco Video Surveillance services
stop            Stops all running Cisco Video Surveillance services
support-report  Generate the system support report
vsom_db_restore Restore VSOM database from local disk
cron-restart    Restart cron daemon after timezone changes
cert-gen        Generate a ssl server key and certificate

To view the archive summary, use the show video surveillance archive summary command. For example:

cvmss-module# show video-surveillance archive summary
Archive Name            Archive Location (IP Address)   Type      Export Directory
a_p_lab_cam1_-_a_ar1    —                               local
a_p_lab_cam2_-_a_ar2    1.100.30.220                    nfs       /media0

Related Commands

Command
Description

video-surveillance

Sets video surveillance configurations, logs, reports, and tasks.


state (storages nfs)

To mount or unmount an NFS export, use the state sub-command in the Storages NFS configuration mode.

state [disabled | enabled]

Syntax Description

disabled

NFS export unmounted.

enabled

NFS export mounted.


Command Default

Disabled

Command Modes

Storages NFS configuration

Command History

Version
Modification

2.2

This command was introduced.


Usage Guidelines

Configure the NFS export state to enabled (mounted) or disabled (unmounted).

Examples

The following example shows the NFS state command to mount the NFS export:

cvmss-module# configure terminal
cvmss-module(config)# storages nfs media1 
cvmss-module(config-nfs)# state enabled
Media successfully enabled!

Related Commands

Command
Description

switch-on-fail (storages nfs)

Configures whether the archives can be switched to the local hard drive when the NFS media device is not available.

target-ip (storages nfs)

Configures the IP address and name of an NFS export target.


storages nfs

To configure the media tag for an NFS mount, use the storages nfs command in global configure mode.

storages nfs media-tag

Syntax Description

media-tag

Unique string identifier for the NFS mount from an NFS server in the range of media1 to media9.


Command Default

NFS mount is not configured.

Command Modes

G1obal Configuration

Command History

Version
Modification

2.2

This command was introduced.


Usage Guidelines

For the NFS mount configuration, nine media tags, media1 through media9, are configurable.

Examples

The following example shows configuring the NFS mount media1 tag for media1 using the storages nfs command:

cvmss-module# configure terminal
cvmss-module(config)# storages nfs media1
Adding new nfs
cvmss-module(config-nfs)#

Related Commands

Command
Description

state (storages nfs)

Mounts or unmounts an NFS export.

switch-on-fail (storages nfs)

Configures whether the archives can be switched to the local hard drive when the NFS media device is not available.

target-ip (storages nfs)

Configures the IP address and name of an NFS export target.


switch-on-fail (storages nfs)

To configure whether the archives can be switched to the local hard drive in the case where the NFS media device is not available, use the switch-on-fail sub-command in Storages NFS configuration mode.

switch-on-fail [on | off]

Syntax Description

switch-on-fail

Set to whether the archives can be switched to the local hard drive in the case where the NFS media device is not available.

on

Switchover of the archives processing to the local drive occurs in the event the NFS media is not available.

off

The application waits for the configured NFS media device to become available before starting the archive.


Command Default

Off

Command Modes

Storages NFS configuration

Command History

Version
Modification

2.2

This command was introduced.


Usage Guidelines

The switch-on-fail sub-command activates a standby repository and provides automatic failover from one repository to the other. The local repository (media0) is the standby repository and an external storage server (media1, media2, media3... or media9) is the active repository in the initial setup. When there is a disconnect from the external storage server, the local repository, media0, automatically becomes the active repository. The failover process is as follows:

1. When an external storage server is configured for archiving, the system automatically enables media0 as the standby repository location.

2. In the event of a disconnect to the external server (determined through a portal reachability test), the archive automatically uses media0 as the active repository.

3. When the external server is reconnected, all archives must be moved from media0 back to the external server.

4. Archives accumulated on media0 during the failover process are removed.


Note This failover archive feature is only available to the NFS device on the Cisco Integrated Storage System module. The software checks whether or not the configured device is the NFS media from the Cisco Integrated Storage System module.


Examples

The following example shows the NFS state command to mount the NFS export:

cvmss-module# configure terminal
cvmss-module(config)# storages nfs media1 
cvmss-module(config-nfs)# switch-on-fail on
Media successfully enabled!

Related Commands

Command
Description

state (storages nfs)

Mounts or unmounts an NFS export.

target-ip (storages nfs)

Configures the IP address and name of an NFS export target.


target-ip (storages nfs)

To configure the IP address and export name of an NFS export target, use the target-ip sub-command in Storages NFS configuration mode. To remove the IP address and export name of an NFS storage target device, use the no form of this command.

target-ip ip-address exportname name

no target-ip ip-address exportname name

Syntax Description

ip-address

IP address in dotted decimal notation.

exportname

Configures the NFS export directory name.

name

Directory name.


Command Default

No NFS target IP address is configured.

Command Modes

Storages NFS configuration

Command History

Version
Modification

2.2

This command was introduced.


Usage Guidelines

For the NFS configuration, nine media tags are configurable (for example, media1, media2, and so on) for up to nine NFS target devices.

Examples

The following example shows the target-ip command assumes only one export:

cvmss-module# configure terminal
cvmss-module(config)# storages nfs media1 
cvmss-module(config-nfs)# target-ip 10.10.10.60
Connecting 10.10.10.60... succeeded.

The following example shows the target-ip command assumes multiple exports, causing the following failed connection error message to appear:

cvmss-module# configure terminal
cvmss-module(config)# storages nfs media1 
cvmss-module(config-nfs)# target-ip 10.10.10.60
Connecting 10.10.10.60... failed.

ERROR: The target could not be connected because multiple exports exist on this storage 
server. The following exports exist on this storage server:
/var/nfs
/source/nfs

The following example shows the target-ip command and the resulting error message when the target IP address fails to connect:

cvmss-module# configure terminal
cvmss-module(config)# storages nfs media1 
cvmss-module(config-nfs)# target-ip 10.10.10.60
Connecting 10.10.10.60... failed.
10.10.10.60--target connection failed.
Please reissue "target-ip" to retry connection.

The following example shows the target-ip command with the export parameter:

cvmss-module# configure terminal
vmss-module(config)# storages nfs media1 
cvmss-module(config-nfs)# target-ip 10.10.10.60 exportname /nfs/export
Connecting 172.107.146.207 export /nfs/export... succeeded.

Related Commands

Command
Description

state (storages nfs)

Mounts or unmounts an NFS export.

switch-on-fail (storages nfs)

Configures whether the archives can be switched to the local hard drive when the NFS media device is not available.


video-surveillance

To set video surveillance configurations, logs, reports, and tasks, use the video-surveillance command in user EXEC configuration mode.

video-surveillance {httpd {set attribute [value] | unset attribute [value]} | logging {set attribute [value] | unset attribute [value]} | task {archive-restart string | archive-stop string | cert-gen | cron-restart | restart | start | status | stop | support-report | vsom_db_restore}}

Syntax Description

httpd

Sets and unsets HTTP-related tasks.

set

Sets the attribute value name of a shell httpd-related or logging-related variable.

unset

Unsets a shell httpd-related or logging-related attribute value name, removing it from memory.

attribute

Attribute related to shell httpd or logging to set or unset.

value

Optional. Value of related to shell httpd or logging to set or unset.

logging

Sets and unsets shell log-related tasks.

task

Starts predefined tasks.

archive-restart

Restarts the NFS archiving process.

string

Configures NFS media tag in the range of media1 to media9.

archive-stop

Stops archive processes running on NFS storage media.

cert-gen

Generates a secure SSL server key and certificate.

cron-restart

Restarts the cron daemon after time changes are made in time zones.

restart

Restarts Cisco Video Surveillance services.

start

Starts Cisco Video Surveillance services.

status

Displays the status of Cisco Video Surveillance services.

stop

Stops Cisco Video Surveillance services.

support-report

Generates the system report for tech support.

vsom_db_restore

Restores the VSOM database from the local disk drive.


Command Modes

User EXEC

Command History

Version
Modification

1.0

This command was introduced.

6.5.1

This command was modified.


Examples

To view predefined tasks, use the show video surveillance tasks command. For example:

cvmss-module# video-surveillance task status
Report on status of Cisco Video Surveillance services ...
Checking for vsms daemons... running.
Checking for httpd... running.
snmpd:/usr/BWhttpd/sbin/snmpd:status...Running
snmptrapd:/usr/BWhttpd/sbin/snmptrapd:status...Running
Checking for service MRTG mrtg:/usr/BWhttpd/bin/mrtg:status...Running

Related Commands

Command
Description

show video-surveillance

Displays video surveillance configurations, logs, reports, and tasks.


Cisco IOS Commands

This section documents new Cisco IOS commands used for accessing the Cisco Video Management and Storage System module from the host router.

Use the following commands to access and configure the Cisco Video Management and Storage System module from the host router:

service-module sm default-boot

service-module sm heartbeat-reset

service-module sm install

service-module sm install abort

service-module sm reload

service-module sm reset

service-module sm session

service-module sm shutdown

service-module sm statistics

service-module sm status

service-module sm uninstall

show controllers sm

show interfaces sm

service-module sm default-boot

To configure the Cisco SM-SRE service module to use the default BIOS and bootloader, use the service-module sm default-boot command in privileged EXEC mode.

service-module sm slot/port default-boot

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

After a downtime event or failed upgrade, use this command to configure the service module to use the primary BIOS and primary bootloader to perform startup routines.

Examples

The following is sample output for a service module:

Router# service-module sm 1/0 default-boot
clear  Clear Default Boot
set    Set Default Boot
 
Router# service-module sm 1/0 default-boot clear
Router# service-module sm 1/0 default-boot set

service-module sm heartbeat-reset

To prevent Cisco IOS software from rebooting the Cisco SM-SRE service module when the heartbeat is lost, use the service-module sm heartbeat-reset command in privileged EXEC mode.

service-module sm slot/port heartbeat-reset {disable | enable}

Syntax Description

slot

Number of the router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.

disable

Disables reset of the service module if the heartbeat is lost.

enable

Enables reset of the service module if the heartbeat is lost.


Command Default

Service module is reset when heartbeat is lost.

Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

When the service module is booted in fail-safe mode or is undergoing an upgrade, this command prevents a reboot during the process.

When the service module heartbeat is lost, the router applies a fail-open or fail-close configuration option to the module, stops sending traffic to the module, and sets the module to error state. The router performs a hardware reset on the service module and monitors it until the heartbeat is reestablished.

Examples

The following example shows how to disable the service module from being reset if the heartbeat is lost:

Router# service-module sm 1/0 heartbeat-reset disable
 

You can display the status of the heartbeat reset feature with the service-module sm status command:

Router# service-module sm 1/0 status

 

Service Module is Cisco IDS-Sensor 1/0

Service Module supports session via TTY line 194

Service Module heartbeat-reset is enabled <=====

Related Commands

Command
Description

interface sm

Configures an interface for a service module and enters interface configuration mode.

service-module sm reload

Performs a graceful shutdown and reboot of the service module.

service-module sm reset

Resets the service module hardware.

service-module sm shutdown

Performs a graceful shutdown of the service module.

service-module sm status

Displays configuration information related to the hardware and software on a service module.


service-module sm install

To use Cisco SRE to install an application on a service module (Cisco SM-SRE), use the service-module sm install command in privileged EXEC configuration mode.

service-module sm slot/port install url url [script filename] [argument "string"] [force]

Syntax Description

slot/port

Location of the services engine module in the router. For service modules, the slot number is 1 to 4 and the port number must be 0.

url url

Address of FTP or HTTP server, as defined in RFC 2396, on which application packages and Tcl scripts are located.

script

(Optional) Changes name of Tcl script to be run from default value to script specified by filename argument.

filename

Name of Tcl script.

argument

(Optional) Installer will not present options for the variable specified in the string argument.

string

Alphanumeric characters of variable to be passed directly to the Tcl script via the command line. Variable must be enclosed in quotation marks (" ").

force

(Optional) Tcl script automatically proceeds with install without prompting for user input.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

This command uses a common module-dependent bootloader on Cisco SRE to install a Linux-based application on a service module (Cisco SM-SRE).

The slash mark (/) is required between the slot argument and the port argument.

You can only issue one instance of this command at a time on a router. You cannot use this command to install an application on two or more services engine modules in the same router at a time.

The Tcl script to be run must reside in the same FTP or HTTP server and directory as the application packages to be installed. If a credential is required, the user name and password must be imbedded in the url as shown in the following example:

Router# service-module sm 1/0 install url 
ftp://username:passwd@server.com/vmss-k9.sme.version.pkg
 

If two or more of the optional keyword/argument combinations are used with this command, they must be issued in the order presented in the command syntax. For example, you cannot use the force keyword before the script or argument keywords nor the argument keyword before the script keyword when you issue this command.

Use the script filename keyword/argument combination with this command to specify that the Cisco IOS software use some Tcl script other than the default installer during the installation.

Use the argument "string" keyword/argument combination with this command to manually provide variables during installation process and bypass the user interaction feature of the installer. The variable must include the left and right quotation marks (" ").

Use the force keyword with this command to install an application without prompting for user input. If you use this keyword and if the application requires you to provide certain variables during the installation, you should also use the argument "string" keyword/argument combination to manually provide the required variables because the force keyword will direct the installer to bypass all user interaction during the installation.

To stop the install while the Tcl script is being downloaded, use the service-module sm install abort command. This command cannot be used once the actual installation begins.

Examples

The following example shows how to use the install menu on the Cisco Video Management and Storage System application, choose the first choice, Install software:

        Welcome to Cisco Systems Service Engine Helper Software
Please select from the following
1       Install software
2       Reload module
3       Disk cleanup
4       Install License(s)
5       Linux shell
(Type '?' at any time for help)
Choice: 1
Package name: vmss-k9.sme.eng_bld.pkg

cvmss-module#$mss-k9.sme.eng_bld.pkg script vmss-k9.sme.eng_bld.pkg.install.s$
Delete the installed Cisco Foundation Software and proceed with new installation? [no]: 
yes
Loading pub/VMSS-RAID0/vmss-k9.sme.eng_bld.pkg.install.sre !
[OK - 7918/4096 bytes]
Please select RAID mode for storage partition (1 = RAID-1, 2 = Linear RAID, 3 = RAID-0): 3
If you are installing on a system which already has VMSS installed your media partition 
may contain archives.
Would you like for the install to preserve this partition if it exists? Please note that 
if you are changing
your RAID option from the previous install, the media partition will not be preserved.  
Preserve? [n]:

Related Commands

Command
Description

service-module sm install abort

Stops the install and returns to the boot-loader prompt.

service-module sm uninstall

Uses Cisco SRE to uninstall an SRE-supported application on an SRE-enabled services engine module.


service-module sm install abort

To abort the install process on a Cisco SM-SRE, use the service-module sm install abort command in privileged EXEC configuration mode.

service-module sm slot/port install abort [force]

Syntax Description

slot/port

Location of the services engine module in the router. For service modules, the slot number is 1 to 4 and the port number must be 0.

force

(Optional) Tcl script automatically stops the installation without prompting for confirmation.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

This command stops the installation during the downloading portion of the process only and returns the console to the boot-loader prompt.


Note You cannot use this command to stop the process once the actual installation has begun.


Use the force keyword with this command to stop the process without first prompting for confirmation.

Examples

The following example shows how to use this command to stop an application installation without first prompting for confirmation:

Router# service-module sm 4/0 install abort force
.
.
.
boot-loader>
 

Related Commands

Command
Description

service-module sm install

Uses Cisco SRE to install an SRE-supported application on an SRE-enabled services engine module.


service-module sm reload

To perform a graceful shutdown and reboot of the Cisco SM-SRE service module operating system, use the service-module sm reload command in privileged EXEC mode.

service-module sm slot/port reload

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

At the confirmation prompt, press Enter to confirm the action or n to cancel.

Examples

The following example shows how to gracefully shut down the module and reboot the operating system:

Router# service-module sm 1/0 reload
 
Do you want to proceed with reload?[confirm]

Related Commands

Command
Description

interface sm

Configures an interface for a service module and enters interface configuration mode.

service-module sm reset

Resets the service module hardware.

service-module sm shutdown

Gracefully shuts down the service module.

show diag

Displays controller information for service modules.

show interfaces sm

Displays basic interface configuration information for service modules.


service-module sm reset

To reset the Cisco SM-SRE service module hardware, use the service-module sm reset command in privileged EXEC mode.

service-module sm slot/port reset

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

At the confirmation prompt, press Enter to confirm the action or n to cancel.


Caution Because you may lose data, use the service-module sm reset command only to recover from a shutdown or failed state.

Examples

The following example shows how to reset the service module hardware:

Router# service-module sm 1/0 reset
 

Use reset only to recover from shutdown or failed state

Warning: May lose data on the NVRAM, nonvolatile file system or unsaved configuration!

Do you want to reset?[confirm]

Related Commands

Command
Description

interface sm

Configures an interface for a service module and enters interface configuration mode.

service-module sm reload

Performs a graceful shutdown and reboot of the service module operating system.

service-module sm shutdown

Gracefully shuts down the service module.

show diag

Displays controller information for service modules.

show interfaces sm

Displays basic interface configuration information for service modules.


service-module sm session

To begin a configuration session for an Cisco SM-SRE service module through a console connection, use the service-module sm session command in privileged EXEC mode.

service-module sm slot/port session [clear]

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.

clear

(Optional) Clears the service module configuration session.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

Only one session at a time is allowed into the service module from the service module interface.

After starting a session, you can perform any service module configuration task. You first access the service module console in a user-level shell. To access the privileged EXEC command shell, where most commands are available, use the enable command.

After you finish configuration tasks and exit the service module console session, use this command with the clear keyword to clear the session. At the confirmation prompt, press Enter to confirm the action or n to cancel.

Examples

The following example shows a session being opened for a Cisco SM-SRE:

Router# service-module sm 1/0 session

 

Trying 10.10.10.1, 2129 ... Open

 

SE-Module con now available

Press RETURN to get started!

 

SE-Module> enable

 

The following example clears the session that had been used to configure the Cisco SM-SRE in slot 1:

Router# service-module sm 1/0 session clear
[confirm]
 [OK]

Related Commands

Command
Description

enable

Enters privileged EXEC mode.

interface

Configures an interface and enters interface configuration mode.

show diag

Displays controller information for a service module.

show interface sm

Displays basic interface configuration information for service modules.


service-module sm shutdown

To gracefully shut down a Cisco SM-SRE service module, use the service-module sm shutdown command in privileged EXEC mode.

service-module sm slot/port shutdown

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

At the confirmation prompt, press Enter to confirm the action or n to cancel.

This command brings down the operating system of the specified service module in an orderly fashion to protect the hard drive. When the system is shut down, the module can be removed from the router.

Examples

The following example shows how to gracefully shut down the service module:

Router# service-module sm 1/0 shutdown
 
Do you want to proceed with shutdown?[confirm] 
Use service module reset command to recover from shutdown.
 
WARNING: Confirm that the service-module status shows 'is Shutdown' before removing the 
module or powering off the system !

Related Commands

Command
Description

interface sm

Configures an interface for a Cisco SM-SRE and enters interface configuration mode.

service-module sm reload

Performs a graceful shut down and reboot of the Cisco SM-SRE operating system.

service-module sm reset

Resets the hardware on the Cisco SM-SRE.

show diag

Displays controller information for service modules.

show interfaces sm

Displays basic interface configuration information for the Cisco SM-SREs.


service-module sm statistics

To display reset and reload information for a Cisco SM-SRE service module and its Cisco IOS software, use the service-module sm statistics command in EXEC mode.

service-module sm slot/port statistics

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.


Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Examples

The following example displays information for a service module in slot 1:

Router# service-module sm 1/0 statistics

 

Module Reset Statistics:

 CLI reset count = 0

 CLI reload count = 0

 Registration request timeout reset count = 1

 Error recovery timeout reset count = 1

 Module registration count = 1

Related Commands

Command
Description

interface sm

Configures an interface for a Cisco SM-SRE and enters interface configuration mode.

service-module sm reload

Performs a graceful shutdown and reboot of the Cisco SM-SRE operating system.

service-module sm reset

Resets the Cisco SM-SRE hardware.

service-module sm shutdown

Gracefully shuts down the Cisco SM-SRE.

show interfaces sm

Displays basic interface configuration information for the Cisco SM-SREs.


service-module sm status

To display configuration information related to the hardware and software on a Cisco SM-SRE service module, use the service-module sm status command in privileged EXEC mode.

service-module sm slot/port status

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

/port

Port number of the module interface. Always use 0. The slash mark (/) is required.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

Use this command to:

Display the Cisco SM-SREs software release version

Check the Cisco SM-SRE status (steady or down)

Display hardware information for the Cisco SM-SRE, including CPU, memory, and interface information

Examples

The following example displays information for a Cisco SM-SRE:

Router# service-module sm 1/0 status

 

Service Module is Cisco SM1/0

Service Module supports session via TTY line 67

Service Module is in Steady state

Service Module heartbeat-reset is enabled

Getting status from the Service Module, please wait..

Cisco Foundation Software 1.0

FNDN Running on SM

No install/uninstall in progress

Related Commands

Command
Description

interface sm

Configures an interface for a Cisco SM-SRE and enters interface configuration mode.

show diag

Displays controller information for service modules.

show interfaces sm

Displays basic interface configuration information for the Cisco SM-SREs.


service-module sm uninstall

To use Cisco SRE to uninstall an application on a service module (Cisco SM-SRE), use the service-module sm uninstall command in privileged EXEC configuration mode.

service-module sm slot/port uninstall [force]

Syntax Description

slot/port

Location of the services engine module in the router. For service modules, the slot number is 1 to 4 and port number must be 0.

force

(Optional) Tcl script automatically proceeds with uninstall without prompting for confirmation.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

This command completely erases the disk or compact flash of the SRE-enabled services engine module and removes the application keys. It does not remove application licenses.

The slash mark (/) is required between the slot argument and the port argument.

You can only issue one instance of this command at a time on a router. You cannot use this command to uninstall an application on two or more services engine modules in a router at a time.

Use the force keyword with this command to uninstall an application without first prompting for confirmation.

Examples

The following example shows how to use this command to uninstall an application without first prompting for confirmation:

Router# service-module sm uninstall 1/0 force
Router#
 

Related Commands

Command
Description

service-module sm install

Uses Cisco SRE to install an SRE-supported application on an SRE-enabled services engine module.


show controllers sm

To display controller information for the service module interface, use the show controllers sm command in user EXEC or privileged EXEC mode.

show controllers sm slot/unit

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

unit

Port number of the module interface. Always use 0. The slash mark (/) is required between the slot argument and the unit argument.


Command Default

None

Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Version
Modification

15.0(1)M

This command was introduced.


Usage Guidelines

The output from this command is generally useful for diagnostic tasks performed by technical support only. You can, however, use the displayed hardware statistics to obtain the receive and transmit packet statistics that are collected by the hardware controller during packet processing.

Examples

The following example shows how to display information for the Cisco SM-SRE installed in the router:

Router# show controllers sm 1/0

Interface SM1/0
Hardware is PSE2
HWIDB: 0x11E3C8C8 INSTANCE: 0x01323100, FASTSEND: 0x040D6C44
Init flags: 0x23
 
FPGA registers
----------------
  Base address:   0xE4000000    Revision:       0x09030416
  FPGA type:      0x316B6278    FPGA_error_val: 0x00000000
  Cfg MSI mask:   0x00000008    Rx_buffer_size: 0x00000600
 
Frame statistics: (polling enabled)
-----------------------------------
  tx_frame_cnt: 177                     rx_frame_cnt: 28              
  tx_byte_cnt: 45154                    rx_byte_cnt: 2113            
  tx_pause_frame_cnt: 0                 rx_pause_frame_cnt: 0               
  rx_unicast_filtered_cnt: 0            rx_multicast_filtered_cnt: 8       
  rx_undersize_pkts: 0                  rx_oversize_pkts: 0
  tx_64_byte_pkts: 38                   rx_64_byte_pkts: 17              
  tx_65_to_127_byte_pkts: 17            rx_65_to_127_byte_pkts: 8
  tx_128_to_255_byte_pkts: 6            rx_128_to_255_byte_pkts: 3
  tx_256_to_511_byte_pkts: 116          rx_256_to_511_byte_pkts: 0
  tx_512_to_1023_byte_pkts: 0           rx_512_to_1023_byte_pkts: 0
  tx_1024_to_1518_byte_pkts: 0          rx_1024_to_1518_byte_pkts: 0
  rx_congestion_drop_cnt: 0             rx_mtusize_drop_cnt: 0
  rx_bad_cnt: 0               
 
Interrupt statistics
--------------------
  ge_tx_interrupt: 171                  ge_rx_interrupt: 20              
  txbd_seq_err: 0                       txbd_done_err: 0
  rxbd_done_err: 0                      isl_inner_crc_err: 0
  pcie_busmstr_dsbld_err: 0             pcie_tgt_abort_err: 0
  pcie_mst_abort_err: 0                 spi_done_event: 0
  rx_empty_pak: 0                       rx_sw_usage_err: 0
  ing_buf_adrs_err: 0                   pcie_null_ptr_err: 0
  uart_tx_intr: 13                      uart_rx_intr: 27169           
  uart_break_detected: 1                uart_framing_err: 0               
  uart_bad_egr_adrs: 0                  uart_egr_overflow: 0               
  i2c_errs: misc/nack/tmo: 0/0/0
 
TX ring
-------
  Tx Ring txr_head/txr_tail:  178/178
  Tx Shadow txs_head/txs_tail/txs_free: 178/178/256
  Tx Ring(txr): 0x3C631800 Tx Shadow (malloc): 0x01323380
  Tx Limited: 0 Tx Count: 0 hold_pak 0x00000000
 
RX rings
--------
  size: 256      max_spin_size 32       head: 20
  Rx Ring(rxr):   0x3C631000  rxr_malloc: 0x3C631000
  Rx Shadow(rxs): 0x11E3D6CC   rxs_malloc: 0x11E3D6CC
 
Software MAC Address Filter (hash:length/addr/mask/hits)
--------------------------------------------------------
   000:  0  ffff.ffff.ffff  0000.0000.0000         3
   007:  0  001e.4a97.644d  0000.0000.0000         0
   192:  0  0180.c200.0002  0000.0000.0000         0
   192:  1  0100.0ccc.cccc  0000.0000.0000         0
   197:  0  0180.c200.0007  0000.0000.0000         0
 
   Software filtered frames: 0
   Unicast overflow mode:   0
   Multicast overflow mode: 1
   Promiscuous mode:        0
 
  HW MAC Address Filter
  ---------------------
   Unicast Addr0: 001E.4A97.644D
   Unicast Addr1: 0000.0000.0100
   Unicast Addr2: 0000.0000.0100
   Unicast Addr3: 0000.0000.0100
   Unicast Addr4: 0000.0000.0100
   Unicast HW Filter Count   : 1
 
   Multicast Hash b63_32: 0x2000001
   Multicast Hash b32_00: 0x00
   HW unicast filter enabled: Yes
   HW multicast filter enabled: Yes
 
FPGA upgrade info
-----------------
  Golden area fpga version:  00000000
  Upgrade area fpga version: 09030416
  IOS bundled fpga version:  09030416

Table 11 describes the significant fields shown in the display.

Table 11 show controllers analysis-module Field Descriptions  

Field
Description

Hardware

Description of the chip being used.

IDB, FASTSEND

Address in router memory of the IDB1 and the fastsend routine.

INSTANCE

Device-specific data stored in router memory that lists the memory locations and current indexes of receive (Rx) and transmit (Tx) rings in router I/O memory.

CONTROL AND STATUS REGISTERS (CSR)

Control and status registers that are physically located on the chip itself and that are accessed by the CPU over the Peripheral Component Interconnect (PCI) bus.

PHY REGISTERS

Contents of the PHY registers. PHY is a device that interfaces the physical Ethernet line and that is located between the chip and the physical line.

HARDWARE STATISTICS

Receive (Rx) and transmit (Tx) traffic statistics collected by the chip.

INTERRUPT STATISTICS

Transmit (Tx), Receive (Rx), control, software, and flow control interrupt statistics collected by the chip.

1 IBD = Interface Descriptor Block


Related Commands

Command
Description

service-module sm status

Displays hardware and software status information about the Cisco SM-SRE.

show interfaces sm

Displays status, traffic data, and configuration information about the Cisco SM-SRE interface.


show interfaces sm

To display status, traffic data, and configuration information about the Cisco SM-SRE service module interface, use the show interfaces sm command in user EXEC or privileged EXEC mode.

show interfaces sm slot/port

Syntax Description

slot

Router slot in which the service module is installed. Range: 1 to 4.

port

Port number of the module interface. The slash mark (/) is required.


Defaults

None

Command Modes

User EXEC (>)
Privileged EXEC (#)

Command History

Version
Modification

115.0(1)M

This command was introduced.


Usage Guidelines

The service module interface is the Gigabit Ethernet interface on the router that connects to the Cisco SM-SRE.

Examples

The following example shows output from the show interfaces sm 1/0 command:

Router# show interfaces sm 1/0
SM1/0 is up, line protocol is up 
  Hardware is PSE2, address is 001e.4a97.644d (bia 001e.4a97.644d)
  Internet address is 30.0.0.1/24
  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec, 
     reliability 255/255, txload 1/255, rxload 1/255
  Encapsulation ARPA, loopback not set
  Keepalive set (10 sec)
  Full-duplex, 1000Mb/s, media type is internal
  output flow-control is XON, input flow-control is XON
  ARP type: ARPA, ARP Timeout 04:00:00
  Last input 00:00:13, output 00:00:04, output hang never
  Last clearing of "show interface" counters never
  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
  Queueing strategy: fifo
  Output queue: 0/60 (size/max)
  5 minute input rate 0 bits/sec, 0 packets/sec
  5 minute output rate 0 bits/sec, 0 packets/sec
     22 packets input, 1398 bytes, 0 no buffer
     Received 3 broadcasts, 0 runts, 0 giants, 0 throttles
     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
     0 watchdog, 0 multicast, 0 pause input
     0 input packets with dribble condition detected
     134 packets output, 42720 bytes, 0 underruns
     0 output errors, 0 collisions, 0 interface resets
     0 unknown protocol drops
     0 unknown protocol drops
     0 babbles, 0 late collision, 0 deferred
     0 lost carrier, 0 no carrier, 0 pause output
     0 output buffer failures, 0 output buffers swapped out

Table 12 describes the significant fields shown in the display.

Table 12 show interfaces sm Field Descriptions 

Field
Description

Hardware, address

Hardware type and address.

MTU

MTU1 of the service module interface.

BW

Bandwidth of the interface, in kbps.

DLY

Delay of the interface, in microseconds.

reliability

Reliability of the interface as a fraction of 255 (255/255 is 100 percent reliability), calculated as an exponential average over 5 minutes.

txload

Transmit load on the interface as a fraction of 255 (255/255 is completely saturated), calculated as an exponential average over 5 minutes.

rxload

Receive load on the interface as a fraction of 255 (255/255 is completely saturated), calculated as an exponential average over 5 minutes.

Encapsulation

Encapsulation method assigned to the interface.

loopback

Indicates whether or not loopback is set.

Keepalive

Indicates whether or not keepalives are set and the interval between keepalives if they have been set.

ARP type...ARP Timeout

Type of ARP2 assigned and length of timeout.

Last input

Number of hours, minutes, and seconds since the last packet was successfully received by the interface and processed locally on the router. This field is useful for detecting when a dead interface failed.

Note This field is not updated by fast-switched traffic.

output

Number of hours, minutes, and seconds since the last packet was successfully transmitted by the interface. This field is useful for detecting when a dead interface failed.

output hang

Number of hours, minutes, and seconds (or never) since the interface was last reset because a transmission took too long. When the number of hours in any of the "last" fields exceeds 24 hours, the number of days and hours is printed. If that field overflows, asterisks are printed.

Last clearing

Time at which the counters that measure cumulative statistics (such as number of bytes transmitted and received) shown in this report were last reset to zero. Note that variables that might affect routing (for example, load and reliability) are not cleared when the counters are cleared.

Asterisks (***) indicate that the elapsed time is too large to be displayed.

Input queue

Number of packets in the input queue. Each number is followed by a slash, the maximum size of the queue, the number of packets dropped because of a full queue, and the number of times that queued packets have been discarded.

Total output drops

Number of packets in the output queue that have been dropped because of a full queue.

Queueing strategy

Queueing strategy applied to the interface, which is configurable under the interface. The default is FIFO3 .

Output queue

Number of packets in the output queue, and the maximum size of the queue. Each number is followed by a slash.

5 minute input rate, 5 minute output rate

Average number of bits and packets transmitted per second in the last 5 minutes. If the interface is not in promiscuous mode, it senses network traffic that it sends and receives (rather than all network traffic).

The 5-minute input and output rates should be used only as an approximation of traffic per second during a given 5-minute period. These rates are exponentially weighted averages with a time constant of 5 minutes. A period of four time constants must pass before the average will be within 2 percent of the instantaneous rate of a uniform stream of traffic over that period.

Note The 5-minute period referenced in this output is a load interval that is configurable under the interface. The default value is
5 minutes.

packets input

Total number of error-free packets received by the system.

bytes

Total number of bytes, including data and MAC4 encapsulation, in the error-free packets received by the system.

no buffer

Number of received packets discarded because there was no buffer space in the main system. Compare with ignored count. Broadcast storms on Ethernets and bursts of noise on serial lines are often responsible for no input buffer events.

Received...broadcasts

Number of broadcasts received.

runts

Number of packets that are discarded because they are smaller than the minimum packet size of the medium. For instance, any Ethernet packet that is less than 64 bytes is considered a runt.

giants

Number of packets that are discarded because they exceed the maximum packet size of the medium. For example, any Ethernet packet that is greater than 1518 bytes is considered a giant.

throttles

Number of times that the interface requested another interface within the router to slow down.

input errors

Errors that include runts, giants, no buffer, CRC5 , frame, overrun, and ignored counts. Other input-related errors can also cause the input errors count to be increased, and some datagrams may have more than one error; therefore, this sum may not balance with the sum of enumerated input error counts.

CRC

Errors created when the CRC generated by the originating LAN station or far-end device does not match the checksum calculated from the data received. On a LAN, this usually indicates noise or transmission problems on the LAN interface or the LAN bus itself. A high number of CRCs is usually the result of collisions or a station that is transmitting bad data.

frame

Number of packets received incorrectly that have a CRC error and a noninteger number of octets. On a LAN, this is usually the result of collisions or a malfunctioning Ethernet device.

overrun

Number of times that the receiver hardware was unable to hand received data to a hardware buffer because the input rate exceeded the receiver's ability to handle the data.

ignored

Number of received packets that were ignored by the interface because the interface hardware ran low on internal buffers. These buffers are different from system buffer space described. Broadcast storms and bursts of noise can cause the ignored count to increase.

input packets with dribble condition detected

Number of packets with dribble condition. Dribble bit error indicates that a frame is slightly too long. This frame error counter is incremented just for informational purposes; the router accepts the frame.

packets output

Total number of messages that have been transmitted by the system.

bytes

Total number of bytes, including data and MAC encapsulation, that have been transmitted by the system.

underruns

Number of times that the transmitter has run faster than the router could handle. This may never be reported on some interfaces.

output errors

Sum of all errors that prevented the final transmission of datagrams out of the interface that is being examined. Note that this may not balance with the sum of the enumerated output errors, because some datagrams may have more than one error, and others may have errors that do not fall into any of the specifically tabulated categories.

collisions

Number of messages that have been retransmitted because of an Ethernet collision. This is usually the result of an overextended LAN (Ethernet or transceiver cable too long, more than two repeaters between stations, or too many cascaded multiport transceivers). A packet that collides is counted only once in output packets.

interface resets

Number of times an interface has been completely reset. This can happen if packets that were queued for transmission were not sent within several seconds. On a serial line, this can be caused by a malfunctioning modem that is not supplying the transmit clock signal or by a cable problem. If the system notices that the carrier detect line of a serial interface is up, but the line protocol is down, it periodically resets the interface in an effort to restart it. Interface resets can also occur when an interface is looped back or shut down.

babbles

Count of frames greater than 1518 bytes that have been transmitted, indicating that the transmitter has been on the interface longer than the time necessary to transmit the largest frame.

late collision

Number of late collisions. A collision becomes a late collision when it occurs after the preamble has been transmitted.

deferred

Deferred indicates that the chip, while ready to transmit a frame, had to defer because the carrier was asserted.

lost carrier

Number of times that the carrier was lost during transmission.

no carrier

Number of times that the carrier was not present during the transmission.

output buffer failures, output buffers swapped out

Number of failed buffers and number of buffers swapped out.

1 MTU = Maximum transmission unit

2 ARP = Address Resolution Protocol

3 FIFO = first-in, first-out

4 MAC = Media Access Control

5 CRC = cyclic redundancy checksum


Related Commands

Command
Description

show controllers sm

Displays controller information for the service module interface.