background image

IBM® Carrier Grade Server X3650 T

 

Revision 3.0 

 

 

41

9. Monitoring 

SysCon 

Activity 

9.1  Logging SysCon Events 

The SysCon feature logs events during the pre-boot phase to one or more destinations, as directed by its 
policy settings.   The user can control the depth of logging as well as the destination type for logged 
events. 

The user may control the SysCon logging policy by modifying the ‘policysettings.xml’ file and using the 
elements described in Appendix X.   User-selectable logging policy settings include: 

Log entry severity filter 

Designates the severity level of logged events.  Event severities 
are (in most severe to least severe order): 

  

CRITICAL 

  

ERROR 

  

WARNING 

  

INFO 

  

DEBUG 

 

Maximum log size 

The maximum log file size (in kilobytes). 

Log entry destination(s) 

The destination or destinations for log entries.  SysCon pre-boot 
events may be logged to one or more of the following: 

System Event Log (SEL) 

The SysCon feature can use the IPMI interface to log 
SysCon events into the hardware-based SEL.  SEL 
entries are accessible out-of-band via the Intel

®

 

Management Module. 

SysCon event log 

The SysCon feature can log events to a text file on the 
SysCon Device itself.  The SysCon event log is an XML 
document which follows the schema documented in 
Appendix D. 

Summary of Contents for Carrier Grade X3650 T

Page 1: ...IBM Carrier Grade Server X3650 T SysCon User s Guide Order Number D23731 003 Revision 3 0 March 2006...

Page 2: ...e Server X3650 T Revision 3 0 ii Revision History Date Revision Number Modifications May 2005 1 0 Preliminary Initial Release June 2005 2 0 Preliminary Restructured installation information March 2006...

Page 3: ...e of development Do not finalize a design with this information Revised information will be published when the product is available Verify with your local sales office that you have the latest datashe...

Page 4: ...re 15 3 3 2 Deactivating the SysCon feature 18 4 SysCon Feature Operation Overview 19 4 1 Configuring and booting the first time 19 4 2 Reconfiguring the system 19 5 Booting the System 20 6 Controllin...

Page 5: ...ation and Actions 46 12 2 1 SysCon Events 46 12 2 2 SysCon Event Logging and Notification 46 12 2 3 SysCon Event Logging and Notification Policies 48 12 2 4 SysCon Actions on Events 48 12 2 5 SysCon E...

Page 6: ...ead Access 80 17 2 2 Read from an Event Log 81 17 2 3 Notify Process of Availability of System Log Data 82 17 2 4 Remove Notification Request 86 17 2 5 Close Event Log 86 17 2 6 Reposition the Read Po...

Page 7: ...rade Server X3650 T Revision 3 0 vii List of Tables Table 1 Seek Directions 87 Table 2 Query Purpose Flags 90 Table 3 Required Operations on Standard Attributes 93 Table 4 Required Operations in Limit...

Page 8: ...IBM Carrier Grade Server X3650 T Revision 3 0 viii This page intentionally left blank...

Page 9: ...feature includes a pre boot application which controls the process of examining the system configuration and taking appropriate action during the system boot process The SysCon feature also provides O...

Page 10: ...e BIOS and the server management features BMC Intel Management Module 2 2 Detection of system setting changes The SysCon feature compares the current settings recently extracted with settings that it...

Page 11: ...er X3650 T Next install the SysCon feature by inserting the IBM Carrier Grade Server X3650 T IBM Server Resource CD into the system s DVD ROM drive and wait for the auto launcher to display a start up...

Page 12: ...IBM Carrier Grade Server X3650 T Revision 3 0 4...

Page 13: ...Revision 3 0 5 3 1 1 Python Python is required to complete the installation of the SysCon device Python version 1 5 is supported in EFI These Python install packages can be skipped if a newer version...

Page 14: ...IBM Carrier Grade Server X3650 T Revision 3 0 6 In this example F happens to be the Windows system root device It is normally C Tcl TK is optional You can uncheck this component here...

Page 15: ...IBM Carrier Grade Server X3650 T Revision 3 0 7...

Page 16: ...here Or if you decide to install Tcl Tk click Yes and follow the install instructions that follow PyXML is required also to complete the installation of the SysCon device This package is included in...

Page 17: ...IBM Carrier Grade Server X3650 T Revision 3 0 9...

Page 18: ...to install the SysCon files onto the SysCon device The user is required to enter the mount point of the SysCon USB device Normally it is the next DOS drive letter following the DVD ROM drive If there...

Page 19: ...0 T Revision 3 0 11 When prompted for the SysCon device you may copy and paste the mount point of the device into the command window Select Option 2 to install the SysCon device Other options are not...

