(file) Return to cimconfig.html CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Clients / cimconfig / doc

File: [Pegasus] / pegasus / src / Clients / cimconfig / doc / cimconfig.html (download) / (as text)
Revision: 1.2, Thu Dec 13 14:53:36 2001 UTC (22 years, 6 months ago) by mike
Branch: MAIN
CVS Tags: test, pep_88, merge_of_dev, mday-merge-start, mday-merge-pegasus/src/Pegasus/Server, mday-merge-pegasus/src/Pegasus/Common, mday-2-0-patches, local, async_dispatcher, VERSION_2_1_RELEASE_HEAD, VERSION_2_1_RELEASE_BRANCH, VERSION_2_1_RELEASE, VERSION_2_1_1_RELEASE, VERSION_2_01_01, VERSION_2_00_RC_4, VERSION_2_00_RC_3, VERSION_2_00_RC_2, VERSION_2_00_RC_1, VERSION_2_00_BRANCH, VERSION_1_10, VERSION_1_09, VERSION_1_08, VERSION_1_07, TEST, RELEASE_2_4_FC_CANDIDATE_1, RELEASE_2_4_3, RELEASE_2_4_2, RELEASE_2_4_1-BETA3, RELEASE_2_4_1-BETA2, RELEASE_2_4_1-BETA1, RELEASE_2_4_1, RELEASE_2_4_0-RC3, RELEASE_2_4_0-RC2, RELEASE_2_4_0, RELEASE_2_4-root, RELEASE_2_4-branch, RELEASE_2_3_2-testfreeze, RELEASE_2_3_2-root, RELEASE_2_3_2-releasesnapshot, RELEASE_2_3_2-branch-freeze, RELEASE_2_3_2-branch, RELEASE_2_3_1-root, RELEASE_2_3_1-branch, RELEASE_2_3_0-root, RELEASE_2_3_0-msg-freeze, RELEASE_2_3_0-branch, RELEASE_2_2_1-snapshot, RELEASE_2_2_0_0-release, RELEASE_2_2_0-root, RELEASE_2_2_0-branch, RELEASE_2_2-root, PRE_LICENSE_UPDATE_2003, POST_LICENSE_UPDATE_2003, PEP213_SIZE_OPTIMIZATIONS, PEGASUS_FC_VERSION_2_2, MONITOR_CONSOLIDATION_2_5_BRANCH, LOCAL_ASSOCPROV-ROOT, LOCAL_ASSOCPROV-BRANCH, IBM_241_April1405, CQL_2_5_BRANCH, CHUNKTESTDONE_PEP140
Changes since 1.1: +193 -0 lines
Merged dev branch into main trunk.

<html>

<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
<meta NAME="GENERATOR" CONTENT="Microsoft FrontPage 3.0">
<title>cimuser</title>
<meta NAME="Template" CONTENT="C:\hp\i\ms\off97pro\32.0\Office\html.dot">
</head>

<body LINK="#0000ff" VLINK="#800080">

<h3>cimconfig</h3>

<h4>Name </h4>

<blockquote>
  <b><p>cimconfig</b> - get, set, unset or list CIMOM configuration properties.</p>
</blockquote>

<h4>Synopsis </h4>

<blockquote>
  <code><b><p>cimconfig</b> -g name [ -c ][ -p ][ -d ]</p>
  <b><p>cimconfig</b> -s name=value [ -c ][ -p ]<i></p>
  </i><b><p>cimconfig</b> -u name [ -c ][ -p ]<i></p>
  </i><b><p>cimconfig </b>-l [ -c | -p ]</p>
  </code>
</blockquote>

<h4>Description </h4>

<blockquote>
  <p>The cimconfig command provides a command line interface to manage CIMOM configuration
  properties. </p>
  <p>The first form of cimconfig allows to get current, planned and / or default value of
  the specified configuration property.&nbsp; </p>
  <p>The second form allows to set the current value and / or planned value of the specified
  configuration property to the specified value.&nbsp; <br>
  <br>
  The third form allows unsetting the current and / or planned values of&nbsp; the specified
  configuration property to its default value.</p>
  <p>The last form of this command allows for all the configuration properties to be listed.
  Specifying the <code>-c </code>or <code>-p </code>options, will provide a listing of all
  the current or planned configuration property names and values.</p>
  <p>Specifying no options with the cimconfig command will show the usage message. </p>
</blockquote>

<h4>Options </h4>

<blockquote>
  <p>The cimconfig command recognizes the following options: </p>
</blockquote>

<blockquote>
  <code><p>-g</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  Gets the current value of the specified configuration property.</p>
  <code><p>-g -c</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the
  current value of the specified configuration property.</p>
  <code><p>-g -p</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the
  planned value of the specified configuration property.</p>
  <code><p>-g -d</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the
  default value of the specified configuration property. Returns an error when the CIMOM is
  not running.</p>
  <code><p>-s</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  Indicates that a configuration property is to be added or updated by setting its current
  value to the specified value. Returns an error when the CIMOM is not running or the
  specified property is not dynamically updatable. </p>
  <code><p>-s -c</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates
  that a configuration property is to be added or updated by setting its current value to
  the specified value. Returns an error when the CIMOM is not running or the specified
  property is not dynamically updatable.</p>
  <code><p>-s -p</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates
  that a configuration property is to be added or updated by setting its planned value to
  the specified value. </p>
  <code><p>-u</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  Indicates that the current value of the specified configuration property is to be reset to
  default. Returns an error when the CIMOM is not running or the specified property is not
  dynamically updatable.</p>
  <code><p>-u -c</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates
  that the current value of the specified configuration property is to be reset to default.
  Returns an error when the CIMOM is not running or the specified property is not
  dynamically updatable.</p>
  <code><p>-u -p</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates
  that the planned value of the specified configuration property is to be reset to default. </p>
  <code><p>-l</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  Displays the name of all the configuration properties.</p>
  <p><code>-l -c</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Displays the
  name and value pair of all the current configuration properties.</p>
  <p><code>-l -p</code>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Displays the
  name and value pair of all the planned configuration properties.</p>
</blockquote>

<h4>Return Values</h4>

<blockquote>
  <p>cimconfig returns one of the following values:</p>
</blockquote>

<blockquote>
  <code><p>0</code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Successful completion.</p>
  <code><p>1</code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Error</p>
</blockquote>

<blockquote>
  <p>When an error occurs, an explanatory error message is written to stderr and an error
  value 1 is returned. </p>
</blockquote>

<h4>Examples </h4>

<blockquote>
  <p>The following commands get the current value for the configuration property
  &quot;port&quot;.</p>
</blockquote>

<blockquote>
  <code><b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -g port</p>
  <b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -g port -c </p>
  </code>
</blockquote>

<blockquote>
  <p>The following command gets the planned value for the configuration property
  &quot;traceLevel&quot;.</p>
  <code><b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -g traceLevel -p </p>
  </code><p>The following commands set the current value of the property
  &quot;traceLevel&quot;, to the new value &quot;2&quot;.</p>
</blockquote>

<blockquote>
  <code><b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -s traceLevel=2</p>
  <b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -s traceLevel=2 -c </p>
  </code>
</blockquote>

<blockquote>
  <p>The following command sets the planned value of the property &quot;traceLevel&quot;, to
  the new value &quot;3&quot;.</p>
  <code><b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -s traceLevel=3 -p</p>
  </code><p>The following commands reset the current value of the property
  &quot;traceLevel&quot; to the default value. </p>
</blockquote>

<blockquote>
  <code><b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -u traceLevel</p>
  </code>
</blockquote>

<blockquote>
  <code><b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -u traceLevel -c</p>
  </code><p>The following command resets the planned value of the property
  &quot;traceLevel&quot; to the default value. </p>
  <p><code><b>&nbsp;&nbsp;&nbsp; cimconfig</b> -u traceLevel -p</code></p>
  <p>The following command displays the list of all the current configuration properties.</p>
</blockquote>

<blockquote>
  <code><b><p>&nbsp;&nbsp;&nbsp; cimconfig</b> -l</p>
  </code><p>The following command displays the list of all the current configuration
  properties and values.</p>
  <p><code><b>&nbsp;&nbsp;&nbsp; cimconfig</b> -l -c</code></p>
  <p>The following command displays the list of all the planned configuration properties and
  values.</p>
  <p><code><b>&nbsp;&nbsp;&nbsp; cimconfig</b> -l -p</code></p>
</blockquote>

<h4>Limitations</h4>

<blockquote>
  <p>This version of the cimconfig command does not return classified error codes. When an
  error occurs, it writes explanatory error message to stderr and returns an error value 1. </p>
</blockquote>

<h4>Author </h4>

<blockquote>
  <b><p>cimconfig</b> was developed by the Hewlett-Packard Company. </p>
</blockquote>
</body>
</html>

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2