1cimsub(1) cimsub(1)
2
6 cimsub - list, enable, disable,remove or create CIM indication sub‐
7 scriptions
8
10 cimsub -l s|f|h [-v][-n namespace][-F [fnamespace:]filtername][-H
11 [hnamespace:][hclassname.]handlername]
12 cimsub -e [-n namespace] -F [fnamespace:]filtername -H [hnames‐
14 pace:][hclassname.]handlername
15 cimsub -d [-n namespace] -F [fnamespace:]filtername -H [hnames‐
17 pace:][hclassname.]handlername
18 cimsub -r s|f|h|a [-n namespace][-F [fnamespace:]filtername][-H
20 [hnamespace:][hclassname.]handlername]
21 cimsub -c f [fnamespace:]filtername -Q query [-L querylanguage] [-N
23 sourcenamespace(s)]
24 cimsub -c h [hnamespace:][hclassname.]handlername [-D destination]|
26 [-M mailto [-C mailcc] -S mailsubject]|
27 [-T snmptargethost [-P snmpportnumber] -V snmpversion] [-U
28 snmpsecurityname] [-E snmpengineid]]
29 cimsub -c s [-n namespace] -F [fnamespace:]filtername -H [hnames‐
31 pace:][hclassname.]handlername
32 cimsub --help
35 cimsub --version
37
40 The cimsub command provides a command line interface to manage CIM
41 indication subscriptions on the local CIM Server.
42 The first form of cimsub lists all or selected indication subscrip‐
44 tions, filters, or handlers, and displays the requested information
45 about the instance(s).
46 The second form of cimsub enables the specified subscription, i.e. the
48 subscription instance is modified to set the value of the Subscription‐
49 State property to Enabled. When a subscription is enabled, the CIM
50 Server attempts to process the subscription if at least one provider is
51 available to serve the subscription.
52 The third form of cimsub disables the specified subscription, i.e. the
54 subscription instance is modified to set the value of the Subscription‐
55 State property to Disabled. When a subscription is disabled, the CIM
56 Server does not attempt to process the subscription, regardless of
57 whether any providers are available to serve the subscription.
58 The fourth form of cimsub removes the specified subscription, filter,
60 handler, or subscription and its referenced filter and handler, i.e.
61 each instance is deleted from the repository, and the CIM Server will
62 no longer have any information about the instance(s). A filter or han‐
63 dler may not be removed if it is referenced by any other subscription.
64 The fifth form of cimsub command creates the specified Subscription,
66 filter, or handler. i.e each instance is created into the repository
67 and CIM Server will get the new information about the created
68 Instance(s).
69 Options
72 The cimsub command recognizes the following options:
73 -l List and display information about all or
75 selected indication subscriptions ("s"), filters
76 ("f"), or handlers ("h"). It is an error to spec‐
77 ify the -F option with -lh. It is an error to
78 specify the -H option with -lf. With the -lf or
79 -lh option, fnamespace or hnamespace takes prece‐
80 dence over the -n namespace option if both are
81 specified.
82 -e Enable the specified subscription (set the Sub‐
84 scriptionState to Enabled).
85 -d Disable the specified subscription (set the Sub‐
87 scriptionState to Disabled).
88 -r Remove the specified subscription ("s"), filter
90 ("f"), handler ("h"), or subscription and its
91 referenced filter and handler ("a") (delete the
92 instance(s) from the repository). The -F and -H
93 options are required with -rs or -ra. It is an
94 error to specify the -F option with -rh. It is an
95 error to specify the -H option with -rf. With the
96 -rf or -rh option, fnamespace or hnamespace takes
97 precedence over the -n namespace option if both
98 are specified.
99 -c Create the specified subscription ("s"), filter
101 ("f") or handler ("h"). The -F filter and -H
102 handler options are required with -cs. The Fil‐
103 tername and -Q Query are required with -cf. The
104 Handler Name is required with -ch.With the -cf or
105 -ch option, fnamespace or hnamespace takes prece‐
106 dence over the -n namespace option if both are
107 specified.
108 -v Include verbose information in the information
110 displayed for each listed instance.
111 -n namespace Specify the namespace. For the -l forms of the
113 command, if no namespace is specified, instances
114 in all namespaces are listed. For all other forms
115 of the command, if no namespace is specified, the
116 command operates on an instance in the namespace
117 root/PG_InterOp.
118 -F [fnamespace:]filtername
120 Specify the Filter Name. Omission of the filter
121 namespace specifies that it is the same as that
122 of the subscription.
123 -H [hnamespace:][classname.]handlername
125 Specify the Handler Name. Omission of the handler
126 namespace specifies that it is the same as that
127 of the subscription. Omission of the handler
128 classname specifies that it is CIM_ListenerDesti‐
129 nationCIMXML.
130 -Q Specify the Query Expression for the Filter.
132 -L Specify the Query Language for the Filter.
134 -N To Use SourceNamespaces property, Specify multi‐
136 ple SourceNamespaces with coma separated or
137 append comma to the single SourceNamespace. By
138 default SourceNamespace property is populated if
139 the single SourceNamespace is specified.
140 -D Specify Destination of a CIM_IndicationHan‐
142 dlerCIMXML Handler. Required option for CIM_Indi‐
143 cationHandlerCIMXML or CIM_ListenerDestina‐
144 tionCIMXML Handler.
145 -M Specify Mailto of a PG_ListenerDestinationEmail
147 Handler.
148 -C Specify Mailcc of a PG_ListenerDestinationEmail
150 Handler.
151 -S Specify Subject of a PG_ListenerDestinationEmail
153 Handler.
154 -T Specify Target Host of PG_IndicationHandlerSN‐
156 MPMapper Handler. Required option for SNMPMapper
157 handler.
158 -U Specify Security Name of PG_IndicationHandlerSN‐
160 MPMapper Handler.
161 -P Specify Port Number of a PG_IndicationHandlerSN‐
163 MPMapper Handler.(default 162)
164 -V Specify SNMPVersion of a PG_IndicationHandlerSN‐
166 MPMapper Handler.
167 2 : SNMPv1 Trap
168 3 : SNMPv2C Trap
169 4 : SNMPv2C Inform
170 5 : SNMPv3 Trap
171 6 : SNMPv3 Inform
172 Required option for SNMPMapper
173 Handler
174 -E Specify Engine ID of a PG_IndicationHandlerSN‐
176 MPMapper Handler.
177 --help Display command usage information.
179 --version Display the CIM Server version.
181
183 When an error occurs, an error message is written to stderr and an
184 error value is returned. The following return values are returned:
185 0 Successful completion
187 1 General error
188 2 Connection failed
189 3 Connection timed out
190 4 Access was denied
191 5 Namespace does not exist
192 6 Object could not be found
193 7 Operation is not supported
194
196 The cimsub command requires the CIM Server to be running.
197 If the enableSubscriptionsForNonprivilegedUsers configuration property
199 is set to false, only a privileged user may list, enable, disable,
200 remove or create a subscription, filter, or handler. If the enableSub‐
201 scriptionsForNonprivilegedUsers configuration property is set to true,
202 even a non privileged user or the instance creator may enable, disable,
203 remove or create a subscription, filter or handler.
204 Caution should be used when specifying the -r option, since subscrip‐
206 tions, filters or handlers removed may not be easily re-created, and
207 may not be re-created using this command.
208
210 List all indication subscriptions in all namespaces on the local CIM
211 Server:
212 cimsub -ls
214 List all indication subscriptions referencing the Filter with Name
216 'TestFilter' in all namespaces on the local CIM Server:
217 cimsub -ls -F TestFilter
219 List all indication subscriptions referencing the CIM_ListenerDestina‐
221 tionCIMXML Handler with Name 'TestHandler' in all namespaces on the
222 local CIM Server:
223 cimsub -ls -H TestHandler
225 List all indication subscriptions in the root/cimv2 namespace on the
227 local CIM Server, including subscription state, filter query and han‐
228 dler destination (verbose listing output):
229 cimsub -ls -v -n root/cimv2
231 Display information about the subscription referencing Filter with Name
233 'TestFilter' and referencing CIM_ListenerDestinationCIMXML Handler with
234 Name 'TestHandler' (all in namespace root/PG_InterOp), including sub‐
235 scription state, filter query and handler destination (verbose listing
236 output):
237 cimsub -ls -v -n root/PG_InterOp -F TestFilter -H TestHandler
239 Display information about the Filter with Name 'TestFilter' in the
241 root/cimv2 namespace (verbose listing output):
242 cimsub -lf -v -F root/cimv2:TestFilter
244 List all handlers in all namespaces on the local CIM Server:
246 cimsub -lh
248 Enable the subscription referencing Filter with Name 'TestFilter' and
250 referencing CIM_ListenerDestinationCIMXML Handler with Name
251 'TestHandler' (all in namespace root/PG_InterOp):
252 cimsub -e -F TestFilter -H TestHandler
254 Disable the subscription in namespace root/cimv2, referencing Filter
256 with Name 'TestFilter' in namespace test1/cimv2, and referencing
257 PG_ListenerDestinationSystemLog Handler with Name 'TestHandler' in
258 namespace test2/cimv2:
259 cimsub -d -n root/cimv2 -F test1/cimv2:TestFilter -H
261 test2/cimv2:PG_ListenerDestinationSystemLog.TestHandler
262 Remove the subscription referencing Filter with Name 'TestFilter', and
264 referencing CIM_ListenerDestinationCIMXML Handler with Name
265 'TestHandler' (all in namespace root/cimv2), also removing the filter
266 and handler instances (if not referenced by any other subscription):
267 cimsub -ra -n root/cimv2 -F TestFilter -H TestHandler
269 Create filter with Name 'filteraa' with the Query 'select * from Indi‐
271 cationStressTestClass' with SourceNamespaces test/TestProvider and
272 test/testIndSrcNS1.
273 cimsub -c f filteraa -Q select * from IndicationStressTestClass
275 -N test/TestProvider,test/testIndSrcNS1
276 Create handler with Name 'handler01' and Destination '/Pegasus_Indica‐
278 tionStressTestConsumer'.
279 cimsub -c h handler01 -D /Pegasus_IndicationStressTestConsumer
281 Create Subscription with referencing Filter with Name 'TestFilter', and
283 referencing CIM_ListenerDestinationCIMXML Handler with Name
284 'TestHandler'
285 cimsub -c s -F filteraa -H handler01
287
289 cimserver(1), cimconfig(1M).
290 cimsub(1)