RPC Usage Examples Sheet 2 | Intel MPCMM0001 specs

Remote Procedure Calls (RPC)

Table 85. RPC Usage Examples (Sheet 2 of 3)

	Example	ChassisManagementApi()		ChassisManagementApi() [out] Parameters
		[in] Parameters


			uReturnType: DATA_TYPE_INT
	Get the	pszCMMHost: localhost	ppvbuffer: Integer value denoting health state
		uCmdCode: CMD_GET	0	= OK
	overall
	system	pszLocation: system	1	= Minor
	health.	pszDataItem: health	2	= Major

			3	= Critical

	Get a list of	pszCMMHost: localhost
		uCmdCode: CMD_GET	uReturnType: DATA_TYPE_STRING
	blades with
		pszLocation: system	ppvbuffer: List of all blades with problems
	problems.
		pszDataItem: unhealthylocations


		pszCMMHost: localhost	uReturnType: DATA_TYPE_INT
	Get the temp1		ppvbuffer: Integer value denoting health state
		uCmdCode: CMD_GET
			0	= OK
	sensor’s	pszLocation: blade5
	health on		1	= Minor
		pszTarget: Temp1SensorName
	blade 5.		2	= Major
		pszDataItem: health
			3	= Critical


			uReturnType: DATA_TYPE_INT
	Get the	pszCMMHost: localhost	ppvbuffer: Integer value denoting health state
		uCmdCode: CMD_GET	0	= OK
	CMM’s overall
		pszLocation: CMM	1	= Minor
	health.
		pszDataItem: health	2	= Major

			3	= Critical

			uReturnType: DATA_TYPE_INT
		pszCMMHost: localhost	ppvbuffer: Integer value denoting health state
	Get a blade’s	uCmdCode CMD_GET	0	= OK
	overall health.	pszLocation: blade[1..n]	1	= Minor
		pszDataItem: health	2	= Major
			3	= Critical

	Get the	pszCMMHost: localhost	uReturnType: DATA_TYPE_STRING
		uCmdCode: CMD_GET
	version of
			ppvbuffer: A human-readable null-terminated
	software on	pszLocation: CMM
			version string.
	the CMM.	pszDataItem: version



		pszCMMHost: localhost	uReturnType: not used
		uCmdCode: CMD_SET
	Power off one		ppvbuffer: not used
		pszLocation: blade[1-19]
	of the blades.		The return code from ChassisManagementApi()
		pszDataItem: powerstate

			indicates success or failure.
		pszSetData: poweroff


		pszCMMHost: localhost	uReturnType: not used
		uCmdCode: CMD_SET
	Power on one		ppvbuffer: not used
		pszLocation: blade[1-19]
	of the blades.		The return code from ChassisManagementApi()
		pszDataItem: powerstate

			indicates success or failure.
		pszSetData: poweron

188MPCMM0001 Chassis Management Module Software Technical Product Specification

Image 188

Intel MPCMM0001 manual RPC Usage Examples Sheet 2

Contents

