cli.txt

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

	      parameter	 for include_quailifers to false, Note that this nega-
	      tive form is used because the  default  for  this	 parameter  is
	      true.

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

	      -di Set deep inheritance operation parameter to true.

	      -o [xml|mof] Set the output format for the instances to  display
	      the returns as mof

	      -pl [propertyList] optional property list for the operation

	      It returns the instances found either as MOF or XML depending on
	      the output options parameter.

	      Example

		  cimcli ei CIM_ComputerSystem -niq -di

		  This example enumerates CIM_ComputerSystem in the  namespace
	          root/CIMV2 (default) requesting without qualifiers (-niq) 
                  with deepInheritance (-di).


       niall enumerateallinstanceNames
	      Execute an enumerateinstancenames on  all	 classes  to  get  all
	      instance	names  within  the  defined  namespace.	 This function
	      searches the complete namespace using the CIM getClass operation
	      to  get  the  classes  and the enumerateInstanceNames command to
	      enumerate all of the instances for each class.  It  returns  the
	      list of all of the instance names found in the namespace.

	      The format is:

	      cimcli niall [options]

	      where  the  options  include  any	 of the universal options (ex.
	      namespace, location, etc.)

	      Example

		  cimcli niall -n test/testproviders

		  Returns  all	instancenames  in  the	namespace 
                  test/testproviders by executing enumerateinstancenames
		  on each class in the namespace.


       mi modifyinstance
	      NOTE: This command is not implemented in the current version and
	      return a fixed "NOT IMPLEMENTED" response.   This	 is  the  same
	      format  as  the  createinstance.	 The  difference  is  that the
	      instance must already exist to be modified.


       gi GetInstance
	      Gets the instance defined by the	instance  name	parameter  and
	      displays	it  in	the  format  chosen for this operation (xml or
	      mof).

	      The syntax for this opration is:

	      CLIgi[objectname][options]

	      which causes execution of the CIM getinstance operation.	OR

	      cimcli gi [class-name] [options]

	      which presents a list of possible instances  to  the  user  from
	      which  one  can  be selected for the getinstance.	 In this case,
	      the command actually executes an enumerateInstanceNames  to  get
	      the  list	 of  instances	that  is  presented  to the user.  The
	      getInstance is executed after the user makes a selection.

	      This command  requieres  the  [objectname]  parameter.   If  the
	      parameter	 is  an	 instance with keys defined (a CIMObjectPath),
	      the a getInstance CIM operation is executed and the return  from
	      the  CIM Server presented (in either xml or mof depending on the
	      ouput option).  If the input is a class name, a enumerateinstan-
	      ceNames  CIM Operation is executed and if any instance names are
	      returned the result is presented to the console for the user  to
	      select one of the instances to be deleted.

	      If  there	 are  no  instances,  the  return from this command is
	      normally an exception as defined	in  the	 DMTF  CIM  Operations
	      specification..


	      The possible options specific to this command are:

	      -iq include qualifiers

	      -nlo localonly

	      -pl [propertyList] optional property list for the operation

	      Example:

		   cimcli gi cim_managedElement

	           This  is an interactive request that returns a list of 
                   instances from an enumerateinstance of CIM_ManagedElement
                   from which the user can select one which cimcli will return
                   as a complete instance.



       di deleteinstance
	      Delete instance executed a single deleteInstance command to  the
	      CIM Server.  The syntax is

		   cimcli di [objectname] [options]

	      This  command  requires  the  [objectname]  parameter.   If this
	      parameter is a full instance name with className and  key	 bind-
	      ings, the deleteInstance CIM Operation is executed directly.  If
	      it is a class name with no keybindings, the   enumerateInstances
	      command is executed and the list of returned instances presented
	      to the console for the user to select one to delete. cimcli then
	      executes	deleteInstance	with  the  selected  instance name and
	      returns the response,

	      return - there is an empty response if the instance was success-
	      fully deleted or an exception return if there were any errors.

	      cimcli di [object] [options]

	      Examples:


	           cimcli di PG_test

	           Executes enumerateInstanceName on PG_test and allows the 
                   user to select the instance to be deleted.

	           cimcli di PG_test.name="abc"

	           Attempts to delete that object in the default namespace.


       gq getQualifier
	      getQualifier displays the target qualifier. The syntax is

	      cimcli gq [qualifier name] [options]

	      Example:	    

                   cimcli gq abstract 

                   Returns the mof or xml for the abstract qualifier.

       sq setQualifier
	      This command is not implemented.


       eq enumeratequalifiers
	      Issues  the  CIM	Operation  to  enumerate all of the qualifiers
	      defined in the target namespace. The syntax is:

		   cimcli eq [options]

	      There are no special options for this operation.


       dq deletequalifier
	      Issues the CIM operation to delete the target qualifier  defined
	      by qualifier_name in the target namespace.  The Syntax is:

	      cimcli dq [qualifier_name] [options]


	      NOTE: This should be used with great caution.


       a associators
	      Enumerate	 the  associators CIM Operation for the target object-
	      name.  The syntax for this operation is:

	      cimcli a [objectname] [options]

	      Note that the objectname may be either a classname or an instan-
	      cename.	If  classname  is  supplied,  the  return  is a set of
	      classes that match the objectname supplied unless the -i (inter-
	      active)  parameter is used.  If objectname is used, the response
	      is instances of the association that matches the classname.

	      The options provide the various operation parameters including;

	      -ac [associationClass] association Class parameter

	      -rc [resultClass] resultClass parameter

	      -r [role] String defining the role parameter for the CIM	Opera-
	      tion

	      -rr [resultrole] resultrole parameter

	      -ic includeClassOrigin The -ic parameter

	      -pl [properytlist] Optional PropertyList

	      -i  Interactive  request - If this parameter is supplied and the
	      objectname is a classname, the
		 environment performs an enumerateinstances on the  objectname
	      and presents the list of possible
		 instances for user selection

       an associatornames
	      Enumerate	 teh associator names for the target object.  The syn-
	      tax for this operation is:

		  cimcli an [objectname] [options]

	      where objectname can be either a class name or an instance name.

	      The options provide the various operation parameters including;

	      -ac [associationClass] association Class parameter

	      -rc [resultClass] resultClass parameter

	      -r  [role] String defining the role parameter for the CIM Opera-
	      tion

	      -rr [resultrole] resultrole parameter

	      -i Interactive request - If this parameter is supplied  and  the
	      objectname is a classname, the
		 environment  performs an enumerateinstances on the objectname
	      and presents the list of possible
		 instances for user selection


       r references
	      Executes	the  CIM  Operation  references.  Which	 returns   CIM
	      Objects.	The format of the operation is:

		   cimcli r [objectname] [options]

	      Note  that the objectname may be either a classname or aninstan-
	      cename.  If classname is	supplied,  the	return	is  a  set  of
	      classes that match the objectname supplier unless the -i (inter-
	      active) parameter is used.  If objectname is used, the  response
	      is instances of the association that matches the classname

	      Where the options specifically used by this operation are:

	      -r [role] role parameter for the CIM Operation.

	      -rc [resultClass] resultClass parameter for the CIM Operation

	      -iq includQualifiers (The default is false)

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

	      -pl [propertyList] optional property list for the operation

	      -i Interactive request - If this parameter is supplied  and  the
	      objectname is a classname, the
		 environment  performs an enumerateinstances on the objectname
	      and presents the list of possible
		 instances for user selection

	      Examples
		  TBD


       rn referencenames
	      Executes the CIM Operation referencenames.  The  format  of  the
	      operation is:

	      cimcli rn [objectname] [options]

	      Note that the objectname may be either a classname or a specific
	      instancename.  If classname is supplied, the return is a set  of
	      classnames  that	match  the  objectname	supplier unless the -i
	      parameter is used.  If  objectname  is  used,  the  response  is
	      instance namess of the associations that matches the classname

	      Where the options specifically used by this operation are:

	      -r role parameter for the CIM Operation

	      -rc resultClass parameter for the CIM Operation

	      -i  Interactive  request - If this parameter is supplied and the
	      objectname is a classname, the
		 environment performs an enumerateinstances on the  objectname
	      and presents the list of possible
		 instances for user selection


       im invokeMethod
	      This  operation  executes	 an  extrinsic	operation to execute a
	      method on a CIM class or instance.  The form of the command is:

	      cimcli im [objectname] [methodname] *[parameters] [options]

	      Note that there  there  are  two	required  parameters  to  this
	      command, the objectname and the [methodname].

	      Parametere are input in the form:

	      The  completed operations displays the return code from the com-
	      mand and any parameters that are qualified as OUT parameters.

	      Example:

		   cimcli PG_WBEMSLPTemplate register -n root/PG_Interop

	      The parameters are supplied as name=value pairs. In the  current
	      version, all parameters are treated as strings.


       eq executeQuery
	       The executeQuery operation is not supported in the current ver-
	      sion of cimcli.


       son    Set the CIMServer	 statistics  to	 enabled  by  doing  a	modify
	      instance	of  the	 CIM_ObjectManager  instance  that defines the
	      server. This depends on the server having implemented statistics
	      and  having  also	 implemented the functionality of enabling and
	      disabling	 statistics   through	setting	  this	 property   in
	      CIM_ObjectManager.  This should be considered a temporary opera-
	      tion in cimcli until a more permanent utility  is	provided  with
	      OpenPegasus  to  manage  this type of functionality.  The corre-
	      sponding operation soff will attempt to  disable	statistics  on
	      the  server.   This works with OpenPegasus servers starting with
	      version 2.5.1.