Page 20: ...s automatically restarted This will remount the SysCon device under the System Root in the SysCon folder To reformat the SysCon device using the startup cmd the SysConMonitor service must be stopped A...

Page 21: ...l do this the FAT file system that is created using this method is not recognized by EFI The SysCon device needs to be formatted with the EFI format utility An EFI menu option is provided for this pur...

Page 22: ...to the SysCon directory Note The format option is not available when the device is mapped to the SysCon directory 3 2 Linux The Linux SysCon feature is contained in the RPM syscon i386 rpm The followi...

Page 23: ...has a filesystem installed on it by attempting to mount the device with the following shell commands i mkdir etc syscon mnt2 ii mount dev etc syscon mnt2 where dev is the device identifier noted in a...

Page 24: ...rt the server On restart the system will boot to the Extensible Firmware Interface an embedded pre OS system management environment From the EFI Main Menu select Boot Option Maintenance Menu a list of...

Page 25: ...IBM Carrier Grade Server X3650 T Revision 3 0 17...

Page 26: ...BM Carrier Grade Server X3650 T Revision 3 0 18 3 3 2 Deactivating the SysCon feature To deactivate the SysCon device simply remove it from the top of the boot sequence in the BIOS Boot Selection Menu...

Page 27: ...e of the system itself detecting any changes and acting according to its policy settings By default the SysCon policy is to reconfigure the system using saved settings whenever it detects that system...

Page 28: ...the applied folder c Capture the current system settings in the current folder of the SysCon Device d Copy the settings from current to the saved folder e Reboot the system See Creating System Setting...

Page 29: ...that can be customized by the user These policies and their format are described in detail in the SysCon Service User s Guide AlwaysArchiveSystemSettingsCopy When this policy is selected the SysCon f...

Page 30: ...stem searches for a boot device If there is no console or if the console prompts time out the SysCon feature follows the preset policies to determine its course of action At startup the SysCon feature...

Page 31: ...vironments present 0 fs1 SysCon Version 1 0 1 fs2 Unknown or Update Version 2 fs0 SysCon Version 1 1 working SysCon environment 0 is the SysCon Device 1 Change working SysCon environment 2 Format SysC...

Page 32: ...tion 4 Accept all current component settings removes saved settings which deletes all saved setting from the saved folder was selected Note that because this operation is only performed once per sessi...

Page 33: ...rtup here resume from the SysConRAMdisk to restart SysCon appears This allows the user to restart the SysCon feature execution from the root directory of any SysCon environment Using the word resume w...

Page 34: ...f the user presses Enter the SysCon feature retains the current configuration and does not update the saved configuration on the SysCon Device If the user presses s then Enter the SysCon feature remov...

Page 35: ...policy AlwaysRestoreSavedSettings is not set the following messages are displayed and logged Replacement system detected due to system attribute change Not restoring settings to replacement system Th...

Page 36: ...m onto the SysCon Key This can also be accomplished with the following menu option 7 Backup configuration data to Key The user can disable this function using the SysCon policy settings See Controllin...

Page 37: ...Device using a SysCon Key When the system s SysCon Device is not installed the user may install the feature using a SysCon Key However installing the SysCon feature from EFI is not recommended for 2...

Page 38: ...at this point and the map r EFI command executed Note that the EFI mapping table now contains a new file system designated fs1 representing the USB device that was inserted in the front panel for Pci...

Page 39: ...ented with the following menu Select menu option 3 to install the SysCon feature to the SysCon Device Note The menu above will also be presented if the Format SysCon Device option is selected and a Sy...

Page 40: ...first To verify that the EFI environment is set up correctly one can exit to the EFI shell and execute the map command The set command shows the EFI EfiMapTable variable settings which designates the...

Page 41: ...0 in the system Changing to the newly installed file system with the EFI command fs0 one can now enter startup to execute the EFI startup nsh script and run the SysCon feature for the first time This...

Page 42: ...can select the menu option resume SysCon processing 7 4 4 Updating a SysCon Device using a SysCon Key When the SysCon device already has an established SysCon environment and a SysCon Key is inserted...

Page 43: ...IBM Carrier Grade Server X3650 T Revision 3 0 35...

Page 44: ...nd in the log xml file located in sysconenv data config thisSystem folder of the SysCon Device 8 1 Encrypting Settings Data If desired the user may encrypt component settings data in order to protect...

Page 45: ...ed folder to indicate that they have been applied User specified settings may be placed on the SysCon Device via user interruption of the Pre Boot application user authorized import of settings from a...

