<!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) 2006 by IBM Corporation"> <!-- 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. --> <!-- Created for V5R4 by beth hagemeister 6/30/04 --> <!-- Change history: --> <!-- end header records --> <title>Set Master Key (QC3SETMK, Qc3SetMasterKey)</title> <link rel="stylesheet" type="text/css" href="../rzahg/ic.css"> </head> <body> <a name="Top_Of_Page"></a> <!--Java sync-link--> <script type="text/javascript" language="Javascript" src="../rzahg/synch.js"> </script> <h2><img src="delta.gif" alt="Start of change">Set Master Key (QC3SETMK, Qc3SetMasterKey)</h2> <div class="box" style="width: 80%;"> <br> 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="60%">Master key ID</td> <td align="left" valign="top" width="15%">Input</td> <td align="left" valign="top" width="15%">Binary(4)</td> </tr> <tr> <td align="center" valign="top" width="10%">2</td> <td align="left" valign="top" width="60%">Key verification value</td> <td align="left" valign="top" width="15%">Output</td> <td align="left" valign="top" width="15%">Char(20)</td> </tr> <tr> <td align="center" valign="top" width="10%">3</td> <td align="left" valign="top" width="60%">Error code</td> <td align="left" valign="top" width="15%">I/O</td> <td align="left" valign="top" width="15%">Char(*)</td> </tr> </table> <br> Service Program Name: QC3MKSET<br> <!-- iddvc RMBR --> <br> Default Public Authority: *EXCLUDE<br> <!-- iddvc RMBR --> <br> Threadsafe: Yes<br> <!-- iddvc RMBR --> <br> </div> <p>The Set Master Key (OPM, QC3SETMK; ILE, Qc3SetMasterKey) API sets the specified master key from the parts already loaded. </p> <p>For more information about master keys, refer to <a href="qc3MasterKeys.htm">Cryptographic Services Master Keys</a>. </p> <br> <h3>Authorities and Locks</h3> <dl> <dt><strong>Required special authority</strong></dt> <dd>*ALLOBJ and *SECADM <br> </dd> </dl> <br> <h3>Required Parameter Group</h3> <dl> <dt><strong>Master key ID</strong></dt> <dd>INPUT; BINARY(4) <p>The master key IDs are </p> <table width="95%"> <!-- cols="5 95" --> <tr> <td align="left" valign="top" width="15%"><strong>1</strong></td> <td align="left" valign="top">Master key 1</td> </tr> <tr> <td align="left" valign="top" width="15%"><strong>2</strong></td> <td align="left" valign="top">Master key 2</td> </tr> <tr> <td align="left" valign="top" width="15%"><strong>3</strong></td> <td align="left" valign="top">Master key 3</td> </tr> <tr> <td align="left" valign="top" width="15%"><strong>4</strong></td> <td align="left" valign="top">Master key 4</td> </tr> <tr> <td align="left" valign="top" width="15%"><strong>5</strong></td> <td align="left" valign="top">Master key 5</td> </tr> <tr> <td align="left" valign="top" width="15%"><strong>6</strong></td> <td align="left" valign="top">Master key 6</td> </tr> <tr> <td align="left" valign="top" width="15%"><strong>7</strong></td> <td align="left" valign="top">Master key 7</td> </tr> <tr> <td align="left" valign="top" width="15%"><strong>8</strong></td> <td align="left" valign="top">Master key 8</td> </tr> </table> <br> </dd> <dt><strong>Key verification value</strong></dt> <dd>OUTPUT; CHAR(20) <p>The key verification value (KVV) can be used to determine if the master key has changed.</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> <h3>Error Messages</h3> <table width="100%"> <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">CPF222E E</td> <td width="85%" valign="top">&1 special authority is required.</td> </tr> <tr> <td valign="top">CPF24B4 E</td> <td valign="top">Severe error while addressing parameter list.</td> </tr> <tr> <td valign="top">CPF3C1E E</td> <td valign="top">Required parameter &1 omitted.</td> </tr> <tr> <td valign="top">CPF3CF1 E</td> <td valign="top">Error code parameter not valid.</td> </tr> <tr> <td align="left" valign="top">CPF3CF2 E</td> <td align="left" valign="top">Error(s) occurred during running of &1 API.</td> </tr> <tr> <td valign="top">CPF9872 E</td> <td valign="top">Program or service program &1 in library &2 ended. Reason code &3.</td> </tr> <tr> <td valign="top">CPF9DAD E</td> <td valign="top">The master key ID is not valid.</td> </tr> <tr> <td valign="top">CPF9DB0 E</td> <td valign="top">No key parts have been loaded.</td> </tr> <tr> <td valign="top">CPF9DDA E</td> <td valign="top">Unexpected return code &1.</td> </tr> </table> <br> <img src="deltaend.gif" alt="End of change"><br> <hr> API introduced: V5R4 <hr> <center> <table cellpadding="2" cellspacing="2"> <tr align="center"> <td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href= "catcrypt.htm">Cryptographic Services APIs</a> | <a href="aplist.htm">APIs by category</a></td> </tr> </table> </center> </body> </html>