IBM Carrier Grade X3650 T User Manual

IBM® Carrier Grade Server X3650 T
Revision 3.0
77
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);
17.1.1.2 Description
The syscon_log_write() function writes an event record to the syscon event log. The syscon_log_write()
succeeds in writing a complete log record or it leaves the system log unchanged. The event record
consists of a syscon_log_entry structure (or an implementation-defined object that includes the members
of struct syscon_log_entry) and a copy of the data (if any) referenced by the buf argument.
The event record’s log_size member shall be set to the value of the len argument, or to zero if buf is
NULL. The len argument specifies the length in bytes of the data referenced by buf. If buf is NULL, or
the len argument is zero, then only the syscon_log_entry structure is included in the event record.
If the value of len is greater than {SYSCONLOG_ENTRY_MAXLEN} and buf is not NULL, the result of
the syscon_log_write() shall be as follows:
• If {SYSCONLOG_TRUNCATE} is not defined 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 set to
{SYSCONLOG_ENTRY_MAXLEN}, and only the first {SYSCONLOG_ENTRY_MAXLEN} bytes of the
data pointed to by buf will be included in the data portion of the event record. If the value of the
format argument is {SYSCONLOG_STRING}, a null character will be stored at the end of the data
portion of the record, so that the truncated string is null-terminated.
1
If buf is NULL, or the len argument is zero, the event record's log_format member will be set to
{SYSCONLOG_NODATA}; otherwise, the event record's log_format member will be set to the value of
the format argument. The interpretation of this value will be implementation-defined, with the following
exception:
A format of {SYSCONLOG_STRING} shall indicate that buf points to a null-terminated character string
whose length in bytes (including the terminating null character) is len.
The event_type argument identifies the type of event record being written. Its value and interpretation are
left to the application or the implementation. The event record’s log_event_type member shall be set to
the value of the event_type argument.
1
Note, however, that the implementation is not permitted to accomplish this by setting
buf[SYSCONLOG_ENTRY_MAXLEN-1] to the null character, since buf points to a const buffer.

IBM Carrier Grade X3650 T Specifications

General

Product Type	Server
Processor	Intel Xeon
Network Interface	Gigabit Ethernet
Operating System Support	Microsoft Windows Server, Red Hat Enterprise Linux, SUSE Linux Enterprise Server
RAID Support	Yes
Power Supply	Redundant power supply options

Summary

Revision History

Disclaimers

1. Introduction

2. SysCon Features

2.1 Automatic preservation of system settings

Preserves current BIOS and server management feature settings during system startup.

2.2 Detection of system setting changes

Compares current settings to saved ones and restores them if different, by default.

2.3 Transfer of system settings

Allows transferring system settings to a second system or using a SysCon Key.

3. Installing the SysCon Feature

3.1 Microsoft Windows*

Details the installation of the SysCon feature on Microsoft Windows* 2003 Enterprise Edition systems.

3.2 Linux

Details the installation of the SysCon feature on Linux operating systems.

3.3 Activating/Deactivating the SysCon Feature

Explains how to activate and deactivate the SysCon feature through system BIOS settings.

4. SysCon Feature Operation Overview

4.1 Configuring and booting the first time

Guides initial system configuration and boot process after SysCon installation.

4.2 Reconfiguring the system

Explains how SysCon uses policy settings to detect and act on system setting changes.

5. Booting the System

6. Controlling SysCon Behavior Using Policies

7. Interacting with the SysCon Feature

7.1 Using the SysCon Menu

Describes how to access and navigate the SysCon menu for system management.

7.2 Detecting system setting changes

Explains how SysCon detects and prompts for action when system settings change.

7.3 Applying transferred settings

Details how SysCon handles transferred settings when a device is moved to another system.

7.4 Using a SysCon Key

Covers backing up, restoring, and installing SysCon using a removable SysCon Key.

8. Creating System Settings Files

8.1 Encrypting Settings Data

Details how to encrypt sensitive component settings data using the SysconCipher.py utility.

8.2 Applying new user-specified settings

Explains how SysCon applies user-specified settings from the 'specified' folder.

8.3 Importing User-Specified Settings

Describes applying common settings to multiple servers via SysCon Keys.

9. Monitoring SysCon Activity

9.1 Logging SysCon Events

Configures logging of SysCon events, including severity filters and destinations.

9.2 Configuring Event Notification Actions

Sets up proactive user notifications for SysCon events to destinations like Telco Alarm Panel.

10. Using SysCon Operating System Services and Utilities

11. Using the SysCon Device for Application Data

12. SysCon Services

12.1 SysCon Service for Linux Features

Details SysCon install tools and utilities for Linux environments.

12.2 Events, Notification, and Actions

Explains SysCon events, logging, notification policies, and actions.

13. APPENDIX A – SysCon Environment Folder Structure

14. APPENDIX B – SysCon Policy File Format

14.1 SysCon Device Policy Defaults: policydefaults.xml

Documents default SysCon device policy settings and provides XML schema excerpts.

15. APPENDIX C – System Settings File Format

15.1 A Typical System Settings File Example

Provides an example of a system settings file in XML format for BIOS and IMM configuration.

15.2 A “Full” System Settings File Example

Presents a comprehensive example of a system settings file for detailed configuration.

15.3 System / Component Schema

Describes the XML schema files used for system and component settings.

15.4 Updating BIOS and Intel® Management Module firmware

15.4.1 Intel:BIOSVersion update example

Example XML for updating BIOS firmware versions with labels and tokens.

15.4.2 Intel:IMMVersion update example

Example XML for updating Intel Management Module firmware versions.

16. APPENDIX D – SysCon Log File Format

17. APPENDIX E – POSIX Logging API and Query Specification for SysCon

17.1 Logging Functions

Details SysCon logging functions, including writing to logs and formatted output.

17.2 Log Processing Functions

Covers functions for opening, reading, and managing log files and notifications.

18. Appendix F: Troubleshooting the SysCon Feature

18.1 Embedded USB Device “Present”

Troubleshooting table for SysCon behavior when the embedded USB device is present.

18.2 Embedded USB device “Not Present”

Troubleshooting table for SysCon behavior when the embedded USB device is not present.

18.3 Problem USB devices

Lists tested USB devices and their compatibility for use with SysCon.