Page 46: ...tings the following messages are displayed As indicated above the specified file Intel syscfg V001 scf is applied then the Intel imm chassis xml is scanned for settings for each installed SysCon compo...

Page 47: ...key The import option copies the files in the sysconenv data common settings specified folder of the SysCon key to the sysconenv data config thisSystem specified folder on the SysCon device These spe...

Page 48: ...as shown above If the key has an existing SysCon environment on it the version information will be displayed After the key has been installed the SysConMonitor service will be restarted mapping the S...

Page 49: ...y filter Designates the severity level of logged events Event severities are in most severe to least severe order CRITICAL ERROR WARNING INFO DEBUG Maximum log size The maximum log file size in kiloby...

Page 50: ...ents the SysCon feature provides the capability to proactively notify a user or management application of a SysCon event SysCon event notifications can be directed to the following destinations Telco...

Page 51: ...matically detect mount and monitor SysCon Device and Keys o The SysCon service auto mounts the detected SysCon Device and or SysCon Keys and assigns access credentials that restrict access to the syst...

Page 52: ...on the device though this practice is not recommended The user should not store any data in the sysconenv TOOLKIT or efi folders and sub folders in any circumstance as this data may interfere with the...

Page 53: ...Unlike the SysCon Device if a Key is present but becomes unmounted a umount message is reported to the SysCon log and the device is removed from the daemon s checklist see 12 1 2 for details on the d...

Page 54: ...sCon event occurs whenever a device or key is inserted mounted changed unmounted or removed An event also occurs in the case of device key remount failure Each event has a device type associated with...

Page 55: ...log_format int log_event_type syscon_log_dev_type_t log_dev_type syscon_log_severity_t log_severity uid_t log_uid gid_t log_gid pid_t log_pid pid_t log_pgrp struct timespec log_time unsigned int log_...

Page 56: ...Err Warning Notice Info or Debug AlertUsingSNMP SNMP Trap Notification requires Net SNMP Severity may be specified as Crit Major Minor or Info AlertUsingTAM Telco Alarms Manager LED Relay activation...

Page 57: ...ype syscon_log_severity_t severity const void buf size_t len int format int syscon_log_printf syscon_log_dev_type_t dev_type int event_type syscon_log_severity_t severity const char format int syscon_...

Page 58: ...0509C30831003922 dev sdc syscon_getdev Utility that given the mount point of a SysCon device key returns the device type physical address USB bus level port status and mount point Usage syscon_getdev...

Page 59: ...nguage is defined in syscon_query 1 man page Three examples are provided below The following query string will limit the displayed entries to only key insertions syscon_log_read event_type devadd dev_...

Page 60: ...ecord ID 1 searching event log for record ID Found Recid 1 Device Type SysCon Removable Device Severity Warning User root Group root Event Type A SysCon device has been removed This event is related t...

Page 61: ...e screen 12 3 Other Policies The policysettings xml file must contain SysConKeyEnable to enable the use of removable SysCon Keys If this entry is not in the policysettings xml file the SysCon mounting...

Page 62: ...ed Archived settings for this system sysconenv data config thisSystem policysettings xml Contains the current policy settings in effect that control SysCon behavior sysconenv data config thisSystem lo...

Page 63: ...dor Intel schema syscfg xsd An XML schema for syscfg utility accessible settings sysconenv data vendor vendorname productname Components xml The components known to the SysCon environment If a new com...

Page 64: ...tp developer intel com software XML 2004 CIM29PolicySchema xsi schemaLocation http developer intel com software XML 2004 SysConSchema syscon schema syscon xsd xmlns syscon http developer intel com sof...

Page 65: ...ailable Log Actions are LogUsingSEL and LogUsingSysLog Available Alert Actions are AlertUsingSNMP and AlertUsingTAM TAM Severity levels may be assigned to TAM alarms using tag TAMSeverity Critical Maj...

Page 66: ...ogSeverity syscon SNMPSeverity Info syscon SNMPSeverity syscon SELSeverity Info syscon SELSeverity syscon Actions syscon PolicyAction syscon PolicyActions syscon PolicyRule SysCon Device Changed polic...

Page 67: ...everity syscon TAMSeverity Major syscon TAMSeverity syscon Actions syscon PolicyAction syscon PolicyActions syscon PolicyRule SysCon Device Unmounted policy syscon PolicyRule syscon PolicyCondition sy...

Page 68: ...Severity syscon SNMPSeverity Major syscon SNMPSeverity syscon TAMSeverity Major syscon TAMSeverity syscon Actions syscon PolicyAction syscon PolicyActions syscon PolicyRule SysCon Key Insert policy sy...

