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
|
.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../../vim/Task.rst
.. _datetime: https://docs.python.org/2/library/stdtypes.html
.. _CreateProfile: ../../vim/profile/ProfileManager.rst#createProfile
.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5
.. _vSphere API 5.0: ../../vim/version.rst#vimversionversion7
.. _vim.ManagedEntity: ../../vim/ManagedEntity.rst
.. _HostProfileManager: ../../vim/profile/host/ProfileManager.rst
.. _ComplianceResultStatus: ../../vim/profile/ComplianceResult/Status.rst
.. _vmodl.fault.InvalidType: ../../vmodl/fault/InvalidType.rst
.. _CheckProfileCompliance_Task: ../../vim/profile/Profile.rst#checkCompliance
.. _ProfileSerializedCreateSpec: ../../vim/profile/Profile/SerializedCreateSpec.rst
.. _vmodl.fault.InvalidArgument: ../../vmodl/fault/InvalidArgument.rst
.. _vim.profile.ComplianceResult: ../../vim/profile/ComplianceResult.rst
.. _vim.profile.Profile.ConfigInfo: ../../vim/profile/Profile/ConfigInfo.rst
.. _vim.profile.Profile.Description: ../../vim/profile/Profile/Description.rst
.. _vim.fault.InvalidProfileReferenceHost: ../../vim/fault/InvalidProfileReferenceHost.rst
vim.profile.Profile
===================
TheProfilemanaged object is the base class for host and cluster profiles.
:since: `vSphere API 4.0`_
Attributes
----------
config (`vim.profile.Profile.ConfigInfo`_):
privilege: Profile.Edit
Configuration data for the profile.
description (`vim.profile.Profile.Description`_):
Localizable description of the profile
name (`str`_):
Name of the profile.
createdTime (`datetime`_):
Time at which the profile was created.
modifiedTime (`datetime`_):
Time at which the profile was last modified.
entity ([`vim.ManagedEntity`_]):
List of managed entities associated with the profile.
complianceStatus (`str`_):
Overall compliance of entities associated with this profile. If one of the entities is out of compliance, the profile isnonCompliant. If all entities are in compliance, the profile iscompliant. If the compliance status of one of the entities is not known, compliance status of the profile isunknown. See `ComplianceResultStatus`_ .
Methods
-------
RetrieveDescription():
Returns the localizable description for the profile.
since: `vSphere API 5.0`_
Privilege:
System.View
Args:
Returns:
`vim.profile.Profile.Description`_:
Profile divided into sections containing element descriptions and messages.
Raises:
`vim.fault.InvalidProfileReferenceHost`_:
if the reference host associated with the profile is incompatible or there is no reference host for the profile.
DestroyProfile():
Destroy the profile.
Privilege:
Profile.Delete
Args:
Returns:
None
AssociateProfile(entity):
Associate a profile with a managed entity. You can check the compliance of entities associated with a profile by calling the `CheckProfileCompliance_Task`_ method.
Privilege:
Profile.Edit
Args:
entity (`vim.ManagedEntity`_):
The entity(s) to associate with the profile. If an entity is already associated with the profile, the association is maintained and the vCenter Server does not perform any action.
Returns:
None
Raises:
`vmodl.fault.InvalidType`_:
If the entity is of an unexpeted type.
`vmodl.fault.InvalidArgument`_:
If the association conflicts with existing association.
DissociateProfile(entity):
Remove the association between a profile and a managed entity.
Privilege:
Profile.Edit
Args:
entity (`vim.ManagedEntity`_, optional):
List of entities. The vCenter Server will remove the associations that the profile has with the entities in the list. If unset, the Server removes all the associations that the profile has with any managed entities in the inventory. If the specified entity is not associated with the profile, the Server does not perform any action.
Returns:
None
Raises:
`vmodl.fault.InvalidArgument`_:
If the dissociation conflicts with existing association.
CheckProfileCompliance(entity):
Check compliance of an entity against a Profile.
Privilege:
System.View
Args:
entity (`vim.ManagedEntity`_, optional):
If specified, the compliance check is performed on this entity. If the entity is not specified, the vCenter Server runs a compliance check on all the entities associated with the profile. The entity does not have to be associated with the profile.
Returns:
`vim.Task`_:
The compliance result.
Raises:
`vim.fault.InvalidProfileReferenceHost`_:
if the reference host associated with the profile is incompatible or there is no reference host for the profile.
ExportProfile():
Export the profile in a serialized form. To use the serialized string to create a profile, specify a `ProfileSerializedCreateSpec`_ when you call the `HostProfileManager`_ . `CreateProfile`_ method.
Privilege:
Profile.Export
Args:
Returns:
`str`_:
Serialized form of the profile.
|
