Skip to main content
Cluster and storage switches

Ethernet Switch Health Monitoring log collection

Contributors netapp-yvonneo aclose-ntap
PDFs

The Ethernet switch health monitor (CSHM) is responsible for ensuring the operational health of Cluster and Storage network switches and collecting switch logs for debugging purposes. This procedure guides you through the process of setting up and starting the collection of detailed Support logs from the switch and starts an hourly collection of Periodic data that is collected by AutoSupport.

Before you begin

  • To enable the log collection feature, you must be running ONTAP version 9.10.1P15, 9.11.1P12, or 9.12.1 or later and EFOS 3.8.0.2 or later.

  • Switch health monitoring must be enabled for the switch. Verify this by ensuring the Is Monitored: field is set to true in the output of the system switch ethernet show command.

Steps

  1. To set up log collection, run the following command for each switch. You are prompted to enter the switch name, username, and password for log collection.

    system switch ethernet log setup-password

    Show example 
    cluster1::*> system switch ethernet log setup-password
Enter the switch name: <return>
The switch name entered is not recognized.
Choose from the following list:
cs1
cs2

cluster1::*> system switch ethernet log setup-password

Enter the switch name: cs1
Would you like to specify a user other than admin for log collection? {y|n}: n

Enter the password: <enter switch password>
Enter the password again: <enter switch password>

cluster1::*> system switch ethernet log setup-password

Enter the switch name: cs2
Would you like to specify a user other than admin for log collection? {y|n}: n

Enter the password: <enter switch password>
Enter the password again: <enter switch password>

  2. To start log collection, run the following command, replacing DEVICE with the switch used in the previous command. This starts both types of log collection: the detailed Support logs and an hourly collection of Periodic data.

    system switch ethernet log modify -device <switch-name> -log-request true

    Show example 
    cluster1::*> system switch ethernet log modify -device cs1 -log-request true

Do you want to modify the cluster switch log collection configuration? {y|n}: [n] y

Enabling cluster switch log collection.

cluster1::*> system switch ethernet log modify -device cs2 -log-request true

Do you want to modify the cluster switch log collection configuration? {y|n}: [n] y

Enabling cluster switch log collection.

    Wait for 10 minutes and then check that the log collection completes:

    system switch ethernet log show

    Caution If any of these commands return an error or if the log collection does not complete, contact NetApp support.
Troubleshoot

If you encounter any of the following error statuses reported by the log collection feature (visible in the output of system switch ethernet log show), try the corresponding debug steps:

Log collection error status

Resolution

RSA keys not present

Regenerate ONTAP SSH keys. Contact NetApp support.

switch password error

Verify credentials, test SSH connectivity, and regenerate ONTAP SSH keys. Review switch documentation or contact NetApp support for instructions.

ECDSA keys not present for FIPS

If FIPS mode is enabled, ECDSA keys need to be generated on the switch before retrying.

pre-existing log found

Remove the previous log collection file on the switch.

switch dump log error

Ensure the switch user has log collection permissions. Refer to the prerequisites above.