Page 69: ...ogSeverity syscon SNMPSeverity Info syscon SNMPSeverity syscon SELSeverity Info syscon SELSeverity syscon Actions syscon PolicyAction syscon PolicyActions syscon PolicyRule SysCon Key Changed policy s...

Page 70: ...ule syscon PolicyCondition syscon PolicyConditionName SysConKeyUnMnt syscon PolicyConditionName syscon PolicyCondition syscon PolicyActions syscon PolicyAction syscon DoActionLogging true syscon DoAct...

Page 71: ...be established by the user to control SysCon feature behavior The values in bold type apply only to the SysCon preboot feature Other policies are used by the SysCon Service OS resident xs simpleType n...

Page 72: ...onentSettings config ComponentKey config ComponentIdString Intel BIOS syscfg V001 config ComponentIdString config ComponentKey SysCon root syscfg BIOSV001 handler syscfg BIOSV001 path sysconenv data v...

Page 73: ...nV001 UUID 986C7E53 28D2 4e90 B77A 87B2CCE3E179 ipmi15 IPAddressSource Static ipmi15 IPAddressSource ipmi15 IPAddress 10 243 42 115 ipmi15 IPAddress ipmi15 SubnetMask 255 255 255 0 ipmi15 SubnetMask i...

Page 74: ...ccessV001 channelNo 1 UUID DF78C026 E319 4f09 B75B A377896379EE ipmi15 enableUser true ipmi15 enableUser ipmi15 PrivilegeLevelLimit Admin ipmi15 PrivilegeLevelLimit bmccfg ChannelAccessV001 bmccfg Cha...

Page 75: ...UserName u4 ipmi15 UserName bmccfg ChannelAccessV001 channelNo 1 UUID DF78C026 E319 4f09 B75B A377896379EE ipmi15 enableUser true ipmi15 enableUser ipmi15 PrivilegeLevelLimit Operator ipmi15 Privilege...

Page 76: ...RTS CD bios FlowControl CTS RTS bios FlowControl BaudRate values 9600 19200 38400 57600 115200 bios BaudRate 19200 bios BaudRate TerminalType values PC ANSI VT100 VT UTF8 bios TerminalType VT100 bios...

Page 77: ...atewayMacAddress LAN CHANNEL1 CommunityString ipmi15 CommunityString public ipmi15 CommunityString bmccfg LANAlertDestinationV001 UUID 7533A810 6A48 4b2f 9B6C 3E4E310FBDC2 LAN CHANNEL1 AlertIPAddress1...

Page 78: ...annelV001 bmccfg ChannelV001 channelNo 4 UUID 3CB2F383 BF03 4a28 B44A 5E6307A60F73 bmccfg ChannelSettingsV001 alias ChannelSetting UUID 97DC9363 9B8D 4ca0 A9C3 5B96D0688966 EMP PEPAlertMode ipmi15 ena...

Page 79: ...fg enableHTTP true bmccfg enableHTTP bmccfg ChannelAccessV001 bmccfg ChannelAccessV001 channelNo 4 UUID 33A948D9 B452 4b56 AAA4 3F050CD90CB2 USERS USER1 Status ipmi15 enableUser true ipmi15 enableUser...

Page 80: ...2 1A Nic MAC Nic OptionsV001 Nic OptionsV001 instance 10 description Intel R PRO 100 S Server Adapter UUID 22965F9B FEE5 4407 9051 4E46D907E60B Valid MAC adress in the form xx xx xx xx xx xx Nic MAC A...

Page 81: ...arameter List XML element name of parameter Allowable values or format bmccfg ChannelV001 channelNo attribute 1 3 4 ipmi15 enablePEFAlerting true false ipmi15 AccessModeForIPMIMessaging Always Availab...

Page 82: ...m SMTPConfigurationV001 imm SendingSystemName Up to 64 characters imm SMTPSendingAddr Up to 64 characters imm SMTPReceivingAddr Up to 64 characters imm SMTPConfigurationEntryV001 imm SMTPSubjectLine U...

Page 83: ...5 xmlns Intel http developer intel com software XML 2004 IntelSystemsSchema config Version config label BIOS version 09 00 config label config token 09 00 config token config Version config Version co...

Page 84: ...a5 000423b574c6 Intel SystemBaseboardUUID Intel SystemAttributesV001 config SystemAttributes config System syscon eventSet syscon event level INFO module config SystemSpecification date 2005 12 14T09...

Page 85: ...ined by the implementation syscon_log_write shall fail Otherwise syscon_log_write will set the SYSCONLOG_TRUNCATE flag in the event record s log_flags member the event record s log_size member will be...

