Archiving RPD Logs

Finding Feature Information

Your software release may not support all the features that are documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. The Feature Information Table at the end of this document provides information about the documented features and lists the releases in which each feature is supported.

Use Cisco Feature Navigator to find information about the platform support and Cisco software image support. To access Cisco Feature Navigator, go to the link http://tools.cisco.com/ITDIT/CFN/. An account at the http://www.cisco.com/ site is not required.

Hardware Compatibility Matrix for Cisco Remote PHY Device


Note

Unless otherwise specified, the hardware components introduced in a given Cisco Remote PHY Device Software Release are supported in all subsequent releases.
Table 1. Hardware Compatibility Matrix for the Cisco Remote PHY Device

Cisco HFC Platform

Remote PHY Device

Cisco GS7000 Super High Output Node

Cisco 1x2 / Compact Shelf RPD Software 2.1 and Later Releases

Cisco GS7000 Super High Output Intelligent Node (iNode)

Cisco 1x2 / Compact Shelf RPD Software 4.1 and Later Releases

Cisco Intelligent Remote PHY Device 1x2

  • PID—iRPD-1X2=

  • PID—iRPD-1X2-PKEY=


Note

The -PKEY suffix in the PID indicates units that enable the SCTE-55-2 Out-of-Band protocol support.

Information About Archiving Logs

You can archive logs to the SCP or TFTP server, or RPD itself.

When an RPD SSH session is closed during an RPD logging archive process, the RPD logging temp file is retained in the RPD file system. In this release, only the latest temp file is retained. The legacy temp files are removed.

Archiving Logs Using SCP or TFTP

To archive logs, use the logging command.

To transfer files to the TFTP server, use the logging [provision-archive|1588-archive|corefile-archive] tftp server_ip save_path command.

To transfer files to the SCP server, use the logging [provision-archive|1588-archive|corefile-archive] scp server_ip user save_path command.

To archive logs created during RPD provisioning to the SCP server, use the logging provision-archive scp server_ip user save_path command.


Note

  • Use provision-archive to archive logs created during RPD provisioning.

  • Use 1588-archive to archive PTP logs.

  • Use corefile-archive to archieve logs created duing system crashes.

  • user is the username of the SCP or TFTP server account to which files are transferred.

  • save_path is the relative path of the folder in the SCP or TFTP server. You must have write permission to access the folder. Make sure that the folder has sufficient space.

  • server_ip can be IPv4 or IPv6 address. The server IP address type must be the same as the RPD IP address.

  • For SCP file transfer, type the password of your server account when prompted. For TFTP file transfer, password is not required.

  • RPD should be able to successfully ping the SCP or TFTP server. If the ping is unsuccessful, files are not archived.


This is an example of how to archive logs created during RPD provisioning to the SCP server.


R-PHY#logging provision-archive scp 198.51.100.1 <user> /tmp
Wait for archiving logs
Collect tech-support info...

Wait for upload archive to server. It would take 3 minutes or more.
RPD logs will be saved in <user>@<server_ip>:/<save_path>/RPD_PROV_10049fc20200_LOG_2018-08-20_00_12_22_419798.tar.gz
 
Host '<server_ip>' is not in the trusted hosts file.
(ssh-rsa fingerprint md5 b6:bb:d4:20:92:47:bb:29:d7:2c:5d:47:7a:a5:c6:8d)
Do you want to continue connecting? (y/n) y
<user>@<server_ip>'s password:
RPD_PROV_10049fc20200_LOG_2018-08-20_00_12_22 100%   61MB   1.9MB/s   00:32   
[Done]

This is an example of how to archive PTP logs to the SCP server.


R-PHY#logging 1588-archive scp 198.51.100.1  <user> /tmp
 
wait for archiving 1588 logs
Wait for upload archive to server. It would take 3 minutes or more.
RPD logs are saved in user@198.51.100.1:/tmp/RPD_1588_0027900a0cf8_LOG_1977-01-08_21_26_05_222552.tar.gz
 
Host '198.51.100.1' is not in the trusted hosts file.
(ssh-rsa fingerprint md5 1d:9d:69:0c:17:1e:66:03:11:7e:ff:a3:c1:55:b1:a7)
Do you want to continue connecting? (y/n) user@198.51.100.1's password:
RPD_1588_0027900a0cf8_LOG_1977-01-08_21_26_05 100%   29     0.0KB/s   00:00
[Done]

This is an example of how to archive logs created during system crashes to the SCP server.

R-PHY#logging corefile-archive scp 198.51.100.1  <user> /tmp
 
