ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QSYCHGDS.htm

473 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2005 by IBM Corporation">
<title>Change Service Tools User ID (QSYCHGDS) API</title>
<!-- Begin Header Records ========================================== -->
<!-- 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. -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten Dec 2001 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Change Service Tools User ID (QSYCHGDS) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Requesting service tools user ID</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Requesting service tools user ID password</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Service tools user ID to be changed</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">New service tools user ID</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">New service tools user ID password</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">7</td>
<td align="left" valign="top" width="50%">Length of requesting service tools
user ID profile</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Bin(4)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Length of requesting service tools user ID
password</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Bin(4)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">CCSID of requesting service tools user ID
password</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Bin(4)</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="left" valign="top">Length of new service tools user ID</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Bin(4)</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="left" valign="top">Length of new service tools user ID password</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Bin(4)</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CCSID of new service tools user ID password</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Bin(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change Service tools user ID (QSYCHGDS) API changes the ID name or the
password (or both) for service tools user IDs.</p>
<p>Calling this API from a command line may result in a security exposure since
the plain text service tools user ID and password may appear in the job log.
Therefore, you should avoid calling this API from the command line.</p>
<br>
<h3>Authorities and Locks</h3>
<p>When the requesting service tools user ID is different than the service
tools user ID to be changed, the requesting service tools user ID must have the
Service Tool user function privilege &quot;Service Tool Security&quot;.</p>
<p>When the requesting service tools user ID is the same as the service tools
user ID to be changed and the service tools user ID name is to be changed, the
requesting service tools user ID must have the Service Tool user function
privilege "Service Tool Security".</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Requesting service tools user ID</strong></dt>
<dd>INPUT; CHAR(*)
<p>The requesting service tools user ID. This value is converted to uppercase.
If the optional parameter group is not specified, a default of length 8 is
used. The requesting service tools user ID parameter should be padded with
trailing blank characters if necessary.</p>
</dd>
<dt><strong>Requesting service tools user ID password</strong></dt>
<dd>INPUT; CHAR(*)
<p>The password for the requesting service tools user ID.</p>
</dd>
<dt><strong>Service tools user ID to be changed</strong></dt>
<dd>INPUT; CHAR(10)
<p>The service tools user ID to be changed. This value is converted to
uppercase. The service tools user ID to be changed parameter should be padded
with trailing blank characters. You can use these special values for the
service tools user ID to be changed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SECURITY</em></td>
<td align="left" valign="top">Change the security capability profile.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FULL</em></td>
<td align="left" valign="top">Change the full capability profile.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BASIC</em></td>
<td align="left" valign="top">Change the basic capability profile.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SERVICE</em></td>
<td align="left" valign="top">Change the service capability profile.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>New service tools user ID</strong></dt>
<dd>INPUT; CHAR(*)
<p>The new service tools user ID or *SAME. This value is converted to
uppercase. If the optional parameter group is not specified, a default length
of 8 is used. The new service tools user ID parameter should be padded with
trailing blank characters if necessary.</p>
</dd>
<dt><strong>New service tools user ID password</strong></dt>
<dd>INPUT; CHAR(*)
<p>The new service tools user ID password or *SAME.</p>
<p> If 128 character, case sensitive passwords are enabled for the service
tools user IDs, then *SAME is not allowed.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<br>
<h3>Optional Parameter Group</h3>
<dl>
<dt><strong>Length of requesting service tools user ID</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length, in bytes, of the ID contained in the requesting service tools ID
parameter. If the optional parameter group is not specified, a default of 8 is
used. The requesting service tools user ID parameter should be padded with
trailing blank characters, if necessary, to the size specified by this
parameter.</p>
<p>This parameter accepts values from 1 to 10.</p>
</dd>
<dt><strong>Length of requesting service tools user ID password</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length, in bytes, of the password contained in the requesting service
tools user ID password parameter. If the optional parameter group is not
specified, a default of 8 is used. The requesting service tools user ID
password parameter should be padded with trailing blank characters, if
necessary, to the size specified by this parameter.</p>
<p>This parameter accepts values from 1 to 512. If 128 character, case
sensitive passwords are not enabled for the service tools user IDs, the
password is limited to 8 characters. If 128 character, case sensitive passwords
are enabled for the service tools user IDs, then this password may be from 6 to
512 bytes. However, values greater than 128 should only be used if multi-byte
characters are specified for the service tools user ID password. The number of
characters, as interpreted by the CCSID of the service tools user ID password
parameter, cannot exceed 128.</p>
</dd>
<dt><strong>CCSID of requesting service tools user ID password</strong></dt>
<dd>INPUT; BINARY(4)
<p>The CCSID of the requesting service tools user ID password parameter. If the
optional parameter group is not specified, CCSID 37 is used. For a list of
valid CCSIDs, see the <a href="../nls/rbagsglobalmain.htm">Globalization</a>
topic in the iSeries Information Center.</p>
<p>The valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The CCSID of the job is used to determine the
CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from
the default CCSID (DFTCCSID) job attribute is used.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1-65533</em></td>
<td align="left" valign="top">A valid CCSID in this range.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Length of new service tools user ID</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length, in bytes, of the ID contained in the new service tools user ID
parameter. If the optional parameter group is not specified, a default of 8 is
used. The new service tools user ID parameter should be padded with trailing
blank characters, if necessary, to the size specified by this parameter.</p>
<p>This parameter accepts values from 1 to 10.</p>
</dd>
<dt><strong>Length of new service tools user ID password</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length, in bytes, of the password contained in the new service tools
user ID password parameter. If the optional parameter group is not specified, a
default of 8 is used. The new service tools user ID password parameter should
be padded with trailing blank characters, if necessary, to the size specified
by this parameter.</p>
<p>This parameter accepts values from 6 to 512. If 128 character, case
sensitive passwords are not enabled for the service tools user IDs, the
password is limited to 8 characters. If 128 character, case sensitive passwords
are enabled for the service tools user IDs, then this password may be from 6 to
512 bytes. However, values greater than 128 should only be used if multi-byte
characters are specified for the service tools user ID password. The number of
characters, as interpreted by the CCSID of the service tools user ID password
parameter, cannot exceed 128.</p>
</dd>
<dt><strong>CCSID of new service tools user ID password</strong></dt>
<dd>INPUT; BINARY(4)
<p>The CCSID of the new service tools user ID password parameter. If the
optional parameter group is not specified, CCSID 37 is used. For a list of
valid CCSIDs, see the <a href="../nls/rbagsglobalmain.htm">Globalization</a>
topic in the iSeries Information Center.</p>
<p>The valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The CCSID of the job is used to determine the
CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from
the default CCSID (DFTCCSID) job attribute is used.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1-65533</em></td>
<td align="left" valign="top">A valid CCSID in this range.</td>
</tr>
</table>
<br>
</dd>
</dl>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF225B E</td>
<td width="85%" valign="top">Service tools user ID to be changed is not
correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF225C E</td>
<td align="left" valign="top">Requesting service tools user ID not
correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF225D E</td>
<td align="left" valign="top">Requesting service tools user ID password not
correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3BC7 E</td>
<td align="left" valign="top">CCSID &amp;1 outside of valid range.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3BDE E</td>
<td align="left" valign="top">CCSID &amp;1 not supported by API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C3C E</td>
<td align="left" valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF4AB3 E</td>
<td align="left" valign="top">Error changing service tools user ID. Reason code
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">
CPF4AB7 E</td>
<td align="left" valign="top">Service tools user ID password cannot be changed.
</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>