Artesyn MaxCore MC3000 User manual

SSF for MaxCore™ MC3000 Platform
Command Line Interface Guide
P/N: 6806800T87D
March 2017

© Copyright 2017 Artesyn Embedded Technologies, Inc.
All rights reserved.
Trademarks
Artesyn Embedded Technologies, Artesyn and the Artesyn Embedded Technologies logo are trademarks and service marks of
Artesyn Embedded Technologies, Inc. All other names and logos referred to are trade names, trademarks, or registered trademarks
of their respective owners. © 2017 Artesyn Embedded Technologies, Inc. All rights reserved. For full legal terms and conditions,
please visit www.artesyn.com/legal.
Notice
While reasonable efforts have been made to assure the accuracy of this document, Artesyn assumes no liability resulting from any
omissions in this document, or from the use of the information obtained therein. Artesyn reserves the right to revise this document
and to make changes from time to time in the content hereof without obligation of Artesyn to notify any person of such revision or
changes.
Electronic versions of this material may be read online, downloaded for personal use, or referenced in another document as a URL to
an Artesyn website. The text itself may not be published commercially in print or electronic form, edited, translated, or otherwise
altered without the permission of Artesyn.
It is possible that this publication may contain reference to or information about Artesyn products (machines and programs),
programming, or services that are not available in your country. Such references or information must not be construed to mean that
Artesyn intends to announce such Artesyn products, programming, or services in your country.
Limited and Restricted Rights Legend
If the documentation contained herein is supplied, directly or indirectly, to the U.S. Government, the following notice shall apply
unless otherwise agreed to in writing by Artesyn.
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (b)(3) of the Rights in
Technical Data clause at DFARS 252.227-7013 (Nov. 1995) and of the Rights in Noncommercial Computer Software and
Documentation clause at DFARS 252.227-7014 (Jun. 1995).
Contact Address
Artesyn Embedded Technologies Artesyn Embedded Technologies
Marketing Communications Lilienthalstr. 17-19
2900 S. Diablo Way, Suite 190 85579 Neubiberg/Munich
Tempe, Arizona 85282 Germany

Contents
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 3
About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1 Accessing SSF using CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.2 Connecting to CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2 Access Control Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.1 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.2 user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.3 group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.4 show-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
2.5 user, group, and membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3 Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.1 snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.2 reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.3 commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.4 system-upgrade-initiate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.4.1 system-upgrade-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4 Hardware Platform Manager Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.1 applyPEXConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
4.2 assignIODeviceFunctionToCPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
4.3 createIODeviceFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.4 destroyAllIODeviceFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.5 eventLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.6 getCPUAssignedFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.7 getCPUVirtualNICFunctionCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
4.8 getChassisPayloadPowerPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
4.9 getCoolingPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
4.10 getFunctionAssignedCPUAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
4.11 getPEXMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
4.12 getSATAAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Contents

SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
Contents
4
Contents
Contents
4.13 getShelfHostAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.14 getUSBAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.15 getZoneType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4.16 listAlarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4.17 listAvailableCPUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
4.18 listAvailableIODevices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4.19 listShelfInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4.20 removeIODeviceFunctionFromCPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
4.21 resetPEXConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
4.22 setCPUVirtualNICFunctionCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.23 setChassisPayloadPowerPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.24 setCoolingPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4.25 setPEXMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4.26 setSATAAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
4.27 setUSBAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
4.28 getBIOSBootOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
4.29 getBIOSConsoleRedirectionParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4.30 getBIOSBootConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4.31 getBIOSPeripheralConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
4.32 getBIOSIIOConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
4.33 getBIOSSATAConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
4.34 getBIOSVideoConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
4.35 getBIOSUSBConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4.36 getBIOSProcessorConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4.37 getBIOSPowerManagementConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.38 getBIOSThermalConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.39 getBIOSMemoryConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
4.40 getBIOSCommonRefcodeConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
4.41 setBIOSBootOrderNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
4.42 setBIOSBootOrderDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
4.43 setBIOSBootOrderbyIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
4.44 setBIOSConsoleRedirectionParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4.45 setBIOSBootConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
4.46 setBIOSPeripheralConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
4.47 setBIOSIIOConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4.48 setBIOSSATAConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Contents
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 5
4.49 setBIOSVideoConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
4.50 setBIOSUSBConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
4.51 setBIOSProcessorConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.52 setBIOSPowerManagementConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
4.53 setBIOSThermalConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
4.54 setBIOSMemoryConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.55 setBIOSCommonRefcodeConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
5 System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
5.1 CLI Commands in disable mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
5.2 CLI commands in enable mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
5.3 CLI commands in config mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
5.4 CLI Commands in System Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
5.5 exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.6 CLI Commands for Shelf Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.7 CLI Commands for PCIeSlot Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
5.8 CLI Commands for PCIeCard Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.9 CLI Commands for CPU Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
5.10 CLI Commands for BIOS Configuration mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.11 CLI Commands for VEE mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5.12 CLI Commands for Linux Application mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
6 System Log Collection Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
6.1 collectlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
6.2 listlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
6.3 deletelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.4 ssflogsize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.5 downloadlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
A Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
A.1 Artesyn Embedded Technologies - Embedded Computing Documentation . . . . . . . . . . . . . . . . 95

SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
Contents
6
Contents
Contents

List of Tables
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 7
Table 1-1 Command Line Editing Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Table 2-1 Parameters of the show command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 2-2 Parameters of the user command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 2-3 Parameters of the group command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 2-4 Parameters of the user, group, and membership commands . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 3-1 Parameters of snapshot command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 3-2 Parameters of reload command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 3-3 Parameters of commit command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Table 3-4 Parameters of systemupgrade command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Table 4-1 Parameters of applyPEXConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Table 4-2 Parameters of assignIODeviceFunctionToCPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Table 4-3 Parameters of createIODeviceFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Table 4-4 Parameters of destroyAllIODeviceFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Table 4-5 Parameters of eventLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Table 4-6 Parameters of getCPUAssignedFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Table 4-7 Parameters of getCPUVirtualNICFunctionCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Table 4-8 Parameters of getChassisPayloadPowerPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 4-9 Parameters of getCoolingPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 4-10 Parameters of getFunctionAssignedCPUAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 4-11 Parameters of getPEXMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 4-12 Parameters of getSATAAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 4-13 Parameters of getShelfHostAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 4-14 Parameters of getUSBAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 4-15 Parameters of getZoneType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Table 4-16 Parameters of listAlarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Table 4-17 Parameters of listAvailableCPUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Table 4-18 Parameters of listAvailableIODevices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Table 4-19 Parameters of listShelfInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Table 4-20 Parameters of removeIODeviceFunctionFromCPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Table 4-21 Parameters of resetPEXConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Table 4-22 Parameters of setCPUVirtualNICFunctionCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Table 4-23 Parameters of removeIODeviceFunctionFromCPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Table 4-24 Parameters of setCoolingPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Table 4-25 Parameters of setPEXMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 4-26 Parameters of setSATAAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 4-27 Parameters of setUSBAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
8
List of Tables
Table 4-28 Parameters of getBIOSBootOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Table 4-29 Parameters of getBIOSConsoleRedirectionParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Table 4-30 Parameters of getBIOSBootConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Table 4-31 Parameters of getBIOSPeripheralConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Table 4-32 Parameters of getBIOSIIOConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Table 4-33 Parameters of getBIOSSATAConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 4-34 Parameters of getBIOSVideoConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 4-35 Parameters of getBIOSUSBConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Table 4-36 Parameters of getBIOSProcessorConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Table 4-37 Parameters of getBIOSPowerManagementConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 4-38 Parameters of getBIOSThermalConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 4-39 Parameters of getBIOSMemoryConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 4-40 Parameters of getBIOSCommonRefcodeConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 4-41 Parameters of setBIOSBootOrderNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 4-42 Parameters of setBIOSBootOrderDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 4-43 Parameters of setBIOSBootOrderbyIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 4-44 Parameters of setBIOSConsoleRedirectionParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Table 4-45 Parameters of setBIOSBootConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Table 4-46 Parameters of setBIOSPeripheralConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Table 4-47 Parameters of setBIOSIIOConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Table 4-48 Parameters of setBIOSSATAConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Table 4-49 Parameters of getBIOSVideoConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 4-50 Parameters of setBIOSUSBConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Table 4-51 Parameters of setBIOSProcessorConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Table 4-52 Parameters of setBIOSPowerManagementConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 4-53 Parameters of setBIOSThermalConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Table 4-54 Parameters of setBIOSMemoryConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Table 4-55 Parameters of setBIOSCommonRefcodeConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Table 5-1 Parameters of Disable mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Table 5-2 Parameters of Enable mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Table 5-3 Parameters of Configure mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Table 5-4 Parameters of System mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Table 5-5 Parameters of Shelf mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Table 5-6 Parameters of PCIeSlot mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
Table 5-7 Parameters of PCIeCard mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Table 5-8 Parameters of CPU mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

List of Tables
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 9
Table 5-9 Parameters of BIOS mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Table 5-10 Parameters of VEE mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Table 5-11 Parameters of Linux Application mode commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Table A-1 Artesyn Embedded Technologies - Embedded Computing Publications . . . . . . . . . . . . . . . 95

SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
10
List of Tables

SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 11
About this Manual
Overview of Contents
This guide provides detailed information on usage of Command Line Interface (CLI) to work
with System Services Framework (SSF). The following list gives an overview of the chapters
described in this document.
Chapter 1, Introduction provides overview of SSF, SSF key features, accessing of SSF using CLI, and
connecting to CLI.
Chapter 2, Access Control Commands provides Access Control commands and their definitions in
detail.
Chapter 3, Configuration Commands provides Snapshot, Reload, and Commit commands and
their definitions in detail.
Chapter 4, Hardware Platform Manager Commands provides Hardware Platform Manager
commands and their definitions in detail.
Chapter 5, System Commands provides System related commands and their definitions in detail.
Chapter 6, System Log Collection Commands provides System Log Collection commands and
their definitions in detail. Also, describes how to collect system logs from different cards to SSF Core.
Appendix A, Related Documentation lists the relevant manuals.
Abbreviations
The following table lists the abbreviations used in this guide.
Abbreviation Definition
BMC Baseboard Management Controller
CSIM Common System Information Model
HPM Hardware Platform Manager
PEE Physical Execution Environment
PCIe Peripheral Component Interconnect Express
VEE Virtual Execution Environment

SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
About this Manual
12
About this Manual
Conventions
The following table describes the conventions used throughout this manual.
SRstackware Switching and Routing stackware
SSF System Services Framework
VEE Virtual Execution Environment
VF Virtual Function
Abbreviation Definition
Notation Description
0x00000000 Typical notation for hexadecimal numbers (digits are
0 through F) used for addresses, offsets, and so on
0b0000 Same for binary numbers (digits are 0 and 1)
bold Used to emphasize a word
Screen Used for on-screen output and code related elements
or commands in body text
Courier + Bold Used to characterize user input and to separate it
from system output
Reference Used for references and for table and figure
descriptions
File > Exit Notation for selecting a submenu
<text> Notation for variables and keys
[text] Notation for software buttons to click on the screen
and parameter description
... Repeated item for example node 1, node 2, ..., node
12
.
.
.
Omission of information from example/command
that is not necessary at the time being
.. Ranges. For example: 0..4 means one of the integers
0,1,2,3, and 4 (used in registers)
| Logical OR

About this Manual
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 13
Indicates a hazardous situation which, if not avoided,
could result in death or serious injury
Indicates a hazardous situation which, if not avoided,
may result in minor or moderate injury
Indicates a property damage message
No danger encountered. Pay attention to important
information
Notation Description

SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
About this Manual
14
About this Manual
Summary of Changes
Part Number Date Description
6806800T87D March 2017 Added CLI Commands for PCIeSlot Mode on page 77, CLI
Commands for PCIeCard Mode on page 78, CLI Commands for CPU
Mode on page 80, CLI Commands for BIOS Configuration mode on
page 81, CLI Commands for VEE mode on page 87, CLI Commands
for Linux Application mode on page 89, setBIOSBootOrderDefault
on page 54, setBIOSBootOrderbyIndex on page 55, and system-
upgrade-initiate on page 24.
6806800T87C November 2016 Updated Chapter 1, Introduction, on page 15, Chapter 2, Access
Control Commands, on page 19, Chapter 3, Configuration
Commands, on page 23, Chapter 4, Hardware Platform Manager
Commands, on page 31, and Chapter 5, System Commands, on
page 67.
6806800T87B September 2016 Added a new chapter SharpMedia PCIE-8120 Commands on page
57.
6806800T87A January 2016 Initial version

