File: ProfileManager.rst

package info (click to toggle)
python-pyvmomi 6.7.1-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,984 kB
  • sloc: python: 9,206; xml: 77; makefile: 9
file content (123 lines) | stat: -rw-r--r-- 2,887 bytes parent folder | download | duplicates (5)
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
.. _str: https://docs.python.org/2/library/stdtypes.html

.. _vim.Task: ../../vim/Task.rst

.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5

.. _vim.ManagedEntity: ../../vim/ManagedEntity.rst

.. _vim.profile.Profile: ../../vim/profile/Profile.rst

.. _vim.fault.DuplicateName: ../../vim/fault/DuplicateName.rst

.. _vim.profile.PolicyMetadata: ../../vim/profile/PolicyMetadata.rst

.. _vmodl.fault.InvalidArgument: ../../vmodl/fault/InvalidArgument.rst

.. _vim.profile.Profile.CreateSpec: ../../vim/profile/Profile/CreateSpec.rst

.. _vim.fault.InvalidProfileReferenceHost: ../../vim/fault/InvalidProfileReferenceHost.rst


vim.profile.ProfileManager
==========================
  This Class is responsible for managing Profiles.


:since: `vSphere API 4.0`_


Attributes
----------
    profile ([`vim.profile.Profile`_]):
      privilege: Profile.View
       A list of profiles known to this ProfileManager.


Methods
-------


CreateProfile(createSpec):
   Create a profile from the specified CreateSpec.


  Privilege:
               Profile.Create



  Args:
    createSpec (`vim.profile.Profile.CreateSpec`_):
       Specification for the profile being created. Usually a derived class CreateSpec can be used to create the Profile.




  Returns:
    `vim.profile.Profile`_:
         Profile created from the specified createSpec.

  Raises:

    `vim.fault.DuplicateName`_: 
       If a profile with the specified name already exists.

    `vim.fault.InvalidProfileReferenceHost`_: 
       if the specified reference host is incompatible or no reference host has been specifed.


QueryPolicyMetadata(policyName, profile):
   Get the Metadata information for the policyNames. PolicyNames are available with the defaultProfile obtained by invoking the method createDefaultProfile.


  Privilege:
               System.View



  Args:
    policyName (`str`_, optional):
       Retrieve metadata for the specified policyNames. If policyName is not specified, metadata for all policies will be returned.


    profile (`vim.profile.Profile`_, optional, since `vSphere API 5.0`_ ):
       Base profile whose context needs to be used during the operation




  Returns:
    [`vim.profile.PolicyMetadata`_]:
         The metadata information for the policy.

  Raises:

    `vmodl.fault.InvalidArgument`_: 
       If policyName is invalid.

    `vim.fault.InvalidProfileReferenceHost`_: 
       if the reference host associated with the profile is incompatible or there is no reference host for the profile.


FindAssociatedProfile(entity):
   Get the profile(s) to which this entity is associated. The list of profiles will only include profiles known to this profileManager.


  Privilege:
               System.View



  Args:
    entity (`vim.ManagedEntity`_):
       Entity for which profile is being looked up.




  Returns:
    [`vim.profile.Profile`_]: