1cimsub(1) cimsub(1)
2
6 cimsub - list, enable, disable, or remove CIM indication subscriptions
7
9 cimsub -l s|f|h [-v][-n namespace][-F [fnamespace:]filtername][-H
10 [hnamespace:][hclassname.]handlername]
11 cimsub -e [-n namespace] -F [fnamespace:]filtername -H [hnames‐
13 pace:][hclassname.]handlername
14 cimsub -d [-n namespace] -F [fnamespace:]filtername -H [hnames‐
16 pace:][hclassname.]handlername
17 cimsub -r s|f|h|a [-n namespace][-F [fnamespace:]filtername][-H
19 [hnamespace:][hclassname.]handlername]
20 cimsub --help
22 cimsub --version
24
27 The cimsub command provides a command line interface to manage CIM
28 indication subscriptions on the local CIM Server.
29 The first form of cimsub lists all or selected indication subscrip‐
31 tions, filters, or handlers, and displays the requested information
32 about the instance(s).
33 The second form of cimsub enables the specified subscription, i.e. the
35 subscription instance is modified to set the value of the Subscription‐
36 State property to Enabled. When a subscription is enabled, the CIM
37 Server attempts to process the subscription if at least one provider is
38 available to serve the subscription.
39 The third form of cimsub disables the specified subscription, i.e. the
41 subscription instance is modified to set the value of the Subscription‐
42 State property to Disabled. When a subscription is disabled, the CIM
43 Server does not attempt to process the subscription, regardless of
44 whether any providers are available to serve the subscription.
45 The fourth form of cimsub removes the specified subscription, filter,
47 handler, or subscription and its referenced filter and handler, i.e.
48 each instance is deleted from the repository, and the CIM Server will
49 no longer have any information about the instance(s). A filter or han‐
50 dler may not be removed if it is referenced by any other subscription.
51 Options
53 The cimsub command recognizes the following options:
54 -l List and display information about all or
56 selected indication subscriptions ("s"), filters
57 ("f"), or handlers ("h"). It is an error to spec‐
58 ify the -F option with -lh. It is an error to
59 specify the -H option with -lf. With the -lf or
60 -lh option, fnamespace or hnamespace takes prece‐
61 dence over the -n namespace option if both are
62 specified.
63 -e Enable the specified subscription (set the Sub‐
65 scriptionState to Enabled).
66 -d Disable the specified subscription (set the Sub‐
68 scriptionState to Disabled).
69 -r Remove the specified subscription ("s"), filter
71 ("f"), handler ("h"), or subscription and its
72 referenced filter and handler ("a") (delete the
73 instance(s) from the repository). The -F and -H
74 options are required with -rs or -ra. It is an
75 error to specify the -F option with -rh. It is an
76 error to specify the -H option with -rf. With the
77 -rf or -rh option, fnamespace or hnamespace takes
78 precedence over the -n namespace option if both
79 are specified.
80 -v Include verbose information in the information
82 displayed for each listed instance.
83 -n namespace Specify the namespace. For the -l forms of the
85 command, if no namespace is specified, instances
86 in all namespaces are listed. For all other forms
87 of the command, if no namespace is specified, the
88 command operates on an instance in the namespace
89 root/PG_InterOp.
90 -F [fnamespace:]filtername
92 Specify the Filter Name. Omission of the filter
93 namespace specifies that it is the same as that
94 of the subscription.
95 -H [hnamespace:][classname.]handlername
97 Specify the Handler Name. Omission of the handler
98 namespace specifies that it is the same as that
99 of the subscription. Omission of the handler
100 classname specifies that it is CIM_ListenerDesti‐
101 nationCIMXML.
102 --help Display command usage information.
104 --version Display the CIM Server version.
106
108 When an error occurs, an error message is written to stderr and an
109 error value is returned. The following return values are returned:
110 0 Successful completion
112 1 General error
113 2 Connection failed
114 3 Connection timed out
115 4 Access was denied
116 5 Namespace does not exist
117 6 Object could not be found
118 7 Operation is not supported
119
121 The cimsub command requires the CIM Server to be running.
122 If the enableSubscriptionsForNonprivilegedUsers configuration property
124 is set to false, only a privileged user may list, enable, disable, or
125 remove a subscription, filter, or handler. If the enableSubscriptions‐
126 ForNonprivilegedUsers configuration property is set to true, only a
127 privileged user or the instance creator may enable, disable, or remove
128 a subscription, filter or handler.
129 Caution should be used when specifying the -r option, since subscrip‐
131 tions, filters or handlers removed may not be easily re-created, and
132 may not be re-created using this command.
133
135 List all indication subscriptions in all namespaces on the local CIM
136 Server:
137 cimsub -ls
139 List all indication subscriptions referencing the Filter with Name
141 'TestFilter' in all namespaces on the local CIM Server:
142 cimsub -ls -F TestFilter
144 List all indication subscriptions referencing the CIM_ListenerDestina‐
146 tionCIMXML Handler with Name 'TestHandler' in all namespaces on the
147 local CIM Server:
148 cimsub -ls -H TestHandler
150 List all indication subscriptions in the root/cimv2 namespace on the
152 local CIM Server, including subscription state, filter query and han‐
153 dler destination (verbose listing output):
154 cimsub -ls -v -n root/cimv2
156 Display information about the subscription referencing Filter with Name
158 'TestFilter' and referencing CIM_ListenerDestinationCIMXML Handler with
159 Name 'TestHandler' (all in namespace root/PG_InterOp), including sub‐
160 scription state, filter query and handler destination (verbose listing
161 output):
162 cimsub -ls -v -n root/PG_InterOp -F TestFilter -H TestHandler
164 Display information about the Filter with Name 'TestFilter' in the
166 root/cimv2 namespace (verbose listing output):
167 cimsub -lf -v -F root/cimv2:TestFilter
169 List all handlers in all namespaces on the local CIM Server:
171 cimsub -lh
173 Enable the subscription referencing Filter with Name 'TestFilter' and
175 referencing CIM_ListenerDestinationCIMXML Handler with Name
176 'TestHandler' (all in namespace root/PG_InterOp):
177 cimsub -e -F TestFilter -H TestHandler
179 Disable the subscription in namespace root/cimv2, referencing Filter
181 with Name 'TestFilter' in namespace test1/cimv2, and referencing
182 PG_ListenerDestinationSystemLog Handler with Name 'TestHandler' in
183 namespace test2/cimv2:
184 cimsub -d -n root/cimv2 -F test1/cimv2:TestFilter -H
186 test2/cimv2:PG_ListenerDestinationSystemLog.TestHandler
187 Remove the subscription referencing Filter with Name 'TestFilter', and
189 referencing CIM_ListenerDestinationCIMXML Handler with Name
190 'TestHandler' (all in namespace root/cimv2), also removing the filter
191 and handler instances (if not referenced by any other subscription):
192 cimsub -ra -n root/cimv2 -F TestFilter -H TestHandler
194
196 cimserver(1), cimconfig(1M).
197 cimsub(1)