/
wbemcli.py
2242 lines (1585 loc) · 72.2 KB
/
wbemcli.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# (C) Copyright 2008 Hewlett-Packard Development Company, L.P.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
# Author: Tim Potter <tpot@hp.com>
#
"""
The interactive shell of wbemcli provides global functions for the CIM
operations, and some functions for help display and debugging.
For tooling reasons, these functions are shown as members of the 'wbemcli'
namespace. However, they are directly available in the namespace of the
wbemcli interactive shell.
"""
from __future__ import absolute_import
# We make any global symbols private, in order to keep the namespace of the
# interactive sheel as clean as possible.
import sys as _sys
import os as _os
import getpass as _getpass
import re
import errno as _errno
import code as _code
import argparse as _argparse
from textwrap import fill
# Additional symbols for use in the interactive session
# pylint: disable=unused-import
from pprint import pprint as pp # noqa: F401
# Conditional support of readline module
try:
import readline as _readline
_HAVE_READLINE = True
except ImportError as arg:
_HAVE_READLINE = False
from pywbem import WBEMConnection
from pywbem.cim_http import get_default_ca_cert_paths
from pywbem._cliutils import SmartFormatter as _SmartFormatter
# Connection global variable. Set by remote_connection and use
# by all functions that execute operations.
CONN = None
# global ARGS contains the argparse arguments dictionary
ARGS = None
def _remote_connection(server, opts, argparser_):
"""Initiate a remote connection, via PyWBEM. Arguments for
the request are part of the command line arguments and include
user name, password, namespace, etc.
"""
global CONN # pylint: disable=global-statement
if server[0] == '/':
url = server
elif re.match(r"^https{0,1}://", server) is not None:
url = server
elif re.match(r"^[a-zA-Z0-9]+://", server) is not None:
argparser_.error('Invalid scheme on server argument.'
' Use "http" or "https"')
else:
url = '%s://%s' % ('https', server)
creds = None
if opts.key_file is not None and opts.cert_file is None:
argparser_.error('keyfile option requires certfile option')
if opts.user is not None and opts.password is None:
opts.password = _getpass.getpass('Enter password for %s: '
% opts.user)
if opts.user is not None or opts.password is not None:
creds = (opts.user, opts.password)
if opts.timeout is not None:
if opts.timeout < 0 or opts.timeout > 300:
argparser_.error('timeout option(%s) out of range' % opts.timeout)
# if client cert and key provided, create dictionary for
# wbem connection
x509_dict = None
if opts.cert_file is not None:
x509_dict = {"cert_file": opts.cert_file}
if opts.key_file is not None:
x509_dict.update({'key_file': opts.key_file})
CONN = WBEMConnection(url, creds, default_namespace=opts.namespace,
no_verification=opts.no_verify_cert,
x509=x509_dict, ca_certs=opts.ca_certs,
timeout=opts.timeout)
CONN.debug = True
return CONN
#
# Create some convenient global functions to reduce typing
#
def ein(cn, ns=None):
"""
WBEM operation: EnumerateInstanceNames
Enumerate the instance paths of instances of a class (including instances
of its subclasses) in a namespace.
Parameters:
cn (string or CIMClassName):
Name of the class to be enumerated (case independent).
If specified as a `CIMClassName` object, its `host` attribute will be
ignored.
ns (string):
Name of the CIM namespace to be used (case independent).
If `None`, defaults to the namespace of the `cn` parameter if
specified as a `CIMClassName`, or to the default namespace of the
connection.
Returns:
list of CIMInstanceName:
The instance paths, with their attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: `None`, indicating the WBEM server is unspecified.
"""
return CONN.EnumerateInstanceNames(cn, ns)
# pylint: disable=too-many-arguments
def ei(cn, ns=None, lo=None, di=None, iq=None, ico=None, pl=None):
"""
WBEM operation: EnumerateInstances
Enumerate the instances of a class (including instances of its subclasses)
in a namespace.
Parameters:
cn (string or CIMClassName):
Name of the class to be enumerated (case independent).
If specified as a `CIMClassName` object, its `host` attribute will be
ignored.
ns (string):
Name of the CIM namespace to be used (case independent).
If `None`, defaults to the namespace of the `cn` parameter if
specified as a `CIMClassName`, or to the default namespace of the
connection.
lo (bool):
LocalOnly flag: Exclude inherited properties.
If `None`, this parameter will not be sent to the server, and the
server default of `True` will be used.
Deprecated: Server implementations for `True` vary; therefore it is
recommended to set this parameter to `False`.
di (bool):
DeepInheritance flag: Include properties added by subclasses.
If `None`, this parameter will not be sent to the server, and the
server default of `True` will be used.
iq (bool):
IncludeQualifiers flag: Include qualifiers.
If `None`, this parameter will not be sent to the server, and the
server default of `True` will be used.
Deprecated: Instance qualifiers have been deprecated in CIM. Clients
cannot rely on qualifiers to be returned in this operation.
ico (bool):
IncludeClassOrigin flag: Include class origin info for properties.
If `None`, this parameter will not be sent to the server, and the
server default of `False` will be used.
pl (iterable of string):
PropertyList: Names of properties to be included (if not otherwise
excluded). If `None`, all properties will be included.
Returns:
list of CIMInstance:
The instances, with their `path` attribute being a CIMInstanceName
object with its attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: `None`, indicating the WBEM server is unspecified.
"""
return CONN.EnumerateInstances(cn, ns,
LocalOnly=lo,
DeepInheritance=di,
IncludeQualifiers=iq,
IncludeClassOrigin=ico,
PropertyList=pl)
def gi(ip, lo=None, iq=None, ico=None, pl=None):
"""
WBEM operation: GetInstance
Retrieve an instance.
Parameters:
ip (CIMInstanceName):
Instance path.
If this object does not specify a namespace, the default namespace of
the connection is used.
Its `host` attribute will be ignored.
lo (bool):
LocalOnly flag: Exclude inherited properties.
If `None`, this parameter will not be sent to the server, and the
server default of `True` will be used.
Deprecated: Server implementations for `True` vary; therefore it is
recommended to set this parameter to `False`.
iq (bool):
IncludeQualifiers flag: Include qualifiers.
If `None`, this parameter will not be sent to the server, and the
server default of `False` will be used.
Deprecated: Instance qualifiers have been deprecated in CIM. Clients
cannot rely on qualifiers to be returned in this operation.
ico (bool):
IncludeClassOrigin flag: Include class origin info for properties.
If `None`, this parameter will not be sent to the server, and the
server default of `False` will be used.
pl (iterable of string):
PropertyList: Names of properties to be included (if not otherwise
excluded). If `None`, all properties will be included.
Returns:
CIMInstance:
The instance, with its `path` attribute being a CIMInstanceName
object with its attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: `None`, indicating the WBEM server is unspecified.
"""
return CONN.GetInstance(ip,
LocalOnly=lo,
IncludeQualifiers=iq,
IncludeClassOrigin=ico,
PropertyList=pl)
def mi(mi, iq=None, pl=None):
"""
WBEM operation: ModifyInstance
Modify the property values of an instance.
Parameters:
mi (CIMInstance):
Modified instance, also indicating its instance path.
The properties defined in this object specify the new property
values for the instance to be modified. Missing properties
(relative to the class declaration) and properties provided with
a value of `None` will be set to NULL.
iq (bool):
IncludeQualifiers flag: Modify instance qualifiers as specified in
the instance.
If `None`, this parameter will not be sent to the server, and the
server default of `False` will be used.
Deprecated: Instance qualifiers have been deprecated in CIM. Clients
cannot rely on qualifiers to be modified in this operation.
pl (iterable of string):
PropertyList: Names of properties to be modified (if not otherwise
excluded). If `None`, all properties will be modified.
"""
CONN.ModifyInstance(mi,
IncludeQualifiers=iq,
PropertyList=pl)
def ci(ni, ns=None):
"""
WBEM operation: CreateInstance
Create an instance in a namespace.
Parameters:
ni (CIMInstance):
New instance.
Its `classname` attribute specifies the creation class.
Its `properties` attribute specifies initial property values.
Its `path` attribute is ignored, except for providing a default
namespace.
ns (string):
Name of the CIM namespace to be used (case independent).
If `None`, defaults to the namespace in the `path` attribute of the
`ni` parameter, or to the default namespace of the connection.
Returns:
CIMInstanceName:
The instance path, with its attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: `None`, indicating the WBEM server is unspecified.
"""
return CONN.CreateInstance(ni, ns)
def di(ip):
"""
WBEM operation: DeleteInstance
Delete an instance.
Parameters:
ip (CIMInstanceName):
Instance path.
If this object does not specify a namespace, the default namespace
of the connection is used.
Its `host` attribute will be ignored.
"""
CONN.DeleteInstance(ip)
def an(op, ac=None, rc=None, r=None, rr=None):
"""
WBEM operation: AssociatorNames
Instance level use: Retrieve the instance paths of the instances
associated to a source instance.
Class level use: Retrieve the class paths of the classes associated to a
source class.
Parameters:
op (CIMInstanceName):
Source instance path; select instance level use.
op (CIMClassName):
Source class path; select class level use.
ac (string):
AssociationClass filter: Include only traversals across this
association class.
`None` means this filter is not applied.
rc (string):
ResultClass filter: Include only traversals to this associated
(result) class.
`None` means this filter is not applied.
r (string):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
rr (string):
ResultRole filter: Include only traversals to this role (= reference
name) in associated (=result) objects.
`None` means this filter is not applied.
Returns:
list of CIMInstanceName or CIMClassName:
For instance level use, a list of CIMInstanceName objects representing
the instance paths, with their attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: Host and optionally port of the WBEM server containing
the CIM namespace, or `None` if the server did not return host
information.
For class level use, a list of CIMClassName objects representing
the class paths, with their attributes set as follows:
* `classname`: Name of the class.
* `namespace`: Name of the CIM namespace containing the class.
* `host`: Host and optionally port of the WBEM server containing
the CIM namespace, or `None` if the server did not return host
information.
"""
return CONN.AssociatorNames(op,
AssocClass=ac,
ResultClass=rc,
Role=r,
ResultRole=rr)
# pylint: disable=too-many-arguments
def a(op, ac=None, rc=None, r=None, rr=None, iq=None, ico=None, pl=None):
"""
WBEM operation: Associators
Instance level use: Retrieve the instances associated to a source instance.
Class level use: Retrieve the classes associated to a source class.
Parameters:
op (CIMInstanceName):
Source instance path; select instance level use.
op (CIMClassName):
Source class path; select class level use.
ac (string):
AssociationClass filter: Include only traversals across this
assoiation class.
`None` means this filter is not applied.
rc (string):
ResultClass filter: Include only traversals to this associated
(result) class.
`None` means this filter is not applied.
r (string):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
rr (string):
ResultRole filter: Include only traversals to this role (= reference
name) in associated (=result) objects.
`None` means this filter is not applied.
iq (bool):
IncludeQualifiers flag: Include qualifiers.
Deprecated: Instance qualifiers have been deprecated in CIM.
`None` will cause the server default of `False` to be used.
ico (bool):
IncludeClassOrigin flag: Include class origin info for props.
Deprecated: Server impls. vary; Server may treat as False.
`None` will cause the server default of `False` to be used.
pl (iterable of string):
PropertyList: Names of properties to be included (if not otherwise
excluded). If `None`, all properties will be included.
Returns:
list of CIMInstance or tuple (CIMClassName, CIMClass):
For instance level use, a list of CIMInstance objects representing
the instances, with their `path` attribute being a CIMInstanceName
object with its attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: Host and optionally port of the WBEM server containing
the CIM namespace, or `None` if the server did not return host
information.
For class level use, a list of tuple (classpath, class) representing
the classes, with the following (unnamed) tuple items:
* classpath (CIMClassName): Class path with its attributes set as
follows:
* `classname`: Name of the class.
* `namespace`: Name of the CIM namespace containing the class.
* `host`: Host and optionally port of the WBEM server
containing the CIM namespace, or `None` if the server did not
return host information.
* class (CIMClass): The representation of the class.
"""
return CONN.Associators(op,
AssocClass=ac,
ResultClass=rc,
Role=r,
ResultRole=rr,
IncludeQualifiers=iq,
IncludeClassOrigin=ico,
PropertyList=pl)
def rn(op, rc=None, r=None):
"""
WBEM operation: ReferenceNames
Instance level use: Retrieve the instance paths of the association
instances referencing a source instance.
Class level use: Retrieve the class paths of the association classes
referencing a source class.
Parameters:
op (CIMInstanceName):
Source instance path; select instance level use.
op (CIMClassName):
Source class path; select class level use.
rc (string):
ResultClass filter: Include only traversals across this association
(result) class.
`None` means this filter is not applied.
r (string):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
Returns:
list of CIMInstanceName or CIMClassName:
For instance level use, a list of CIMInstanceName objects representing
the instance paths, with their attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: Host and optionally port of the WBEM server containing
the CIM namespace, or `None` if the server did not return host
information.
For class level use, a list of CIMClassName objects representing
the class paths, with their attributes set as follows:
* `classname`: Name of the class.
* `namespace`: Name of the CIM namespace containing the class.
* `host`: Host and optionally port of the WBEM server containing
the CIM namespace, or `None` if the server did not return host
information.
"""
return CONN.ReferenceNames(op,
ResultClass=rc,
Role=r)
def r(op, rc=None, r=None, iq=None, ico=None, pl=None):
"""
WBEM operation: References
Instance level use: Retrieve the association instances referencing a source
instance.
Class level use: Retrieve the association classes referencing a source
class.
Parameters:
op (CIMInstanceName):
Source instance path; select instance level use.
op (CIMClassName):
Source class path; select class level use.
rc (string):
ResultClass filter: Include only traversals across this association
(result) class.
`None` means this filter is not applied.
r (string):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
iq (bool):
IncludeQualifiers flag: Include qualifiers.
Deprecated: Instance qualifiers have been deprecated in CIM.
`None` will cause the server default of `False` to be used.
ico (bool):
IncludeClassOrigin flag: Include class origin info for props.
Deprecated: Server impls. vary; Server may treat as False.
`None` will cause the server default of `False` to be used.
pl (iterable of string):
PropertyList: Names of properties to be included (if not otherwise
excluded). If `None`, all properties will be included.
Returns:
list of CIMInstance or tuple (CIMClassName, CIMClass):
For instance level use, a list of CIMInstance objects representing
the instances, with their `path` attribute being a CIMInstanceName
object with its attributes set as follows:
* `classname`: Name of the creation class of the instance.
* `keybindings`: Keybindings of the instance.
* `namespace`: Name of the CIM namespace containing the instance.
* `host`: Host and optionally port of the WBEM server containing
the CIM namespace, or `None` if the server did not return host
information.
For class level use, a list of tuple (classpath, class) representing
the classes, with the following (unnamed) tuple items:
* classpath (CIMClassName): Class path with its attributes set as
follows:
* `classname`: Name of the class.
* `namespace`: Name of the CIM namespace containing the class.
* `host`: Host and optionally port of the WBEM server
containing the CIM namespace, or `None` if the server did not
return host information.
* class (CIMClass): The representation of the class.
"""
return CONN.References(op,
ResultClass=rc,
Role=r,
IncludeQualifiers=iq,
IncludeClassOrigin=ico,
PropertyList=pl)
# pylint: disable=too-many-arguments
def oei(cn, ns=None, lo=None, di=None, iq=None, ico=None, pl=None, fl=None,
fq=None, ot=None, coe=None, moc=None):
"""
WBEM operation: OpenEnumerateInstances
Open an enumeration sequence to enumerate the instances of a class
(including instances of its subclasses) in a namespace. Subsequent to this
open response, additional instances may be pulled using the
`PullInstancesWithPath` request. The enumeration sequence may also be
closed before it is complete with the `CloseEnumeration` request
This operation returns a named tuple containing any instances returned and
status of the enumeration sequence.
Parameters:
cn (string or CIMClassName):
Name of the class to be enumerated (case independent).
If specified as a `CIMClassName` object, its `host` attribute will be
ignored.
ns (string):
Name of the CIM namespace to be used (case independent).
If `None`, defaults to the namespace of the `cn` parameter if
specified as a `CIMClassName`, or to the default namespace of the
connection.
lo (bool):
LocalOnly flag: Exclude inherited properties.
Deprecated: Server impls for True vary; Set to False.
`None` will cause the server default of `True` to be used.
di (bool):
DeepInheritance flag: Include properties added by subclasses.
`None` will cause the server default of `True` to be used.
iq (bool):
IncludeQualifiers flag: Include qualifiers.
Deprecated: Instance qualifiers have been deprecated in CIM.
`None` will cause the server default of `False` to be used.
ico (bool):
IncludeClassOrigin flag: Include class origin info for props.
Deprecated: Server may treat as False.
`None` will cause the server default of `False` to be used.
pl (iterable of string):
PropertyList: Names of properties to be included (if not otherwise
excluded). If `None`, all properties will be included.
fl (string):
Filter query language to be used for the filter defined in the `fi`
parameter.
`None` means that no such filtering is peformed.
fq (string):
Filter to apply to objects to be returned. Based on filter query
language defined by `fl` parameter.
`None` means that no such filtering is peformed.
ot (integer):
Operation timeout in seconds. This is the minimum time the server
must keep the enumerate session open between this open request and
the next request.
A value of 0 indicates that the server should never time out.
The server may reject the proposed value.
`None` will cause the server to use its default timeout.
coe (bool):
Continue on error flag.
`None` will cause the server to use its default of `False`.
moc (integer):
Maximum number of objects to return for this operation.
`None` will cause the server to use its default of 0.
Returns:
Named tuple, containing the following named items:
instances (list of CIMInstance):
The result set of instances in response to this request.
eos (bool):
`True` if this response is the complete response to this request
and there are no more instances to return. Otherwise `eos` is
`False` and the `context` item will define the context for the
next operation.
context (string):
A context string that must be supplied with any subsequent pull
or close operation on this enumeration sequence.
"""
return CONN.OpenEnumerateInstances(cn, ns,
LocalOnly=lo,
DeepInheritance=di,
IncludeQualifiers=iq,
IncludeClassOrigin=ico,
PropertyList=pl,
FilterQueryLanguage=fl,
FilterQuery=fq,
OperationTimeout=ot,
ContinueOnError=coe,
MaxObjectCount=moc)
# pylint: disable=too-many-arguments
def oeip(cn, ns=None, fl=None, fq=None, ot=None, coe=None, moc=None):
"""
WBEM operation: OpenEnumerateInstancePaths
Open an enumeration sequence to enumerate the instances of a class
(including instances of its subclasses) in a namespace. Subsequent to this
open response, additional instances may be pulled using the
`PullInstancesWithPath` request. The enumeration sequence may also be
closed before it is complete with the `CloseEnumeration` request
This operation returns a named tuple containing any instances returned and
status of the enumeration sequence.
Parameters:
cn (string or CIMClassName):
Name of the class to be enumerated (case independent).
If specified as a `CIMClassName` object, its `host` attribute will be
ignored.
ns (string):
Name of the CIM namespace to be used (case independent).
If `None`, defaults to the namespace of the `cn` parameter if
specified as a `CIMClassName`, or to the default namespace of the
connection.
lo (bool):
LocalOnly flag: Exclude inherited properties.
Deprecated: Server impls for True vary; Set to False.
`None` will cause the server default of `True` to be used.
fl (string):
Filter query language to be used for the filter defined in the `fi`
parameter.
`None` means that no such filtering is peformed.
fq (string):
Filter to apply to objects to be returned. Based on filter query
language defined by `fl` parameter.
`None` means that no such filtering is peformed.
ot (integer):
Operation timeout in seconds. This is the minimum time the server
must keep the enumerate session open between this open request and
the next request.
A value of 0 indicates that the server should never time out.
The server may reject the proposed value.
`None` will cause the server to use its default timeout.
coe (bool):
Continue on error flag.
`None` will cause the server to use its default of `False`.
moc (integer):
Maximum number of objects to return for this operation.
`None` will cause the server to use its default of 0.
Returns:
Named tuple, containing the following named items:
paths (list of CIMInstanceName):
The result set of instance paths in response to this request.
eos (bool):
`True` if this response is the complete response to this request
and there are no more instances to return. Otherwise `eos` is
`False` and the `context` item will define the context for the
next operation.
context (string):
A context string that must be supplied with any subsequent pull
or close operation on this enumeration sequence.
"""
return CONN.OpenEnumerateInstancePaths(cn, ns,
FilterQueryLanguage=fl,
FilterQuery=fq,
OperationTimeout=ot,
ContinueOnError=coe,
MaxObjectCount=moc)
# pylint: disable=too-many-arguments
def ori(op, rc=None, r=None, iq=None, ico=None, pl=None, fl=None, fq=None,
ot=None, coe=None, moc=None):
"""
WBEM operation: OpenReferenceInstances
Open an enumeration sequence to enumerate the association instances of an
instance in a namespace. Subsequent to this open response, additional
instances may be pulled using the `PullInstancesWithPath` request. The
enumeration sequence may also be closed before it is complete with the
`CloseEnumeration` request.
This operation returns a named tuple containing any instances returned and
status of the enumeration sequence.
Parameters:
op (CIMInstanceName):
Source instance path.
rc (string):
ResultClass filter: Include only traversals across this association
(result) class.
`None` means this filter is not applied.
r (string):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
iq (bool):
IncludeQualifiers flag: Include qualifiers.
Deprecated: Instance qualifiers have been deprecated in CIM.
`None` will cause the server default of `False` to be used.
ico (bool):
IncludeClassOrigin flag: Include class origin info for props.
Deprecated: Server impls. vary; Server may treat as False.
`None` will cause the server default of `False` to be used.
pl (iterable of string):
PropertyList: Names of properties to be included (if not otherwise
excluded). If `None`, all properties will be included.
fl (string):
Filter query language to be used for the filter defined in the `fi`
parameter.
`None` means that no such filtering is peformed.
fq (string):
Filter to apply to objects to be returned. Based on filter query
language defined by `fl` parameter.
`None` means that no such filtering is peformed.
ot (integer):
Operation timeout in seconds. This is the minimum time the server
must keep the enumerate session open between this open request and
the next request.
A value of 0 indicates that the server should never time out.
The server may reject the proposed value.