Page 86: ...his shall be the current value of the CLOCK_REALTIME clock The event record s log_recid member shall be set to an implementation defined value that uniquely identifies this event record in the active...

Page 87: ...rite Clocks and CLOCK_REALTIME getpid geteuid getegid getpgrp 17 1 2 Write Formatted String to Log Function syscon_log_printf 17 1 2 1 Synopsis include syscon h int syscon_log_printf syscon_log_event_...

Page 88: ...17 2 1 Open an Event Log for Read Access Function syscon_log_open 17 2 1 1 Synopsis include syscon h int syscon_log_open syscon_logd_t logdes const char path 17 2 1 2 Description The syscon_log_open f...

Page 89: ...con h int syscon_log_read syscon_logd_t logdes struct syscon_log_entry entry void log_buf size_t log_len 17 2 2 2 Description The syscon_log_read function shall read the event record at the read point...

Page 90: ...on sigval sval syscon_log_recid_t recid int syscon_log_notify_get syscon_log_notify_t nfyhandle struct sigevent notification int flags char qsbuf size_t qslen size_t reqlen 17 2 3 2 Description 17 2 3...

Page 91: ...al_int or sival_ptr member shall be available to the notification handling function This value shall be available either as the si_value member of the siginfo_t object that is passed to a signal catch...

Page 92: ...object If the notification request s query object is NULL a null character shall be stored to qsbuf 0 The buffer pointed to by qsbuf is assumed to be at least qslen bytes long If qsbuf is equal to NUL...

Page 93: ...PERM The process does not have the appropriate implementation defined privilege to receive notification of the indicated class of events If any of the following conditions occur the syscon_log_siginfo...

Page 94: ...he error 17 2 4 4 Errors If any of the following conditions occur the syscon_log_notify_remove function shall return the corresponding error number EINVAL The nfyhandle argument is not valid 17 2 4 5...

Page 95: ...START Set the read pointer to the beginning of the log SYSCONLOG_SEEK_END Set the read pointer to the end of the log SYSCONLOG_SEEK_FIRST Set the read pointer to point to the first event record that m...

Page 96: ...completion syscon_log_seek shall return zero Otherwise an error number shall be returned to indicate the error and the read pointer associated with logdes shall remain unchanged 17 2 6 4 Errors If an...

Page 97: ...pointed to by order shall be set to zero Otherwise the integer pointed to by order shall be set to a negative value 17 2 7 3 Returns Upon successful completion syscon_log_severity_compare shall return...

Page 98: ...contents of the buffer shall be unchanged The query object shall be initialized for the purpose s specified by the purpose argument which shall be the bitwise OR of one or more of the purpose flags de...

Page 99: ...e flags to the location pointed to by purpose If the query object was not initialized by syscon_log_query_create then the result of the call to syscon_log_query_get shall be undefined 17 2 8 2 3 Query...

Page 100: ...ammar but makes no sense semantically Semantic rules are explained in the following sections syscon_log_query_create shall fail if the query expression is syntactically or semantically incorrect and t...

Page 101: ...red An integer constant token is a sequence of digits and letters than conforms to the rules for a C language integer constant decimal hexadecimal or octal except than unsigned and long suffixes upper...

Page 102: ...root bin daemon sys adm tty disk lp mem kmem wheel mail news uucp man games gopher dip ftp nobody or users pid Integer Process ID Integer comparison val shall be 0 65536 pgrp Integer Group process ID...

Page 103: ...g null character is in the range 1 to SYSCONLOG_ENTRY_MAXLEN shall be accepted The implementation is permitted but not required to reject other values 17 2 8 2 8 Limited Queries The syntax and semanti...

Page 104: ...to by query shall remain unchanged If syscon_log_query_get fails the values pointed to by query_string and purpose shall remain unchanged 17 2 8 4 Errors If any of the following conditions occur the s...

Page 105: ...eturn the corresponding error number EINVAL The query argument does not point to a valid query object as initialized by syscon_log_query_create 17 2 9 5 Cross References syscon_log_query_create 17 2 1...

Page 106: ...xample is a simulation of EFI SysCon processing fs1 startup fs1 echo off SysCon Version 0 4 Dev Test System Type detected Intel TIGNC2U SE7520JR23 EFI only challenges user for BIOS Admin password In a...

Page 107: ...fies the system configuration data Opens Is reboot necessary Or can user cause SysCon process to run continue using the imported data and then Load OS Present Installed Yes Not present N A User is pro...

Page 108: ...r this system on Key SysCon Feature Behavior Not present N A System will enter the EFI Shell and display the shell prompt If the user wants to disable the SysCon feature the user must remove the EFI B...

Reviews: