97 lines
6.0 KiB
HTML
97 lines
6.0 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html lang="en-us" xml:lang="en-us">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="security" content="public" />
|
|
<meta name="Robots" content="index,follow" />
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
|
<meta name="DC.Type" content="task" />
|
|
<meta name="DC.Title" content="Use remote control panel APIs" />
|
|
<meta name="abstract" content="Use these APIs to write a program that can access the control panel remotely. Your program can access many commands and queries using these APIs." />
|
|
<meta name="description" content="Use these APIs to write a program that can access the control panel remotely. Your program can access many commands and queries using these APIs." />
|
|
<meta name="DC.Relation" scheme="URI" content="rzatmkickoff.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzatmapisyspowtest.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzatmapiiplrelated.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzatmapiother.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzatmapistatus.htm" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2000, 2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2000, 2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="rzatmcontrolapi" />
|
|
<meta name="DC.Language" content="en-us" />
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
|
<title>Use remote control panel APIs</title>
|
|
</head>
|
|
<body id="rzatmcontrolapi"><a name="rzatmcontrolapi"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">Use remote control panel APIs</h1>
|
|
<div><p>Use these APIs to write a program that can access the control panel
|
|
remotely. Your program can access many commands and queries using these APIs.</p>
|
|
<div class="section"><p>The remote control panel function of Operations Console provides
|
|
a set of APIs (application program interfaces) that system administrators
|
|
can use to control the server through programs. The APIs allow custom programs
|
|
to interface with the system control panel and perform many common system
|
|
control panel functions.</p>
|
|
<p>You can only use these APIs if you are using
|
|
the remote control panel that is connected with the serial console cable.
|
|
You cannot use these APIs with the virtual control panel or remote control
|
|
panel connected with a parallel cable.</p>
|
|
<p>The interface to the remote control
|
|
panel APIs is established through a standard TCP/IP socket connection. The
|
|
socket connection can be implemented in any programming language that supports
|
|
sockets on the Windows<sup>®</sup> platform (Java™ , C/C++, Visual Basic to name a few).</p>
|
|
<p>To
|
|
use the remote control panel APIs you need to follow these steps:</p>
|
|
</div>
|
|
<ol><li><span>Start Operations Console with the remote control panel function.</span></li>
|
|
<li><span>From a custom program open a socket connection to port 2150 on
|
|
the same PC.</span></li>
|
|
<li><span>Send a supported command from the set of commands that are described
|
|
below.</span></li>
|
|
<li><span>Receive the byte stream that is sent back on the same socket connection.</span></li>
|
|
<li><span>Repeat steps 3 and 4 as necessary on the same socket connection.</span></li>
|
|
<li><span>Close the socket connection when done.</span></li>
|
|
</ol>
|
|
<div class="section"><p>Your program will need to interpret the byte stream sent back from
|
|
the server. The returned byte stream consists of a predefined format which
|
|
is the same for all commands. The byte stream will be at least 4 bytes long.
|
|
Some commands will return additional bytes.</p>
|
|
<p>The first two bytes (0 and
|
|
1) will return the command status, typically successful or unsuccessful. The
|
|
next two bytes (2 and 3) will be a 16-bit number N, which tells how many additional
|
|
bytes will follow these first 4 bytes. If N is nonzero, then there will be
|
|
additional information in bytes 4 through 4 + N.. This information will be
|
|
additional data related to the command, such as TRUE or FALSE.</p>
|
|
<div class="note"><span class="notetitle">Note:</span> If
|
|
the command sent is not one of the command strings defined below, then the
|
|
return code in bytes 0 and 1 of the return value will be 32 (0x20). This means
|
|
<samp class="codeph">Command not Supported</samp>.</div>
|
|
<p>Your programs can perform
|
|
the following control panel functions by using the following APIs.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<ul class="ullinks">
|
|
<li class="ulchildlink"><strong><a href="rzatmapisyspowtest.htm">System power and test APIs</a></strong><br />
|
|
These APIs tell how to power on and off the system and how to perform and clear panel lamp tests.</li>
|
|
<li class="ulchildlink"><strong><a href="rzatmapiiplrelated.htm">IPL-related APIs</a></strong><br />
|
|
These APIs tell how to set IPL modes, types, and speed, along with how to start an IPL.</li>
|
|
<li class="ulchildlink"><strong><a href="rzatmapiother.htm">Other system function APIs</a></strong><br />
|
|
These APIs tell how to start dedicated service tools, start a main storage dump, and how to disable continuously powered main storage.</li>
|
|
<li class="ulchildlink"><strong><a href="rzatmapistatus.htm">APIs that question system status</a></strong><br />
|
|
These APIs tell about system status.</li>
|
|
</ul>
|
|
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzatmkickoff.htm">Control panel</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |