6. pywbemcli Help Command Details¶
This section shows the help text for each pywbemcli command group and command.
Help text for pywbemcli:
Usage: pywbemcli [GENERAL-OPTIONS] COMMAND [ARGS]...
Pywbemcli is a command line WBEM client that uses the DMTF CIM-XML
protocol to communicate with WBEM servers. Pywbemcli can:
* Manage the information in WBEM servers CIM objects using the
operations defined in the DMTF specification. It can manage CIM
classes, CIM instances and CIM qualifier declarations in the WBEM
Server and execute CIM methods and queries on the server.
* Inspect WBEM server characteristics including namespaces, registered
profiles, and other server information.
* Capture detailed information on communication with the WBEM
server including time statistics and logs of the operations.
* Maintain a persistent list of named connections to WBEM servers
and execute operations on them by name.
Pywbemcli implements command groups and commands to execute the CIM-XML
operations defined by the DMTF CIM Operations Over HTTP specification
(DSP0200).
The general options shown below can also be specified on any of the
commands, positioned right after the 'pywbemcli' command name.
For more detailed documentation, see:
https://pywbemtools.readthedocs.io/en/stable/
Options:
-n, --name NAME Use the WBEM server defined by the WBEM
connection definition NAME. This option is
mutually exclusive with the --server and
--mock-server options, since each defines a
WBEM server. Default: EnvVar PYWBEMCLI_NAME,
or none.
-m, --mock-server FILE Use a mock WBEM server that is automatically
created in pywbemcli and populated with CIM
objects that are defined in the specified
MOF file or Python script file. See the
pywbemcli documentation for more
information. This option may be specified
multiple times, and is mutually exclusive
with the --server and --name options, since
each defines a WBEM server. Default: EnvVar
PYWBEMCLI_MOCK_SERVER, or none.
-s, --server URL Use the WBEM server at the specified URL
with format: [SCHEME://]HOST[:PORT]. SCHEME
must be "https" (default) or "http". HOST is
a short or long hostname or literal IPV4/v6
address. PORT defaults to 5989 for https and
5988 for http. This option is mutually
exclusive with the --mock-server and --name
options, since each defines a WBEM server.
Default: EnvVar PYWBEMCLI_SERVER, or none.
-u, --user TEXT User name for the WBEM server. Default:
EnvVar PYWBEMCLI_USER, or none.
-p, --password TEXT Password for the WBEM server. Default:
EnvVar PYWBEMCLI_PASSWORD, or prompted for
if --user specified.
--verify / --no-verify If --verify, client verifies the X.509
server certificate presented by the WBEM
server during TLS/SSL handshake. If --no-
verify client bypasses verification.
Default: EnvVar PYWBEMCLI_VERIFY, or "--
verify".
--ca-certs FILE Path name of a file or directory containing
certificates that will be matched against
the server certificate presented by the WBEM
server during TLS/SSL handshake. Default:
EnvVar PYWBEMCLI_CA_CERTS, or [/etc/pki/ca-
trust/extracted/openssl/ca-bundle.trust.crt,
/etc/ssl/certs, /etc/ssl/certificates].
-c, --certfile FILE Path name of a PEM file containing a X.509
client certificate that is used to enable
TLS/SSL 2-way authentication by presenting
the certificate to the WBEM server during
TLS/SSL handshake. Default: EnvVar
PYWBEMCLI_CERTFILE, or none.
-k, --keyfile FILE Path name of a PEM file containing a X.509
private key that belongs to the certificate
in the --certfile file. Not required if the
private key is part of the --certfile file.
Default: EnvVar PYWBEMCLI_KEYFILE, or none.
-t, --timeout INT Client-side timeout in seconds for
operations with the WBEM server. Default:
EnvVar PYWBEMCLI_TIMEOUT, or 30.
-U, --use-pull [yes|no|either] Determines whether pull operations are used
for operations with the WBEM server that
return lists of instances, as follows: "yes"
uses pull operations and fails if not
supported by the server; "no" uses
traditional operations; "either" (default)
uses pull operations if supported by the
server, and otherwise traditional
operations. Default: EnvVar
PYWBEMCLI_USE_PULL, or "either".
--pull-max-cnt INT Maximum number of instances to be returned
by the WBEM server in each open or pull
response, if pull operations are used. This
is a tuning parameter that does not affect
the external behavior of the commands.
Default: EnvVar PYWBEMCLI_PULL_MAX_CNT, or
1000
-T, --timestats Show time statistics of WBEM server
operations.
-d, --default-namespace NAMESPACE
Default namespace, to be used when commands
do not specify the --namespace command
option. Default: EnvVar
PYWBEMCLI_DEFAULT_NAMESPACE, or root/cimv2.
-o, --output-format FORMAT Output format for the command result. The
specified format may be overriden since not
all formats apply to all result data types.
FORMAT is a table format
[table|plain|simple|grid|psql|rst|html] or
object format [mof|xml|repr|txt]. Default:
simple.
-l, --log COMP[=DEST[:DETAIL]],...
Enable logging of the WBEM operations,
defined by a list of log configuration
strings with: COMP: [api|http|all]; DEST:
[file|stderr], default: file; DETAIL:
[all|paths|summary], default: all. Default:
EnvVar PYWBEMCLI_LOG, or all.
-v, --verbose / --no-verbose Display extra information about the
processing.
--pdb Pause execution in the built-in pdb debugger
just before executing the command within
pywbemcli. Default: EnvVar PYWBEMCLI_PDB, or
false.
--version Show the version of this command and the
pywbem package and exit.
-h, --help Show this message and exit.
Commands:
class Command group for CIM classes.
connection Command group for WBEM connection definitions.
help Show help message for interactive mode.
instance Command group for CIM instances.
qualifier Command group for CIM qualifier declarations.
repl Enter interactive mode (default).
server Command group for WBEM servers.
6.1. pywbemcli class –help¶
Help text for pywbemcli class (see Class command group):
Usage: pywbemcli class [COMMAND-OPTIONS] COMMAND [ARGS]...
Command group for CIM classes.
This command group defines commands to inspect classes, to invoke methods
on classes, and to delete classes.
Creation and modification of classes is not currently supported.
In addition to the command-specific options shown in this help text, the
general options (see 'pywbemcli --help') can also be specified before the
'class' keyword.
Options:
-h, --help Show this message and exit.
Commands:
associators List the classes associated with a class.
delete Delete a class.
enumerate List top classes or subclasses of a class in a namespace.
find List the classes with matching class names on the server.
get Get a class.
invokemethod Invoke a method on a class.
references List the classes referencing a class.
tree Show the subclass or superclass hierarchy for a class.
6.1.1. pywbemcli class associators –help¶
Help text for pywbemcli class associators (see Class associators command):
Usage: pywbemcli class associators [COMMAND-OPTIONS] CLASSNAME
List the classes associated with a class.
List the CIM classes that are associated with the specified class
(CLASSNAME argument) in the specified CIM namespace (--namespace option).
If no namespace was specified, the default namespace of the connection is
used.
The classes to be retrieved can be filtered by the --role, --result-role,
--assoc-class, and --result-class options.
The --include-classorigin, --no-qualifiers, and --propertylist options
determine which parts are included in each retrieved class.
The --names-only option can be used to show only the class paths.
In the output, the classes and class paths will be formatted as defined by
the --output-format general option. Table formats on classes will be
replaced with MOF format.
Examples:
pywbemcli -n myconn class associators CIM_Foo -n interop
Options:
--ac, --assoc-class CLASSNAME Filter the result set by association class
name. Subclasses of the specified class also
match.
--rc, --result-class CLASSNAME Filter the result set by result class name.
Subclasses of the specified class also
match.
-r, --role PROPERTYNAME Filter the result set by source end role
name.
--rr, --result-role PROPERTYNAME
Filter the result set by far end role name.
--nq, --no-qualifiers Do not include qualifiers in the returned
class(es). Default: Include qualifiers.
--ico, --include-classorigin Include class origin information in the
returned class(es). Default: Do not include
class origin information.
--pl, --propertylist PROPERTYLIST
Filter the properties included in the
returned object(s). Multiple properties may
be specified with either a comma-separated
list or by using the option multiple times.
Properties specified in this option that are
not in the object(s) will be ignored. The
empty string will include no properties.
Default: Do not filter properties.
--no, --names-only Retrieve only the object paths (names).
Default: Retrieve the complete objects
including object paths.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this message and exit.
6.1.2. pywbemcli class delete –help¶
Help text for pywbemcli class delete (see Class delete command):
Usage: pywbemcli class delete [COMMAND-OPTIONS] CLASSNAME
Delete a class.
Delete a CIM class (CLASSNAME argument) in a CIM namespace (--namespace
option). If no namespace was specified, the default namespace of the
connection is used.
If the class has subclasses, the command is rejected.
If the class has instances, the command is rejected, unless the --force
option was specified, in which case the instances are also deleted.
WARNING: Deleting classes can cause damage to the server: It can impact
instance providers and other components in the server. Use this command
with caution.
Many WBEM servers may not allow this operation or may severely limit the
conditions under which a class can be deleted from the server.
Example:
pywbemcli -n myconn class delete CIM_Foo -n interop
Options:
-f, --force Delete any instances of the class as well. Some
servers may still reject the class deletion.
Default: Reject command if the class has any
instances.
-n, --namespace NAMESPACE Namespace to use for this command, instead of the
default namespace of the connection.
-h, --help Show this message and exit.
6.1.3. pywbemcli class enumerate –help¶
Help text for pywbemcli class enumerate (see Class enumerate command):
Usage: pywbemcli class enumerate [COMMAND-OPTIONS] CLASSNAME
List top classes or subclasses of a class in a namespace.
Enumerate CIM classes starting either at the top of the class hierarchy in
the specified CIM namespace (--namespace option), or at the specified
class (CLASSNAME argument) in the specified namespace. If no namespace was
specified, the default namespace of the connection is used.
The --local-only, --include-classorigin, and --no-qualifiers options
determine which parts are included in each retrieved class.
The --deep-inheritance option defines whether or not the complete subclass
hierarchy of the classes is retrieved.
The --names-only option can be used to show only the class paths.
In the output, the classes and class paths will be formatted as defined by
the --output-format general option. Table formats on classes will be
replaced with MOF format.
Examples:
pywbemcli -n myconn class enumerate -n interop
pywbemcli -n myconn class enumerate CIM_Foo -n interop
Options:
--di, --deep-inheritance Include the complete subclass hierarchy of the
requested classes in the result set. Default:
Do not include subclasses.
--lo, --local-only Do not include superclass properties and
methods in the returned class(es). Default:
Include superclass properties and methods.
--nq, --no-qualifiers Do not include qualifiers in the returned
class(es). Default: Include qualifiers.
--ico, --include-classorigin Include class origin information in the
returned class(es). Default: Do not include
class origin information.
--no, --names-only Retrieve only the object paths (names).
Default: Retrieve the complete objects
including object paths.
-n, --namespace NAMESPACE Namespace to use for this command, instead of
the default namespace of the connection.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this message and exit.
6.1.4. pywbemcli class find –help¶
Help text for pywbemcli class find (see Class find command):
Usage: pywbemcli class find [COMMAND-OPTIONS] CLASSNAME-GLOB
List the classes with matching class names on the server.
Find the CIM classes whose class name matches the specified wildcard
expression (CLASSNAME-GLOB argument) in all CIM namespaces of the WBEM
server, or in the specified namespace (--namespace option).
The CLASSNAME-GLOB argument is a wildcard expression that is matched on
class names case insensitively. The special characters from Unix file name
wildcarding are supported ('*' to match zero or more characters, '?' to
match a single character, and '[]' to match character ranges). To avoid
shell expansion of wildcard characters, the CLASSNAME-GLOB argument should
be put in quotes.
For example, "pywbem_*" returns classes whose name begins with "PyWBEM_",
"pywbem_", etc. "*system*" returns classes whose names include the case
insensitive string "system".
In the output, the classes will be formatted as defined by the --output-
format general option if it specifies table output. Otherwise the classes
will be in the form "NAMESPACE:CLASSNAME".
Examples:
pywbemcli -n myconn class find "CIM_*System*" -n interop
pywbemcli -n myconn class find *Foo*
Options:
-n, --namespace NAMESPACE Add a namespace to the search scope. May be
specified multiple times. Default: Search in all
namespaces of the server.
-s, --sort Sort by namespace. Default is to sort by
classname
-h, --help Show this message and exit.
6.1.5. pywbemcli class get –help¶
Help text for pywbemcli class get (see Class get command):
Usage: pywbemcli class get [COMMAND-OPTIONS] CLASSNAME
Get a class.
Get a CIM class (CLASSNAME argument) in a CIM namespace (--namespace
option). If no namespace was specified, the default namespace of the
connection is used.
The --local-only, --include-classorigin, --no-qualifiers, and
--propertylist options determine which parts are included in each
retrieved class.
In the output, the class will be formatted as defined by the --output-
format general option. Table formats are replaced with MOF format.
Example:
pywbemcli -n myconn class get CIM_Foo -n interop
Options:
--lo, --local-only Do not include superclass properties and
methods in the returned class(es). Default:
Include superclass properties and methods.
--nq, --no-qualifiers Do not include qualifiers in the returned
class(es). Default: Include qualifiers.
--ico, --include-classorigin Include class origin information in the
returned class(es). Default: Do not include
class origin information.
--pl, --propertylist PROPERTYLIST
Filter the properties included in the
returned object(s). Multiple properties may
be specified with either a comma-separated
list or by using the option multiple times.
Properties specified in this option that are
not in the object(s) will be ignored. The
empty string will include no properties.
Default: Do not filter properties.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-h, --help Show this message and exit.
6.1.6. pywbemcli class invokemethod –help¶
Help text for pywbemcli class invokemethod (see Class invokemethod command):
Usage: pywbemcli class invokemethod [COMMAND-OPTIONS] CLASSNAME METHODNAME
Invoke a method on a class.
Invoke a static CIM method (METHODNAME argument) on a CIM class (CLASSNAME
argument) in a CIM namespace (--namespace option), and display the method
return value and output parameters. If no namespace was specified, the
default namespace of the connection is used.
The method input parameters are specified using the --parameter option,
which may be specified multiple times.
Pywbemcli retrieves the class definition from the server in order to
verify that the specified input parameters are consistent with the
parameter characteristics in the method definition.
Use the 'instance invokemethod' command to invoke CIM methods on CIM
instances.
Example:
pywbemcli -n myconn class invokemethod CIM_Foo methodx -p p1=9 -p
p2=Fred
Options:
-p, --parameter PARAMETERNAME=VALUE
Specify a method input parameter with its
value. May be specified multiple times.
Default: No input parameters.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-h, --help Show this message and exit.
6.1.7. pywbemcli class references –help¶
Help text for pywbemcli class references (see Class references command):
Usage: pywbemcli class references [COMMAND-OPTIONS] CLASSNAME
List the classes referencing a class.
List the CIM (association) classes that reference the specified class
(CLASSNAME argument) in the specified CIM namespace (--namespace option).
If no namespace was specified, the default namespace of the connection is
used.
The classes to be retrieved can be filtered by the --role and --result-
class options.
The --include-classorigin, --no-qualifiers, and --propertylist options
determine which parts are included in each retrieved class.
The --names-only option can be used to show only the class paths.
In the output, the classes and class paths will be formatted as defined by
the --output-format general option. Table formats on classes will be
replaced with MOF format.
Examples:
pywbemcli -n myconn class references CIM_Foo -n interop
Options:
--rc, --result-class CLASSNAME Filter the result set by result class name.
Subclasses of the specified class also
match.
-r, --role PROPERTYNAME Filter the result set by source end role
name.
--nq, --no-qualifiers Do not include qualifiers in the returned
class(es). Default: Include qualifiers.
--ico, --include-classorigin Include class origin information in the
returned class(es). Default: Do not include
class origin information.
--pl, --propertylist PROPERTYLIST
Filter the properties included in the
returned object(s). Multiple properties may
be specified with either a comma-separated
list or by using the option multiple times.
Properties specified in this option that are
not in the object(s) will be ignored. The
empty string will include no properties.
Default: Do not filter properties.
--no, --names-only Retrieve only the object paths (names).
Default: Retrieve the complete objects
including object paths.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this message and exit.
6.1.8. pywbemcli class tree –help¶
Help text for pywbemcli class tree (see Class tree command):
Usage: pywbemcli class tree [COMMAND-OPTIONS] CLASSNAME
Show the subclass or superclass hierarchy for a class.
List the subclass or superclass hierarchy of a CIM class (CLASSNAME
argument) or CIM namespace (--namespace option):
- If CLASSNAME is omitted, the complete class hierarchy of the specified
namespace is retrieved.
- If CLASSNAME is specified but not --superclasses, the class and its
subclass hierarchy in the specified namespace are retrieved.
- If CLASSNAME and --superclasses are specified, the class and its
superclass ancestry up to the top-level class in the specified namespace
are retrieved.
If no namespace was specified, the default namespace of the connection is
used.
In the output, the classes will formatted as a ASCII graphical tree; the
--output-format general option is ignored.
Examples:
pywbemcli -n myconn class tree -n interop
pywbemcli -n myconn class tree CIM_Foo -n interop
pywbemcli -n myconn class tree CIM_Foo -s -n interop
Options:
-s, --superclasses Show the superclass hierarchy. Default: Show the
subclass hierarchy.
-n, --namespace NAMESPACE Namespace to use for this command, instead of the
default namespace of the connection.
-h, --help Show this message and exit.
6.2. pywbemcli connection –help¶
Help text for pywbemcli connection (see Connection command group):
Usage: pywbemcli connection [COMMAND-OPTIONS] COMMAND [ARGS]...
Command group for WBEM connection definitions.
This command group defines commands to manage persistent WBEM connection
definitions that have a name. The connection definitions are stored in a
connections file named 'pywbemcli_connection_definitions.yaml' in the
current directory. The connection definition name can be used as a
shorthand for the WBEM server via the '--name' general option.
In addition to the command-specific options shown in this help text, the
general options (see 'pywbemcli --help') can also be specified before the
'connection' keyword.
Options:
-h, --help Show this message and exit.
Commands:
delete Delete a WBEM connection definition.
export Export the current connection.
list List the WBEM connection definitions.
save Save the current connection to a new WBEM connection definition.
select Select a WBEM connection definition as current or default.
show Show a WBEM connection definition or the current connection.
test Test the current connection with a predefined WBEM request.
6.2.1. pywbemcli connection delete –help¶
Help text for pywbemcli connection delete (see Connection delete command):
Usage: pywbemcli connection delete [COMMAND-OPTIONS] NAME
Delete a WBEM connection definition.
Delete a named connection definition from the connections file. If the
NAME argument is omitted, prompt for selecting one of the connection
definitions in the connections file.
Example:
pywbemcli connection delete blah
Options:
-h, --help Show this message and exit.
6.2.2. pywbemcli connection export –help¶
Help text for pywbemcli connection export (see Connection export command):
Usage: pywbemcli connection export [COMMAND-OPTIONS]
Export the current connection.
Display commands that set pywbemcli environment variables to the
parameters of the current connection.
Examples:
pywbemcli --name srv1 connection export
pywbemcli --server https://srv1 --user me --password pw connection
export
Options:
-h, --help Show this message and exit.
6.2.3. pywbemcli connection list –help¶
Help text for pywbemcli connection list (see Connection list command):
Usage: pywbemcli connection list [COMMAND-OPTIONS]
List the WBEM connection definitions.
This command displays all entries in the connections file and the current
connection if it exists and is not in the connections file as a table.
'#' before the name indicates the default connection.
'*' before the name indicates that it is the current connection.
See also the 'connection select' command.
Options:
-h, --help Show this message and exit.
6.2.4. pywbemcli connection save –help¶
Help text for pywbemcli connection save (see Connection save command):
Usage: pywbemcli connection save [COMMAND-OPTIONS] NAME
Save the current connection to a new WBEM connection definition.
Save the current connection to the connections file as a connection
definition named NAME. The NAME argument is required. If a connection
definition with that name already exists, it is overwritten without
warning.
In the interactive mode, general options that are connection related are
applied to the current connection before it is saved.
Examples:
pywbemcli --server https://srv1 connection save mysrv
Options:
-h, --help Show this message and exit.
6.2.5. pywbemcli connection select –help¶
Help text for pywbemcli connection select (see Connection select command):
Usage: pywbemcli connection select [COMMAND-OPTIONS] NAME
Select a WBEM connection definition as current or default.
Select the connection definition named NAME from the connections file to
be the current connection. The connection definition in the connections
file must exist. If the NAME argument is omitted, a list of connection
definitions from the connections file is presented with a prompt for the
user to select a connection definition.
If the --default option is set, the default connection is set to the
selected connection definition, in addition. Once defined, the default
connection will be used as a default in future executions of pywbemcli if
none of the server-defining general options (i.e. --server, --mock-server,
or --name) was used.
The 'connection list' command marks the current connection with '*' and
the default connection with '#'.
Example of selecting a default connection in command mode:
pywbemcli connection select myconn --default
pywbemcli connection show
name: myconn
. . .
Example of selecting just the current connection in interactive mode:
pywbemcli
pywbemcli> connection select myconn
pywbemcli> connection show
name: myconn
. . .
Options:
-d, --default If set, the connection is set to be the default connection
in the connections file in addition to setting it as the
current connection.
-h, --help Show this message and exit.
6.2.6. pywbemcli connection show –help¶
Help text for pywbemcli connection show (see Connection show command):
Usage: pywbemcli connection show [COMMAND-OPTIONS] NAME
Show a WBEM connection definition or the current connection.
Show the name and attributes of a WBEM connection definition or the
current connection, as follows:
* If the NAME argument is specified, the connection definition with that
name from the connections file is shown.
* If the NAME argument is '?', the command presents a list of connection
definitions from the connections file and prompts the user for selecting
one, which is then shown.
* If the NAME argument is omitted, the current connection is shown.
Example showing a named connection definition:
pywbemcli connection show svr1
name: svr1
...
Example for prompting for a connection definition:
pywbemcli connection show ?
0: svr1
1: svr2
Input integer between 0 and 2 or Ctrl-C to exit selection: : 0
name: svr1
...
Options:
--show-password If set, show existing password in results. Otherwise,
password is masked
-h, --help Show this message and exit.
6.2.7. pywbemcli connection test –help¶
Help text for pywbemcli connection test (see Connection test command):
Usage: pywbemcli connection test [COMMAND-OPTIONS]
Test the current connection with a predefined WBEM request.
Execute the EnumerateClassNames operation on the default namespace against
the current connection to confirm that the connection exists and is
working.
Examples:
pywbemcli --name mysrv connection test
Options:
-h, --help Show this message and exit.
6.3. pywbemcli help –help¶
Help text for pywbemcli help (see Help command):
Usage: pywbemcli help [OPTIONS]
Show help message for interactive mode.
Options:
-h, --help Show this message and exit.
6.4. pywbemcli instance –help¶
Help text for pywbemcli instance (see Instance command group):
Usage: pywbemcli instance [COMMAND-OPTIONS] COMMAND [ARGS]...
Command group for CIM instances.
This command group defines commands to inspect instances, to invoke
methods on instances, and to create and delete instances.
Modification of instances is not currently supported.
In addition to the command-specific options shown in this help text, the
general options (see 'pywbemcli --help') can also be specified before the
'instance' keyword.
Options:
-h, --help Show this message and exit.
Commands:
associators List the instances associated with an instance.
count Count the instances of each class with matching class name.
create Create an instance of a class in a namespace.
delete Delete an instance of a class.
enumerate List the instances of a class.
get Get an instance of a class.
invokemethod Invoke a method on an instance.
modify Modify properties of an instance.
query Execute a query on instances in a namespace.
references List the instances referencing an instance.
6.4.1. pywbemcli instance associators –help¶
Help text for pywbemcli instance associators (see Instance associators command):
Usage: pywbemcli instance associators [COMMAND-OPTIONS] INSTANCENAME
List the instances associated with an instance.
List the CIM instances that are associated with the specified CIM
instance, and display the returned instances, or instance paths if
--names-only was specified.
The CIM instance can be specified in two ways:
1. By specifying an untyped WBEM URI of an instance path in the
INSTANCENAME argument. The CIM namespace in which the instance is looked
up is the namespace specified in the WBEM URI, or otherwise the namespace
specified in the --namespace option, or otherwise the default namespace of
the connection. Any host name in the WBEM URI will be ignored.
2. By specifying a class name with wildcard for the keys in the
INSTANCENAME argument, i.e. "CLASSNAME.?". The instances of the specified
class are displayed and the user is prompted for an index number to select
an instance. The namespace in which the instances are looked up is the
namespace specified in the --namespace option, or otherwise the default
namespace of the connection.
The instances to be retrieved can be filtered by the --filter-query,
--role, --result-role, --assoc-class, and --result-class options.
The --include-qualifiers, --include-classorigin, and --propertylist
options determine which parts are included in each retrieved instance.
The --names-only option can be used to show only the instance paths.
In the output, the instances and instance paths will be formatted as
defined by the --output-format general option. Table formats on instances
will be replaced with MOF format.
Options:
--ac, --assoc-class CLASSNAME Filter the result set by association class
name. Subclasses of the specified class also
match.
--rc, --result-class CLASSNAME Filter the result set by result class name.
Subclasses of the specified class also
match.
-r, --role PROPERTYNAME Filter the result set by source end role
name.
--rr, --result-role PROPERTYNAME
Filter the result set by far end role name.
--iq, --include-qualifiers When traditional operations are used,
include qualifiers in the returned
instances. Some servers may ignore this
option. By default, and when pull operations
are used, qualifiers will never be included.
--ico, --include-classorigin Include class origin information in the
returned instance(s). Some servers may
ignore this option. Default: Do not include
class origin information.
--pl, --propertylist PROPERTYLIST
Filter the properties included in the
returned object(s). Multiple properties may
be specified with either a comma-separated
list or by using the option multiple times.
Properties specified in this option that are
not in the object(s) will be ignored. The
empty string will include no properties.
Default: Do not filter properties.
--no, --names-only Retrieve only the object paths (names).
Default: Retrieve the complete objects
including object paths.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-s, --summary Show only a summary (count) of the objects.
--fq, --filter-query QUERY-STRING
When pull operations are used, filter the
instances in the result via a filter query.
By default, and when traditional operations
are used, no such filtering takes place.
--fql, --filter-query-language QUERY-LANGUAGE
The filter query language to be used with
--filter-query. Default: DMTF:FQL.
-h, --help Show this message and exit.
6.4.2. pywbemcli instance count –help¶
Help text for pywbemcli instance count (see Instance count command):
Usage: pywbemcli instance count [COMMAND-OPTIONS] CLASSNAME-GLOB
Count the instances of each class with matching class name.
Display the count of instances of each CIM class whose class name matches
the specified wildcard expression (CLASSNAME-GLOB) in all CIM namespaces
of the WBEM server, or in the specified namespaces (--namespace option).
This differs from instance enumerate, etc. in that it counts the instances
specifically for the classname of each instance returned, not including
subclasses.
The CLASSNAME-GLOB argument is a wildcard expression that is matched on
class names case insensitively. The special characters from Unix file name
wildcarding are supported ('*' to match zero or more characters, '?' to
match a single character, and '[]' to match character ranges). To avoid
shell expansion of wildcard characters, the CLASSNAME-GLOB argument should
be put in quotes.
If CLASSNAME-GLOB is not specified, then all classes in the specified
namespaces are counted (same as when specifying CLASSNAME-GLOB as "*").
For example, "pywbem_*" returns classes whose name begins with "PyWBEM_",
"pywbem_", etc. "*system*" returns classes whose names include the case
insensitive string "system".
This command can take a long time to execute since it potentially
enumerates all instance names for all classes in all namespaces.
Options:
-n, --namespace NAMESPACE Add a namespace to the search scope. May be
specified multiple times. Default: Search in all
namespaces of the server.
-s, --sort Sort by instance count. Otherwise sorted by class
name.
-h, --help Show this message and exit.
6.4.3. pywbemcli instance create –help¶
Help text for pywbemcli instance create (see Instance create command):
Usage: pywbemcli instance create [COMMAND-OPTIONS] CLASSNAME
Create an instance of a class in a namespace.
Create a CIM instance of the specified creation class (CLASSNAME argument)
in the specified CIM namespace (--namespace option), with the specified
properties (--property options) and display the CIM instance path of the
created instance. If no namespace was specified, the default namespace of
the connection is used.
The properties to be initialized and their new values are specified using
the --property option, which may be specified multiple times.
Pywbemcli retrieves the class definition from the server in order to
verify that the specified properties are consistent with the property
characteristics in the class definition.
Example:
pywbemcli instance create CIM_blah -P id=3 -P arr="bla bla",foo
Options:
-p, --property PROPERTYNAME=VALUE
Initial property value for the new instance.
May be specified multiple times. Array
property values are specified as a comma-
separated list; embedded instances are not
supported. Default: No initial properties
provided.
-V, --verify Prompt for confirmation before performing a
change, to allow for verification of
parameters. Default: Do not prompt for
confirmation.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-h, --help Show this message and exit.
6.4.4. pywbemcli instance delete –help¶
Help text for pywbemcli instance delete (see Instance delete command):
Usage: pywbemcli instance delete [COMMAND-OPTIONS] INSTANCENAME
Delete an instance of a class.
The CIM instance to be deleted can be specified as follows:
1. By specifying an untyped WBEM URI of an instance path in the
INSTANCENAME argument. The CIM namespace in which the instance is looked
up is the namespace specified in the WBEM URI, or otherwise the namespace
specified in the --namespace option, or otherwise the default namespace of
the connection. Any host name in the WBEM URI will be ignored.
2. By specifying a class name with wildcard for the keys in the
INSTANCENAME argument, i.e. "CLASSNAME.?". The instances of the specified
class are displayed and the user is prompted for an index number to select
an instance. The namespace in which the instances are looked up is the
namespace specified in the --namespace option, or otherwise the default
namespace of the connection.
Options:
-n, --namespace NAMESPACE Namespace to use for this command, instead of the
default namespace of the connection.
-h, --help Show this message and exit.
6.4.5. pywbemcli instance enumerate –help¶
Help text for pywbemcli instance enumerate (see Instance enumerate command):
Usage: pywbemcli instance enumerate [COMMAND-OPTIONS] CLASSNAME
List the instances of a class.
Enumerate the CIM instances of the specified class (CLASSNAME argument),
including instances of subclasses in the specified CIM namespace
(--namespace option), and display the returned instances, or instance
paths if --names-only was specified. If no namespace was specified, the
default namespace of the connection is used.
The instances to be retrieved can be filtered by the --filter-query
option.
The --local-only, --deep-inheritance, --include-qualifiers, --include-
classorigin, and --propertylist options determine which parts are included
in each retrieved instance.
The --names-only option can be used to show only the instance paths.
In the output, the instances and instance paths will be formatted as
defined by the --output-format general option. Table formats on instances
will be replaced with MOF format.
Options:
--lo, --local-only When traditional operations are used, do not
include superclass properties in the
returned instances. Some servers may ignore
this option. By default, and when pull
operations are used, superclass properties
will always be included.
--di, --deep-inheritance Include subclass properties in the returned
instances. Default: Do not include subclass
properties.
--iq, --include-qualifiers When traditional operations are used,
include qualifiers in the returned
instances. Some servers may ignore this
option. By default, and when pull operations
are used, qualifiers will never be included.
--ico, --include-classorigin Include class origin information in the
returned instance(s). Some servers may
ignore this option. Default: Do not include
class origin information.
--pl, --propertylist PROPERTYLIST
Filter the properties included in the
returned object(s). Multiple properties may
be specified with either a comma-separated
list or by using the option multiple times.
Properties specified in this option that are
not in the object(s) will be ignored. The
empty string will include no properties.
Default: Do not filter properties.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
--no, --names-only Retrieve only the object paths (names).
Default: Retrieve the complete objects
including object paths.
-s, --summary Show only a summary (count) of the objects.
--fq, --filter-query QUERY-STRING
When pull operations are used, filter the
instances in the result via a filter query.
By default, and when traditional operations
are used, no such filtering takes place.
--fql, --filter-query-language QUERY-LANGUAGE
The filter query language to be used with
--filter-query. Default: DMTF:FQL.
-h, --help Show this message and exit.
6.4.6. pywbemcli instance get –help¶
Help text for pywbemcli instance get (see Instance get command):
Usage: pywbemcli instance get [COMMAND-OPTIONS] INSTANCENAME
Get an instance of a class.
The instance can be specified in two ways:
1. By specifying an untyped WBEM URI of an instance path in the
INSTANCENAME argument. The CIM namespace in which the instance is looked
up is the namespace specified in the WBEM URI, or otherwise the namespace
specified in the --namespace option, or otherwise the default namespace of
the connection. Any host name in the WBEM URI will be ignored.
2. By specifying a class name with wildcard for the keys in the
INSTANCENAME argument, i.e. "CLASSNAME.?". The instances of the specified
class are displayed and the user is prompted for an index number to select
an instance. The namespace in which the instances are looked up is the
namespace specified in the --namespace option, or otherwise the default
namespace of the connection.
The --local-only, --include-qualifiers, --include-classorigin, and
--propertylist options determine which parts are included in the retrieved
instance.
In the output, the instance will formatted as defined by the --output-
format general option.
Options:
--lo, --local-only Do not include superclass properties in the
returned instance. Some servers may ignore
this option. Default: Include superclass
properties.
--iq, --include-qualifiers Include qualifiers in the returned instance.
Not all servers return qualifiers on
instances. Default: Do not include
qualifiers.
--ico, --include-classorigin Include class origin information in the
returned instance(s). Some servers may
ignore this option. Default: Do not include
class origin information.
--pl, --propertylist PROPERTYLIST
Filter the properties included in the
returned object(s). Multiple properties may
be specified with either a comma-separated
list or by using the option multiple times.
Properties specified in this option that are
not in the object(s) will be ignored. The
empty string will include no properties.
Default: Do not filter properties.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-h, --help Show this message and exit.
6.4.7. pywbemcli instance invokemethod –help¶
Help text for pywbemcli instance invokemethod (see Instance invokemethod command):
Usage: pywbemcli instance invokemethod [COMMAND-OPTIONS] INSTANCENAME
METHODNAME
Invoke a method on an instance.
Invoke a CIM method (METHODNAME argument) on a CIM instance with the
specified input parameters (--parameter options), and display the method
return value and output parameters.
The CIM instance can be specified in two ways:
1. By specifying an untyped WBEM URI of an instance path in the
INSTANCENAME argument. The CIM namespace in which the instance is looked
up is the namespace specified in the WBEM URI, or otherwise the namespace
specified in the --namespace option, or otherwise the default namespace of
the connection. Any host name in the WBEM URI will be ignored.
2. By specifying a class name with wildcard for the keys in the
INSTANCENAME argument, i.e. "CLASSNAME.?". The instances of the specified
class are displayed and the user is prompted for an index number to select
an instance. The namespace in which the instances are looked up is the
namespace specified in the --namespace option, or otherwise the default
namespace of the connection.
The method input parameters are specified using the --parameter option,
which may be specified multiple times.
Pywbemcli retrieves the class definition of the creation class of the
instance from the server in order to verify that the specified input
parameters are consistent with the parameter characteristics in the method
definition.
Use the 'class invokemethod' command to invoke CIM methods on CIM classes.
Example:
pywbemcli -n myconn instance invokemethod CIM_x.id='hi" methodx -p id=3
Options:
-p, --parameter PARAMETERNAME=VALUE
Specify a method input parameter with its
value. May be specified multiple times.
Array property values are specified as a
comma-separated list; embedded instances are
not supported. Default: No input parameters.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-h, --help Show this message and exit.
6.4.8. pywbemcli instance modify –help¶
Help text for pywbemcli instance modify (see Instance modify command):
Usage: pywbemcli instance modify [COMMAND-OPTIONS] INSTANCENAME
Modify properties of an instance.
The CIM instance to be modified can be specified in two ways:
1. By specifying an untyped WBEM URI of an instance path in the
INSTANCENAME argument. The CIM namespace in which the instance is looked
up is the namespace specified in the WBEM URI, or otherwise the namespace
specified in the --namespace option, or otherwise the default namespace of
the connection. Any host name in the WBEM URI will be ignored.
2. By specifying a class name with wildcard for the keys in the
INSTANCENAME argument, i.e. "CLASSNAME.?". The instances of the specified
class are displayed and the user is prompted for an index number to select
an instance. The namespace in which the instances are looked up is the
namespace specified in the --namespace option, or otherwise the default
namespace of the connection.
The properties to be modified and their new values are specified using the
--property option, which may be specified multiple times.
The --propertylist option allows restricting the set of properties to be
modified. Given that the set of properties to be modified is already
determined by the specified --property options, it does not need to be
specified.
Example:
pywbemcli instance modify CIM_blah.fred=3 -P id=3 -P arr="bla bla",foo
Options:
-p, --property PROPERTYNAME=VALUE
Property to be modified, with its new value.
May be specified once for each property to
be modified. Array property values are
specified as a comma-separated list;
embedded instances are not supported.
Default: No properties modified.
--pl, --propertylist PROPERTYLIST
Reduce the properties to be modified (as per
--property) to a specific property list.
Multiple properties may be specified with
either a comma-separated list or by using
the option multiple times. The empty string
will cause no properties to be modified.
Default: Do not reduce the properties to be
modified.
-V, --verify Prompt for confirmation before performing a
change, to allow for verification of
parameters. Default: Do not prompt for
confirmation.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-h, --help Show this message and exit.
6.4.9. pywbemcli instance query –help¶
Help text for pywbemcli instance query (see Instance query command):
Usage: pywbemcli instance query [COMMAND-OPTIONS] QUERY-STRING
Execute a query on instances in a namespace.
Execute the specified query (QUERY_STRING argument) in the specified CIM
namespace (--namespace option), and display the returned instances. If no
namespace was specified, the default namespace of the connection is used.
In the output, the instances will formatted as defined by the --output-
format general option.
Options:
--ql, --query-language QUERY-LANGUAGE
The query language to be used with --query.
Default: DMTF:CQL.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this message and exit.
6.4.10. pywbemcli instance references –help¶
Help text for pywbemcli instance references (see Instance references command):
Usage: pywbemcli instance references [COMMAND-OPTIONS] INSTANCENAME
List the instances referencing an instance.
List the CIM (association) instances that reference the specified CIM
instance, and display the returned instances, or instance paths if
--names-only was specified.
The CIM instance can be specified in two ways:
1. By specifying an untyped WBEM URI of an instance path in the
INSTANCENAME argument. The CIM namespace in which the instance is looked
up is the namespace specified in the WBEM URI, or otherwise the namespace
specified in the --namespace option, or otherwise the default namespace of
the connection. Any host name in the WBEM URI will be ignored.
2. By specifying a class name with wildcard for the keys in the
INSTANCENAME argument, i.e. "CLASSNAME.?". The instances of the specified
class are displayed and the user is prompted for an index number to select
an instance. The namespace in which the instances are looked up is the
namespace specified in the --namespace option, or otherwise the default
namespace of the connection.
The instances to be retrieved can be filtered by the --filter-query,
--role and --result-class options.
The --include-qualifiers, --include-classorigin, and --propertylist
options determine which parts are included in each retrieved instance.
The --names-only option can be used to show only the instance paths.
In the output, the instances and instance paths will be formatted as
defined by the --output-format general option. Table formats on instances
will be replaced with MOF format.
Options:
--rc, --result-class CLASSNAME Filter the result set by result class name.
Subclasses of the specified class also
match.
-r, --role PROPERTYNAME Filter the result set by source end role
name.
--iq, --include-qualifiers When traditional operations are used,
include qualifiers in the returned
instances. Some servers may ignore this
option. By default, and when pull operations
are used, qualifiers will never be included.
--ico, --include-classorigin Include class origin information in the
returned instance(s). Some servers may
ignore this option. Default: Do not include
class origin information.
--pl, --propertylist PROPERTYLIST
Filter the properties included in the
returned object(s). Multiple properties may
be specified with either a comma-separated
list or by using the option multiple times.
Properties specified in this option that are
not in the object(s) will be ignored. The
empty string will include no properties.
Default: Do not filter properties.
--no, --names-only Retrieve only the object paths (names).
Default: Retrieve the complete objects
including object paths.
-n, --namespace NAMESPACE Namespace to use for this command, instead
of the default namespace of the connection.
-s, --summary Show only a summary (count) of the objects.
--fq, --filter-query QUERY-STRING
When pull operations are used, filter the
instances in the result via a filter query.
By default, and when traditional operations
are used, no such filtering takes place.
--fql, --filter-query-language QUERY-LANGUAGE
The filter query language to be used with
--filter-query. Default: DMTF:FQL.
-h, --help Show this message and exit.
6.5. pywbemcli qualifier –help¶
Help text for pywbemcli qualifier (see Qualifier command group):
Usage: pywbemcli qualifier [COMMAND-OPTIONS] COMMAND [ARGS]...
Command group for CIM qualifier declarations.
This command group defines commands to inspect CIM qualifier declarations
in the WBEM Server.
Creation, modification and deletion of qualifier declarations is not
currently supported.
In addition to the command-specific options shown in this help text, the
general options (see 'pywbemcli --help') can also be specified before the
'qualifier' keyword.
Options:
-h, --help Show this message and exit.
Commands:
enumerate List the qualifier declarations in a namespace.
get Get a qualifier declaration.
6.5.1. pywbemcli qualifier enumerate –help¶
Help text for pywbemcli qualifier enumerate (see Qualifier enumerate command):
Usage: pywbemcli qualifier enumerate [COMMAND-OPTIONS]
List the qualifier declarations in a namespace.
Enumerate the CIM qualifier declarations in the specified CIM namespace
(--namespace option). If no namespace was specified, the default namespace
of the connection is used.
In the output, the qualifier declaration will formatted as defined by the
--output-format general option.
Options:
-n, --namespace NAMESPACE Namespace to use for this command, instead of the
default namespace of the connection.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this message and exit.
6.5.2. pywbemcli qualifier get –help¶
Help text for pywbemcli qualifier get (see Qualifier get command):
Usage: pywbemcli qualifier get [COMMAND-OPTIONS] QUALIFIERNAME
Get a qualifier declaration.
Get a CIM qualifier declaration (QUALIFIERNAME argument) in a CIM
namespace (--namespace option). If no namespace was specified, the default
namespace of the connection is used.
In the output, the qualifier declaration will formatted as defined by the
--output-format general option.
Options:
-n, --namespace NAMESPACE Namespace to use for this command, instead of the
default namespace of the connection.
-h, --help Show this message and exit.
6.6. pywbemcli repl –help¶
Help text for pywbemcli repl (see Repl command):
Usage: pywbemcli repl [OPTIONS]
Enter interactive mode (default).
Enter the interactive mode where pywbemcli commands can be entered
interactively. The prompt is changed to 'pywbemcli>'.
Command history is supported. The command history is stored in a file
~/.pywbemcli_history.
Pywbemcli may be terminated from this mode by entering <CTRL-D>, :q,
:quit, :exit
Options:
-h, --help Show this message and exit.
6.7. pywbemcli server –help¶
Help text for pywbemcli server (see Server command group):
Usage: pywbemcli server [COMMAND-OPTIONS] COMMAND [ARGS]...
Command group for WBEM servers.
This command group defines commands to inspect and manage core components
of a WBEM server including server attributes, namespaces, the Interop
namespace, management profiles, and access to profile central instances.
In addition to the command-specific options shown in this help text, the
general options (see 'pywbemcli --help') can also be specified before the
'server' keyword.
Options:
-h, --help Show this message and exit.
Commands:
brand Get the brand of the server.
centralinsts List central instances of mgmt profiles on the server.
info Get information about the server.
interop Get the Interop namespace of the server.
namespaces List the namespaces of the server.
profiles List management profiles advertized by the server.
6.7.1. pywbemcli server brand –help¶
Help text for pywbemcli server brand (see Server brand command):
Usage: pywbemcli server brand [COMMAND-OPTIONS]
Get the brand of the server.
Brand information is defined by the server implementor and may or may not
be available. Pywbem attempts to collect the brand information from
multiple sources.
Options:
-h, --help Show this message and exit.
6.7.2. pywbemcli server centralinsts –help¶
Help text for pywbemcli server centralinsts (see Server centralinsts command):
Usage: pywbemcli server centralinsts [COMMAND-OPTIONS]
List central instances of mgmt profiles on the server.
Retrieve the CIM instances that are central instances of the specified
WBEM management profiles, and display these instances. By default, all
management profiles advertized on the server are used. The profiles can be
filtered by using the --organization and --profile options.
The central instances are determined using all methodologies defined in
DSP1033 V1.1 in the order of GetCentralInstances, central class, and
scoping class methodology.
Profiles that only use the scoping class methodology require the
specification of the --central-class, --scoping-class, and --scoping-path
options because additional information is needed to perform the scoping
class methodology.
The retrieved central instances are displayed along with the organization,
name, and version of the profile they belong to, formatted as a table. The
--output-format general option is ignored unless it specifies a table
format.
Options:
-o, --organization ORG-NAME Filter by the defined organization. (ex. -o
DMTF
-p, --profile PROFILE-NAME Filter by the profile name. (ex. -p Array
--cc, --central-class CLASSNAME
Optional. Required only if profiles supports
only scopig methodology
--sc, --scoping-class CLASSNAME
Optional. Required only if profiles supports
only scopig methodology
--sp, --scoping-path CLASSLIST Optional. Required only if profiles supports
only scopig methodology. Multiples allowed
--rd, --reference-direction [snia|dmtf]
Navigation direction for association.
[default: dmtf]
-h, --help Show this message and exit.
6.7.3. pywbemcli server info –help¶
Help text for pywbemcli server info (see Server info command):
Usage: pywbemcli server info [COMMAND-OPTIONS]
Get information about the server.
The information includes CIM namespaces and server brand.
Options:
-h, --help Show this message and exit.
6.7.4. pywbemcli server interop –help¶
Help text for pywbemcli server interop (see Server interop command):
Usage: pywbemcli server interop [COMMAND-OPTIONS]
Get the Interop namespace of the server.
Options:
-h, --help Show this message and exit.
6.7.5. pywbemcli server namespaces –help¶
Help text for pywbemcli server namespaces (see Server namespaces command):
Usage: pywbemcli server namespaces [COMMAND-OPTIONS]
List the namespaces of the server.
Options:
-h, --help Show this message and exit.
6.7.6. pywbemcli server profiles –help¶
Help text for pywbemcli server profiles (see Server profiles command):
Usage: pywbemcli server profiles [COMMAND-OPTIONS]
List management profiles advertized by the server.
Retrieve the CIM instances representing the WBEM management profiles
advertized by the WBEM server, and display information about each profile.
WBEM management profiles are defined by DMTF and SNIA and define the
management functionality that is available.
The retrieved profiles can be filtered using the --organization and
--profile options.
The output is formatted as a table showing the organization, name, and
version for each profile. The --output-format option is ignored unless it
specifies a table format.
Options:
-o, --organization ORG-NAME Filter by the defined organization. (ex. -o
DMTF
-p, --profile PROFILE-NAME Filter by the profile name. (ex. -p Array
-h, --help Show this message and exit.