hit counter script
IBM Carrier Grade X3650 T User Manual
  1. Manuals
  2. Brands
  3. IBM Manuals
  4. Server
  5. Carrier Grade X3650 T
  6. User manual

IBM Carrier Grade X3650 T User Manual

Hide thumbs Also See for Carrier Grade X3650 T:
Table of Contents

Advertisement

Quick Links

Download this manual
IBM® Carrier Grade Server
X3650 T
SysCon User's Guide
Order Number: D23731-003
Revision 3.0
March 2006

Advertisement

Table of Contents
loading

Related Manuals for IBM Carrier Grade X3650 T

Summary of Contents for IBM 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: Revision History

    IBM® Carrier Grade Server X3650 T Revision History Date Revision Modifications Number May 2005 Preliminary. Initial Release. June 2005 Preliminary. Restructured installation information. March 2006 ECO release. Revision 3.0...
  • Page 3 IBM disclaims any express or implied warranty, relating to sale and/or use of IBM products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right.

  • Page 4: Table Of Contents

    IBM® Carrier Grade Server X3650 T Table of Contents 1. Introduction .......................... 1 2. SysCon Features ........................2 Automatic preservation of system settings .............. 2 Detection of system setting changes ............... 2 Transfer of system settings..................2 3. Installing the SysCon Feature ..................... 3 Microsoft Windows* ....................
  • Page 5 IBM® Carrier Grade Server X3650 T Applying new user-specified settings..............37 Importing User-Specified Settings ................. 39 9. Monitoring SysCon Activity....................41 Logging SysCon Events ..................41 Configuring Event Notification Actions..............42 10. Using SysCon Operating System Services and Utilities ..........43 11.
  • Page 6 IBM® Carrier Grade Server X3650 T 16. APPENDIX D – SysCon Log File Format ................76 17. APPENDIX E – POSIX Logging API and Query Specification for SysCon ....77 17.1 Logging Functions ....................77 17.1.1 Write to the Log ..................... 77 17.1.2...
  • Page 7 IBM® Carrier Grade Server X3650 T 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 Limited Queries............... 95 Revision 3.0...
  • Page 8 IBM® Carrier Grade Server X3650 T < This page intentionally left blank. > viii Revision 3.0...

  • Page 9: Introduction

    IBM® Carrier Grade Server X3650 T Introduction The IBM SysCon feature checks server system configuration during the pre-boot process and manages the configuration of system components based on configuration data, vendor rules, and user policy settings. The SysCon feature includes a pre-boot application which controls the process of examining the system configuration and taking appropriate action during the system boot process.

  • Page 10: Syscon Features

    IBM® Carrier Grade Server X3650 T SysCon Features The SysCon feature is available on IBM servers that include an embedded USB device called a SysCon Device. The SysCon Device works in conjunction with the system firmware (BIOS) to manage the system ®...

  • Page 11: Installing The Syscon Feature

    IBM® Carrier Grade Server X3650 T Installing the SysCon Feature The SysCon feature may only be installed on IBM servers that are equipped with an IBM SysCon Device. See your system documentation to confirm that your system has a SysCon Device.
  • Page 12 IBM® Carrier Grade Server X3650 T Revision 3.0...

  • Page 13: Python

    IBM® Carrier Grade Server X3650 T 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 of Python is already installed.
  • Page 14 IBM® Carrier Grade Server X3650 T 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. Revision 3.0...
  • Page 15 IBM® Carrier Grade Server X3650 T Revision 3.0...
  • Page 16 IBM® Carrier Grade Server X3650 T Tcl/Tk is optional. You can click on "No" 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 newer versions of Python;...
  • Page 17 IBM® Carrier Grade Server X3650 T Revision 3.0...

  • Page 18: Installing The Syscon Device

    IBM® Carrier Grade Server X3650 T 3.1.2 Installing the SysCon Device Once Python is installed and the SysCon Service is installed and running, a Windows command window is launched to install the SysCon files onto the SysCon device. The user is required to enter the mount point of the SysCon USB device.
  • Page 19 IBM® Carrier Grade Server X3650 T 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 appropriate in this situation.
  • Page 20 IBM® Carrier Grade Server X3650 T Once the files are installed to the device, the SysCon service is 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. After the SysConMonitor service has been stopped the SysCon device will again have an assigned DOS drive mapping.

  • Page 21: Installation Issues Using Microsoft* Software

    IBM® Carrier Grade Server X3650 T The install script restarts the SysConMonitor service so the USB device will no longer have a DOS drive letter mapping. In this case, it is remapped under the Windows system root directory generally "C:\Windows\SysCon\IntelTSD SYSCN HS-NAND USB Device"...

  • Page 22: Linux

    Manager (TAM) package, both of which are available on the Resource CD. 3.2.1 Installation Procedure Insert the Resource CD into the IBM® Carrier Grade Server X3650 T running an XFree86 session. From the opening page, click on the “Additional Management Utilities” link in the left frame of browser’s display.

  • Page 23: Activating/Deactivating The Syscon Feature

    IBM® Carrier Grade Server X3650 T Click the “Install SysCon feature on Linux” button to initiate the installation. When prompted, reboot the system. Following the system reboot, restart the SysCon service to complete the initial service setup by executing /etc/init.d/syscon restart from a Linux shell prompt.

  • Page 24: Activating The Syscon Feature

    IBM® Carrier Grade Server X3650 T Note: the SysCon feature may be activated and deactivated without uninstalling the operating system files. 3.3.1 Activating the SysCon feature • On system startup, press [F2] to enter the BIOS setup. • From the [Boot] options page, highlight the [Boot Device Priority] option and press [Enter].
  • Page 25 IBM® Carrier Grade Server X3650 T Revision 3.0...

  • Page 26: Deactivating The Syscon Feature

    IBM® Carrier Grade Server X3650 T 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. Revision 3.0...

  • Page 27: Syscon Feature Operation Overview

    IBM® Carrier Grade Server X3650 T SysCon Feature Operation Overview Configuring and booting the first time Once the SysCon feature has been installed and activated, but before rebooting the system, the user may configure the system and any components using the normal configuration methods, including using the BIOS Setup menus, the System Configuration Wizard, etc.

  • Page 28: Booting The System

    IBM® Carrier Grade Server X3650 T Booting the System Each time the system is booted, the SysCon feature will extract the current system settings and save them to the SysCon device. Once the current system settings are saved, the SysCon Device uses the policy settings to determine how to examine the system settings.

  • Page 29: Controlling Syscon Behavior Using Policies

    IBM® Carrier Grade Server X3650 T Controlling SysCon Behavior Using Policies The behavior of the SysCon feature can be customized by using the SysCon policy settings file, which details the policies in effect for a single system and resides in the top-level settings folder for that system.

  • Page 30: Interacting With The Syscon Feature

    IBM® Carrier Grade Server X3650 T Interacting with the SysCon Feature If access to the system console is available during boot time, the user may interrupt the SysCon feature and override its behavior. The SysCon feature is started after the system performs any pre-boot diagnostics but before the system searches for a boot device.

  • Page 31: Using The Syscon Menu

    IBM® Carrier Grade Server X3650 T As illustrated below, whenever the following three lines are displayed, the user has three choices: SysCon processing is about to begin in 5 seconds, wait or - enter BIOS admin password to perform SysCon configuration or - press space bar and 'Enter' to skip SysCon processing and boot the OS: •...
  • Page 32 IBM® Carrier Grade Server X3650 T In following example, option 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 session, it is not displayed as an option the next time the menu is displayed.

  • Page 33: Using The Efi Shell

    IBM® Carrier Grade Server X3650 T 7.1.1 Using the EFI Shell If “Enter the EFI shell” is selected from the EFI Menu, the user is able to use EFI shell commands to modify files directly in the SysCon environment and/or affect the execution of the SysCon feature.

  • Page 34: Detecting System Setting Changes

    IBM® Carrier Grade Server X3650 T Detecting system setting changes If a “saved” configuration exists on the SysCon device (i.e. a configuration has been placed in the “saved” folder) and it is different from the current settings, the SysCon feature will provide an additional prompt in...
  • Page 35 IBM® Carrier Grade Server X3650 T SysCon Device will be automatically adopted as the settings for the current system and the following messages are displayed and logged: Replacement system detected due to system attribute change Restoring settings to replacement system If the policy ‘AlwaysRestoreSavedSettings’...

  • Page 36: Using A Syscon Key

    IBM® Carrier Grade Server X3650 T Using a SysCon Key A SysCon key is a removable USB storage device that contains a SysCon environment. The primary use of the SysCon Key is to backup and restore settings for a single system. Each system is identified by the unique identifier of the baseboard.

  • Page 37: Installing A Syscon Device Using A Syscon Key

    IBM® Carrier Grade Server X3650 T Restoring settings from a SysCon Key is currently only supported for the same system from which the settings were initially backed up to a key. This capability is not intended and does not support restoring settings onto any system other than the system from which those settings have been backed up.
  • Page 38 IBM® Carrier Grade Server X3650 T A SysCon key should be inserted 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/(1D|1)/Usb(0,0)).
  • Page 39 IBM® Carrier Grade Server X3650 T After entering the BIOS password, the user will be presented 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 SysCon Key is present when the system resets.
  • Page 40 IBM® Carrier Grade Server X3650 T The user may enter the EFI shell at this point; however, it is recommended that the system be reset first. To verify that the EFI environment is set up correctly, one can exit to the EFI shell and execute the ‘map’...
  • Page 41 IBM® Carrier Grade Server X3650 T It should be noted that the SysCon device is always located at Pci/(1D|1)/Usb(1,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.

  • Page 42: Updating A Syscon Device Using A Syscon Key

    IBM® Carrier Grade Server X3650 T After SysCon processing is complete, the EFI shell exits to ‘Legacy Boot’ which will then boot the next item in the BIOS boot order. Important: If a BIOS password has been established, the BIOS password must be made known to SysCon on the SysCon device to enable settings to be restored properly.
  • Page 43 IBM® Carrier Grade Server X3650 T Revision 3.0...

  • Page 44: Creating System Settings Files

    IBM® Carrier Grade Server X3650 T Creating System Settings Files The SysCon feature allows the user to configure multiple system components using Extensible Markup Language (XML) syntax. XML schema files (or XSDs) that describe the XML element types and value constraints for each component are provided on the SysCon Device.

  • Page 45: Applying New User-Specified Settings

    IBM® Carrier Grade Server X3650 T /config:Settings/config:ComponentSettings/syscfg:BIOSV001/bios:SecurityV001 \ >sysconenv\data\config\thisSystem\specified\sectest.xml python sysconenv/syscon/python1.5/SysconCipher.pyc sysconenv\data\common\ciphertemplate.xml sysconenv\data\config\thisSystem\specified\sectest.xml /config:Settings >sysconenv\data\config\thisSystem\specified\settest.xml Applying new user-specified settings When the SysCon feature detects that there are user-specified settings present on the SysCon Device in the “specified” folder, the application will apply these settings regardless of the state of the “current” and “saved”...
  • Page 46 IBM® Carrier Grade Server X3650 T When the application detects and applies user-specified settings, 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 component. Once the settings are applied, they are captured in the “current”...

  • Page 47: Importing User-Specified Settings

    IBM® Carrier Grade Server X3650 T Importing User-Specified Settings The SysCon feature can be used to apply settings common to a group of servers in the enterprise. XML files designating the settings changes can be copied to a SysCon key, from which the settings may be applied to other servers.
  • Page 48 IBM® Carrier Grade Server X3650 T “startup.cmd” - the script will ask for the DOS drive letter to designate as the target device - be sure that the target device drive letter is not the DOS drive letter of the SysCon device.

  • Page 49: Monitoring Syscon Activity

    IBM® Carrier Grade Server X3650 T Monitoring SysCon Activity 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.

  • Page 50: Configuring Event Notification Actions

    IBM® Carrier Grade Server X3650 T Configuring Event Notification Actions In addition to logging events, 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...

  • Page 51: Using Syscon Operating System Services And Utilities

    10. Using SysCon Operating System Services and Utilities IBM provides application software for managing the SysCon feature from the host operating system environment. This section gives a brief overview of the functions provided by the services and utilities. A full user’s guide is available for each of the operating systems supported (Linux, Windows).

  • Page 52: Using The Syscon Device For Application Data

    IBM® Carrier Grade Server X3650 T 11. Using the SysCon Device for Application Data Since the SysCon Device is implemented as a Mass Storage device that is visible to the operating system and applications, the user may store operating system and/or application data on the device (though this practice is not recommended).

  • Page 53: Syscon Services

    IBM® Carrier Grade Server X3650 T 12. SysCon Services 12.1 SysCon Service for Linux Features 12.1.1 SysCon Install tool A Linux syscon_format utility is provided to partition and format a USB storage device and to install the SysCon runtime environment either as a SysCon Device or SysCon Key. The SysCon runtime environment includes the configuration, policy, and vendor data.

  • Page 54: Events, Notification, And Actions

    IBM® Carrier Grade Server X3650 T and policies. In addition to the XML policies, the /etc/syscon.conf also contains two basic parameters for starting and controlling the SysCon service: SYSCONENABLE and SYSCONINTERVAL. If SYSCONENABLE is not set, the daemon dies and all syscon device monitoring and logging are disabled.
  • Page 55 IBM® Carrier Grade Server X3650 T 12.2.2 SysCon Event Logging and Notification All SysCon events are logged to the SysCon log (/var/log/syscon) and notification made available to any process that has registered an event query with the SysCon daemon through the SysCon API.

  • Page 56: Syscon Event Logging And Notification Policies

    IBM® Carrier Grade Server X3650 T SysConDevInsert + SysConKeyInsert: 0001 01/20/05 04:28:55 BMC 21 Slot/Connector 00 Inserted 00 [02 08 21] SysConDevMnt + SysConKeyMnt: 0002 01/20/05 04:28:56 BMC 21 Slot/Connector 00 InsReady 00 [03 08 21] SysConDevChange + SysConKeyChange: 0005 01/20/05 04:39:57 BMC 21 Slot/Connector 00 Interlock 00 [07 08 21]...
  • Page 57 IBM® Carrier Grade Server X3650 T The syscond daemon provides real-time event notification to any process that registers an event query string with the daemon. Any event matching the query will invoke a Linux RT signal which will send the client into a function registered with the query.
  • Page 58 IBM® Carrier Grade Server X3650 T int syscon_log_query_destroy(syscon_log_query_t *query); int syscon_log_query_match(const syscon_log_query_t *query, const struct syscon_log_entry *entry, const void *buf, int *match); SysCon-only API calls: int syscon_message(int dev_type, int type, char *dev, char *mntpnt, char *mesg); int sellog(int dev_type, char dev[], int event_type, int sev);...
  • Page 59 IBM® Carrier Grade Server X3650 T Quiet (log entry is not returned). Returns zero if an entry is found and non-zero if no entries are found. -o <format> Display log output in user specified format using: recid - Record ID (1-N)
  • Page 60 IBM® Carrier Grade Server X3650 T -u Send a SysCon device unmount event. -f Send a SysCon device mount failure. -p provide mount point of the SysCon device. -d provide the SCSI name of the SysCon device. syscon_format – Utility that formats and initializes a syscon device.

  • Page 61: Other Policies

    IBM® Carrier Grade Server X3650 T Example 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 routines will only mount and monitor the SysCon Device.

  • Page 62: Appendix A - Syscon Environment Folder Structure

    IBM® Carrier Grade Server X3650 T 13. APPENDIX A – SysCon Environment Folder Structure The following folders and files are found on a SysCon Device and on SysCon Keys: sysconenv/data Contains working data, including system settings files, saved and user-specified.
  • Page 63 IBM® Carrier Grade Server X3650 T An XML schema for IPMI v1.5 settings. sysconenv/data/vendor Contains vendor-supplied system and component specification files that govern system and component configuration. Each folder represents specification files from a single vendor. sysconenv/data/vendor/SystemSpecs.xml Contains a system specification for each system type supported by this installation of the SysCon feature.

  • Page 64: Appendix B - Syscon Policy File Format

    IBM® Carrier Grade Server X3650 T 14. APPENDIX B – SysCon Policy File Format Control of SysCon feature behavior is implemented via the SysCon policy file. The default values for the SysCon Device policy are documented in the file “policydefaults.xml”. The user may copy this file to the system settings folder and modify it to suit the deployed environment.
  • Page 65 IBM® Carrier Grade Server X3650 T Key and Device status change policies The following conditions are known to the SysCon service: SysConDevRemoval SysConDevMnt SysConDevUnMnt SysConDevMntFail SysConDevInsert SysConDevChange SysConKeyRemoval SysConKeyMnt SysConKeyUnMnt SysConKeyMntFail SysConKeyInsert SysConKeyChange If no policy is defined for a condition above, the condition is ignored.
  • Page 66 IBM® Carrier Grade Server X3650 T "SysCon Device Mount" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConDevMnt</syscon:PolicyConditionName> </syscon:PolicyCondition> <syscon:PolicyActions> <syscon:PolicyAction> <syscon:DoActionLogging>true</syscon:DoActionLogging> <syscon:Actions> <syscon:SysConAction>NoAction-ReportOnly</syscon:SysConAction> <syscon:LogAction>LogUsingSEL</syscon:LogAction> <syscon:LogAction>LogUsingSysLog</syscon:LogAction> <syscon:AlertAction>AlertUsingSNMP</syscon:AlertAction> <syscon:SysLogSeverity>INFO</syscon:SysLogSeverity> <syscon:SNMPSeverity>Info</syscon:SNMPSeverity> <syscon:SELSeverity>Info</syscon:SELSeverity> </syscon:Actions> </syscon:PolicyAction> </syscon:PolicyActions> </syscon:PolicyRule> <!-- "SysCon Device Changed" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConDevChange</syscon:PolicyConditionName> </syscon:PolicyCondition>...
  • Page 67 IBM® Carrier Grade Server X3650 T "SysCon Device Removal" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConDevRemoval</syscon:PolicyConditionName> </syscon:PolicyCondition> <syscon:PolicyActions> <syscon:PolicyAction> <syscon:DoActionLogging>true</syscon:DoActionLogging> <syscon:Actions> <syscon:SysConAction>Shutdown</syscon:SysConAction> <syscon:LogAction>LogUsingSEL</syscon:LogAction> <syscon:LogAction>LogUsingSysLog</syscon:LogAction> <syscon:AlertAction>AlertUsingSNMP</syscon:AlertAction> <syscon:AlertAction>AlertUsingTAM</syscon:AlertAction> <syscon:SysLogSeverity>ALERT</syscon:SysLogSeverity> <syscon:SELSeverity>Major</syscon:SELSeverity> <syscon:SNMPSeverity>Major</syscon:SNMPSeverity> <syscon:TAMSeverity>Major</syscon:TAMSeverity> </syscon:Actions> </syscon:PolicyAction> </syscon:PolicyActions> </syscon:PolicyRule> <!-- "SysCon Device Unmounted" policy --> <syscon:PolicyRule> <syscon:PolicyCondition>...
  • Page 68 IBM® Carrier Grade Server X3650 T "SysCon Device Mount Fail" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConDevMntFail</syscon:PolicyConditionName> </syscon:PolicyCondition> <syscon:PolicyActions> <syscon:PolicyAction> <syscon:DoActionLogging>true</syscon:DoActionLogging> <syscon:Actions> <syscon:SysConAction>Shutdown</syscon:SysConAction> <syscon:LogAction>LogUsingSEL</syscon:LogAction> <syscon:LogAction>LogUsingSysLog</syscon:LogAction> <syscon:AlertAction>AlertUsingSNMP</syscon:AlertAction> <syscon:AlertAction>AlertUsingTAM</syscon:AlertAction> <syscon:SysLogSeverity>ALERT</syscon:SysLogSeverity> <syscon:SELSeverity>Major</syscon:SELSeverity> <syscon:SNMPSeverity>Major</syscon:SNMPSeverity> <syscon:TAMSeverity>Major</syscon:TAMSeverity> </syscon:Actions> </syscon:PolicyAction> </syscon:PolicyActions> </syscon:PolicyRule> <!-- "SysCon Key Insert" policy --> <syscon:PolicyRule>...
  • Page 69 IBM® Carrier Grade Server X3650 T "SysCon Key Mount" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConKeyMnt</syscon:PolicyConditionName> </syscon:PolicyCondition> <syscon:PolicyActions> <syscon:PolicyAction> <syscon:DoActionLogging>true</syscon:DoActionLogging> <syscon:Actions> <syscon:SysConAction>NoAction-ReportOnly</syscon:SysConAction> <syscon:LogAction>LogUsingSEL</syscon:LogAction> <syscon:LogAction>LogUsingSysLog</syscon:LogAction> <syscon:AlertAction>AlertUsingSNMP</syscon:AlertAction> <syscon:SysLogSeverity>INFO</syscon:SysLogSeverity> <syscon:SNMPSeverity>Info</syscon:SNMPSeverity> <syscon:SELSeverity>Info</syscon:SELSeverity> </syscon:Actions> </syscon:PolicyAction> </syscon:PolicyActions> </syscon:PolicyRule> <!-- "SysCon Key Changed" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConKeyChange</syscon:PolicyConditionName> </syscon:PolicyCondition>...
  • Page 70 IBM® Carrier Grade Server X3650 T "SysCon Key Removal" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConKeyRemoval</syscon:PolicyConditionName> </syscon:PolicyCondition> <syscon:PolicyActions> <syscon:PolicyAction> <syscon:DoActionLogging>true</syscon:DoActionLogging> <syscon:Actions> <syscon:SysConAction>NoAction-ReportOnly</syscon:SysConAction> <syscon:LogAction>LogUsingSEL</syscon:LogAction> <syscon:LogAction>LogUsingSysLog</syscon:LogAction> <syscon:AlertAction>AlertUsingSNMP</syscon:AlertAction> <syscon:SysLogSeverity>INFO</syscon:SysLogSeverity> <syscon:SELSeverity>Info</syscon:SELSeverity> <syscon:SNMPSeverity>Info</syscon:SNMPSeverity> </syscon:Actions> </syscon:PolicyAction> </syscon:PolicyActions> </syscon:PolicyRule> <!-- "SysCon Key Unmounted" policy --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConKeyUnMnt</syscon:PolicyConditionName> </syscon:PolicyCondition>...

  • Page 71: Syscon Policy Schema: Syscon.xsd

    IBM® Carrier Grade Server X3650 T --> <syscon:PolicyRule> <syscon:PolicyCondition> <syscon:PolicyConditionName>SysConDevLog</syscon:PolicyConditionName> </syscon:PolicyCondition> <syscon:PolicyActions> <syscon:PolicyAction> <syscon:DoActionLogging>true</syscon:DoActionLogging> <syscon:Actions> <syscon:LoggingLevel>INFO</syscon:LoggingLevel> <syscon:LogEntryLimit>50</syscon:LogEntryLimit> </syscon:Actions> </syscon:PolicyAction> </syscon:PolicyActions> </syscon:PolicyRule> <!-- --> </policy:PolicySetAppliesToElement> </policy:PolicyConfiguration> 14.2 SysCon Policy Schema: syscon.xsd The “syscon.xsd” file defines the domain of values that are allowable for elements of the various SysCon policy and configuration files.

  • Page 72: Appendix C - System Settings File Format

    IBM® Carrier Grade Server X3650 T 15. APPENDIX C – System Settings File Format The SysCon feature allows the user to configure two system components: the system firmware (BIOS) ® and the system’s server management features (Intel Management Module, which includes a Baseboard Management Controller or BMC).
  • Page 73 IBM® Carrier Grade Server X3650 T <ipmi15:IPAddressSource>Static</ipmi15:IPAddressSource> <ipmi15:IPAddress>10.243.42.116</ipmi15:IPAddress> <ipmi15:SubnetMask>255.255.255.0</ipmi15:SubnetMask> <ipmi15:DefaultGateway>10.243.42.251</ipmi15:DefaultGateway> <ipmi15:DefaultGatewayMacAddress>00.d0.06.21.eb.fc</ipmi15:DefaultGatewayMacAddress> <ipmi15:BackupGateway>0.0.0.0</ipmi15:BackupGateway> <ipmi15:BackupGatewayMacAddress>00.00.00.00.00.00</ipmi15:BackupGatewayMacAddress> <ipmi15:CommunityString>public</ipmi15:CommunityString> <bmccfg:LANAlertDestinationV001 UUID="EA3D84C1-6DB0-47f2-8D3D-ABBD1DBAB199"> <ipmi15:AlertIPAddress>10.243.42.116</ipmi15:AlertIPAddress> <ipmi15:AlertIPAddress>10.243.42.189</ipmi15:AlertIPAddress> <ipmi15:AlertMacAddress>00.04.23.bc.ac.1a</ipmi15:AlertMacAddress> <ipmi15:AlertMacAddress>00.06.29.4f.ca.5a</ipmi15:AlertMacAddress> </bmccfg:LANAlertDestinationV001> </bmccfg:LANConfigurationV001> <imm:SOLConfigurationV001 UUID="39EAEFEF-D196-4af0-AB22-2B1F12B99601"> <imm:enableSOL>true</imm:enableSOL> <ipmi15:PrivilegeLevelLimit>User</ipmi15:PrivilegeLevelLimit> <imm:SOLbitrate>19200</imm:SOLbitrate> <imm:SOLRetryCount>5</imm:SOLRetryCount> <imm:SOLRetryInterval>20</imm:SOLRetryInterval> </imm:SOLConfigurationV001> </bmccfg:ChannelV001> <bmccfg:ChannelV001 channelNo="3" UUID="6056002A-3556-4019-81EA-DF23A1393C30"> <bmccfg:ChannelSettingsV001 UUID="D0A18C38-C3A6-4727-8099-8F74A79B6006"> <ipmi15:enablePEFAlerting>true</ipmi15:enablePEFAlerting> <ipmi15:AccessModeForIPMIMessaging>Always Available</ipmi15:AccessModeForIPMIMessaging> <ipmi15:ChannelPrivilegeLimit>Admin</ipmi15:ChannelPrivilegeLimit>...
  • Page 74 IBM® Carrier Grade Server X3650 T <imm:UDPPort>161</imm:UDPPort> </imm:SNMPConfigurationV001> </bmccfg:ChannelV001> <bmccfg:ChannelV001 channelNo="4" UUID="6056002A-3556-4019-81EA-DF23A1393C30"> <bmccfg:ChannelSettingsV001 UUID="D0A18C38-C3A6-4727-8099-8F74A79B6006"> <ipmi15:enablePEFAlerting>false</ipmi15:enablePEFAlerting> <ipmi15:AccessModeForIPMIMessaging>Always Available</ipmi15:AccessModeForIPMIMessaging> <ipmi15:ChannelPrivilegeLimit>Admin</ipmi15:ChannelPrivilegeLimit> </bmccfg:ChannelSettingsV001> <ipmi15:SerialConfigurationV001 UUID="E371D92A-16B6-48d5-A998-A3410D99D86B"> <ipmi15:MessagingSettingsV001 UUID="A5F239DE-F171-4937-9B05-938EC62DABB3"> <bmccfg:SerialConnectionModeV001 UUID="92A1C2EF-C812-4379-9D8F-25880225C3A0"> <ipmi15:ConnectionMode>Direct</ipmi15:ConnectionMode> </bmccfg:SerialConnectionModeV001> <bmccfg:ModemSettingsV001 UUID="610B9B33-9DE3-4a80-A765-90CDF7A4BD04"> <ipmi15:ModemRingDuration>43</ipmi15:ModemRingDuration> <ipmi15:ModemInitString>ATE1Q0V1X4&amp;D2&amp;C1S0=0</ipmi15:ModemInitString> <ipmi15:ModemEscapeSequence>+++</ipmi15:ModemEscapeSequence> <ipmi15:ModemHangupSequence>ATH</ipmi15:ModemHangupSequence> <ipmi15:ModemDialCommand>ATD</ipmi15:ModemDialCommand> <bmccfg:SystemPhoneNumber/> </bmccfg:ModemSettingsV001> </ipmi15:MessagingSettingsV001> <ipmi15:AlertSettingsV001 UUID="9269EE1B-07AE-474f-9A78-F6DD6D8D2CA0"> <ipmi15:PageBlackoutInterval>6</ipmi15:PageBlackoutInterval>...
  • Page 75 IBM® Carrier Grade Server X3650 T <bmccfg:PasswordEncryptionId>95c3bd3a</bmccfg:PasswordEncryptionId> </bmccfg:UserSettingsV001> <bmccfg:UserSettingsV001 userNo="3" UUID="B17B14F5-0A25-46d7-A1A0-D92B318F355A"> <ipmi15:UserName>u3</ipmi15:UserName> <bmccfg:ChannelAccessV001 channelNo="1" UUID="DF78C026-E319-4f09-B75B-A377896379EE"> <ipmi15:enableUser>true</ipmi15:enableUser> <ipmi15:PrivilegeLevelLimit>User</ipmi15:PrivilegeLevelLimit> </bmccfg:ChannelAccessV001> <bmccfg:ChannelAccessV001 channelNo="3" UUID="DF78C026-E319-4f09-B75B-A377896379EE"> <ipmi15:enableUser>true</ipmi15:enableUser> <ipmi15:PrivilegeLevelLimit>User</ipmi15:PrivilegeLevelLimit> <bmccfg:enableTelnet>true</bmccfg:enableTelnet> <bmccfg:enableHTTP>true</bmccfg:enableHTTP> </bmccfg:ChannelAccessV001> <bmccfg:ChannelAccessV001 channelNo="4" UUID="DF78C026-E319-4f09-B75B-A377896379EE"> <ipmi15:enableUser>true</ipmi15:enableUser> <ipmi15:PrivilegeLevelLimit>User</ipmi15:PrivilegeLevelLimit> </bmccfg:ChannelAccessV001> <bmccfg:EncryptedPassword>7ea8d7b125a072c6f2404328c9b9141595c3bd3a</bmccfg:EncryptedPassword> <bmccfg:PasswordEncryptionId>95c3bd3a</bmccfg:PasswordEncryptionId> </bmccfg:UserSettingsV001> <bmccfg:UserSettingsV001 userNo="4" UUID="B17B14F5-0A25-46d7-A1A0-D92B318F355A"> <ipmi15:UserName>u4</ipmi15:UserName> <bmccfg:ChannelAccessV001 channelNo="1"...

  • Page 76: A "Full" System Settings File Example

    IBM® Carrier Grade Server X3650 T 15.2 A “Full” System Settings File Example <?xml version="1.0" encoding="UTF-8"?> <!-- edited with XMLSPY v5 rel. 4 U (http://www.xmlspy.com) by Todd C Davis (private) --> <config:Settings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://developer.intel.com/software/XML/2004/ConfigSchema ../../../vendor/SystemsComponents.xsd" xmlns:config="http://developer.intel.com/software/XML/2004/ConfigSchema"> <config:CheckPoint> <config:DateTime>2004-04-15T09:30:47-05:00</config:DateTime> <config:Description>optional check point for illustration, EFI settings</config:Description>...
  • Page 77 IBM® Carrier Grade Server X3650 T <?SysCon root="bmccfg:IMMV001" handler="bmccfg.IMMV001" path="./sysconenv/data/vendor/Intel" ?> <bmccfg:IMMV001 UUID="083A0F80-EC5E-44a5-9D5B-88F7653E0C06" xmlns:bmccfg="http://developer.intel.com/software/XML/2005/bmccfgSchema" xmlns:ipmi15="http://developer.intel.com/software/XML/2004/IPMI15Schema" xmlns:imm="http://developer.intel.com/software/XML/2004/IMMSchema"> <bmccfg:ChannelV001 channelNo="1" UUID="3CB2F383-BF03-4a28-B44A-5E6307A60F73"> <bmccfg:ChannelSettingsV001 UUID="97DC9363-9B8D-4ca0-A9C3-5B96D0688966"> <!-- [LAN::CHANNEL1]LANAlert --> <ipmi15:enablePEFAlerting>false</ipmi15:enablePEFAlerting> <!-- [LAN::CHANNEL1]AccessMode --> <ipmi15:AccessModeForIPMIMessaging>Disabled</ipmi15:AccessModeForIPMIMessaging> <!-- [LAN::CHANNEL1]PrivLevelLanChannel --> <ipmi15:ChannelPrivilegeLimit>Admin</ipmi15:ChannelPrivilegeLimit> </bmccfg:ChannelSettingsV001> <bmccfg:LANConfigurationV001 UUID="6A467E4D-D3DD-4094-8902-6894C2CF08C6"> <!-- [LAN::CHANNEL1]DHCPMode --> <ipmi15:IPAddressSource>DHCP</ipmi15:IPAddressSource>...
  • Page 78 IBM® Carrier Grade Server X3650 T <ipmi15:BackupGateway>128.128.0.4</ipmi15:BackupGateway> <ipmi15:BackupGatewayMacAddress>32-23-DF-FD-EA-CC</ipmi15:BackupGatewayMacAddress> <ipmi15:CommunityString/> <bmccfg:LANAlertDestinationV001 UUID="7533A810-6A48-4b2f-9B6C-3E4E310FBDC2"> <ipmi15:AlertIPAddress>128.128.0.3</ipmi15:AlertIPAddress> <ipmi15:AlertMacAddress>AE-ED-DE-FA-12-12</ipmi15:AlertMacAddress> </bmccfg:LANAlertDestinationV001> </bmccfg:LANConfigurationV001> <imm:HTTPConfigurationV001 UUID="3EAEBFFB-9328-40fc-8771-998C13F630E4"> <imm:ServerType>https</imm:ServerType> <!-- [ADVANCED]HTTP --> <imm:enableHTTP>true</imm:enableHTTP> <!-- [ADVANCED]HTTPPort --> <imm:ServerPort>4232</imm:ServerPort> </imm:HTTPConfigurationV001> <imm:TELNETConfigurationV001 UUID="BAB62487-9B9F-459d-9B65-E16E5E4FD264"> <!-- [ADVANCED]Telnet --> <imm:enableTelnet>false</imm:enableTelnet> <!-- [ADVANCED]TelnetPort --> <imm:TelnetPort>23</imm:TelnetPort> </imm:TELNETConfigurationV001> <imm:KVMConfigurationV001 UUID="49F8CC73-E1F0-44c1-A7F1-0623A79ABD82">...
  • Page 79 IBM® Carrier Grade Server X3650 T </ipmi15:MessagingSettingsV001> <ipmi15:AlertSettingsV001 alias="AlertSettings" UUID="9269EE1B-07AE-474f-9A78- F6DD6D8D2CA0"> <!-- [EMP]BlackoutPeriod --> <ipmi15:PageBlackoutInterval>0</ipmi15:PageBlackoutInterval> </ipmi15:AlertSettingsV001> </ipmi15:SerialConfigurationV001> </bmccfg:ChannelV001> <!-- [USERS::USER1] --> <!-- [USERS::USER2] --> <!-- [USERS::USER3] --> <!-- [USERS::USER4] --> <!-- [USERS]NumberOfUsers=4 --> <bmccfg:UserSettingsV001 userNo="1" UUID="FEBD28B4-E0F5-41cf-9DB5-2156118CC1CA"> <!-- [USERS::USER1]Username --> <ipmi15:UserName/>...

  • Page 80: System / Component Schema

    IBM provides XML schema files for IBM server components that are configured by the SysCon feature. For detailed descriptions of the component settings described in IBM XML settings files, please see the following Intel documentation: ®...

  • Page 81: Syscfg:biosv001 Settings

    IBM® Carrier Grade Server X3650 T 15.3.1 syscfg:BIOSV001 Settings Parameter List XML element name of parameter Allowable values or format bios:CPUConfigurationV001 bios:ProcessorHyperThreadingEnable true, false bios:ConsoleConfigurationV001 bios:RedirectionPort Disabled, Serial 1, Serial 2 None, CTS/RTS, XON/XOFF, bios:FlowControl CTS/RTS + CD 9600, 19200, 38400, 57600,...

  • Page 82: Nic:nicv001 Settings

    IBM® Carrier Grade Server X3650 T Parameter List Allowable values or XML element name of parameter format imm:TelnetPort 1 – 65535 imm:KVMConfigurationV001 imm:enableKVM true, false imm:SNMPConfigurationV001 imm: enableSNMP true, false imm: UDPPort 1 – 65535 bmccfg:SerialConnectionModeV001 ipmi15:ConnectionMode Modem, Direct bmccfg:ModemSettingsV001...

  • Page 83: Updating Bios And Intel Management Module Firmware

    IBM® Carrier Grade Server X3650 T config:SystemComponentSpecification element for the Intel-NIC-eeupdate-V001 component in the sysconenv/data/vendor/SystemSpecs.xml file. ® 15.4 Updating BIOS and Intel Management Module firmware The fsysconenv/data/vendor/Intel/SE7520JR23components.xml file contains the Intel ® component type specifications. The BIOS and Intel Management Module component attributes must ®...

  • Page 84: Appendix D - Syscon Log File Format

    IBM® Carrier Grade Server X3650 T 16. APPENDIX D – SysCon Log File Format The SysCon Device log file format is defined in elements contained in the SysCon “syscon.xsd” policy schema file. An example SysCon log file is provided below: <?xml version="1.0"...

  • Page 85: Appendix E - Posix Logging Api And Query Specification For Syscon

    IBM® Carrier Grade Server X3650 T 17. APPENDIX E – POSIX Logging API and Query Specification for SysCon 17.1 Logging Functions 17.1.1 Write to the Log Function: syscon_log_write() 17.1.1.1 Synopsis #include <syscon.h> int syscon_log_write(syscon_log_event_type_t event_type, int event_type, syscon_log_severity_t severity, const void *buf, size_t len, int format);...
  • Page 86 IBM® Carrier Grade Server X3650 T The event_type argument indicates the event type that is logging the event. The event record’s log_event_type member shall be set to the value of the event_type argument. The value of the event_type argument shall be a valid log event type or the syscon_log_write() function shall fail.

  • Page 87: Write Formatted String To Log

    IBM® Carrier Grade Server X3650 T For each of the following conditions, if the condition is detected, the syscon_log_write() function shall return the corresponding error number: • [EPERM]: The caller does not have the appropriate implementation-defined privilege for writing with the given event type. For example, an application whose effective user ID is not root has attempted to log an event with a reserved event_type code.

  • Page 88: Log Processing Functions

    IBM® Carrier Grade Server X3650 T 17.1.2.4 Errors If any of the following conditions occur, the syscon_log_printf() function shall return the corresponding error number: • [EINVAL]: The event_type argument is invalid, or the severity argument is invalid. • [EINVAL]: The format argument is NULL.

  • Page 89: Read From An Event Log

    IBM® Carrier Grade Server X3650 T • [EACCES]: Search permission is denied on a component of the path prefix, or the log file exists and read permission is denied. • [EINVAL]: The path argument refers to a file that is not a log file.

  • Page 90: Notify Process Of Availability Of System Log Data

    IBM® Carrier Grade Server X3650 T 17.2.2.4 Errors If any of the following conditions occur, the syscon_log_read() function shall return the corresponding error number: • [EINVAL]: The logdes argument is not a valid log descriptor (as returned by the syscon_log_open() function), or the entry argument is NULL.
  • Page 91 IBM® Carrier Grade Server X3650 T The flags argument shall be the bitwise OR of zero or more of the following three flags. These flags (along with SYSCONLOG_NFY_DISABLED, (which may be returned by syscon_log_notify_get()) shall be defined in <syscon.h>. SYSCONLOG_ONCE_ONLY: If this flag is zero, the specified notification request shall remain in effect until it is removed (via the syscon_log_notify_remove() function, or when the process execs or terminates) or disabled.
  • Page 92 IBM® Carrier Grade Server X3650 T 17.2.3.2.4 syscon_log_sigval_recid() The syscon_log_sigval_recid() function shall store the record ID of the event record associated with the current notification to the location pointed to by the recid argument. If the SYSCONLOG_SEND_RECID flag is not set in the associated notification request, the value stored to recid shall be undefined.
  • Page 93 IBM® Carrier Grade Server X3650 T 17.2.3.4 Errors If any of the following conditions occur, the syscon_log_notify_add() function shall return the corresponding error number: • [EINVAL]: The query argument is not NULL and does not point to a valid query object.

  • Page 94: Remove Notification Request

    IBM® Carrier Grade Server X3650 T 17.2.4 Remove Notification Request Function: syscon_log_notify_remove() 17.2.4.1 Synopsis #include <syscon.h> int syscon_log_notify_remove(syscon_log_notify_t nfyhandle); 17.2.4.2 Description The syscon_log_notify_remove() function shall remove the notification request, if any, associated with the nfyhandle argument. The nfyhandle argument must be a valid syscon_log_notify_t object, as created by a previous call to syscon_log_notify_add().

  • Page 95: Reposition The Read Pointer

    IBM® Carrier Grade Server X3650 T 17.2.5.4 Errors If any of the following conditions occur, the syscon_log_close() function shall return the corresponding error number: [EBADF]: The logdes argument is not a valid log descriptor. 17.2.5.5 Cross-References close() 17.2.6 Reposition the Read Pointer Function: syscon_log_seek() 17.2.6.1...

  • Page 96: Compare Event Record Severities

    IBM® Carrier Grade Server X3650 T If the direction argument is equal to SYSCONLOG_SEEK_LAST, then the read pointer shall be set to point to the last record in the event log that matches query. If there is no matching record, syscon_log_seek() shall fail.

  • Page 97: Create Log Query

    IBM® Carrier Grade Server X3650 T 17.2.7.1 Synopsis #include <syscon.h> int syscon_log_severity_compare(int *order, syscon_log_severity_t s1, syscon_log_severity_t s2); 17.2.7.2 Description The syscon_log_severity_compare() function shall compare the severities of the s1 and s2 arguments. If s1 is more severe than s2, then the integer pointed to by order shall be set to a positive value. If s1 is the same severity as s2, then the integer pointed to by order shall be set to zero.

  • Page 98: Table 2. Query Purpose Flags

    IBM® Carrier Grade Server X3650 T 17.2.8.1 Synopsis #include <syscon.h> int syscon_log_query_create(const char *query_string, int purpose, syscon_log_query_t *query, char *errbuf, size_t errlen); int syscon_log_query_get(const syscon_log_query_t *query, int *purpose, char *qsbuf, size_t qslen, size_t *reqlen); 17.2.8.2 Description 17.2.8.2.1 syscon_log_query_create() The syscon_log_query_create() function shall initialize the query object pointed to by the query argument according to the textual query expression pointed to by the query_string argument.
  • Page 99 IBM® Carrier Grade Server X3650 T 17.2.8.2.2 syscon_log_query_get() The syscon_log_query_get() function shall store a textual query expression to the buffer pointed to by the qsbuf argument. This expression shall be functionally equivalent to the one that was passed to syscon_log_query_create() to create the query object pointed to by the query argument.
  • Page 100 IBM® Carrier Grade Server X3650 T 17.2.8.2.4 Query Grammar A strictly conforming textual query expression shall conform to the following grammar, expressed using the notation and terminology of the C Standard. The implementation may support syntactic and/or semantic extensions to the grammar, so long as strictly conforming query expressions are interpreted according to this query standard.

  • Page 101: Table 3. Required Operations On Standard Attributes

    IBM® Carrier Grade Server X3650 T operators result in string comparisons unless otherwise specified. For example, if x and y are character- string values, "x != y" evaluates to 1 if strcmp(x,y) would return a non-zero value, or to zero otherwise.
  • Page 102 IBM® Carrier Grade Server X3650 T Attribute Name Operand Operations Interpretation of attr_name op val Type recid Integer =, !=, <, <=, >, SysCon log record number. Integer comparison. >= Val shall be 1-N. event_type Integer =, !=, <, <=, >, SysCon event type.

  • Page 103: Table 4. Required Operations In Limited Queries

    IBM® Carrier Grade Server X3650 T • Legal values for val are defined by the implementation. The implementation shall accept all legal values, and is free to accept or reject illegal values. • Any value in the range zero to SYSCONLOG_ENTRY_MAXLEN shall be accepted. The implementation is permitted, but not required, to reject other values.

  • Page 104: Destroy Log Query

    IBM® Carrier Grade Server X3650 T "severity > WARNING && severity < CRIT" /* ">" and "<" not supported for severity attribute */ "gid == 12" /* gid attribute not supported */ "recid >= 1000" /* ">=" not supported for recid attribute */ By comparison, the following sample expressions shall yield valid limited queries: "event_type = devunmnt &&...

  • Page 105: Test Event Record Against Query Criteria

    IBM® Carrier Grade Server X3650 T 17.2.9.1 Synopsis #include <syscon.h> int syscon_log_query_destroy(syscon_log_query_t *query); 17.2.9.2 Description The syscon_log_query_destroy() function destroys the log query object pointed to by the query argument; the object becomes, in effect, uninitialized. Memory allocated to the query object itself is not deal located, but any associated data structures allocated by the syscon_log_query_create() function may be deal located.
  • Page 106 IBM® Carrier Grade Server X3650 T 17.2.10.3 Returns Upon successful completion, syscon_log_query_match() shall return zero. Otherwise, an error number shall be returned to indicate the error. 17.2.10.4 Errors If any of the following conditions occur, the syscon_log_query_match() function shall return the corresponding error number: •...

  • Page 107: Appendix F: Troubleshooting The Syscon Feature

    IBM® Carrier Grade Server X3650 T 18. Appendix F: Troubleshooting the SysCon Feature The following tables are provided to assist in troubleshooting the SysCon feature. 18.1 Embedded USB Device “Present” Config Config data data for Embedded SysCon for this SysCon...

  • Page 108: Embedded Usb Device "Not Present

    IBM® Carrier Grade Server X3650 T Config Config data data for Embedded SysCon for this SysCon system SysCon Feature Behavior USB device Device System on UUID on Device settings data. At any time, the user may “Install” the SysCon Device – it will delete all the syscon env data, including the user’s...

Table of Contents