Software Technical Product Specification Intel NetStructure MPCMM0001 Chassis Management ModulePage Contents Failed Failover/Reboot Recovery, Non-Critical 10.1 100 Snmp Rmcp 20.5 217 27.8.1 Figures 110 177 Revision History Date Revision Description Introduction1 OverviewTerms Used in this Document Glossary Sheet 1 Glossary Sheet 2 Operating System Command Line Interface CLI Software SpecificationsRed Hat* Embedded Debug and Bootstrap Redboot Remote Procedural Call RPC Interface RmcpEthernet Interfaces Sensor Event Logs SEL Blade OverTemp Shutdown Script Clearing the SELRetrieving the Raw SEL Synchronization Redundancy, Synchronization,Failover CMM Synchronization Sheet 1 Files or Data Description Path Priority User Scripts Synchronization and Configuration Setting User Scripts Sync Configuration FlagHeterogeneous Synchronization 1 SDR/SIF Synchronization Retrieving User Scripts Sync Configuration Flag Synchronization RequirementsInitial Data Synchronization Initial Data Sync Failure Datasync Status Sensor Sensor bitmapEvent IDs Querying the Datasync Status Initial Data Sync is complete and Priority 1 data is changed SEL Event Snmp Trap System Health CMM FailoverScenarios That Prevent Failover Scenarios That Failover to a Healthier Standby CMM Manual Failover Scenarios That Force a Failover Event String Event Code Event Severity CMM Ready EventCMM Status Event Strings CMM Status Built-In Self Test Bist Bist Test Flow Bist Implementation Bist Flow ChartBoot-BIST Early-BIST Mid-BIST Late-BIST Boot-BIST Early-BISTMid-BIST Late-BIST QuickBoot Feature Configuring QuickBoot Monitoring the Static Images OS Flash Corruption Detection and Recovery DesignEvent Log Area and Event Management Bist Test Descriptions Fpga Version Check 5 DS1307 RTC Real-Time Clock TestNIC Presence/Local PCI Bus Test OS Image Checksum Test Ipmb Bus Busy/Not Ready Test Re-enumeration5 Re-enumeration on Failover Events Regeneration Resolution of EKeysRe-enumeration of M5 FRU Thread Watchdog Monitoring Process Monitoring and IntegrityProcess Existence Monitoring Process Integrity Monitoring Processes MonitoredProcess Monitoring Targets Processes Monitored Process Monitoring Dataitems Examples Snmp MIB Commands Process Monitoring CMM Events No Action Recovery Failure Scenarios and Eventing Successful Restart Recovery No Action RecoverySuccessful Restart Recovery Description Event String Successful Failover/Restart Recovery Successful Failover/Restart Recovery Successful Failover/Reboot Recovery Successful Failover/Reboot RecoveryFailed Failover/Reboot Recovery, Non-Critical Failed Failover/Reboot Recovery, Critical Failed Failover/Reboot Recovery, Non-Critical Failed Failover/Reboot Recovery, Critical Excessive Restarts, Escalate No Action Excessive Restarts, Successful Escalate Failover/Reboot Excessive Restarts, Successful Escalate Failover/Reboot Process Monitoring and Integrity Process Administrative Action Administrative Action Excessive Failover/Reboots, Administrative Action Excessive Failover/Reboots, Administrative Action Configuring pms.ini PMS Administrative StatePMS Excessive Reboot/Failover Count PMS Excessive Reboot/Failover Interval Process Specific Data Process Section NameUnique ID Chassis Applicability Administrative State Start Program Name and ArgumentsProcess Existence Interval Thread Watchdog Retries Process Definition Section of pms.ini Monitor Process Chassis Wrapper Process CMM Wrapper Process CLI Server Command HandlerSnmp 3.8 BPM Dynamic Wrapper Process Inet Daemon Syslog Daemon Process Integrity Executable PIE Specific Data ConfigPIE Section Name Unique ID Administrative StateProcess Integrity Executable PmsPieSnmp Command Line Process Integrity IntervalChassis Applicability Snmp PIE Section of pms.ini 11 WP/BPM PIE 11.1 WP/BPM Section of pms.ini Power and Hot Swap Management Hot Swap StatesFRU Insertion Graceful FRU Extraction Forced Power State Changes Power Management on the Standby CMMPower Feed Targets Surprise FRU Extraction/IPMI Failure Variable Description Value Time to Delay and Number of AttemptsPinging Ipmi Controllers Command Line Interface CLI Connecting to the CLIConnecting through a Serial Port Console CLI Overview Initial Setup- Logging in for the First Time Setting IP Address Properties Setting Static IP Information for eth0 Setting Static IP Information for eth1 and eth11 Setting eth0 to Dhcp Setting eth1 to DhcpSetip Interface Assignments when BOOTPROTO=static Interface Setip Interface Assignments when BOOTPROTO=dhcp Setting a HostnameSetting the Amount of Time for Auto-Logout Setting the Date and Time Rebooting the CMMTelnet into the CMM Connect Through SSH Secure Shell CLI Command Line Syntax and Arguments Cmmget and Cmmset SyntaxHelp Parameter -h Location Parameter -l Target Parameter -t PEM2 CMM Targets Keyword Description Dataitem Parameter -d Location Dataitem listsDataitem Keywords for All Locations Dataitem Keywords for All Locations Except System Command Line Interface CLI Will only work on standby PowerOn Command Line Interface CLI Dataitem Keywords for Chassis Location MPCHC0001 Dataitem Keywords for Cmm Location Sheet 1 Dataitem Description Get CLI Get Output Valid Set Values Dataitem Keywords for Cmm Location Sheet 2 Dataitem Keywords for Cmm Location Sheet 3 Refer to , Updating CMM Software on Dataitem Keywords for Cmm Location Sheet 4 C.D Dataitem Keywords for Cmm Location Sheet 5 Dataitem Keywords for Cmm Location Sheet 6 Dataitem Keywords for Cmm Location Sheet 7 Dataitem Keywords for System Location Target Dataitem Lists Dataitem Keywords for FantrayN Location Dataitem Keywords Used with the Target Parameter Sheet 1 Dataitem Keywords Used with the Target Parameter Sheet 2 CMM Scripting on Dataitem Keywords Used with the Target Parameter Sheet 3 125 for more Value Parameter Sample CLI OperationsGenerating a System Status Report Dataitem Keywords Used with the Target Parameter Sheet 4 Command Line Interface CLI Resetting the Password Resetting the Password in a Dual CMM System Resetting the Password in a Single CMM System Threshold-Based Sensor Events Sensor TypesCMM Sensor Types Threshold-Based Sensors CMM Voltage/Temp Sensor Thresholds Discrete SensorsCMM Voltage and Temp Sensor Thresholds Sensor Name Discrete Sensor Events Health Events Syntax of Health Event StringsHealthevents Query Event Syntax SEL Event Syntax SEL Sensor Types Snmp Trap Event SyntaxCMM SEL Sensor Information Descriptions Sensor Target Description Sensor TargetsSensor Targets Sheet 1 Sensor Targets Sheet 2 Healthevents QueriesHealthEvents Queries for Individual Sensors HealthEvents Queries for All Sensors on a Location No Active EventsNot Present or Non-IPMI Locations List of Possible Health Event Strings Event String Event Code Event Severity Hex Decimal All LocationsThreshold-Based Sensors Voltage, Temp, Current, Fan Hot Swap Sensor Filter Tray HS, FRU Hot Swap Ipmb Link State Sensor IPMB-0 Snsr 0x255 597 Major Health Events Watchdog 2 Sensor Event Strings Sheet 1 Watchdog 2 Sensor Event Strings Sheet 2 CMM Location CMM RedundancyCMM Trap Connectivity CMM 1-2 Trap Conn CMM Failover Sheet 1 CMM Failover Sheet 2 Bist Event Strings Sheet 1 Bist Event Strings Sheet 2 Chassis Data Module CDM 1,2Datasync Status Event String Event Code Event Severity Hex Process Monitoring Service Fault Event Strings PMS Fault Ipmi Error Completion Codes Process Monitoring Service Info Event Strings PMS InfoChassis Location Chassis Events Configuring Ipmi Error Completion Codes IPMI/IMB Error Message FormatIpmi Error Completion Codes and Enumerations Code Error Message Example Alarm LEDs LED Symbol Status DescriptionFront Panel LEDs LED Types and States Health LED Hot Swap LEDUser Definable LEDs Retrieving a Location’s LED properties Setting the State of the User LEDs Retrieving the State of LEDsLedstate Functions and Function Options Function values Description Function options Event Health LED Hot Swap LED Boot SequenceLED Event Sequence Node Power Control Resetting a Board EKeying CLI Commands Electronic Keying ManagerPoint-to-Point EKeying Bused EKeying CDMs and FRU Information Chassis Data Module15.2 FRU/CDM Election Process FRU Information Dataitem Description FRU Query SyntaxDataitems Used With FRU Target -t to Obtain FRU Information CMM Cooling Manager Temperature Status Fan Control and MonitoringAutomatic Fan Control Querying Fan Tray Sensors FantrayN location Setting Values in the Cooling Table Temperature Sample Cooling UserCMM Cooling Table CMM Cooling Table CMM Control Mode Fantray Control ModeEmergency Shutdown Control Mode Control Modes for Fan Trays Getting Temperature Statuses User Initiated Mode ChangeAutomatic Mode Change Fantray Insertion Fantray PropertiesRetrieving the Current Cooling Level Setting User Defaults and Defaultcontrol through the CLI Default Cooling ValuesVendor Defaults Code Defaults Restoring DefaultsFirmware Upgrade/Downgrade Structure of /etc/cmm/fantray.cfg Legacy Method of Querying/Setting Fan Speed Chassis vs. Fantray Snmp CMM MIB MIB DesignMIB Tree MIB II Objects System Group CMM MIB Objects CMM Custom MIB Tree System Location OID Shelf Location Equivalent to Chassis String 145 Cmm Location 1.3.6.1.4.1.343.2.14.2.10.3 Sheet 1 Cmm Location 1.3.6.1.4.1.343.2.14.2.10.3 Sheet 2 CMM2 Cmm Location 1.3.6.1.4.1.343.2.14.2.10.3 Sheet 3 CmmTable/cmmEntry 1.3.6.1.4.1.343.2.14.2.10.3.51.1 Sheet 1 CmmTable/cmmEntry 1.3.6.1.4.1.343.2.14.2.10.3.51.1 Sheet 2 CmmFruTable/cmmFruEntry CmmFruTargetTable Blade# Location #TotalFrus Blade#FruTable/blade#FruEntry Blade#FruTargetTable/blade#FruTargetEntry FanTrayMaximumSetting Read-write Used to associate a script to a Snmp Agent Configuring the Snmp Agent PortConfiguring the Agent to Respond to Snmp v3 Requests Configuring the Agent Back to Snmp Setting up an Snmp v1 MIB BrowserSetting up an Snmp v3 MIB Browser Changing the Snmp MD5 and DES Passwords Configuring the Snmp Trap Port Configuring the CMM to Send Snmp v3 TrapsConfiguring the CMM to Send Snmp v1 Traps Configuring and Enabling Snmp Trap Addresses Configuring an Snmp Trap Address Alerts Using SnmpAlert Using UDP Alert Enabling and Disabling Snmp Traps Snmp Security Snmp v1 Security Snmp Trap DescriptionsSnmp v3 Security Fields For Traps Snmp v3 Security Fields For Queries Snmpd.conf File CMM Scripting CLI ScriptingScript Synchronization Event Scripting Setting Scripts for Specific Individual Events Listing Scripts Associated With EventsRemoving Scripts From an Associated Event Event Codes Setting Event Action Scripts Sensor Data BitsCMM State Transition Events and Event IDs Event ID Event Name Bit Bit Name Explanation Retrieving the Value of the Data Sensor BitsCMM Status Sensor Data Bits CMMReadyTimeout Value Setting the CMMReadyTimeout ValueRetrieving the CMMReadyTimeout Value CMM State Transition Model CMM Status State Diagram FRU Control Script Command line arguments Sample frucontrol file 171 # Activation 173 Using the RPC Interface Remote Procedure Calls RPCSetting Up the RPC Interface GetAuthCapability ChassisManagementApi Remote Procedure Calls RPC Error and Return Codes for the RPC Interface Sheet 1 Code # Error Code String Error Code Description Error and Return Codes for the RPC Interface Sheet 2 Error and Return Codes for the RPC Interface Sheet 3 Error and Return Codes for the RPC Interface Sheet 4 Ewpthresholdunsupported ChassisManagementApi Threshold Response Format ChassisManagementApi String Response FormatThreshold Response Formats String Response Formats Sheet 1 String Response Formats Sheet 2 Critical/Major/Minor Event Health String Response Formats Sheet 3 Board is present or not present /n String Response Formats Sheet 4 X.XXXX /0 Integer Response Formats ChassisManagementApi Integer Response FormatString Response Formats Sheet 5 Data Item Description FRU String Response FormatFRU Data Items String Response Format RPC Usage Examples Sheet 1 RPC Sample CodeRPC Usage Examples RPC Usage Examples Sheet 2 RPC Usage Examples Sheet 3 Rmcp Mode Description Rmcp ReferencesRmcp Modes Rmcp Modes Rmcp Session Activation Rmcp User Privilege LevelsRmcp Discovery Rmcp Port Numbers Rmcp Session TimersRmcp Session Phase Time-out Interval CMM Rmcp Configuration Ipmb Slave AddressesRmcp Slave Addresses Nodes Value Command Type Defined Ipmi Commands Supported by CMM RmcpIpmi Commands Supported by CMM Rmcp Sheet 1 Ipmi Commands Supported by CMM Rmcp Sheet 2 Configuring Ipmi Command Privileges Ipmi Commands Supported by CMM Rmcp Sheet 3 Sample cmdPrivillege.ini file Completion Codes for the Rmcp Messages Rmcp Message Completion Codes Code Description Command and Error Logging Command LoggingError Logging Error.log File Cmmdump Utility Application Hosting System Details Startup and Shutdown ScriptsSystem Resources Available to User Applications File System Storage Constraints RAM-Disk Storage Locations RAM ConstraintsFlash Memory Map Interrupt Constraints RAM Disk Directory Structure Updating CMM Software Key Features of the Firmware Update ProcessUpdate Process Architecture Critical Software Update Files and Directories Update PackageList of Critical Software Update Files and Directories File or Directory Name Description Update Package File Validation Contents of the Update Package SaveList and Data Preservation Update Firmware Package VersionComponent Versioning File Priority Update ModeSaveList Items and Their Priorities UpdateMetadata File Firmware Update Synchronization/Failover SupportAutomatic/Manual Failover Configuration CMM Update Directions Setting Failover Configuration Flag Retrieving the Failover Configuration FlagCLI Software Update Procedure Single CMM System Update Mode User Scripts Hooks for User Scripts Data Restore User Scripts Example Task-Replace /home/scripts/myScript Update Process Software update must be executed again to solve the problem Update Process Status and Logging Update Process Sensor and SEL EventsRedboot* Update Process Required Setup Updatecmm 00-a0-b7-d8-d8-5d FFS2 Updating Shelf Components Command Syntax and Interface Command Request String Format Response String Usage ExamplesSnmp Usage Example Ipmi Pass-Through Platform FRU Accessibility of the FRU Update Utility FRU Update UtilityFRU Update Architecture FRU Update Process FRU Recovery Process Setting the Library Path And Invoking the Utility FRU Update Command Line InterfaceFRU Verification FRU Display Argument Parameter Description Short Name Required/Optional Using the Location SwitchFruUpdate Utility Command Line Options Viewing the Contents of the FRU Getting the Contents of the FRUDumping the Contents of the FRU Updating the FRU LDLIBRARYPATH=. ./fruUpdate /d output.bin 12 /l chassis FRU Update Configuration File Configuration File FormatFile Format String Constraints Control Commands Numeric ConstraintsTags Ifset 27.6.4 SET ElseEndif Probing Commands ClearCfgname Probe Probe Command Parameters SystemFruver Probe Type Parameter Description of Parameter Bmcver Found Update Commands Fruname Fruaddress Fruarea FRU Area String Specifications FRU Area Ascii Strings Multi-Record Selection Parameters Parameter Parameter Value Description Number FRU Field First String Specifications FRU Field Maximum Allowed Lengths Sheet 1FRU Field First String Description Ascii String FRU Fields FRU Field Max Allowed Length Empty string FRU Field Second String SpecificationFRU Field Maximum Allowed Lengths Sheet 2 Type Code Specification Type Description Frusdr Version Display Commands Input of Data Menu Input CommandsDisplay Menutitle Prompt Command Quick Reference Command Quick Reference Sheet 127.9.8 YES 27.9.9 no Command Quick Reference Sheet 2 Else Command Quick Reference Sheet 3 Frufield Example Configuration File Chassis Update VersionProbe Arguments Quick Reference Probe Arguments Description 247 Errorlevel 0 Else Ifset Fruverneeded Chassis Update Version Errorlevel Endif Probe Fruver Found Allupdates 251 Endif Ifset Ipmblinkupdate Unrecognized Sensor Types System Events Overview Snmp Trap Atca Trap Text Translation Format System Events- Snmp Trap SupportSnmp Trap Header Format Snmp Trap Raw Format SNMPTrapFormat = Results of Variable Settings Snmp Trap ControlSystem Events- SEL Support SEL Header Format Configuring SEL Format SEL Raw FormatSELFormat = 1 text Example Output SELFormat = 2 raw Example Output System Events SEL Display Control Warranty Information Returning a Defective Product RMA For Europe, Middle East, and Africa Emea For Asia and Pacific Apac 261 Customer Support Customer Support Certifications31 Agency Information North America FCC Class a English French Agency Information Safety Warnings Not the Main Disconnect Mesures de Sécurité 269 Sicherheitshinweise 271 Norme di Sicurezza 273 Instrucciones de Seguridad 275 Chinese Safety Warning Use Case CLI Command Return Example CLI CommandsExample CLI Commands Sheet 1 Example CLI Commands Example CLI Commands Sheet 2 Example CLI Commands Sheet 3 Data Sheet Reference Intel AdvancedTCA* Product Information Open Source CD