cimsub(1) cimsub(1)

NAME cimsub - list, enable, disable, or remove CIM indication subscriptions

SYNOPSIS cimsub -l s|f|h [-v][-n namespace][-F [fnamespace:]filtername][-H [hnamespace:][hclassname.]handlername]

cimsub -e [-n namespace] -F [fnamespace:]filtername -H [hnames- pace:][hclassname.]handlername

cimsub -d [-n namespace] -F [fnamespace:]filtername -H [hnames- pace:][hclassname.]handlername

cimsub -r s|f|h|a [-n namespace][-F [fnamespace:]filtername][-H [hnamespace:][hclassname.]handlername]

cimsub --help

cimsub --version

DESCRIPTION The cimsub command provides a command line interface to manage CIM indication subscriptions on the local CIM Server.

The first form of cimsub lists all or selected indication subscrip- tions, filters, or handlers, and displays the requested information about the instance(s).

The second form of cimsub enables the specified subscription, i.e. the subscription instance is modified to set the value of the Subscription- State property to Enabled. When a subscription is enabled, the CIM Server attempts to process the subscription if at least one provider is available to serve the subscription.

The third form of cimsub disables the specified subscription, i.e. the subscription instance is modified to set the value of the Subscription- State property to Disabled. When a subscription is disabled, the CIM Server does not attempt to process the subscription, regardless of whether any providers are available to serve the subscription.

The fourth form of cimsub removes the specified subscription, filter, handler, or subscription and its referenced filter and handler, i.e. each instance is deleted from the repository, and the CIM Server will no longer have any information about the instance(s). A filter or han- dler may not be removed if it is referenced by any other subscription.

Options The cimsub command recognizes the following options:

-l List and display information about all or selected indication subscriptions ("s"), filters ("f"), or handlers ("h"). It is an error to spec- ify the -F option with -lh. It is an error to specify the -H option with -lf. With the -lf or -lh option, fnamespace or hnamespace takes prece- dence over the -n namespace option if both are specified.

-e Enable the specified subscription (set the Sub- scriptionState to Enabled).

-d Disable the specified subscription (set the Sub- scriptionState to Disabled).

-r Remove the specified subscription ("s"), filter ("f"), handler ("h"), or subscription and its referenced filter and handler ("a") (delete the instance(s) from the repository). The -F and -H options are required with -rs or -ra. It is an error to specify the -F option with -rh. It is an error to specify the -H option with -rf. With the -rf or -rh option, fnamespace or hnamespace takes precedence over the -n namespace option if both are specified.

-v Include verbose information in the information displayed for each listed instance.

-n namespace Specify the namespace. For the -l forms of the command, if no namespace is specified, instances in all namespaces are listed. For all other forms of the command, if no namespace is specified, the command operates on an instance in the namespace root/PG_InterOp.

-F [fnamespace:]filtername Specify the Filter Name. Omission of the filter namespace specifies that it is the same as that of the subscription.

-H [hnamespace:][classname.]handlername Specify the Handler Name. Omission of the handler namespace specifies that it is the same as that of the subscription. Omission of the handler classname specifies that it is CIM_ListenerDesti- nationCIMXML.

--help Display command usage information.

--version Display the CIM Server version.

EXIT STATUS When an error occurs, an error message is written to stderr and an error value is returned. The following return values are returned:

0 Successful completion 1 General error 2 Connection failed 3 Connection timed out 4 Access was denied 5 Namespace does not exist 6 Object could not be found 7 Operation is not supported

USAGE NOTES The cimsub command requires the CIM Server to be running.

If the enableSubscriptionsForNonprivilegedUsers configuration property is set to false, only a privileged user may list, enable, disable, or remove a subscription, filter, or handler. If the enableSubscriptions- ForNonprivilegedUsers configuration property is set to true, only a privileged user or the instance creator may enable, disable, or remove a subscription, filter or handler.

Caution should be used when specifying the -r option, since subscrip- tions, filters or handlers removed may not be easily re-created, and may not be re-created using this command.

EXAMPLES List all indication subscriptions in all namespaces on the local CIM Server:

cimsub -ls

List all indication subscriptions referencing the Filter with Name TestFilter in all namespaces on the local CIM Server:

cimsub -ls -F TestFilter

List all indication subscriptions referencing the CIM_ListenerDestina- tionCIMXML Handler with Name TestHandler in all namespaces on the local CIM Server:

cimsub -ls -H TestHandler

List all indication subscriptions in the root/cimv2 namespace on the local CIM Server, including subscription state, filter query and han- dler destination (verbose listing output):

cimsub -ls -v -n root/cimv2

Display information about the subscription referencing Filter with Name TestFilter and referencing CIM_ListenerDestinationCIMXML Handler with Name TestHandler (all in namespace root/PG_InterOp), including sub- scription state, filter query and handler destination (verbose listing output):

cimsub -ls -v -n root/PG_InterOp -F TestFilter -H TestHandler

Display information about the Filter with Name TestFilter in the root/cimv2 namespace (verbose listing output):

cimsub -lf -v -F root/cimv2:TestFilter

List all handlers in all namespaces on the local CIM Server:

cimsub -lh

Enable the subscription referencing Filter with Name TestFilter and referencing CIM_ListenerDestinationCIMXML Handler with Name TestHandler (all in namespace root/PG_InterOp):

cimsub -e -F TestFilter -H TestHandler

Disable the subscription in namespace root/cimv2, referencing Filter with Name TestFilter in namespace test1/cimv2, and referencing PG_ListenerDestinationSystemLog Handler with Name TestHandler in namespace test2/cimv2:

cimsub -d -n root/cimv2 -F test1/cimv2:TestFilter -H test2/cimv2:PG_ListenerDestinationSystemLog.TestHandler

Remove the subscription referencing Filter with Name TestFilter, and referencing CIM_ListenerDestinationCIMXML Handler with Name TestHandler (all in namespace root/cimv2), also removing the filter and handler instances (if not referenced by any other subscription):

cimsub -ra -n root/cimv2 -F TestFilter -H TestHandler

SEE ALSO cimserver(1), cimconfig(1M).

cimsub(1)