• Unisphere CLI commands

    PDF

    Unisphere CLI commands

    Upgrade the system

    Create an upgrade session to upgrade the system or view existing upgrade sessions. The upgrade session installs an upgrade candidate file that was uploaded to the system. Download the latest upgrade candidate from the support website. Use the -upload switch to upload it to the system before creating the upgrade session.

    The latest software upgrade candidate contains all available hot fixes. If you have applied hot fixes to your system, the hot fixes will be included in the latest upgrade candidate.

    Note:  All system components must be healthy, prior to upgrading the system. If any system components are degraded, the update will fail. Perform a system health check explains how to run a health check on the system.

    The following table lists the attributes for upgrade sessions.

    Table 1. Upgrade session attributes
    Attribute
    Description
    Status
    Current status of the upgrade session. Value is one of the following:
    • running — Session is upgrading the system software.
    • completed — Session has completed upgrading the system software.
    • paused— Upgrade session has paused before rebooting the SPs.
    • failed— Upgrade session has failed.
    Progress
    Current progress of the upgrade session.
    Creation time
    Date and time the upgrade session was created.
    Elapsed time
    Amount of time that the upgrade session has been running.
    Estimated time left
    Estimated time required to complete the upgrade session.
    Percent complete
    Indicates the progress of the upgrade in percent.
    Type
    The type of upgrade being performed: software upgrade or storage processor upgrade. With software upgrade, details can be found with /sys/soft/ver show.
    Additional info
    Additional information about the status of the upgrade.

    View system software versions

    Display details about the version of the installed system software any upgrade candidates that have been uploaded to the system. Upgrade the system explains how to upgrade the system software.

    Format
    /sys/soft/ver [{-id <value>|-type {installed|candidate|downloaded}}] show
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the system software.
    -type
    Type the software type. Value is one of the following:
    • installed — View the version of the system software that is installed.
    • candidate — View the version of the system software upgrade candidate that was uploaded to the system.
    • downloaded — Software image that was automatically pushed to the system by support.
    Example

    The following command displays details about the installed system software and an uploaded upgrade candidate:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/soft/ver show
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:    ID              = INST_1
          Type            = installed
          Version         = 4.3.0.1498853411
          Release date    = 2017-06-30 23:33:44
          Image type      =
          Reboot required =
          Pause allowed   =
          Image filename  =
    
    2:    ID              = CAND_1
          Type            = candidate
          Version         = 4.3.0.1502142551
          Release date    = 2017-08-08 05:19:50
          Image type      = software
          Reboot required = yes
          Pause allowed   = yes
          Image filename  = Unity-c4dev_PIE_471-upgrade-4.3.0.1502142551-4.3.0.1502142551-GNOSIS_DEBUG.tgz.bin
    
    3:    ID              = ASD_1
          Type            = downloaded
          Version         = 4.2.0.9215195
          Release date    = 
          Image type      = software
          Reboot required =
          Pause allowed   =
          Image filename  = Unity-_dev_001-upgrade-4.2.0.9215195.9215195-4.2.0.9215195.9215195-GNOSIS_DEBUG.tgz.bin.gpg
    
    4:    ID              = ASD_2
          Type            = downloaded
          Version         = V2-Dec-19-2016
          Release date    =
          Image type      = firmware
          Reboot required =
          Pause allowed   =
          Image filename  = Unity-Drive-Firmware-V2-Dec-19-2016.tgz.bin.gpg
    
    
                            

    Perform a system health check

    Perform a health check of the entire system. A health check is a series of checks on the state of your system to ensure that no underlying problems exist.

    Note:  Before upgrading the system software, a system health check must be performed. All system components must be healthy prior to upgrading the system software. If any of the system components are degraded, the software update will fail.
    Format
    /sys/general healthcheck
    Example

    The following command performs a health check of the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/general healthcheck
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1: Error code = Error: The health check has failed. An internal error is preventing 
    the health check from completing successfully. Record the error code and search the 
    EMC Online Support website for available support options. 
    [Error Code: platform::check_boot_control_status_2]
    
    Operation completed successfully.
    
                            
    Note:  
    • The results of the health check may show errors and warnings, but a message of Operation completed successfully. displays in the output. This is only an indication that the health check action was performed, not that it was successfully completed without errors and warnings. Attempt to resolve all errors and rerun the health check.
    • If errors occur, a system software upgrade is not allowed. If warnings occur, they can be bypassed during the upgrade procedure.

    Upload an upgrade candidate

    To upgrade the system software, upload an upgrade candidate file that you download from the support website and use the -upload qualifier. Once you upload the candidate file to the system, use an upgrade session to start the upgrade process. Create upgrade sessions explains configuring upgrade sessions.

    Prerequisites

    Download the latest system software upgrade candidate from the support website.

    Format
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! -upload -f <file> upgrade
    Options
    Qualifier
    Description
    -f
    Type the path and file name of the upgrade candidate file to upload. Wrap the path and file name in quotes.
    Example

    The following example upload a upgrade candidate file to the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! -upload -f “upgrade-2.0.0.12190-MAGNUM-RETAIL.tgz.bin” upgrade
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            

    Create upgrade sessions

    Creates a new upgrade session. This could be a software or hardware upgrade that is monitored by a session.

    NOTICE  Do not use Unisphere or Unisphere CLI to manage or configure the system during a software upgrade.
    Format
    /sys/upgrade create –type { software [–candId <value>] [-pauseBeforeReboot] | sp -newSPModel <value>} [-offline]} [-pauseBetweenReboots]
    Action qualifiers
    Qualifier
    Description
    -candId
    Type the ID of the uploaded upgrade candidate. View system software versions explains how to view the ID of the uploaded software candidate.
    Note:  This argument is optional. If unspecified, the system looks up the upgrade candidate.
    -pauseBeforeReboot
    Specify whether to pause during the upgrade, executing all tasks before the SPs reboot.
    Note:  This option is ignored for language packs, hot fix, and ODFU upgrades.
    -newSPModel
    Start a storage processor upgrade with the specified target model. The possible values for this system are identified using /sys/general show.
    -offline
    Optional parameter that will start an offline storage processor upgrade rather than an online (default) storage processor upgrade.
    -pauseBetweenReboots
    Optional parameter for software or online Data-in-place (DIP) upgrades. If specified, the system will pause after the first SP has been upgraded, but before the second SP is upgraded. This will allow you to suspend the upgrade until you manually resume the upgrade using /sys/upgrade resume.
    Example 1

    The following command creates a session to upgrade the system software:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/upgrade create –type software
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            
    Note:  All warning messages, if any, appear the first time you run the upgrade process. When a potential issue results in a warning message, the upgrade process stops. Once you review the warning message, run the upgrade command again to continue with the upgrade process. This time the upgrade process will run the checks again, but it will not stop for any warnings. The upgrade process will only stop when an error occurs.
    Example 2

    The following command creates a session to upgrade the storage processor:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/upgrade create –type sp –newSPModel SP500
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            
    Example 3

    The following command initiates an offline DIP upgrade.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/upgrade create -type sp -newSPModel SP500 -offline
                              Storage system address: 10.64.75.201
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            
    Example 4

    The following command initiates a software upgrade that pauses after the first SP reboots.

    uemcli /sys/upgrade create -type software -pauseBetweenReboots
                              Storage system address: 10.64.75.201
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            

    View upgrade sessions

    View details for an existing upgrade session.

    Note:   The show action command explains how to change the output format.
    Format
    /sys/upgrade show
    Example 1

    The following command displays details about the hardware upgrade session:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/upgrade show
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:     Type                = SP
           Status              = Running
           Status message      = 
           Creation time       = 2015-11-09 19:43:08
           Elapsed time        = 01h 3m 08s
           Estimated time left = 01h 70m 00s
           Progress            = Task 2 of 5 (Running health checks)
           Percent complete    = 5%
                            
    Example 2

    The following command displays details about the software upgrade session:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/upgrade show
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:     Type                = Software
           Status              = Failed
           Status message      = Stopping c4 stack on SPA timeout expired
           Creation time       = 2009-11-09 18:04:12
           Elapsed time        = 00h 20m 08s
           Estimated time left = 
           Progress            = Task 5 of 25 (Stopping c4 stack on SPA)
           Percent complete    = 15%
                            
    Example 3

    The following command shows an issue with the pre-upgrade health check in Additional info.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /sys/upgrade show -detail
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:     Type                = Software
           Status              = Failed
           Creation time       = 2009-11-09 18:04:12
           Elapsed time        = 00h 20m 08s
           Estimated time left = 
           Progress            = 
           Percent complete    = 5%
           Additional info     = "Error: The health check has failed. An internal error is preventing the health check from completing successfully. Record the error code and search the EMC Online Support website for available support options. [Error Code: platform::check_boot_control_status_2]","Error: One or more LUNs are in degraded state. Record the error code and contact your service provider. [Error Code: flr::check_if_lun_recovery_is_required_2]"
                            

    The show action command

    The show action command displays a list of objects that exist on the system and the attributes of those objects. You can specify an object qualifier to view the attributes for a single object. The show action command provides qualifiers for changing the display of the output, including the format and the attributes to include. The available output formats are name-value pair (NVP), table, and comma-separated values (CSV).

    Format
    uemcli [<switches>] <object> [<object qualifier>] show [{-detail | -brief | -filter <value>] [-output {nvp | table [-wrap] | csv}]
    Action qualifier
    Qualifier
    Description
    -output|-o
    Specify the output format. Value is one of the following:
    • nvp — The name-value pair (NVP) format displays output as name=value. Name-value pair format provides an example of the NVP format.
    • table — The table format displays output as a table, with column headers and rows. By default, values that are too long to fit in a column are cut off. Add -wrap after the table qualifier, separated by a space, so that the values wrap. Table format provides an example of the table format.
    • csv — The comma-separated values (CSV) format is similar to the table format, but the names and values are separated by commas. Comma-separated values format provides an example of the CSV format.
    -detail
    Display all attributes.
    -brief
    Display only the basic attributes (default).
    -filter
    Comma-separated list of attributes which are included into the command output.
    Name-value pair format
                          1:     ID                 = la0_SPA
           SP                 = SPA
           Ports              = eth0_SPA,eth1_SPA
           Health state       = OK (5)
    
    2:     ID                 = la0_SPB
           SP                 = SPB
           Ports              = eth0_SPB,eth1_SPB
           Health state       = OK (5)
    
                        
    Table format
                          ID      | SP  | Ports             | Health state
    --------+-----+-------------------+--------------
    la0_SPA | SPA | eth0_SPA,eth1_SPA | OK (5)
    la0_SPB | SPB | eth0_SPB,eth1_SPB | OK (5)
                        
    Comma-separated values format
                          ID,SP,Ports,Health state
    la0_SPA,SPA,”eth0_SPA,eth1_SPA”,OK (5)
    la0_SPB,SPB,”eth0_SPB,eth1_SPB”,OK (5)
                        
    Example

    The following command modifies the set of attributes in the show action output. For example, if you add -filter "ID,ID,ID,ID" to the command, in the output you will see four lines with the "ID" attribute for each listed instance:

                          1:  ID = la_0
        ID = la_0
        ID = la_0
        ID = la_0
                        
    uemcli /net/nas/server show -filter “ID, SP, Health state, ID, Name”
    Filter format
                          Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:     ID           = nas_1
           SP           = SPA
           Health state = OK (5)
           ID           = nas_1
           Name         = Mynas1
    
    2:     ID           = nas_2
           SP           = SPA
           Health state = OK (5)
           ID           = nas_2
           Name         = Mynas2