wait for archiving corefile
Wait for upload archive to server. It would take 3 minutes or more.
RPD logs are saved in user@198.51.100.1:/tmp/RPD_COREFILE_0027900a0cf8_LOG_1977-01-08_21_27_59_522646.tar.gz
jianyzha@198.51.100.1's password:
RPD_COREFILE_0027900a0cf8_LOG_1977-01-08_21_2 100% 9126KB   8.9MB/s   00:01
[Done]

This is an example of how to archive logs created during RPD provisioning to the TFTP server.


R-PHY#logging provision-archive tftp 198.51.100.1 .
 
wait for archiving logs
Collect tech-support info...
 
wait for upload archive to server
RPD provision logs are saved in 198.51.100.1:$TFTP_DIR/./RPD_0027900a0cf8_LOG_1977-01-08_18_20_10_509660.tar.gz
[Done]

This is an example of how to archive PTP logs to the TFTP server.

R-PHY#logging 1588-archive tftp 198.51.100.1 .
 
wait for archiving 1588 logs
Wait for upload archive to server. It would take 3 minutes or more.
RPD logs are saved in 198.51.100.1:$TFTP_DIR/./RPD_1588_0027900a0cf8_LOG_1977-01-08_21_25_26_352484.tar.gz
[Done]

This is an example of how to archive logs created during system crashes to the TFTP server.


R-PHY#logging corefile-archive tftp 198.51.100.1 .
 
wait for archiving corefile
Wait for upload archive to server. It would take 3 minutes or more.
RPD logs are saved in 198.51.100.1:$TFTP_DIR/./RPD_COREFILE_0027900a0cf8_LOG_1977-01-08_21_27_37_782555.tar.gz
[Done]

Archiving Logs Locally

Starting from Cisco 1x2 / Compact Shelf RPD Software 7.3, user can save a log archive to /rpd/archive on the RPD using the command logging [provision-archive|1588-archive|corefile-archive] local . This archive can then be transferred or viewed locally.


Note

  • Use provision-archive to archive logs created during RPD provisioning.

  • Use 1588-archive to archive PTP logs.

  • Use corefile-archive to archieve logs created duing system crashes.


You can specify a date-range for archiving logs using the logging command. This command helps in controlling the size of the log archive if you specify logging only in the specific date range.

Configure logging by running the following commands:

logging provision-archive <from_date> <to_date> [scp|tftp|local]
logging 1588-archive <from_date> <to_date> [scp|tftp|local]
logging core-file archive <from_date> <to_date> [scp|tftp|local]

Usage

Enter the date range in the logging command and verify the logs locally or through SCP, TFTP. For example:

R-PHY#logging provision-archive 2020-07-10 2020-07-20 local
R-PHY#logging 1588-archive 2020-07-10 2020-07-20 local

R-PHY#logging provision-archive local
Collect tech-support info...
Please wait, archiving...
Created archive: /rpd/archive/RPD_PROV_badbad13ac3e_LOG_2019-08-28_11_59_01_898484.tar.gz
Created archive: /rpd/archive/RPD_running_log.tar.gz
Created archive: /rpd/archive/RPD_config_log.tar.gz
[Done]

Copying RPD Log Files using SCP

Remotely retrieving log files from the RPD via SCP is supported starting from Cisco 1x2 / Compact Shelf RPD Software 7.3 release. For security reasons, the SCP support would be limited to specific directories that contain the log files and only certain types of files under these directories. Only files from /tmp/, /rpd/, /rpd/archive/, /rpd/log/, and /rpd/log/<logname>.log/ are allowed. Filename must include one of: 'log', '.gz', or '.pcap'. This feature will only allow copying-out of files and will not allow copying-in of files to the RPD.

Feature Information for Archiving Logs

Use Cisco Feature Navigator to find information about the platform support and software image support. Cisco Feature Navigator enables you to determine which software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to the https://cfnng.cisco.com/ link. An account on the Cisco.com page is not required.


Note

The following table lists the software release in which a given feature is introduced. Unless noted otherwise, subsequent releases of that software release train also support that feature.


Table 2. Feature Information for Archiving Logs

Feature Name

Releases

Feature Information

Archiving Logs

Cisco 1x2 / Compact Shelf RPD Software 6.1

This feature was introduced on the Cisco Remote PHY Device.

SCP Support to Copy RPD Logfiles

Cisco 1x2 / Compact Shelf RPD Software 7.3

This feature was introduced on the Cisco Remote PHY Device.

Support for Local Archive

Cisco 1x2 / Compact Shelf RPD Software 7.3

This feature was introduced on the Cisco Remote PHY Device.