Chapter 1
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 15
Introduction
System Services Framework (SSF) is a management and configuration interface to Artesyn's
hardware and software products. It facilitates system level configuration and management
access to SSF managed hardware and software components, through Web, CLI, and XML
protocol interfaces.
SSF learns all the hardware and system software components to represent in Common System
Information Model (CSIM). It provides a user interface to manage servers from a single
management interface and stores the attributes and corresponding configurations of each
hardware or software component in the PostgreSQL database for persistency.
SSF key features:
Access, Authentication, and Authorization
Configuration persistency, reload, and rollback
Hierarchal representation of System Model
Dynamic population of System Model
Remote system configuration management, firmware upgrade, and system diagnosis
1.1 Accessing SSF using CLI
You can access SSF using the CLI. SSF provides a fully functional CLI with auto complete, history,
and help features.
SSF CLI is a Telnet daemon that waits for inbound TCP connections. You can access the CLI
through Telnet session. The CLI can serve multiple client sessions simultaneously, and the
number of sessions supported by SSF is limited to "maxSessions" configured in
"/opt/ssf/etc/config/main/cli.cfg".
SSF CLI enables to traverse the system hierarchically and provides configuration and
management access to the SSF system. All these hierarchies are represented as nodes.
Using CLI, you can:
Edit SSF configuration
View general system information
Configure and manage all platform services, such as syslog-ng and syslcu
Upgrade the firmware

Introduction
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
16
The following table provides command line editing features of SSF CLI.
1.2 Connecting to CLI
You can connect to the CLI after login into the SSF running Host, using External SSH Daemon
with SSH Connection. This is the default behavior of SSF CLI.
Start the Telnet connection from an already established secure shell.
[root@abts-ap-static-214 ~]# telnet localhost 11001
Trying ::1...
telnet: connect to address ::1: Connection refused
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Welcome to SSF CLI
Username: Admin
Password:
Access granted
Table 1-1 Command Line Editing Features
Keywords Description
Left and Right arrow keys Allow you to move the cursor within the current command line.
Up and Down arrow keys Allow you to browse through a command history.
BACKSPACE Key Enables you to remove the character towards left.
TAB key Completes the keyword being entered automatically.
"?" key Provides you context help.
<cr> Carriage return. System displays this command when you provide all
mandatory arguments of a particular CLI command. It represents the
command syntax completion.

Introduction
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 17
>enable
#configure terminal
MaxCore(config)#
By default, the IP address is configured as 127.0.0.1 and the port numbers are
11001(CLI) and 15550 (XML).
Also the cli.cfg file configures:
The maximum number of connections to the command line interface, default value is 5.
The time out in seconds, default value is 300.

Introduction
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
18

Chapter 2
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D) 19
Access Control Commands
The access control commands allow you to access the authentication mode of the SSF. Using
the access control commands, you can:
Add new users
Modify existing user details
Delete existing users
Create new groups and add users into it
View the list of available users and groups.
To execute the access control commands, you should work in the privilege mode of CLI as
shown below:
[root@abts-ap-static-214 ~]# telnet localhost 11001
Trying ::1...
telnet: connect to address ::1: Connection refused
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Welcome to SSF CLI
Username: Admin
Password:
Access granted
>enable
#configure terminal
MaxCore(config)#

Access Control Commands
SSF for MaxCore™ MC3000 Platform Command Line Interface Guide (6806800T87D)
20
2.1 show
The showcommand in the authentication mode allows you to view the properties of users and
groups. This command takes user name or group name as its parameters. When the parameter
is <user name>, it displays the properties of the specified user name. When the parameter is
<group name>, it displays the properties of the specified group name.
Syntax
show {user|group} <username>|<groupname>
Example
#show user Admin
2.2 user
The user commands allow you to add, delete, and modify users from the user database.
To add a user
Syntax
username <username> password <password>
To modify a user password
Syntax
password <username> <password>
To delete a user
Table 2-1 Parameters of the show command
Argument Description
<username> Type the valid user name of whom you want to view the details. The
name and password of the specified user are displayed.
<groupname> Type the valid group name of which you want to view the details. The
name and membership object of the specified group are displayed.