2.5. 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] [COMMAND-OPTIONS]
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.
The width of help texts of this command can be set with the PYWBEMTOOLS_TERMWIDTH environment variable.
For more detailed documentation, see:
https://pywbemtools.readthedocs.io/en/stable/
General 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. The
files may be specified with relative or absolute path.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. Use "" to set default in interactive mode.Default:
EnvVar PYWBEMCLI_USER, or none.
-p, --password TEXT Password for the WBEM server. Default: EnvVar PYWBEMCLI_PASSWORD, or prompted for if
--user specified. Use "" to set default in interactive mode.
--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 CACERTS Certificates used to validate the certificate presented by the WBEM server during
TLS/SSL handshake: FILE: Use the certs in the specified PEM file; DIR: Use the certs
in the PEM files in the specified directory; "certifi" (pywbem 1.0 or later): Use the
certs provided by the certifi Python package; Default: EnvVar PYWBEMCLI_CA_CERTS, or
"certifi" (pywbem 1.0 or later), or the certs in the PEM files in the first existing
directory from from a system defined list of directories (pywbem before 1.0).
-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. Use "" to set default in interactive mode. 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. Use "" to set default in interactive mode.Default: EnvVar PYWBEMCLI_KEYFILE, or
none.
-t, --timeout INT Client-side timeout (seconds) on data read for operations with the WBEM server. This
integer is the timeout for a single server request. Pywbem retries reads 0 times so
the delay for read timeout failure may be multiple times the timeout value.Default:
EnvVar PYWBEMCLI_TIMEOUT, or 30. Min/max: [0<=x<=300]
-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 / --no-timestats
Display operation time statistics gathered by pywbemcli after each command. Otherwise
statistics can be displayed with "statistics show" command. Default: EnvVar
PYWBEMCLI_TIMESTATS, or no-timestats.
-d, --default-namespace NAMESPACE
Default namespace, to be used when commands do not specify the --namespace command
option. Use "" to set default in interactive mode. Default: EnvVar
PYWBEMCLI_DEFAULT_NAMESPACE, or root/cimv2.
-o, --output-format FORMAT Output format for the command result. The default and allowed output formats are
command specific. The default output_format is None so that each command selects its
own default format. Use "" to set default in interactive mode. FORMAT is: table
formats: [table|plain|simple|grid|psql|rst|html]; CIM object formats:
[mof|xml|repr|txt]]; TEXT formats: [text].
-l, --log COMP[=DEST[:DETAIL]],...
Enable logging of WBEM operations, defined by a list of log configuration strings
with: COMP: [api|http|all]; DEST: [file|stderr|off], default: file; DETAIL:
[all|paths|summary], default: all. "all=off" disables all logging. "all" is max
logging. EnvVar: PYWBEMCLI_LOG. Default: no logging
-v, --verbose / --no-verbose Display extra information about the processing.
--warn / --no-warn Warnings control: True enables display of all Python warnings; False leaves warning
control to the PYHONWARNINGS env var, which by default displays no warnings. Default:
False.
-C, --connections-file FILE PATH
Path name of the connections file to be used. Default: EnvVar
PYWBEMCLI_CONNECTIONS_FILE, or ".pywbemcli_connections.yaml" in the user's home
directory (as determined using Python's os.path.expanduser("~"). See there for
details, particularly for Windows). Use "" to set default in interactive mode.
--pdb Pause execution in the built-in pdb debugger just before executing the command within
pywbemcli. Ignored in interactive mode, but can be specified on each interactive
command. Default: EnvVar PYWBEMCLI_PDB, or false.
--version Show the version of this command and the pywbem package.
-h, --help Show this help message.
Commands:
class Command group for CIM classes.
instance Command group for CIM instances.
namespace Command group for CIM namespaces.
profile Command group for WBEM management profiles.
qualifier Command group for CIM qualifier declarations.
server Command group for WBEM servers.
statistics Command group for WBEM operation statistics.
subscription Command group to manage WBEM indication subscriptions.
connection Command group for WBEM connection definitions.
repl Enter interactive mode (default).
help Show help for pywbemcli subjects.
docs Get pywbemtools documentation in web browser.
2.5.1. pywbemcli class –help
Help text for pywbemcli class
(see class command group):
Usage: pywbemcli [GENERAL-OPTIONS] class COMMAND [ARGS] [COMMAND-OPTIONS]
Command group for CIM classes.
This command group defines commands to inspect classes, invoke methods on classes, 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.
Command Options:
-h, --help Show this help message.
Commands:
enumerate List top classes or subclasses of a class in namespace(s).
get Get a class.
delete Delete a class.
invokemethod Invoke a method on a class.
references List the classes referencing a class.
associators List the classes associated with a class.
find List the classes with matching class names on the server.
tree Show the subclass or superclass hierarchy for a class.
2.5.1.1. pywbemcli class associators –help
Help text for pywbemcli class associators
(see class associators command):
Usage: pywbemcli [GENERAL-OPTIONS] class associators CLASSNAME [COMMAND-OPTIONS]
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
Command 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(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this help message.
2.5.1.2. pywbemcli class delete –help
Help text for pywbemcli class delete
(see class delete command):
Usage: pywbemcli [GENERAL-OPTIONS] class delete CLASSNAME [COMMAND-OPTIONS]
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 instances, the command is rejected, unless the --include-instances option is specified, in which case
the instances are also deleted.
If other classes in that namespace depend on the class to be deleted, the command is rejected. Dependencies considered
for this purpose are subclasses, referencing classes and embedding classes (EmbeddedInstance qualifier only).
WARNING: Deletion of instances will cause the removal of corresponding resources in the managed environment (i.e. in
the real world). Some instances may not be deletable.
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
Command Options:
--include-instances Delete any instances of the class as well. WARNING: Deletion of instances will cause the
removal of corresponding resources in the managed environment (i.e. in the real
world).Default: Reject command if the class has any instances.
--dry-run Enable dry-run mode: Do not actually delete the objects, but display what would be done.
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
-h, --help Show this help message.
2.5.1.3. pywbemcli class enumerate –help
Help text for pywbemcli class enumerate
(see class enumerate command):
Usage: pywbemcli [GENERAL-OPTIONS] class enumerate CLASSNAME [COMMAND-OPTIONS]
List top classes or subclasses of a class in namespace(s).
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
Command 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(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
-s, --summary Show only a summary (count) of the objects.
--association / --no-association
Filter the returned classes to return only indication classes (--association) or
classes that are not associations(--no-association). If the option is not defined no
filtering occurs
--indication / --no-indication Filter the returned classes to return only indication classes (--indication) or
classes that are not indications (--no-indication). If the option is not defined no
filtering occurs
--experimental / --no-experimental
Filter the returned classes to return only experimental classes (--experimental) or
classes that are not experimental (--no-iexperimental). If the option is not defined
no filtering occurs
--deprecated / --no-deprecated Filter the returned classes to return only deprecated classes (--deprecated) or
classes that are not deprecated (--no-deprecated). If the option is not defined no
filtering occurs
--since VERSION Filter the returned classes to return only classes with a version qualifier ge the
supplied string. The string must define a version of the form M.N.V consistent the
definitions of the VERSION qualifier.
--schema SCHEMA Filter the returned classes to return only classes where the classname scheme
component (characters before the "_" match the scheme provided.
--subclass-of CLASSNAME Filter the returned classes to return only classes that are a subclass of the option
value.
--leaf-classes Filter the returned classes to return only leaf (classes; classes with no subclass.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-h, --help Show this help message.
2.5.1.4. pywbemcli class find –help
Help text for pywbemcli class find
(see class find command):
Usage: pywbemcli [GENERAL-OPTIONS] class find CLASSNAME-GLOB [COMMAND-OPTIONS]
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*
Command Options:
-n, --namespace NAMESPACE(s) Namespace(s) for search scope. May be specified multiple times using either the option
multiple times and/or comma separated list. Default: Search in all namespaces of the
server.
-s, --sort Sort by namespace. Default is to sort by classname
--association / --no-association
Filter the returned classes to return only indication classes (--association) or
classes that are not associations(--no-association). If the option is not defined no
filtering occurs
--indication / --no-indication Filter the returned classes to return only indication classes (--indication) or
classes that are not indications (--no-indication). If the option is not defined no
filtering occurs
--experimental / --no-experimental
Filter the returned classes to return only experimental classes (--experimental) or
classes that are not experimental (--no-iexperimental). If the option is not defined
no filtering occurs
--deprecated / --no-deprecated Filter the returned classes to return only deprecated classes (--deprecated) or
classes that are not deprecated (--no-deprecated). If the option is not defined no
filtering occurs
--since VERSION Filter the returned classes to return only classes with a version qualifier ge the
supplied string. The string must define a version of the form M.N.V consistent the
definitions of the VERSION qualifier.
--schema SCHEMA Filter the returned classes to return only classes where the classname scheme
component (characters before the "_" match the scheme provided.
--subclass-of CLASSNAME Filter the returned classes to return only classes that are a subclass of the option
value.
--leaf-classes Filter the returned classes to return only leaf (classes; classes with no subclass.
-h, --help Show this help message.
2.5.1.5. pywbemcli class get –help
Help text for pywbemcli class get
(see class get command):
Usage: pywbemcli [GENERAL-OPTIONS] class get CLASSNAME [COMMAND-OPTIONS]
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
Command 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(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
-h, --help Show this help message.
2.5.1.6. pywbemcli class invokemethod –help
Help text for pywbemcli class invokemethod
(see class invokemethod command):
Usage: pywbemcli [GENERAL-OPTIONS] class invokemethod CLASSNAME METHODNAME [COMMAND-OPTIONS]
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
Command 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 help message.
2.5.1.7. pywbemcli class references –help
Help text for pywbemcli class references
(see class references command):
Usage: pywbemcli [GENERAL-OPTIONS] class references CLASSNAME [COMMAND-OPTIONS]
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
Command 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(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this help message.
2.5.1.8. pywbemcli class tree –help
Help text for pywbemcli class tree
(see class tree command):
Usage: pywbemcli [GENERAL-OPTIONS] class tree CLASSNAME [COMMAND-OPTIONS]
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.
The class hierarchy will formatted as a ASCII graphical tree; the --output-format general option is ignored.
The --detail options to display extra information about each class including:
- The Version qualifier value if the class includes a version qualifier. This is normally a string with 3 integers
- Information about each class type (Association, Indication, Abstract)
Examples:
# Display the complete class hierarchy from the interop namespace pywbemcli -n myconn class tree -n interop
# Display CIM_Foo an its subclasses from the namespace interop pywbemcli -n myconn class tree CIM_Foo -n interop
# Display CIM_Foo and its superclasses from interop pywbemcli -n myconn class tree CIM_Foo -s -n interop
Command Options:
-s, --superclasses Show the superclass hierarchy. Default: Show the subclass hierarchy.
-d, --detail Show details about the class: the Version, Association, Indication, and Abstact
qualifiers.
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
-h, --help Show this help message.
2.5.2. pywbemcli connection –help
Help text for pywbemcli connection
(see connection command group):
Usage: pywbemcli [GENERAL-OPTIONS] connection COMMAND [ARGS] [COMMAND-OPTIONS]
Command group for WBEM connection definitions.
This command group defines commands to manage persistent WBEM connection definitions that have a name. The names of
these connection definitions can then be used as shorthand for the WBEM server or mock server via the '--name' general
option.
The connection definitions are stored in a connections file. By default, the connections file is
'.pywbemcli_connections.yaml' in the user's home directory. The location of the user's home directory depends on the
operating system used. It is determined with Python's 'os.path.expanduser("~")', which works on all operating systems
including Windows. The default path name of the connections file can be overwritten using the
'PYWBEMCLI_CONNECTIONS_FILE' environment variable, or with the '--connections-file' 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.
Command Options:
-h, --help Show this help message.
Commands:
export Export the current connection.
show Show a WBEM connection definition or the current connection.
delete Delete a WBEM connection definition.
select Select a WBEM connection definition as current or default.
test Test the current connection with a predefined WBEM request.
save Save the current connection to a new WBEM connection definition.
list List the WBEM connection definitions.
set-default Set a connection as the default connection.
2.5.2.1. pywbemcli connection delete –help
Help text for pywbemcli connection delete
(see connection delete command):
Usage: pywbemcli [GENERAL-OPTIONS] connection delete NAME [COMMAND-OPTIONS]
Delete a WBEM connection definition.
Delete a named connection definition from the connections file. If the NAME argument is omitted, a list of all
connection definitions is displayed on the terminal and a prompt for selecting one of these connections.
Example:
pywbemcli connection delete blah
Command Options:
-h, --help Show this help message.
2.5.2.2. pywbemcli connection export –help
Help text for pywbemcli connection export
(see connection export command):
Usage: pywbemcli [GENERAL-OPTIONS] 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
Command Options:
-h, --help Show this help message.
2.5.2.3. pywbemcli connection list –help
Help text for pywbemcli connection list
(see connection list command):
Usage: pywbemcli [GENERAL-OPTIONS] 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.
Command Options:
-f, --full If set, display the full table. Otherwise display a brief view(name, server, mock_server columns).
-h, --help Show this help message.
2.5.2.4. pywbemcli connection save –help
Help text for pywbemcli connection save
(see connection save command):
Usage: pywbemcli [GENERAL-OPTIONS] connection save NAME [COMMAND-OPTIONS]
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
Command Options:
-f, --set-default Set this definition as the default definition that will be loaded upon pywbemcli startup if no
server or name is included on the command line.
-h, --help Show this help message.
2.5.2.5. pywbemcli connection select –help
Help text for pywbemcli connection select
(see connection select command):
Usage: pywbemcli [GENERAL-OPTIONS] connection select NAME [COMMAND-OPTIONS]
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 --set-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
. . .
Command Options:
-d, --set-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 help message.
2.5.2.6. pywbemcli connection set-default –help
Help text for pywbemcli connection set-default
(see connection set-default command):
Usage: pywbemcli [GENERAL-OPTIONS] connection set-default NAME [COMMAND-OPTIONS]
Set a connection as the default connection.
Sets either the connection defined in the NAME argument as the default current connection definition or, if there is
no NAME argument on the command it sets the current connection (if there is one) as the default connection.
The character "?" may be used as the name argument to allow selecting the connection to be set as the default
connection interactively from all of the existing connection definitions.
Command Options:
--clear Clear default connection name.
-v, --verify Prompt user to verify change before changing the default connection definition).
-h, --help Show this help message.
2.5.2.7. pywbemcli connection show –help
Help text for pywbemcli connection show
(see connection show command):
Usage: pywbemcli [GENERAL-OPTIONS] connection show NAME [COMMAND-OPTIONS]
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, display the connection information with that name from the connections file or
the current connection if it is the same name.
* If the NAME argument is '?', the command presents a list of connection definitions from the connections file and
prompts the user to select one, which is then displayed.
* If the NAME argument is omitted, displays the current connection information if there is a current connection.
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
...
Command Options:
--show-password If set, show existing password in results. Otherwise, password is masked
-h, --help Show this help message.
2.5.2.8. pywbemcli connection test –help
Help text for pywbemcli connection test
(see connection test command):
Usage: pywbemcli [GENERAL-OPTIONS] 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
Command Options:
--test-pull If set, the connection is tested to determine if theDMTF defined pull operations (ex.
OpenEnumerateInstancesare implemented since these are optional.
-h, --help Show this help message.
2.5.3. pywbemcli docs –help
Help text for pywbemcli docs
(see docs command):
Usage: pywbemcli [GENERAL-OPTIONS] docs
Get pywbemtools documentation in web browser.
EXPERIMENTAL
Calls the current default web browser to display the current stable pywbemtools documentation in a new window.
Command Options:
-h, --help Show this help message.
2.5.4. pywbemcli help –help
Help text for pywbemcli help
(see help command):
Usage: pywbemcli [GENERAL-OPTIONS] help SUBJECT
Show help for pywbemcli subjects.
Show help for specific pywbemcli subjects. This is in addition to the help messages that are available with the -h or
--help option for every command group and command in pywbemcli. It helps document pywbemcli subjects that are more
general than specific commands and configuration subjects that do not have specific commands
If there is no argument provided, outputs a list and summary of the existing help subjects.
If an argument is provided, it outputs the help for the subject(s) defined by the argument.
Command Options:
-h, --help Show this help message.
2.5.5. pywbemcli instance –help
Help text for pywbemcli instance
(see instance command group):
Usage: pywbemcli [GENERAL-OPTIONS] instance COMMAND [ARGS] [COMMAND-OPTIONS]
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.
Command Options:
-h, --help Show this help message.
Commands:
enumerate List the instances of a class.
get Get an instance of a class.
delete Delete an instance of a class.
create Create an instance of a class in a namespace.
modify Modify properties of an instance.
associators List the instances associated with an instance.
references List the instances referencing an instance.
invokemethod Invoke a method on an instance.
query Execute a query on instances in a namespace.
count Count the instances of each class with matching class name.
shrub Show the association shrub for INSTANCENAME.
2.5.5.1. pywbemcli instance associators –help
Help text for pywbemcli instance associators
(see instance associators command):
Usage: pywbemcli [GENERAL-OPTIONS] instance associators INSTANCENAME [COMMAND-OPTIONS]
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.
For information on how to specify the instance using INSTANCENAME and the --key and --namespace options, invoke with
--help-instancename.
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.
Command 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.
-k, --key KEYNAME=VALUE Value for a key in keybinding of CIM instance name. May be specified multiple times.
Allows defining keys without the issues of quotes. Default: No keybindings provided.
-n, --namespace NAMESPACE(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
-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.
--show-null In the TABLE output formats, show properties with no value (i.e. Null) in all of the
instances to be displayed. Otherwise only properties at least one instance has a non-
Null property are displayed
--hi, --help-instancename Show help message for specifying INSTANCENAME including use of the --key and
--namespace options.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-h, --help Show this help message.
2.5.5.2. pywbemcli instance count –help
Help text for pywbemcli instance count
(see instance count command):
Usage: pywbemcli [GENERAL-OPTIONS] instance count CLASSNAME-GLOB [COMMAND-OPTIONS]
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".
If a CIMError occurs on any enumerate, it is flagged with a warning message and the search for instances continues.
If an Error exception occurs (ex. Connection error) the scan is terminated under the assumption that the server may
have failed and the remaining items are shown as "Not scanned".
This command can take a long time to execute since it potentially enumerates all instance names for all classes in all
namespaces.
Command Options:
-n, --namespace NAMESPACE(s) Namespace(s) for search scope. May be specified multiple times using either the option
multiple times and/or comma separated list. Default: Search in all namespaces of the
server.
-s, --sort Sort by instance count. Otherwise sorted by class name.
--ignore-class CLASSNAME Class names of classes to be ignored (not counted). Allows counting instances in
servers where instance retrieval may cause a CIMError or Error exception on some
classes. CIM errors on particular classes are ignored. Error exceptions cause scan to
stop and remaining classes status shown as 'not scanned'. Multiple class names are
allowed (one per option or comma-separated).
--association / --no-association
Filter the returned classes to return only indication classes (--association) or
classes that are not associations(--no-association). If the option is not defined no
filtering occurs
--indication / --no-indication Filter the returned classes to return only indication classes (--indication) or
classes that are not indications (--no-indication). If the option is not defined no
filtering occurs
--experimental / --no-experimental
Filter the returned classes to return only experimental classes (--experimental) or
classes that are not experimental (--no-iexperimental). If the option is not defined
no filtering occurs
--deprecated / --no-deprecated Filter the returned classes to return only deprecated classes (--deprecated) or
classes that are not deprecated (--no-deprecated). If the option is not defined no
filtering occurs
--since VERSION Filter the returned classes to return only classes with a version qualifier ge the
supplied string. The string must define a version of the form M.N.V consistent the
definitions of the VERSION qualifier.
--schema SCHEMA Filter the returned classes to return only classes where the classname scheme
component (characters before the "_" match the scheme provided.
--subclass-of CLASSNAME Filter the returned classes to return only classes that are a subclass of the option
value.
--leaf-classes Filter the returned classes to return only leaf (classes; classes with no subclass.
-h, --help Show this help message.
2.5.5.3. pywbemcli instance create –help
Help text for pywbemcli instance create
(see instance create command):
Usage: pywbemcli [GENERAL-OPTIONS] instance create CLASSNAME [COMMAND-OPTIONS]
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
Command 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 help message.
2.5.5.4. pywbemcli instance delete –help
Help text for pywbemcli instance delete
(see instance delete command):
Usage: pywbemcli [GENERAL-OPTIONS] instance delete INSTANCENAME [COMMAND-OPTIONS]
Delete an instance of a class.
WARNING: Deletion of instances will cause the removal of corresponding resources in the managed environment (i.e. in
the real world). Some instances may not be deletable.
For information on how to specify the instance using INSTANCENAME and the --key and --namespace options, invoke with
--help-instancename.
Command Options:
-k, --key KEYNAME=VALUE Value for a key in keybinding of CIM instance name. May be specified multiple times. Allows
defining keys without the issues of quotes. Default: No keybindings provided.
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
--hi, --help-instancename Show help message for specifying INSTANCENAME including use of the --key and --namespace
options.
-h, --help Show this help message.
2.5.5.5. pywbemcli instance enumerate –help
Help text for pywbemcli instance enumerate
(see instance enumerate command):
Usage: pywbemcli [GENERAL-OPTIONS] instance enumerate CLASSNAME [COMMAND-OPTIONS]
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(s) (--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.
Command 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(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
--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.
--show-null In the TABLE output formats, show properties with no value (i.e. Null) in all of the
instances to be displayed. Otherwise only properties at least one instance has a non-
Null property are displayed
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-h, --help Show this help message.
2.5.5.6. pywbemcli instance get –help
Help text for pywbemcli instance get
(see instance get command):
Usage: pywbemcli [GENERAL-OPTIONS] instance get INSTANCENAME [COMMAND-OPTIONS]
Get an instance of a class.
For information on how to specify the instance using INSTANCENAME and the --key and --namespace options, invoke with
--help-instancename.
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.
Command 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.
-k, --key KEYNAME=VALUE Value for a key in keybinding of CIM instance name. May be specified multiple times.
Allows defining keys without the issues of quotes. Default: No keybindings provided.
-n, --namespace NAMESPACE(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
--hi, --help-instancename Show help message for specifying INSTANCENAME including use of the --key and
--namespace options.
--show-null In the TABLE output formats, show properties with no value (i.e. Null) in all of the
instances to be displayed. Otherwise only properties at least one instance has a non-
Null property are displayed
-h, --help Show this help message.
2.5.5.7. pywbemcli instance invokemethod –help
Help text for pywbemcli instance invokemethod
(see instance invokemethod command):
Usage: pywbemcli [GENERAL-OPTIONS] instance invokemethod INSTANCENAME METHODNAME [COMMAND-OPTIONS]
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.
For information on how to specify the instance using INSTANCENAME and the --key and --namespace options, invoke with
--help-instancename.
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
Command 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.
-k, --key KEYNAME=VALUE Value for a key in keybinding of CIM instance name. May be specified multiple times.
Allows defining keys without the issues of quotes. Default: No keybindings provided.
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
--hi, --help-instancename Show help message for specifying INSTANCENAME including use of the --key and
--namespace options.
-h, --help Show this help message.
2.5.5.8. pywbemcli instance modify –help
Help text for pywbemcli instance modify
(see instance modify command):
Usage: pywbemcli [GENERAL-OPTIONS] instance modify INSTANCENAME [COMMAND-OPTIONS]
Modify properties of an instance.
For information on how to specify the instance using INSTANCENAME and the --key and --namespace options, invoke with
--help-instancename.
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
Command 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.
-k, --key KEYNAME=VALUE Value for a key in keybinding of CIM instance name. May be specified multiple times.
Allows defining keys without the issues of quotes. Default: No keybindings provided.
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
--hi, --help-instancename Show help message for specifying INSTANCENAME including use of the --key and
--namespace options.
-h, --help Show this help message.
2.5.5.9. pywbemcli instance query –help
Help text for pywbemcli instance query
(see instance query command):
Usage: pywbemcli [GENERAL-OPTIONS] instance query QUERY-STRING [COMMAND-OPTIONS]
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.
Command 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 help message.
2.5.5.10. pywbemcli instance references –help
Help text for pywbemcli instance references
(see instance references command):
Usage: pywbemcli [GENERAL-OPTIONS] instance references INSTANCENAME [COMMAND-OPTIONS]
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.
For information on how to specify the instance using INSTANCENAME and the --key and --namespace options, invoke with
--help-instancename.
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.
Command 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.
-k, --key KEYNAME=VALUE Value for a key in keybinding of CIM instance name. May be specified multiple times.
Allows defining keys without the issues of quotes. Default: No keybindings provided.
-n, --namespace NAMESPACE(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
-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.
--show-null In the TABLE output formats, show properties with no value (i.e. Null) in all of the
instances to be displayed. Otherwise only properties at least one instance has a non-
Null property are displayed
--fql, --filter-query-language QUERY-LANGUAGE
The filter query language to be used with --filter-query. Default: DMTF:FQL.
--hi, --help-instancename Show help message for specifying INSTANCENAME including use of the --key and
--namespace options.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-h, --help Show this help message.
2.5.5.11. pywbemcli instance shrub –help
Help text for pywbemcli instance shrub
(see instance shrub command):
Usage: pywbemcli [GENERAL-OPTIONS] instance shrub INSTANCENAME [COMMAND-OPTIONS]
Show the association shrub for INSTANCENAME.
The shrub is a view of all of the instance association relationships for a defined INSTANCENAME showing the various
components that are part of the association including Role, AssocClasse,ResultRole, And ResultClas
The default view is a tree view from the INSTANCENAME to associated instances.
Displays the shrub of association components for the association source instance defined by INSTANCENAME.
For information on how to specify the instance using INSTANCENAME and the --key and --namespace options, invoke with
--help-instancename.
Normally the association information is displayed as a tree but it may also be displayed as a table or as one of the
object formats (ex. MOF) of all instances that are part of the shrub if one of the cim object formats is selected with
the global output_format parameter.
Results are formatted as defined by the output format global option.
Command 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.
-k, --key KEYNAME=VALUE Value for a key in keybinding of CIM instance name. May be specified multiple times.
Allows defining keys without the issues of quotes. Default: No keybindings provided.
-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.
-f, --fullpath Normally the instance paths in the tree views are by hiding some keys with ~ to make
the tree simpler to read. This includes keys that have the same value for all
instances and the "CreationClassName" key. Whenthis option is used the full instance
paths are displayed.
--hi, --help-instancename Show help message for specifying INSTANCENAME including use of the --key and
--namespace options.
-h, --help Show this help message.
2.5.6. pywbemcli namespace –help
Help text for pywbemcli namespace
(see namespace command group):
Usage: pywbemcli [GENERAL-OPTIONS] namespace COMMAND [ARGS] [COMMAND-OPTIONS]
Command group for CIM namespaces.
This command group defines commands to create, delete and list namespaces in a WBEM server.
In addition to the command-specific options shown in this help text, the general options (see 'pywbemcli --help') can
also be specified before the 'namespace' keyword.
Command Options:
-h, --help Show this help message.
Commands:
list List the namespaces of the server.
create Create a namespace on the server.
delete Delete a namespace from the server.
interop Get the Interop namespace of the server.
2.5.6.1. pywbemcli namespace create –help
Help text for pywbemcli namespace create
(see namespace create command):
Usage: pywbemcli [GENERAL-OPTIONS] namespace create NAMESPACE [COMMAND-OPTIONS]
Create a namespace on the server.
Leading and trailing slash (``/``) characters specified in the NAMESPACE argument will be stripped.
The namespace must not yet exist on the server.
The Interop namespace must exist on the server and cannot be created using this command, because that namespace is
required to implement client requests to manage namespaces.
WBEM servers may not allow this operation or may severely limit the conditions under which a namespace can be created
on the server.
Example:
pywbemcli -n myconn namespace create root/cimv2
Command Options:
-h, --help Show this help message.
2.5.6.2. pywbemcli namespace delete –help
Help text for pywbemcli namespace delete
(see namespace delete command):
Usage: pywbemcli [GENERAL-OPTIONS] namespace delete NAMESPACE [COMMAND-OPTIONS]
Delete a namespace from the server.
Leading and trailing slash (``/``) characters specified in the NAMESPACE argument will be stripped.
The Interop namespace must exist on the server and cannot be deleted using this command.
The targeted namespace must exist on the server. If the namespace contains any objects (qualifier types, classes or
instances), the command is rejected unless the --include-objects option is specified.
If the --include-objects option is specified, the dependency order of classes is determined, and the instances are
deleted first in that order, then the classes in that order, and at last the qualifier types. This ensures that no
dangling dependencies remain at any point in the operation. Dependencies that are considered for this purpose are
subclasses, referencing classes and embedding classes (EmbeddedInstance qualifier only). Cross-namespace associations
are deleted in the targeted namespace and are assumed to be properly handled by the server in the other namespace.
(i.e. to be cleaned up there as well without requiring a deletion by the client).
WARNING: Deletion of instances will cause the removal of corresponding resources in the managed environment (i.e. in
the real world). Some instances may not be deletable.
WARNING: Deletion of classes or qualifier types can cause damage to the server: It can impact instance providers and
other components in the server. WBEM servers may not allow the deletion of classes or qualifier declarations.
WBEM servers may not allow deletion of namespaces or may severely limit the conditions under which a namespace can be
deleted.
Example:
pywbemcli -n myconn namespace delete root/cimv2
Command Options:
--include-objects Delete any objects in the namespace as well. WARNING: Deletion of instances will cause the removal
of corresponding resources in the managed environment (i.e. in the real world). Default: Reject
command if the namespace has any objects.
--dry-run Enable dry-run mode: Do not actually delete the objects, but display what would be done.
-h, --help Show this help message.
2.5.6.3. pywbemcli namespace interop –help
Help text for pywbemcli namespace interop
(see namespace interop command):
Usage: pywbemcli [GENERAL-OPTIONS] namespace interop [COMMAND-OPTIONS]
Get the Interop namespace of the server.
The Interop namespace must exist on the server.
Command Options:
-h, --help Show this help message.
2.5.6.4. pywbemcli namespace list –help
Help text for pywbemcli namespace list
(see namespace list command):
Usage: pywbemcli [GENERAL-OPTIONS] namespace list [COMMAND-OPTIONS]
List the namespaces of the server.
The Interop namespace must exist on the server.
Examples:
pywbemcli -n myconn namespace list
Command Options:
-h, --help Show this help message.
2.5.7. pywbemcli profile –help
Help text for pywbemcli profile
(see profile command group):
Usage: pywbemcli [GENERAL-OPTIONS] profile COMMAND [ARGS] [COMMAND-OPTIONS]
Command group for WBEM management profiles.
This command group defines commands to inspect and manage the WBEM management profiles maintained by the WBEM server.
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.
Command Options:
-h, --help Show this help message.
Commands:
list List WBEM management profiles advertised by the server.
centralinsts List WBEM management profile central instances on the server.
2.5.7.1. pywbemcli profile centralinsts –help
Help text for pywbemcli profile centralinsts
(see profile centralinsts command):
Usage: pywbemcli [GENERAL-OPTIONS] profile centralinsts [COMMAND-OPTIONS]
List WBEM management profile central instances 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 included. 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.
Command 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 scoping methodology
--sc, --scoping-class CLASSNAME
Optional. Required only if profiles supports only scoping methodology
--sp, --scoping-path CLASSLIST Optional. Required only if profiles supports only scoping methodology. Multiples
allowed
--rd, --reference-direction [snia|dmtf]
Navigation direction for association. [default: dmtf]
-h, --help Show this help message.
2.5.7.2. pywbemcli profile list –help
Help text for pywbemcli profile list
(see Profile list command):
Usage: pywbemcli [GENERAL-OPTIONS] profile list [COMMAND-OPTIONS]
List WBEM management profiles advertised by the server.
Retrieve the WBEM management profiles advertised 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.
Command 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 help message.
2.5.8. pywbemcli qualifier –help
Help text for pywbemcli qualifier
(see qualifier command group):
Usage: pywbemcli [GENERAL-OPTIONS] qualifier COMMAND [ARGS] [COMMAND-OPTIONS]
Command group for CIM qualifier declarations.
This command group defines commands to inspect and delete CIM qualifier declarations in the WBEM Server.
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.
Command Options:
-h, --help Show this help message.
Commands:
get Get a qualifier declaration.
delete Delete a qualifier declaration.
enumerate List the qualifier declarations in a namespace.
2.5.8.1. pywbemcli qualifier delete –help
Help text for pywbemcli qualifier delete
(see qualifier delete command):
Usage: pywbemcli [GENERAL-OPTIONS] qualifier delete QUALIFIERNAME [COMMAND-OPTIONS]
Delete a qualifier declaration.
Delete 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.
This command executes the DeleteQualifier operation against the WBEM server and leaves it to the WBEM server to reject
the operation if any classes in the namespace use the qualifier.
In the output, the qualifier declaration will formatted as defined by the --output-format general option.
Command Options:
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
-h, --help Show this help message.
2.5.8.2. pywbemcli qualifier enumerate –help
Help text for pywbemcli qualifier enumerate
(see qualifier enumerate command):
Usage: pywbemcli [GENERAL-OPTIONS] qualifier enumerate [COMMAND-OPTIONS]
List the qualifier declarations in a namespace.
Enumerate the CIM qualifier declarations in the specified CIM namespace(s) (--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.
Command Options:
-n, --namespace NAMESPACE(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-s, --summary Show only a summary (count) of the objects.
-h, --help Show this help message.
2.5.8.3. pywbemcli qualifier get –help
Help text for pywbemcli qualifier get
(see qualifier get command):
Usage: pywbemcli [GENERAL-OPTIONS] qualifier get QUALIFIERNAME [COMMAND-OPTIONS]
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.
Command Options:
-n, --namespace NAMESPACE(s) Namespace(s) to use for this command, instead of the default connection namespace. May
be specified multiple times using either the option multiple times and/or comma
separated list. Default: connection default namespace.
--object-order Order the objects by object before namespace. Only applies when multiple namespaces
defined.
-h, --help Show this help message.
2.5.9. pywbemcli repl –help
Help text for pywbemcli repl
(see repl command):
Usage: pywbemcli [GENERAL-OPTIONS] repl
Enter interactive mode (default).
Enter the interactive mode where pywbemcli commands can be entered interactively. The prompt is changed to
'pywbemcli>'.
<COMMAND> <COMMAND OPTIONS> - Execute pywbemcli command COMMAND
<GENERAL_OPTIONS> <COMMAND> <COMMAND_OPTIONS> - Execute command with general options. General options set here exist
only for the current command.
-h, --help - Show pywbemcli general help message, including a list of pywbemcli
commands. COMMAND -h, --help - Show help message for pywbemcli command COMMAND.
!SHELL-CMD - Execute shell command SHELL-CMD
Pywbemcli termination - <CTRL-D>, :q, :quit, :exit
Command history is supported. The command history is stored in a file ~/.pywbemcli_history.
<UP>, <DOWN> - Scroll through pwbemcli command history.
<CTRL-r> <search string> - initiate an interactive search of the pywbemcli history file. Can be used with <UP>, <DOWN>
to display commands that match the search string. Editing the search string updates the search.
<TAB> - tab completion for current command line (can be used anywhere in command)
Interactive mode also includes an autosuggest feature that makes suggestions from the command history as the command
the user types in the command and options.
Command Options:
-h, --help Show this help message.
2.5.10. pywbemcli server –help
Help text for pywbemcli server
(see server command group):
Usage: pywbemcli [GENERAL-OPTIONS] server COMMAND [ARGS] [COMMAND-OPTIONS]
Command group for WBEM servers.
This command group defines commands to inspect and manage core components of a WBEM server including server
attributes, namespaces, compiling MOF, the Interop namespace and schema information.
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.
Command Options:
-h, --help Show this help message.
Commands:
brand Get the brand of the server.
info Get information about the server.
add-mof Compile MOF and add/update CIM objects in the server.
remove-mof Compile MOF and remove CIM objects from the server.
schema Get information about the server schemas.
2.5.10.1. pywbemcli server add-mof –help
Help text for pywbemcli server add-mof
(see server add-mof command):
Usage: pywbemcli [GENERAL-OPTIONS] server add-mof MOFFILE [COMMAND-OPTIONS]
Compile MOF and add/update CIM objects in the server.
The MOF files are specified with the MOFFILE argument, which may be specified multiple times. The minus sign ('-')
specifies the standard input.
Initially, the target namespace is the namespace specified with the --namespace option or if not specified the default
namespace of the connection. If the MOF contains '#pragma namespace' directives, the target namespace will be changed
accordingly.
MOF include files (specified with the '#pragma include' directive) are searched first in the directory of the
including MOF file, and then in the directories specified with the --include option.
Any CIM objects (instances, classes and qualifiers) specified in the MOF files are created in the server, or modified
if they already exist in the server.
The global --verbose option will show the CIM objects that are created or modified.
Command Options:
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
-I, --include INCLUDEDIR Path name of a MOF include directory. May be specified multiple times.
-d, --dry-run Enable dry-run mode: Don't actually modify the server. Connection to the server is still
required for reading.
-h, --help Show this help message.
2.5.10.2. pywbemcli server brand –help
Help text for pywbemcli server brand
(see server brand command):
Usage: pywbemcli [GENERAL-OPTIONS] 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.
Command Options:
-h, --help Show this help message.
2.5.10.3. pywbemcli server info –help
Help text for pywbemcli server info
(see server info command):
Usage: pywbemcli [GENERAL-OPTIONS] server info [COMMAND-OPTIONS]
Get information about the server.
The information includes CIM namespaces and server brand.
Command Options:
-h, --help Show this help message.
2.5.10.4. pywbemcli server remove-mof –help
Help text for pywbemcli server remove-mof
(see server remove-mof command):
Usage: pywbemcli [GENERAL-OPTIONS] server remove-mof MOFFILE [COMMAND-OPTIONS]
Compile MOF and remove CIM objects from the server.
The MOF files are specified with the MOFFILE argument, which may be specified multiple times. The minus sign ('-')
specifies the standard input.
Initially, the target namespace is the namespace specified with the --namespace option or if not specified the default
namespace of the connection. If the MOF contains '#pragma namespace' directives, the target namespace will be changed
accordingly.
MOF include files (specified with the '#pragma include' directive) are searched first in the directory of the
including MOF file, and then in the directories specified with the --include option.
Any CIM objects (instances, classes and qualifiers) specified in the MOF files are deleted from the server.
The global --verbose option will show the CIM objects that are removed.
Command Options:
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
-I, --include INCLUDEDIR Path name of a MOF include directory. May be specified multiple times.
-d, --dry-run Enable dry-run mode: Don't actually modify the server. Connection to the server is still
required for reading.
-h, --help Show this help message.
2.5.10.5. pywbemcli server schema –help
Help text for pywbemcli server schema
(see server schema command):
Usage: pywbemcli [GENERAL-OPTIONS] server schema [COMMAND-OPTIONS]
Get information about the server schemas.
Gets information about the schemas and CIM schemas that define the classes in each namespace. The information provided
includes: * The released DMTF CIM schema version that was the source for the qualifier declarations and classes
for the namespace. * Experimental vs. final elements in the schema * Schema name (defined by the prefix on each
class before the first '_') * Class count
Command Options:
-n, --namespace NAMESPACE Namespace to use for this command, instead of the default namespace of the connection.
-d, --detail Display details about each schema in the namespace rather than accumulated for the
namespace.
-h, --help Show this help message.
2.5.11. pywbemcli statistics –help
Help text for pywbemcli statistics
(see statistics command group):
Usage: pywbemcli [GENERAL-OPTIONS] statistics COMMAND [ARGS] [COMMAND-OPTIONS]
Command group for WBEM operation statistics.
This command group defines commands to control the gathering and display of statistical data about the WBEM operations
issued by pywbemcli or processed by a WBEM server.
Pywbemcli maintains statistics about the WBEM operations it has issued. This includes the Client Time measured on the
client side and the Server Time measured by the WBEM server and reported in the 'WBEMServerResponseTime' header field
in the CIM-XML response (if supported by the WBEM server).
The WBEM server may also support maintaining statistics about the WBEM operations it has processed (possibly by
multiple clients). Pywbemcli supports enabling or disabling the statistics gathering on the WBEM server via the
'GatherStatisticalData' property in the 'CIM_ObjectManager' instance for the WBEM server and supports retrieving and
displaying the server maintained statistics.
In addition to the command-specific options shown in this help text, the general options (see 'pywbemcli --help') can
also be specified before the 'statistics' keyword.
Command Options:
-h, --help Show this help message.
Commands:
reset Reset client maintained statistics.
server-on Enable server maintained statistics.
server-off Disable server maintained statistics.
server-show Display server maintained statistics.
show Display client maintained statistics.
status Show enabled status of client and server maintained statistics.
2.5.11.1. pywbemcli statistics reset –help
Help text for pywbemcli statistics reset
(see statistics reset command):
Usage: pywbemcli [GENERAL-OPTIONS] statistics reset [COMMAND-OPTIONS]
Reset client maintained statistics.
This command resets the counts in the statistics maintained by pywbemcli. This includes the server response times
received from the WBEM server in the 'WBEMServerResponseTime' header field of the CIM-XML response, if supported and
enabled.
This command does not reset the server maintained statistics.
Command Options:
-h, --help Show this help message.
2.5.11.2. pywbemcli statistics server-off –help
Help text for pywbemcli statistics server-off
(see statistics server-off command):
Usage: pywbemcli [GENERAL-OPTIONS] statistics server-off [COMMAND-OPTIONS]
Disable server maintained statistics.
This command deactivates the gathering of statistics in the current WBEM server and also deactivates the returning of
server response times in the CIM-XML response for inclusion in the client maintained statistics, by setting the
'GatherStatisticalData' property to False in the 'CIM_ObjectManager' instance for the WBEM server.
This command fails if the server does not support gathering statistics or does not allow a client to modify the state
of statistics gathering.
This command does not affect the state of the client maintained statistics other than whether the server response
times are included. See the '--timestats' general option for controlling the displaying of client maintained
statistics.
Command Options:
-h, --help Show this help message.
2.5.11.3. pywbemcli statistics server-on –help
Help text for pywbemcli statistics server-on
(see statistics server-on command):
Usage: pywbemcli [GENERAL-OPTIONS] statistics server-on [COMMAND-OPTIONS]
Enable server maintained statistics.
This command activates the gathering of statistics in the current WBEM server and also activates the returning of
server response times in the CIM-XML response for inclusion in the client maintained statistics, by setting the
'GatherStatisticalData' property to True in the 'CIM_ObjectManager' instance for the WBEM server.
This command fails if the server does not support gathering statistics or does not allow a client to modify the state
of statistics gathering.
This command does not affect the state of the client maintained statistics other than whether the server response
times are included. See the '--timestats' general option for controlling the displaying of client maintained
statistics.
Command Options:
-h, --help Show this help message.
2.5.11.4. pywbemcli statistics server-show –help
Help text for pywbemcli statistics server-show
(see statistics server-show command):
Usage: pywbemcli [GENERAL-OPTIONS] statistics server-show [COMMAND-OPTIONS]
Display server maintained statistics.
Retrieve and display the statistics gathered by the current WBEM server. This requires statistics gathering to be
enabled on the server (see 'statistics server-on' command).
This command fails if the server does not support gathering statistics.
These statistics are independent of the client maintained statistics which can be displayed with the command
'statistics show'.
Command Options:
-h, --help Show this help message.
2.5.11.5. pywbemcli statistics show –help
Help text for pywbemcli statistics show
(see statistics show command):
Usage: pywbemcli [GENERAL-OPTIONS] statistics show [COMMAND-OPTIONS]
Display client maintained statistics.
Display the statistics gathered by pywbemcli. This includes the server response times received from the WBEM server in
the 'WBEMServerResponseTime' header field of the CIM-XML response, if supported and enabled.
These statistics are independent of the server maintained statistics which can be displayed with the command
'statistics server-show'.
Command Options:
-h, --help Show this help message.
2.5.11.6. pywbemcli statistics status –help
Help text for pywbemcli statistics status
(see statistics status command):
Usage: pywbemcli [GENERAL-OPTIONS] statistics status [COMMAND-OPTIONS]
Show enabled status of client and server maintained statistics.
Show the enabled status for displaying the statistics gathered by pywbemcli, and for gathering the statistics on the
current WBEM server.
Command Options:
-h, --help Show this help message.
2.5.12. pywbemcli subscription –help
Help text for pywbemcli subscription
(see subscription command group):
Usage: pywbemcli [GENERAL-OPTIONS] subscription COMMAND [ARGS] [COMMAND-OPTIONS]
Command group to manage WBEM indication subscriptions.
This group uses the pywbem subscription manager to create, view, and remove CIM Indication subscriptions for a WBEM
Server.
In addition to the command-specific options shown in this help text, the general options (see 'pywbemcli --help') can
also be specified before the command. These are NOT retained after the command is executed.
Command Options:
-h, --help Show this help message.
Commands:
add-destination Add new listener destination.
add-filter Add new indication filter.
add-subscription Add new indication subscription.
list Display indication subscriptions overview.
list-destinations Display indication listeners on the WBEM server.
list-filters Display indication filters on the WBEM server.
list-subscriptions Display indication subscriptions on the WBEM server.
remove-destination Remove a listener destination from the WBEM server.
remove-filter Remove an indication filter from the WBEM server.
remove-subscription Remove indication subscription from the WBEM server.
remove-server Remove current WBEM server from the SubscriptionManager.
2.5.12.1. pywbemcli subscription add-destination –help
Help text for pywbemcli subscription add-destination
(see subscription add-destination command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription add-destination IDENTITY [COMMAND-OPTIONS]
Add new listener destination.
This command adds a listener destination to be the target of indications sent by a WBEM server a WBEM server, by
adding an instance of the CIM class "CIM_ListenerDestinationCIMXML" in the Interop namespace of the WBEM server.
A listener destination defines the target of a WBEM indication listener including URI of the listener including the
listener port.
The required IDENTITY argument along with the --owned/--permanent option define the ``Name`` key property of the new
instance. If the instance is to be owned by the current SubscriptionManager, pywbemcli creates a 'Name' property
value with the format: "pywbemdestination:" <SubscriptionManagerID> ":" <IDENTITY>. If the destination instance is to
be permanent, the value of the IDENTITY argument becomes the value of the 'Name' property.
Owned destinations are added or updated conditionally: If the destination instance to be added is already registered
with this subscription manager and has the same property values, it is not created or modified. If an instance with
this path and properties does not exist yet (the normal case), it is created on the WBEM server.
Permanent listener destinations are created unconditionally, and it is up to the user to ensure that such an instance
does not already exist.
If the --verbose general option is set, the created instance is displayed.
Command Options:
-l, --listener-url URL Defines the URL of the target listener in the format: [SCHEME://]HOST:PORT. SCHEME must be
"https" (default) or "http". HOST is a short or long hostname or literal IPV4/v6 address. PORT
is a positive integer and is required
--owned / --permanent Defines whether an owned or permanent filter, destination, or subscription is to be added.
Default: owned
-h, --help Show this help message.
2.5.12.2. pywbemcli subscription add-filter –help
Help text for pywbemcli subscription add-filter
(see subscription add-filter command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription add-filter IDENTITY [COMMAND-OPTIONS]
Add new indication filter.
This command adds an indication filter to a WBEM server, by creating an indication filter instance (CIM class
"CIM_IndicationFilter") in the Interop namespace of the server.
A indication listener defines the query and query language to be used by the WBEM server to create indications for an
indication subscription.
The required IDENTITY argument of the command and the --owned/--permanent option defines the 'Name' key property of
the the created instance. If the the instance is to be owned by the current SubscriptionManager, pywbemcli indirectly
specifies the 'Name' property value with the format: "pywbemfilter:" "<SubscriptionManagerID>" ":" <identity>``. If
the destination instance is to be permanent, the value of the IDENTITY argument directly becomes the value of the Name
property.
Owned indication filters are added or updated conditionally: If the indication filter instance to be added is already
registered with this subscription manager and has the same property values, it is not created or modified. If it has
the same path but different property values, it is modified to get the desired property values. If an instance with
this path does not exist yet (the normal case), it is created.
Permanent indication filters are created unconditionally; it is up to the user to ensure that such an instance does
not exist yet.
If the --verbose general option is set, the created instance is displayed.
Command Options:
-q, --query FILTER Filter query definition. This is a SELECT statement in the query language defined in the
filter-query-language parameter [required]
--query-language TEXT Filter query language for this subscription The query languages normally implemented are
'DMTF:CQL' and 'WQL' . Default: WQL
--source-namespaces TEXT The namespace(s) for which the query is defined. Multiple values may be defined with a
single comma-separated string of namespaces or multiple options. If defined the namespaces
will be inserted into the SourceNamespaces property. Otherwise the property will not be
created and the WBEM server typically use the Interop namespace for the indication filter.
--owned / --permanent Defines whether an owned or permanent filter, destination, or subscription is to be added.
Default: owned
-h, --help Show this help message.
2.5.12.3. pywbemcli subscription add-subscription –help
Help text for pywbemcli subscription add-subscription
(see subscription add-subscription command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription add-subscription DESTINATIONID FILTERID [COMMAND-OPTIONS]
Add new indication subscription.
Adds an indication subscription to the current WBEM server for a particular DESTINATIONID and FILTERID. The command
creates an instance of CIM association class "CIM_IndicationSubscription" in the Interop namespace of the server.
The destination and filter instances to be used in the subscription is based on the DESTINATIONID and FILTERID
arguments which define the the 'Handler' and 'Filter' reference properties of the subscription instance to be created.
The required DESTINATIONID argument defines the existing destination instance that will be attached to the 'Handler'
reference of the association class. This argument may consist of either the value of the 'Name' property of the target
destination instance or the identity of that instance. The identity is the full value of the 'Name' property for
permanent destinations and is a component of the 'Name' property for owned instances. If just the identity is used,
this will result in multiple destinations being found if the same string is defined as the identity of an owned and
permanent destination.
The required FILTERID argument defines the existing filter instance that will be attached to the 'Filter' reference of
the association class. This argument may consist of either the value of the 'Name' property of the target filter
instance or the identity of that instance. The identity is the full value of the 'Name' property for permanent
filters and is a component of the 'Name' property for owned instances. If just the identity is used, this will result
in multiple filters being found if the same string is defined as the identity of an owned and permanent filter.
When creating permanent subscriptions, the indication filter and the listener destinations must not be owned. for
owned subscriptions, indication filter and listener destination may be either owned or permanent.
Owned subscriptions are added or updated conditionally: If the subscription instance to be added is already registered
with this subscription manager and has the same path, it is not created.
Permanent subscriptions are created unconditionally, and it is up to the user to ensure that such an instance does not
already exist.
Upon successful return of this method, the added subscription is active on the WBEM server, so that the specified WBEM
listeners may immediately receive indications.
If the --verbose general option is set, the created instance is displayed.
Command Options:
--owned / --permanent Defines whether an owned or permanent filter, destination, or subscription is to be added.
Default: owned
--select Prompt user to select from multiple objects that match the IDENTITY. Otherwise, if the command
finds multiple instance that match the IDENTITY, the operation fails.
-h, --help Show this help message.
2.5.12.4. pywbemcli subscription list –help
Help text for pywbemcli subscription list
(see subscription list command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription list [COMMAND-OPTIONS]
Display indication subscriptions overview.
This command provides an overview of the count of subscriptions, filters, and destinations retrieved from the WBEM
server. The level of detail depends on the --summary and --detail options. '--summary' displays only a single count
for each; --detail displays a table for the instances of each. The default is to display a table of the count of owned
and permanent for each.
Command Options:
--type [owned|permanent|all] Defines whether the command filters owned, permanent, or all objects for the response.
Default: all
-s, --summary Show only summary count of instances. This option is mutually exclusive with options:
(--detail, --names-only).
-d, --detail Show more detailed information. Otherwise only non-null or predefined property values
are displayed. It applies to both MOF and TABLE output formats. This option is mutually
exclusive with options: (--names-only, --summary).
-h, --help Show this help message.
2.5.12.5. pywbemcli subscription list-destinations –help
Help text for pywbemcli subscription list-destinations
(see subscription list-destinations command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription list-destinations [COMMAND-OPTIONS]
Display indication listeners on the WBEM server.
Display existing CIM indication listener destinations on the current connection. The listener destinations to be
displayed can be filtered by the owned choice option (owned, permanent, all).
The data display is determined by the --detail, --names_only, and --summary options and can be displayed as either a
table or CIM objects (ex. mof) format using the --output general option (ex. --output mof).
Command Options:
--type [owned|permanent|all] Defines whether the command filters owned, permanent, or all objects for the response.
Default: all
-d, --detail Show more detailed information. Otherwise only non-null or predefined property values
are displayed. It applies to both MOF and TABLE output formats. This option is mutually
exclusive with options: (--names-only, --summary).
--names-only, --no Show the CIMInstanceName elements of the instances. This only applies when the --output-
format is one of the CIM object options (ex. mof. This option is mutually exclusive with
options: (--detail, --summary).
-s, --summary Show only summary count of instances. This option is mutually exclusive with options:
(--detail, --names-only).
-h, --help Show this help message.
2.5.12.6. pywbemcli subscription list-filters –help
Help text for pywbemcli subscription list-filters
(see subscription list-filters command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription list-filters [COMMAND-OPTIONS]
Display indication filters on the WBEM server.
Display existing CIM indication filters (CIM_IndicationFilter class) on the current connection. The indication filters
to be displayed can be filtered by the owned choice option (owned, permanent, all).
The data display is determined by the --detail, --names-only, and --summary options and can be displayed as either a
table or CIM objects (ex. mof) format using the --output general option (ex. --output mof).
Command Options:
--type [owned|permanent|all] Defines whether the command filters owned, permanent, or all objects for the response.
Default: all
-d, --detail Show more detailed information. Otherwise only non-null or predefined property values
are displayed. It applies to both MOF and TABLE output formats. This option is mutually
exclusive with options: (--names-only, --summary).
--names-only, --no Show the CIMInstanceName elements of the instances. This only applies when the --output-
format is one of the CIM object options (ex. mof. This option is mutually exclusive with
options: (--detail, --summary).
-s, --summary Show only summary count of instances. This option is mutually exclusive with options:
(--detail, --names-only).
-h, --help Show this help message.
2.5.12.7. pywbemcli subscription list-subscriptions –help
Help text for pywbemcli subscription list-subscriptions
(see subscription list-subscriptions command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription list-subscriptions [COMMAND-OPTIONS]
Display indication subscriptions on the WBEM server.
Displays information on indication subscriptions on the WBEM server, filtering the subscriptions to be displayed can
be filtered by the owned choice option (owned, permanent, all).
The default display is a table of information from the associated Filter and Handler instances
The data display is determined by the --detail, --names-only, and --summary options and can be displayed as either a
table or CIM objects (ex. mof) format using the --output general option (ex. --output mof).
Command Options:
--type [owned|permanent|all] Defines whether the command filters owned, permanent, or all objects for the response.
Default: all
-d, --detail Show more detailed information including MOF of referenced listeners and filters.
Otherwise only non-null or predefined property values are displayed. The extra
properties applies to both MOF and TABLE output formats. This option is mutually
exclusive with options: (--names-only, --summary).
--names-only, --no Show the CIMInstanceName elements of the instances. This only applies when the --output-
format is one of the CIM object options (ex. mof. This option is mutually exclusive with
options: (--detail, --summary).
-s, --summary Show only summary count of instances. This option is mutually exclusive with options:
(--detail, --names-only).
-h, --help Show this help message.
2.5.12.8. pywbemcli subscription remove-destination –help
Help text for pywbemcli subscription remove-destination
(see subscription remove-destination command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription remove-destination IDENTITY [COMMAND-OPTIONS]
Remove a listener destination from the WBEM server.
Removes a listener destination instance (CIM_ListenerDestinationCIMXML) from the WBEM server where the instance to be
removed is identified by the IDENTITY argument and optional owned option of the command.
The required IDENTITY argument may be the value of the IDENTITY used to create the destination or may be the full
value of the destination 'Name' property. This is the value of the 'Name' property for permanent destinations and a
component of the 'Name' property for owned destinations.
If the instance is owned by the current pywbem SubscriptionManager, pywbemcli indirectly specifies the Name property
value with the format: "pywbemdestination:" "<SubscriptionManagerID>" ":" <IDENTITY>``. If the destination instance is
permanent, the value of the IDENTITY argument is the value of the Name property.
Some listener_destination instances on a server may be static in which case the server should generate an exception.
Pywbemcli has no way to identify these static destinations and they will appear as permanent destination instances.
The --select option can be used if, for some reason, the IDENTITY and ownership returns multiple instances. This
should only occur in rare cases where destination instances have been created by other tools. If the --select option
is not used pywbemcli displays the paths of the instances and terminates the command.
Command Options:
--owned / --permanent Defines whether an owned or permanent filter, destination, or subscription is to be removed.
Default: owned
--select Prompt user to select from multiple objects that match the IDENTITY. Otherwise, if the command
finds multiple instance that match the IDENTITY, the operation fails.
-h, --help Show this help message.
-v, --verify Prompt user to verify instances to be removed before request is sent to WBEM server.
2.5.12.9. pywbemcli subscription remove-filter –help
Help text for pywbemcli subscription remove-filter
(see subscription remove-filter command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription remove-filter IDENTITY [COMMAND-OPTIONS]
Remove an indication filter from the WBEM server.
Removes a single indication filter instance (CIM_IndicationFilter class) from the WBEM server where the instance to be
removed is identified by the IDENTITY argument and optional --owned option of the command.
The required IDENTITY argument may be the value of the IDENTITY used to create the filter or may be the full value of
the filter Name property. For permanent filters the value of the Name property is required; for owned destinations the
IDENTITY component of the Name property is sufficient.
If the instance is owned by the current pywbem SubscriptionManager, pywbemcli indirectly specifies the Name property
value with the format: "pywbemfilter:" "<SubscriptionManagerID>" ":" <IDENTITY>``. If the destination instance is
permanent, the value of the IDENTITY argument is the value of the Name property.
The --select option can be used if, the IDENTITY and ownership returns multiple instances. This should only occur in
rare cases where filter instances have been created by other tools. If the --select option is not used pywbemcli
displays the paths of the instances and terminates the command.
Command Options:
--owned / --permanent Defines whether an owned or permanent filter, destination, or subscription is to be removed.
Default: owned
--select Prompt user to select from multiple objects that match the IDENTITY. Otherwise, if the command
finds multiple instance that match the IDENTITY, the operation fails.
-v, --verify Prompt user to verify instances to be removed before request is sent to WBEM server.
-h, --help Show this help message.
2.5.12.10. pywbemcli subscription remove-server –help
Help text for pywbemcli subscription remove-server
(see Subscription remove-server command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription remove-server [COMMAND-OPTIONS]
Remove current WBEM server from the SubscriptionManager.
This command unregisters owned listeners from the WBEM server and removes all owned indication subscriptions, owned
indication filters, and owned listener destinations for this server-id from the WBEM server.
Command Options:
-h, --help Show this help message.
2.5.12.11. pywbemcli subscription remove-subscription –help
Help text for pywbemcli subscription remove-subscription
(see subscription remove-subscription command):
Usage: pywbemcli [GENERAL-OPTIONS] subscription remove-subscription DESTINATIONID FILTERID [COMMAND-OPTIONS]
Remove indication subscription from the WBEM server.
This command removes an indication subscription instance from the WBEM server.
The selection of subscription to be removed is defined by the DESTINATIONID and FILTERID arguments which define the
Name property of the destination and filter associations of the subscription to be removed.
The required DESTINATIONID argument defines the existing destination instance that will be attached to the Filter
reference of the association class. This argument may consist of either the value of the Name property of the target
destination instance or the identity of that instance. The identity is the full value of the Name property for
permanent destinations and is a component of the Name property for owned instances. If just the identity is used, this
will result in multiple destinations being found if the same string is defined as the identity of an owned and
permanent destination.
The required FILTERID argument defines the existing filter instance that will be attached to the 'Filter' reference of
the association class. This argument may consist of either the value of the 'Name' property of the target filter
instance or the identity of that instance. The identity is the full value of the 'Name' property for permanent
filters and is a component of the 'Name' property for owned instances. If just the identity is used, this may result
in multiple filters being found if the same string is defined as the identity of an owned and permanent filter.
This operation does not remove associated filter or destination instances unless the option --remove-associated-
instances is included in the command and the associated instances are not used in any other association.
Command Options:
-v, --verify Prompt user to verify instances to be removed before request is sent to WBEM server.
--remove-associated-instances Attempt to remove the instances associated with this subscription. They will only be
removed if they do not participate in any other associations.
--select Prompt user to select from multiple objects that match the IDENTITY. Otherwise, if the
command finds multiple instance that match the IDENTITY, the operation fails.
-h, --help Show this help message.