/
wbemcli.py
3402 lines (2473 loc) · 121 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 Python functions for the WBEM
operations, and some functions for help display and debugging:
===================== ========================================================
Function WBEM operation
===================== ========================================================
:func:`~wbemcli.ei` EnumerateInstances
:func:`~wbemcli.ein` EnumerateInstanceNames
:func:`~wbemcli.gi` GetInstance
:func:`~wbemcli.mi` ModifyInstance
:func:`~wbemcli.ci` CreateInstance
:func:`~wbemcli.di` DeleteInstance
:func:`~wbemcli.a` Associators
:func:`~wbemcli.an` AssociatorNames
:func:`~wbemcli.r` References
:func:`~wbemcli.rn` ReferenceNames
:func:`~wbemcli.im` InvokeMethod
:func:`~wbemcli.eqy` ExecQuery
--------------------- --------------------------------------------------------
:func:`~wbemcli.iei` IterEnumerateInstances (pywbem only)
:func:`~wbemcli.ieip` IterEnumerateInstancePaths (pywbem only)
:func:`~wbemcli.iai` IterAssociatorInstances (pywbem only)
:func:`~wbemcli.iaip` IterAssociatorInstancePaths (pywbem only)
:func:`~wbemcli.iri` IterReferenceInstances (pywbem only)
:func:`~wbemcli.irip` IterReferenceInstancePaths (pywbem only)
:func:`~wbemcli.iqi` IterQueryInstances (pywbem only)
--------------------- --------------------------------------------------------
:func:`~wbemcli.oei` OpenEnumerateInstances
:func:`~wbemcli.oeip` OpenEnumerateInstancePaths
:func:`~wbemcli.oai` OpenAssociatorInstances
:func:`~wbemcli.oaip` OpenAssociatorInstancePaths
:func:`~wbemcli.ori` OpenReferenceInstances
:func:`~wbemcli.orip` OpenReferenceInstancePaths
:func:`~wbemcli.oqi` OpenQueryInstances
:func:`~wbemcli.piwp` PullInstancesWithPath
:func:`~wbemcli.pip` PullInstancePaths
:func:`~wbemcli.pi` PullInstances
:func:`~wbemcli.ce` CloseEnumeration
--------------------- --------------------------------------------------------
:func:`~wbemcli.ec` EnumerateClasses
:func:`~wbemcli.ecn` EnumerateClassNames
:func:`~wbemcli.gc` GetClass
:func:`~wbemcli.mc` ModifyClass
:func:`~wbemcli.cc` CreateClass
:func:`~wbemcli.dc` DeleteClass
--------------------- --------------------------------------------------------
:func:`~wbemcli.eq` EnumerateQualifiers
:func:`~wbemcli.gq` GetQualifier
:func:`~wbemcli.sq` SetQualifier
:func:`~wbemcli.dq` DeleteQualifier
--------------------- --------------------------------------------------------
:func:`~wbemcli.h` Print help text for interactive environment
:func:`~wbemcli.pdb` Run a statement under the PDB debugger
``pp()`` Alias for :func:`~py:pprint.pprint`
===================== ========================================================
The interactive Python environment of the ``wbemcli`` command has ``wbemcli``
as its current Python namespace, so the functions shown below can directly be
invoked (e.g. ``ei(...)``).
"""
from __future__ import absolute_import, print_function
# 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 traceback
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:
_HAVE_READLINE = False
from pywbem import WBEMConnection, MOFParseError
from pywbem.cim_http import get_default_ca_cert_paths
from pywbem._cliutils import SmartFormatter as _SmartFormatter
from pywbem.config import DEFAULT_ITER_MAXOBJECTCOUNT
from pywbem._logging import LOG_DESTINATIONS, \
LOG_DETAIL_LEVELS, LOGGER_SIMPLE_NAMES, DEFAULT_LOG_DETAIL_LEVEL, \
DEFAULT_LOG_DESTINATION, configure_loggers_from_string
from pywbem import __version__
from pywbem_mock import FakedWBEMConnection
# 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
WBEMCLI_LOG_FILENAME = 'wbemcli.log'
def _build_mock_repository(conn_, file_path_list, verbose):
"""
Build the mock repository from the file_path list and fake connection
instance. This allows both mof files and python files to be used to
build the repository.
If verbose is True, it displays the respository after it is build as
mof.
"""
for file_path in file_path_list:
ext = _os.path.splitext(file_path)[1]
if not _os.path.exists(file_path):
raise ValueError("Mock file not found: %s" % file_path)
if ext == '.mof':
try:
conn_.compile_mof_file(file_path)
# any MOF parse errors have already been displayed.
except MOFParseError:
raise ValueError(
"Mock MOF file %r failed compiling (see above)" %
file_path)
elif ext == '.py':
try:
with open(file_path) as fp:
# the exec includes CONN and VERBOSE
globalparams = {'CONN': conn_, 'VERBOSE': verbose}
# pylint: disable=exec-used
file_source = fp.read()
try:
file_code = compile(file_source, file_path, 'exec')
# pylint: disable=exec-used
exec(file_code, globalparams, None)
except Exception:
exc_type, exc_value, exc_traceback = _sys.exc_info()
tb = traceback.format_exception(exc_type, exc_value,
exc_traceback)
raise ValueError(
"Mock script %r failed during execution.\n"
"%s" % (file_path, "\n".join(tb)))
except IOError as exc:
raise ValueError(
"Mock script %r cannot be opened: %s" % (file_path, exc))
else:
raise ValueError(
"Mock file %r has invalid suffix %r "
"(must be '.py' or '.mof')" % (file_path, ext))
if verbose:
conn_.display_repository()
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 opts.timeout is not None:
if opts.timeout < 0 or opts.timeout > 300:
argparser_.error(
"--timeout value out of range: %s (range is 0 to 300)" %
opts.timeout)
# mock only uses the namespace timeout and statistics options from the
# original set of options. It ignores the url
if opts.mock_server:
CONN = FakedWBEMConnection(
default_namespace=opts.namespace,
timeout=opts.timeout,
stats_enabled=opts.statistics)
try:
_build_mock_repository(CONN, opts.mock_server, opts.verbose)
except ValueError as ve:
_error("Building the mock repository failed: %s" % ve)
return CONN
if server[0] == '/':
url = server
else:
m = re.match(r"^([a-zA-Z0-9]+)://", server)
if m is not None:
scheme = m.group(1)
if scheme not in ('http', 'https'):
argparser_.error(
"Invalid scheme on server argument: %s "
"(Valid schemes are 'http' or 'https')" % scheme)
url = server
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 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,
stats_enabled=opts.statistics)
CONN.debug = True
return CONN
#
# Create convenient global functions to reduce typing
#
def ei(cn, ns=None, lo=None, di=None, iq=None, ico=None, pl=None):
# pylint: disable=redefined-outer-name, too-many-arguments
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.EnumerateInstances`.
Enumerate the instances of a class (including instances of its subclasses)
in a namespace.
Parameters:
cn (:term:`string` or :class:`~pywbem.CIMClassName`):
Name of the class to be enumerated (case independent).
If specified as a `CIMClassName` object, its `host` attribute will be
ignored.
ns (:term:`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 (:class:`py:bool`):
LocalOnly flag: Exclude inherited properties.
`None` will cause the server default of `True` to be used.
Deprecated in :term:`DSP0200`: WBEM server implementations for `True`
may vary; this parameter should be set to `False` by the caller.
di (:class:`py: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 (:class:`py:bool`):
IncludeQualifiers flag: Include qualifiers.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200`: Clients cannot rely on qualifiers to
be returned in this operation.
ico (:class:`py:bool`):
IncludeClassOrigin flag: Include class origin information for the
properties in the retrieved instances.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200`: WBEM servers may either implement this
parameter as specified, or may treat any specified value as `False`.
pl (:term:`string` or :term:`py:iterable` of :term:`string`):
PropertyList: Names of properties to be included (if not otherwise
excluded). An empty iterable indicates to include no properties.
If `None`, all properties will be included.
Returns:
list of :class:`~pywbem.CIMInstance`:
The instances, with their `path` attribute being a
:class:`~pywbem.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 ein(cn, ns=None):
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.EnumerateInstanceNames`.
Enumerate the instance paths of instances of a class (including instances
of its subclasses) in a namespace.
Parameters:
cn (:term:`string` or :class:`~pywbem.CIMClassName`):
Name of the class to be enumerated (case independent).
If specified as a `CIMClassName` object, its `host` attribute will be
ignored.
ns (:term:`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 :class:`~pywbem.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)
def gi(ip, lo=None, iq=None, ico=None, pl=None):
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.GetInstance`.
Retrieve an instance.
Parameters:
ip (:class:`~pywbem.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 (:class:`py:bool`):
LocalOnly flag: Exclude inherited properties.
`None` will cause the server default of `True` to be used.
Deprecated in :term:`DSP0200`: WBEM server implementations for `True`
may vary; this parameter should be set to `False` by the caller.
iq (:class:`py:bool`):
IncludeQualifiers flag: Include qualifiers.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200`: Clients cannot rely on qualifiers to
be returned in this operation.
ico (:class:`py:bool`):
IncludeClassOrigin flag: Include class origin information for the
properties in the retrieved instance.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200`: WBEM servers may either implement this
parameter as specified, or may treat any specified value as `False`.
pl (:term:`string` or :term:`py:iterable` of :term:`string`):
PropertyList: Names of properties to be included (if not otherwise
excluded). An empty iterable indicates to include no properties.
If `None`, all properties will be included.
Returns:
:class:`~pywbem.CIMInstance`:
The instance, with its `path` attribute being a
:class:`~pywbem.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):
# pylint: disable=redefined-outer-name
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.ModifyInstance`.
Modify the property values of an instance.
Parameters:
mi (:class:`~pywbem.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 (:class:`py:bool`):
IncludeQualifiers flag: Modify instance qualifiers as specified in
the instance.
`None` will cause the server default of `True` to be used.
Deprecated in :term:`DSP0200`: Clients cannot rely on qualifiers to
be modified by this operation.
pl (:term:`string` or :term:`py:iterable` of :term:`string`):
PropertyList: Names of properties to be modified. An empty iterable
indicates to modify no properties. If `None`, all properties exposed
by the instance will be modified.
"""
CONN.ModifyInstance(mi,
IncludeQualifiers=iq,
PropertyList=pl)
def ci(ni, ns=None):
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.CreateInstance`.
Create an instance in a namespace.
Parameters:
ni (:class:`~pywbem.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.
Instance-level qualifiers have been deprecated in CIM, so any
qualifier values specified using the `qualifiers` attribute
of this object will be ignored.
ns (:term:`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 of the new instance, 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):
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.DeleteInstance`.
Delete an instance.
Parameters:
ip (:class:`~pywbem.CIMInstanceName`):
Instance path of the instance to be deleted.
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 a(op, ac=None, rc=None, r=None, rr=None, iq=None, ico=None, pl=None):
# pylint: disable=too-many-arguments, redefined-outer-name, invalid-name
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.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 (:class:`~pywbem.CIMInstanceName`):
Source instance path; select instance-level use.
op (:class:`~pywbem.CIMClassName`):
Source class path; select class-level use.
ac (:term:`string`):
AssocClass filter: Include only traversals across this association
class.
`None` means this filter is not applied.
rc (:term:`string`):
ResultClass filter: Include only traversals to this associated
(result) class.
`None` means this filter is not applied.
r (:term:`string`):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
rr (:term:`string`):
ResultRole filter: Include only traversals to this role (= reference
name) in associated (=result) objects.
`None` means this filter is not applied.
iq (:class:`py:bool`):
IncludeQualifiers flag: Include qualifiers.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200`: Clients cannot rely on qualifiers to
be returned in this operation.
ico (:class:`py:bool`):
IncludeClassOrigin flag: Include class origin information for the
properties in the retrieved instances or for the properties and
methods in the retrieved classes.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200` for instance-level use: WBEM servers
may either implement this parameter as specified, or may treat any
specified value as `False`.
pl (:term:`string` or :term:`py:iterable` of :term:`string`):
PropertyList: Names of properties to be included (if not otherwise
excluded). An empty iterable indicates to include no properties.
If `None`, all properties will be included.
Returns:
list of result objects:
* For instance-level use, a list of :class:`~pywbem.CIMInstance` objects
representing the retrieved instances, with their `path` attribute
being a :class:`~pywbem.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 retrieved classes, with the following (unnamed) tuple items:
* classpath (:class:`~pywbem.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 (:class:`~pywbem.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 an(op, ac=None, rc=None, r=None, rr=None):
# pylint: disable=redefined-outer-name, invalid-name
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.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 (:class:`~pywbem.CIMInstanceName`):
Source instance path; select instance-level use.
op (:class:`~pywbem.CIMClassName`):
Source class path; select class-level use.
ac (:term:`string`):
AssocClass filter: Include only traversals across this association
class.
`None` means this filter is not applied.
rc (:term:`string`):
ResultClass filter: Include only traversals to this associated
(result) class.
`None` means this filter is not applied.
r (:term:`string`):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
rr (:term:`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 result objects:
* For instance-level use, a list of :class:`~pywbem.CIMInstanceName`
objects representing the retrieved 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 :class:`~pywbem.CIMClassName` objects
representing the retrieved 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)
def r(op, rc=None, r=None, iq=None, ico=None, pl=None):
# pylint: disable=redefined-outer-name, invalid-name, invalid-name
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.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 (:class:`~pywbem.CIMInstanceName`):
Source instance path; select instance-level use.
op (:class:`~pywbem.CIMClassName`):
Source class path; select class-level use.
rc (:term:`string`):
ResultClass filter: Include only traversals across this association
(result) class.
`None` means this filter is not applied.
r (:term:`string`):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
iq (:class:`py:bool`):
IncludeQualifiers flag: Include qualifiers.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200`: Clients cannot rely on qualifiers to
be returned in this operation.
ico (:class:`py:bool`):
IncludeClassOrigin flag: Include class origin information for the
properties in the retrieved instances or for the properties and
methods in the retrieved classes.
`None` will cause the server default of `False` to be used.
Deprecated in :term:`DSP0200` for instance-level use: WBEM servers
may either implement this parameter as specified, or may treat any
specified value as `False`.
pl (:term:`string` or :term:`py:iterable` of :term:`string`):
PropertyList: Names of properties to be included (if not otherwise
excluded). An empty iterable indicates to include no properties.
If `None`, all properties will be included.
Returns:
list of result objects:
* For instance-level use, a list of :class:`~pywbem.CIMInstance` objects
representing the retrieved instances, with their `path` attribute
being a :class:`~pywbem.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 retrieved classes, with the following (unnamed) tuple items:
* classpath (:class:`~pywbem.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 (:class:`~pywbem.CIMClass`): The representation of the class.
"""
return CONN.References(op,
ResultClass=rc,
Role=r,
IncludeQualifiers=iq,
IncludeClassOrigin=ico,
PropertyList=pl)
def rn(op, rc=None, r=None):
# pylint: disable=redefined-outer-name, invalid-name
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.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 (:class:`~pywbem.CIMInstanceName`):
Source instance path; select instance-level use.
op (:class:`~pywbem.CIMClassName`):
Source class path; select class-level use.
rc (:term:`string`):
ResultClass filter: Include only traversals across this association
(result) class.
`None` means this filter is not applied.
r (:term:`string`):
Role filter: Include only traversals from this role (= reference
name) in source object.
`None` means this filter is not applied.
Returns:
list of result objects:
* For instance-level use, a list of :class:`~pywbem.CIMInstanceName`
objects representing the retrieved 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 :class:`~pywbem.CIMClassName` objects
representing the retrieved 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 im(mn, op, params, **kwparams):
"""
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.InvokeMethod`.
Invoke a method on a target instance or on a target class.
The methods that can be invoked are static and non-static methods defined
in a class (also known as *extrinsic* methods). Static methods can be
invoked on instances and on classes. Non-static methods can be invoked only
on instances.
Parameters:
mn (:term:`string`):
Method name.
op (:class:`~pywbem.CIMInstanceName`):
Target instance path.
op (:class:`~pywbem.CIMClassName`):
Target class path.
params (:term:`py:iterable`):
Input parameters for the method.
Each item in the iterable is a single parameter value and can be any
of:
* :class:`~pywbem.CIMParameter` representing a parameter value. The
`name`, `value`, `type` and `embedded_object` attributes of this
object are used.
* tuple of name, value, with:
- name (:term:`string`): Parameter name (case independent)
- value (:term:`CIM data type`): Parameter value
**kwparams (named/keyword arguments):
Input parameters for the method.
* key (:term:`string`): Parameter name (case independent)
* value (:term:`CIM data type`): Parameter value
Returns:
tuple(rv, out), with these tuple items:
* rv (:term:`CIM data type`):
Return value of the CIM method.
* out (:ref:`NocaseDict`):
Dictionary with all provided output parameters of the CIM method,
with:
* key (:term:`unicode string`):
Parameter name
* value (:term:`CIM data type`):
Parameter value
"""
return CONN.InvokeMethod(mn, op, params, **kwparams)
def eqy(ql, qs, ns=None,):
"""
*New in pywbem 0.12*
This function is a wrapper for :meth:`~pywbem.WBEMConnection.ExecQuery`.
Execute a query in a namespace.
Parameters:
ql (:term:`string`):
Name of the query language used in the `qs` parameter, e.g.
"DMTF:CQL" for CIM Query Language, and "WQL" for WBEM Query
Language. Because this is not a filter query, "DMTF:FQL" is not a
valid query language for this request.
qs (:term:`string`):
Query string in the query language specified in the `ql` parameter.
ns (:term:`string`):
Name of the CIM namespace to be used (case independent).
If `None`, defaults to the default namespace of the connection.
Returns:
A list of :class:`~pywbem.CIMInstance` objects that represents
the query result.
These instances have their `path` attribute set to identify
their creation class and the target namespace of the query, but
they are not addressable instances.
""" # noqa: E501
return CONN.ExecQuery(QueryLanguage=ql,
Query=qs,
namespace=ns)
def iei(cn, ns=None, lo=None, di=None, iq=None, ico=None, pl=None, fl=None,
fs=None, ot=None, coe=None, moc=DEFAULT_ITER_MAXOBJECTCOUNT,):
# pylint: disable=too-many-arguments, redefined-outer-name
"""
*New in pywbem 0.10 as experimental and finalized in 0.12.*
This function is a wrapper for
:meth:`~pywbem.WBEMConnection.IterEnumerateInstances`.
Enumerate the instances of a class (including instances of its
subclasses) in a namespace,