cli.txt

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

	      The syntax of the operation is:

	      cimcli son


       soff   See the operaiton son.  This is the corresponding	 operation  to
	      turn  off statistics in the server.  The syntax of the operation
	      is:

	      cimcli soff


       ns enumeratenamespaces
	      Request an Enumeration of all the namespaces in the  target  CIM
	      Server.	This  command uses both the CIM_Namespace class and if
	      that fails, the __Namespace  class  to  determine	 the  list  of
	      namespaces.

	      RETURN  -	 It  returns a list of the namespace names returned by
	      the CIM Server.

	      The format of the operation is:

	      cimcli ns [options]

	      Note that since this operation enumerates namespaces, the names-
	      pace option (-n) is not valid.

	      Examples	    cimcli ns

       ? Show Command Options
	      This operation simply shows the Command options


OPTIONS LIST
       There  are  a  significant  number  of options to this utility, some if
       which provide specific information for one or more commands and some of
       which  are universal across all of the commands.	  In general, the pro-
       gram does not check for spurious options so that if you input an option
       that  is not used by a particular operation, it is simply ignored. Note
       that some of the options require parameters.
	The following is an alphabetic list of the options.

       -ac assocaton_class_name
	      The Association Class parameter defines an assocClass string for
	      Associator  calls (associators and associatornames).  Default().
	      Example: -ac CIM_ManagedElement

       -ar [association_role_name]
	      Defines an association role for associator operations.  Example:
	      -ar  dependent.  This  optional  parameter is used only with the
	      association CIM Operations.

       -count [count]
	      Expected count of objects returned if  the  summary  set.	 Tests
	      this  count  and	display difference. Terminates the cimcli call
	      nonzero if test fails  . Default(). This can be used in  testing
	      to  confirm  that	 a  predefined	number of objects is returned.
	      Example: -count 100 will expect  100  objects  or	 names	to  be
	      returned

       -delay [time in seconds]
	      Delay  between  connection  and  request	.  Default(0). example
	      -delay 3 delays 3 seconds between the call and  the  transmisson
	      of  the actual CIM operation.  This is used only in some testing
	      environments.

       -di    Specifies the boolean parameter  deepInheritance	parameter  for
	      selected	commands.  Setting this options causes the deepinheri-
	      tance=tru to be transmitted for the operation.  Note  that  this
	      means  different	things	to different commands and is used only
	      with the enumerate commands.

       -ic    Boolean to set include class origin operation parameter to true.

       -iq    (DEPRECATED}Specifies   the  includeQualifiers  operation	 input
	      paramter for selected commands.Since the server default for this
	      parameter	 is  normally true, This option is deprecated in favor
	      of the -niq parameters

       -l [location]
	      Define CIMServer host address for the operation.	This  includes
	      either  name  or	IP  address  and  optional  port  number(Host-
	      Name:port).  The default is localhost:5988.   If	name  is  used
	      without  port,  port 5988 is assumed.  Examples include -l fred,
	      -l fred:9999, -l 10.1.134.66 -l 10.1.134.123:5977


       -lo    Specifies the localOnly operation parameter  for	selected  com-
	      mands  if the option is set.  See the commands for more informa-
	      tion. This option is Deprecated in favor of the -nlo because the
	      default for local only is on so that generally the -lo is simply
	      the default.  We recommend using -nlo to turn off local only.


       -n [Namespace]
	      Defines the namespace for the operation.host name.  The  default
	      is    root/cimv2.	   exmple    -n	  root/PG_Interop   sets   the
	      root/PG_Interop namespace as the namespace for the current oper-
	      ation.


       -p [password]
	      Allows input of a password for server authentication of the com-
	      mand. ( ex. -p 12345678). The default is	that  the  command  is
	      submitted with no password.


       -u [User]
	      Defines  nser  ame  for CIM Server authentication. Default is no
	      user name and no authentication.	( ex -u john)  Default	is  no
	      user name and no authentication.


       -lo    DEPRECATED.  This	 was  used  to set LocalOnly. However, default
	      should be true and we cannot use True as	default.   See	!lo  .
	      Default(true).


       -!lo   (DEPRECATED)  When  set,	sets  LocalOnly = false on operations.
	      DEPRECATED,!confuses bash. Use -nlo .  Default(false).  See also
	      -nlo.


       -nlo   When  set,  sets	LocalOnly  =  false  on	 the  CIM  operation .
	      Default(false). See also -!lo..  It is equivalent	 to  -!lo  and
	      superceedes the -!lo form.


       -niq   Sets  includeQualifiers  =  false on operations. Default(false).
	      See also -!iq.  This form was implemented	 because  of  problems
	      with  the	 -!iq  form on some systems.  It is equivalent to -!iq
	      which is deprecated.


       -pl [propertyList]
	      Defines a propertyName List which is an  optional	 parmeter  for
	      some  CIM	 Operations.  Format  is  p1,p2,p3  (without  spaces).
	      Default is that the property list is set to NULL indicating nor-
	      mally  that  the	operation  should  return all properties.  The
	      property list typically has 3 possibilities 1) empty which means
	      return  no  properties, 2) list of properties to be returned, 3)
	      NULL which means return all properties.  Since  the  default  is
	      NULL,  not  applying  the	 option	 means that all properties are
	      being requested.	To set this parameter to empty	use  the  form
	      -pl "".



       -r [role]
	      Defines a role string for reference role parameter. Default()


       -rc [resultClass]
	      Defines  a  resultClass  string for References and Associatiors.
	      Default()


       -rr [resultRole]
	      Defines a	 role  string  for  associators	 operation  resultRole
	      parameter. . Default()


       -ip [inputParameterList]
	      Defines	an   invokeMethod  input  parameter  list.  Format  is
	      p1=v1,p2=v2,..,pn=vn (without spaces) . Default()


       -f [filter]
	      Defines a filter to use for query. One String input . Default()


       -o [ xml | mof ]
	      Output in xml, mof, txt. Default(mof) if the -o options  is  not
	      included.


       -x     Output objects in xml instead of mof format. Default(false)


       /B --v Displays cimcli and Pegasus software Version.


       -v     Verbose	Display.  Includes  Detailed  Param  Input  display  .
	      Default(false). Outputs extra information about  the  parameters
	      actually	used in the request and the return from the operation.
	      This is primarily a debugging tool.


       --sum  Displays only  summary  counts  for  enumerations,  associators,
	      etc.This	option	is used to with the repeat option to repeat an
	      operation without getting the full return display.   It  reduces
	      the  display  to summary information.  It is often used with the
	      time option --t to generate time for  execution  information  on
	      many repetitions of a command.


       -h     Prints help usage message.


       --help Prints full help message with commands, options, examples.


       -ho    Prints list of cimcli options.


       -hc    Prints cimcli Operation command list. This list includes the CIM
	      Operatons defined by the CIM Operations specification and	 other
	      operations  that	were felt to be useful in testing CIM environ-
	      ments.


       --timeout [seconds]
	      Set the connection timeout in seconds. If not set,  the  timeout
	      is  the default Pegasus client timeout which for Pegasus is nor-
	      mally to about 30 seconds. This option executes the client  call
	      to set timeout.


       -d     More detailed debug messages from cimcli.  This can be useful in
              the case where the user is debugging CIM funtionality.


       -trace [trace_level]
	      Set Pegasus Common Components Trace. Sets	 the  Trace  level.  0
	      isoff. Default(0). The trace level can be set to 0 - 4.


       --r [repeat_count]
	      Number of times to repeat the function. Zero means one time. The
	      option ca be used to repeate an operation within a  single  call
	      to cimcli. It simply repeats the operation defined the number of
	      times defined by the repeate_count within the  same  connection.
	      Thus,  it	 establishes  the  connection  executes	 the operation
	      repeat_count times and then terminates.  It can be used with the
	      --time option to measure execution times for many repetitions of
	      an operation.


       --t    Measure time for the operation and present results. When set the
	      response	time  for  the operation is presented with the command
	      output. If the --r (repeat) option is set, minimum, maximum, and
	      average  times are presented.  Note that the time for the opera-
	      tion itself is presented in addition to  the  overall  time  for
	      connect,	operation,  and	 disconnect.   If statistics are being
	      gathered by the server, setting this option  also	 presents  the
	      server time, and the client round trip time which are calculated
	      by the server and client infrastructure.


       -s     Boolean option thatpecifies that the Client  should  attempt  to
	      connnect	over  the  secure  connection  using  SSL. This option
	      causes  cimcli  to  modify  the  client  connect call to set the
              SSLContext option to the certificate defined with the --cert and
               --key options . If this option is set but neither the --cert or
               --key options are included, the SSLContext for the connect call
               is submitted with the Cert and key marked NULL.


       --cert Defines a certificate to be used with the client connect if  the
	      -s  option  is  set. This is optional and used only  with the -s
	      and --key options.


       --key  Defines a Client private key. This is optional and only  has  an
	      effect on connections made over HTTPS using -s


