src/Providers/TestProviders/CLITestProvider/tests/helpresult.master.ssl

   1 17. +++++ test Help Output
   2 Usage: cimcli <command> <CIMObject> <Options> *<extra parameters>
   3     -hc    for <command> set and <CimObject> for each command
   4     -ho    for <Options> set
   5     -h xx  for <command> and <Example> for <xx> operation
   6     -h     for this summary
   7     --help for full help
   8 Version 2.10.0
   9 The options for this command are:
  10
  11 This command executes single CIM Operations.
  12
  13  -count  count. Expected count of objects returned if summary set.
  14     Tests this count and displays difference.
  15     Return nonzero status code if test fails. Default(29346)
  16  -d  debug. More detailed debug messages. Default(false)
  17  -delay  delay. Delay between connection and request. Default(0)
  18  -p  Password. Defines password for authentication. Default()
  19  -l  location. Specifies system and port (HostName:port).
  20     Port is optional. Default()
  21  -s  ssl. Specifies to connect over HTTPS. Default(false)
  22  --cert  clientCert. Specifies a client certificate file path to present to the server.
  23     This is optional and only has an effect on connections
  24     made over HTTPS using -s. Default()
  25  --key  clientKey. Specifies a client private key file path.
  26     This is optional and only has an effect on connections
  27     made over HTTPS using -s. Default()
  28  -u  User. Defines User Name for authentication. Default()
  29  -n  namespace. Specifies namespace to use for operation. Default(root/cimv2)
  30  -ic  includeClassOrigin. If set includeClassOrigin  parameter
  31     set true on requests that honor this parameter. Default(false)
  32  -di  deepInheritance. If set deepInheritance parameter
  33     set true. Default(false)
  34  -lo  localOnly. DEPRECATED. This was used to set LocalOnly.
  35     However, default should be true and we cannot use True
  36     as default. See -nlo. Default(true)
  37  -nlo  notLocalOnly. When set, sets LocalOnly = false on
  38     operations. Default(false)
  39  -iq  includeQualifiers. DEPRECATED. Sets includeQualifiers = True.
  40     Useful for instance operations where default is false. Default(false)
  41  -niq  notIncludeQualifiers. Sets includeQualifiers = false
  42     on operations. Useful for class operations where
  43     the default is true.. Default(false)
  44  -pl  propertyList. Defines a propertyNameList. Format is p1,p2,p3
  45     (without spaces). Use "" for empty. Default(###!###)
  46  -ac  assocClass. Defines a assocation Class string for Associator calls. Default()
  47  -ar  assocRole. Defines a role string for Associators. AssocRole
  48     parameter. Default()
  49  -r  role. Defines a role string for reference role parameter. Default()
  50  -rc  resultClass. Defines a resultClass string for References and
  51     Associatiors. Default()
  52  -rr  resultRole. Defines a role string for associators operation resultRole
  53     parameter. Default()
  54  -ip  inputParameters. This option deprecated and removed. Replaced by use of
  55     the same name/value pair syntax as properties in create
  56     and modify instance.. Default()
  57  -f  filter. Defines a filter to use for query. Single String input. Default()
  58  -ql  queryLanguage. Defines a Query Language to be used with a query filter.
  59 . Default(WQL)
  60  -o  outputformats. Output in xml, mof, txt, table. Default(mof)
  61  -x  xmlOutput. Output objects in xml format. Default(false)
  62  --version  version. Displays software Version. Default(false)
  63  -v  verbose. Verbose Display. Outputs detailed parameter input
  64     display and other request processing information. Default(false)
  65  --sum  summary. Displays only summary count for enumerations,
  66     associators, etc.. Default(false)
  67  -h  help. Prints help usage message. Default(false)
  68  --help  full help. Prints full help message with commands, options,
  69     examples. Default(false)
  70  -ho  help options. Prints list of options. Default(false)
  71  -hc  help commands. Prints CIM Operation command list. Default(false)
  72  --timeout  connecttimeout. Set the connection timeout in seconds.. Default(0)
  73  -i  interactive. Interactively ask user to select instances.
  74     Used with associator and reference operations. Default(false)
  75  --setRtnHostNames  setRtnHostNames. Set namespace component of reference and path outputs parameter.
  76     Used to allow comparison of paths and instances without involving the variable of host namespaces.. Default()
  77  -trace  trace. Set Pegasus Common Components Trace. Sets the Trace level.
  78     0 is off. Default(0)
  79  --r  repeat. Number of times to repeat the operation.
  80     Zero means one time. Default(0)
  81  --t  time. Measure time for the operation and present results. Default(false)
  82  --sort  sort. Sort the returned entities for multi-entity responses. Default(false)
  83
  84 Options vary by command consistent with CIM Operations
  85
  86 ni    enumerateInstanceNames Enumerate instancenames of <classname>
  87 niall enumallInstanceNames  Enumerate all instance names in <namespace>.
  88 ei    enumerateInstances    Enumerate instances of <classname>
  89 nc    enumerateClassNames   Enumerate Class Names of [ <classname> ].
  90                             Classname optional
  91 ec    enumerateClasses      Enumerate classes of [ <classname> ].
  92                             Classname optional
  93 gc    getClass              Get class of <classname>
  94 gi    getInstance           Get instance of <objectname> | <classname>
  95                             (interactive) |
  96                             <classname>
  97                             *<PropertyName=value> for equal property values.
  98 ci    createInstance        Create Instance of <Class> *<name=param> with
  99                             defined properties
 100 ti    testInstance          Test instance  of <objectname>  *<name=value>
 101                             | <classname>
 102                             *<PropertyName=value>
 103                             for equal property
 104                             values.
 105 di    deleteInstance        Delete Instance of <objectname> | <classname>
 106                             *<keyPropertyName=value> | interactive of <className>
 107 cc    createClass           Not supported
 108 mi    modifyInstance        Modify Instance of <objectname> *<name=value>
 109                             | <classname>
 110                             *<name=value>
 111 dc    deleteClass           Delete Class of <classname>
 112 gp    getProperty           get single property of <object name>
 113 sp    setProperty           set a single property of <object-name>
 114 gq    getQualifier          Get Qualifier of <qualifiername>
 115 sq    setQualifier          Not suported
 116 eq    enumerateQualifiers   Enumerate all Qualifiers
 117 dq    deleteQualifier       Delete qualifer of <qualifiername>
 118 a     associators           Enumerate Associators of <classname> |
 119                             <instancename>.
 120 an    associatorNames       Enumerate Associator Names of <classname> |
 121                             <instancename>
 122 r     references            Enumerate References of <classname> |
 123                             <instancename>
 124 rn    referenceNames        Enumerate Reference Names <classname> |
 125                             <instancename>
 126 im    invokeMethod          Invoke Method for <object> <method>
 127                             {<inputParams>}
 128 xq    execQuery              ExecQuery <query-expresssion>
 129                             [<query-language>]
 130 ns    enumerateNamespaces   Enumerate all namespaces on the server.
 131 son   Turn On Statistics    Turn on CIM Server Statistics Gathering
 132 soff  Turn Off Statistics   Turn off CIM Server Statistics Gathering
 133 ?     show command options  Show List of Commands -h for all help, -hc for commands, -ho for options
 134
 135 Examples :
 136 cimcli ni -n test/TestProvider TST_Person
 137     -- Enumerate Instance Names of class TST_Person
 138
 139 cimcli niall -n root/cimv2
 140     -- Enumerate Instance Names of  all classes under
 141        the namespace root/cimv2
 142
 143 cimcli ei PG_ComputerSystem   -- Enumerate Instances of class
 144
 145 cimcli nc -- Enumerate class names from root/cimv2.
 146
 147 cimcli ec -n root/cimv2
 148     -- Enumerate classes from namespace root/cimv2.
 149
 150 cimcli gc CIM_door -u guest -p guest
 151     -- Get class user = guest and password = guest.
 152
 153 cimcli gi -n test/TestProvider TST_Person
 154     -- Get Instance of class
 155
 156 cimcli ci -n test/TestProvider TST_Person Name=Mike SSN=333
 157     -- Create Instance of  class TST_Person with properties
 158        Name= Mike and SSN= 333
 159
 160 cimcli ti -n test/TestProvider TST_Person Name=Mike SSN=333
 161     -- Test Instance of  class for equality of Name and SSN
 162        properties. Returns error code if instance in server
 163        does not have same properties and values as the
 164        instance built from input
 165
 166 cimcli di -n test/TestProvider TST_Person
 167     -- Delete Instance of class TST_Person interactively
 168 or
 169  cimcli di -n test/TestProvider TST_Person name=Mike
 170     -- Delete Instance of class TEST_Persion with key property
 171        name equal Mike using instance builder format to
 172        define object path
 173 or
 174  cimcli di -n test/TestProvider TST_Person.name=\"Mike\"
 175     -- Delete Instance of class TST_Persion with object path
 176        TST_Person.name="Mike" using object path input format
 177
 178 Operation Not supported..
 179
 180 cimcli mi -n test/TestProvider TST_Person.Id=\"Mike\" SSN=444
 181     -- Modifies the Instance if it exists using rules of DMTF
 182        modifyInstance operation.
 183
 184 cimcli dc -n test/TestProvider TST_Person
 185     -- Deletes the Class when there are no instances and
 186        sub-classes for this class
 187
 188 cimcli gp -n test/TestProvider TST_Person.Id=\"Mike\" SSN
 189     -- Get the property named SSN from the instance
 190        defined by TST_Person.Id="Mike"
 191 cimcli sp -n test/TestProvider TST_Person.Id=\"Mike\" SSN=333
 192     -- Set the property named SSS in the instance
 193        defined by TST_Person.Id="Mike")
 194 cimcli gq Association
 195     -- Get the qualifier named Association in mof output
 196        in the default namespace (normally root/cimv2)
 197 Operation Not supported..
 198
 199 cimcli eq -n test/TestProvider
 200     -- Enumerate Qualifiers of namespace test/TestProvider
 201
 202 cimcli dq -n test/TestProvider ASSOCIATION
 203     -- Delete Qualifier named ASSOCIATION in namespace
 204        test/TestProvider
 205
 206 cimcli a TST_Person.name=\"Mike\" -n test/TestProvider  -ac TST_Lineage
 207  -rc TST_Person
 208     -- get associations for instances of association class
 209        TST_Lineage and result class TST_Person
 210        associated with instance of TST_person with key
 211        "Mike" in namespace test/TestProvider
 212 or
 213  cimcli a TST_Person -n test/TestProvider -ac TST_Lineage
 214     -- get associated classes for all instances of classes
 215        associated with class TST_person and with
 216        association class TST_Lineage
 217 or
 218  cimcli a TST_Person -n test/TestProvider -ac TST_Lineage -i
 219     -- get associated instances by selecting interactively for
 220        classes  associated with class TST_person and with
 221        association class TST_Lineage
 222
 223 cimcli an TST_Person.name=\"Mike\" -n test/TestProvider -ac TST_Lineage
 224 or
 225  cimcli an TST_Person -n test/TestProvider -ac TST_Lineage
 226
 227 cimcli r TST_Person.name=\"Mike\" -n test/TestProvider -rc TST_Lineage
 228     -- get references for instances association class TST_Lineage
 229        associated with instance of TST_person with key
 230        "Mike" in namespace test/TestProvider
 231 or
 232  cimcli r TST_Person.name=\"Mike\" -n test/TestProvider
 233     -- get references for all instances of classes
 234        associated with instance of TST_person with key
 235        "Mike" in namespace test/TestProvider
 236 or
 237  cimcli r TST_Person -n test/TestProvider -rc TST_Lineage
 238     -- get reference classes for TST_Lineage association class and
 239        subclasses in namespace test/TestProvider
 240
 241 cimcli rn TST_Person.name=\"Mike\" -n test/TestProvider -rc TST_Lineage
 242     -- get referenceNames for instances association class
 243        TST_Lineage associated with instance of TST_person with key
 244        "Mike" in namespace test/TestProvider
 245 or
 246  cimcli rn TST_Person.name=\"Mike\" -n test/TestProvider
 247     -- get referenceNames for all instances of classes
 248        associated with instance of TST_person with key
 249        "Mike" in namespace test/TestProvider
 250 or
 251  cimcli rn TST_Person -n test/TestProvider -rc TST_Lineage
 252     -- get referenceNames for Class TST_Lineage in namespace
 253        test/TestProvider
 254
 255 cimcli im Sample_MethodProviderClass.Name=\"mooo\" SayHello
 256     -n root/SampleProvider -ip p1=fred
 257
 258 cimcli xq "select * from CIM_ComputerSystem"
 259     -- This command will work when the code is compiled with
 260        ExecQuery enabled
 261
 262 cimcli ns  -- Enumerate all Namespaces in repository
 263
 264 cimcli son  -- Switch On's the statistical information on CIMServer
 265
 266 cimcli soff  -- Switch OFF's the statistical information on CIMServer
 267
 268 cimcli ?  -- Displays help command
 269
 270
 271 ni    enumerateInstanceNames Enumerate instancenames of <classname>
 272 niall enumallInstanceNames  Enumerate all instance names in <namespace>.
 273 ei    enumerateInstances    Enumerate instances of <classname>
 274 nc    enumerateClassNames   Enumerate Class Names of [ <classname> ].
 275                             Classname optional
 276 ec    enumerateClasses      Enumerate classes of [ <classname> ].
 277                             Classname optional
 278 gc    getClass              Get class of <classname>
 279 gi    getInstance           Get instance of <objectname> | <classname>
 280                             (interactive) |
 281                             <classname>
 282                             *<PropertyName=value> for equal property values.
 283 ci    createInstance        Create Instance of <Class> *<name=param> with
 284                             defined properties
 285 ti    testInstance          Test instance  of <objectname>  *<name=value>
 286                             | <classname>
 287                             *<PropertyName=value>
 288                             for equal property
 289                             values.
 290 di    deleteInstance        Delete Instance of <objectname> | <classname>
 291                             *<keyPropertyName=value> | interactive of <className>
 292 cc    createClass           Not supported
 293 mi    modifyInstance        Modify Instance of <objectname> *<name=value>
 294                             | <classname>
 295                             *<name=value>
 296 dc    deleteClass           Delete Class of <classname>
 297 gp    getProperty           get single property of <object name>
 298 sp    setProperty           set a single property of <object-name>
 299 gq    getQualifier          Get Qualifier of <qualifiername>
 300 sq    setQualifier          Not suported
 301 eq    enumerateQualifiers   Enumerate all Qualifiers
 302 dq    deleteQualifier       Delete qualifer of <qualifiername>
 303 a     associators           Enumerate Associators of <classname> |
 304                             <instancename>.
 305 an    associatorNames       Enumerate Associator Names of <classname> |
 306                             <instancename>
 307 r     references            Enumerate References of <classname> |
 308                             <instancename>
 309 rn    referenceNames        Enumerate Reference Names <classname> |
 310                             <instancename>
 311 im    invokeMethod          Invoke Method for <object> <method>
 312                             {<inputParams>}
 313 xq    execQuery              ExecQuery <query-expresssion>
 314                             [<query-language>]
 315 ns    enumerateNamespaces   Enumerate all namespaces on the server.
 316 son   Turn On Statistics    Turn on CIM Server Statistics Gathering
 317 soff  Turn Off Statistics   Turn off CIM Server Statistics Gathering
 318 ?     show command options  Show List of Commands -h for all help, -hc for commands, -ho for options
 319 The options for this command are:
 320
 321 This command executes single CIM Operations.
 322
 323  -count  count. Expected count of objects returned if summary set.
 324     Tests this count and displays difference.
 325     Return nonzero status code if test fails. Default(29346)
 326  -d  debug. More detailed debug messages. Default(false)
 327  -delay  delay. Delay between connection and request. Default(0)
 328  -p  Password. Defines password for authentication. Default()
 329  -l  location. Specifies system and port (HostName:port).
 330     Port is optional. Default()
 331  -s  ssl. Specifies to connect over HTTPS. Default(false)
 332  --cert  clientCert. Specifies a client certificate file path to present to the server.
 333     This is optional and only has an effect on connections
 334     made over HTTPS using -s. Default()
 335  --key  clientKey. Specifies a client private key file path.
 336     This is optional and only has an effect on connections
 337     made over HTTPS using -s. Default()
 338  -u  User. Defines User Name for authentication. Default()
 339  -n  namespace. Specifies namespace to use for operation. Default(root/cimv2)
 340  -ic  includeClassOrigin. If set includeClassOrigin  parameter
 341     set true on requests that honor this parameter. Default(false)
 342  -di  deepInheritance. If set deepInheritance parameter
 343     set true. Default(false)
 344  -lo  localOnly. DEPRECATED. This was used to set LocalOnly.
 345     However, default should be true and we cannot use True
 346     as default. See -nlo. Default(true)
 347  -nlo  notLocalOnly. When set, sets LocalOnly = false on
 348     operations. Default(false)
 349  -iq  includeQualifiers. DEPRECATED. Sets includeQualifiers = True.
 350     Useful for instance operations where default is false. Default(false)
 351  -niq  notIncludeQualifiers. Sets includeQualifiers = false
 352     on operations. Useful for class operations where
 353     the default is true.. Default(false)
 354  -pl  propertyList. Defines a propertyNameList. Format is p1,p2,p3
 355     (without spaces). Use "" for empty. Default(###!###)
 356  -ac  assocClass. Defines a assocation Class string for Associator calls. Default()
 357  -ar  assocRole. Defines a role string for Associators. AssocRole
 358     parameter. Default()
 359  -r  role. Defines a role string for reference role parameter. Default()
 360  -rc  resultClass. Defines a resultClass string for References and
 361     Associatiors. Default()
 362  -rr  resultRole. Defines a role string for associators operation resultRole
 363     parameter. Default()
 364  -ip  inputParameters. This option deprecated and removed. Replaced by use of
 365     the same name/value pair syntax as properties in create
 366     and modify instance.. Default()
 367  -f  filter. Defines a filter to use for query. Single String input. Default()
 368  -ql  queryLanguage. Defines a Query Language to be used with a query filter.
 369 . Default(WQL)
 370  -o  outputformats. Output in xml, mof, txt, table. Default(mof)
 371  -x  xmlOutput. Output objects in xml format. Default(false)
 372  --version  version. Displays software Version. Default(false)
 373  -v  verbose. Verbose Display. Outputs detailed parameter input
 374     display and other request processing information. Default(false)
 375  --sum  summary. Displays only summary count for enumerations,
 376     associators, etc.. Default(false)
 377  -h  help. Prints help usage message. Default(false)
 378  --help  full help. Prints full help message with commands, options,
 379     examples. Default(false)
 380  -ho  help options. Prints list of options. Default(false)
 381  -hc  help commands. Prints CIM Operation command list. Default(false)
 382  --timeout  connecttimeout. Set the connection timeout in seconds.. Default(0)
 383  -i  interactive. Interactively ask user to select instances.
 384     Used with associator and reference operations. Default(false)
 385  --setRtnHostNames  setRtnHostNames. Set namespace component of reference and path outputs parameter.
 386     Used to allow comparison of paths and instances without involving the variable of host namespaces.. Default()
 387  -trace  trace. Set Pegasus Common Components Trace. Sets the Trace level.
 388     0 is off. Default(0)
 389  --r  repeat. Number of times to repeat the operation.
 390     Zero means one time. Default(0)
 391  --t  time. Measure time for the operation and present results. Default(false)
 392  --sort  sort. Sort the returned entities for multi-entity responses. Default(false)
 393
 394 Options vary by command consistent with CIM Operations
 395
 396 mi    modifyInstance        Modify Instance of <objectname> *<name=value>
 397                             | <classname>
 398                             *<name=value>
 399 Example :
 400 cimcli mi -n test/TestProvider TST_Person.Id=\"Mike\" SSN=444
 401     -- Modifies the Instance if it exists using rules of DMTF
 402        modifyInstance operation.
 403
 404 Valid options for this command are :
 405 -n -pl (define properties to be modified)
 406
 407 Common Options are :
 408     -count, -d, -delay, -p, -l, -u, -o, -x, -v, --sum, --timeout, -r, --t
 409 Usage: cimcli <command> <CIMObject> <Options> *<extra parameters>
 410     -hc    for <command> set and <CimObject> for each command
 411     -ho    for <Options> set
 412     -h xx  for <command> and <Example> for <xx> operation
 413     -h     for this summary
 414     --help for full help