EXAMPLES
       Execute an enumerateinstancenames CIM operation for the pg_computersys-
       tem Class
       cimcli enumerateinstancenames pg_computersystem  -- enumerateinstances
       of class
	  or
	cimcli ei pg_computersystem    -- Same as above


       Enumerate the class names from the default namespace "root/cimv2"
	cimcli enumerateclassnames -- Enumerate classnames from root/cimv2.

       Enumerate class names from the namespace "root"
	cimcli ec /n root -- Enumerate classnames from namespace root.

	cimcli  ec -o xml	 -- Enumerate classes with XML output starting
        at root
        
       cimcli enumerateclasses CIM_Computersystem -o xml
	   -- Enumerate classes in MOF starting with CIM_Computersystem

	cimcli getclass CIM_door -a -u guest -p guest
	   -- Get class with authentication set and user = guest,  password  =
       guest.

       cimcli rn TST_Person.name=@MIKE@ -n root/sampleprovider -rc TST_Lineage

	cimcli ec -o XML -- enumerate classes and output XML rather than MOF.

	cimcli getqualifiers -- Get the qualifiers in mof output format

BUGS
       Currently at least some platforms and shells  have  problems  with  the
       double-quote  which  is used extensively in object names within CIM. To
       get   around  this,  the  character  ’@’  has been  mapped  to  the
       double-quote so that inputting a command  line  with  this character in
       place of quotes is acceptable.  Thus, for example,

       cimcli rn TST_Person.name=@MIKE@ ...

       is equivalent to

       cimcli rn TST_Person.name-"MIKE" ...

       In this version there is no way to  turn	 this  character  mapping  off
       which means that the @ character is lost.


WARNINGS
RETURN VALUE
       cimcli returns the following codes:

       0 - Successfull execution of the operation.

       1 - Execution error for the operation.


AUTHOR
       Karl Schopmeyer [e-mail]



				     LOCAL			     cimcli(1)