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
use std::sync::Arc;
use crate::core::client::{VimClient, Result};
/// The *PbmPlacementSolver* data object provides methods to identify
/// placement hubs that support the capabilities to store virtual
/// machine files.
///
/// A placement hub is a datastore or a storage pod.
/// A vSphere API <code>StoragePod</code> corresponds to Storage DRS in the vSphere Web Client.
#[derive(Clone)]
pub struct PbmPlacementSolver {
client: Arc<dyn VimClient>,
mo_id: String,
}
impl PbmPlacementSolver {
pub fn new(client: Arc<dyn VimClient>, mo_id: &str) -> Self {
Self {
client,
mo_id: mo_id.to_string(),
}
}
/// Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements* instead in order to retrieve compatibility status on both compute and storage
/// location.
///
/// Performs placement compatibility checking based on a storage requirement
/// profile.
///
/// If compatibility checking for a hub does not produce any errors,
/// the hub is considered a viable candidate for virtual machine file storage.
/// If this method is invoked for
/// *VVolDefaultProfile*
/// profile, then all the VVOL containers are returned as matching.
///
/// ***Required privileges:*** StorageProfile.View
///
/// ## Parameters:
///
/// ### hubs_to_search
/// Candidate list of hubs, either datastores or storage pods or a
/// mix. If this parameter is not specified, the Server uses all
/// of the datastores and storage pods for placement compatibility
/// checking.
///
/// ### profile
/// Storage requirement profile.
///
/// ## Returns:
///
/// Array of compatibility result objects. The results array contains
/// one entry for each entry in the <code>hubsToSearch</code> list. If
/// a hubs list is not specified, the results array contains one
/// entry for each datastore and storage pod in your vSphere
/// environment. Any errors are described in the results array.
/// - If there is an invalid argument error, the compatibility
/// results will contain <code>InvalidArgument</code> faults
/// indicating that the profile does not exist or that it does not
/// match the requirement type.
/// - If there are errors or warnings during compatibility checking,
/// the compatibility results will contain faults derived from
/// *PbmCompatibilityCheckFault*.
/// - If this method is invoked for
/// *VVolDefaultProfile*
/// then the compatibility results will contain faults derived from
/// *PbmCompatibilityCheckFault* for non-vvol datastores.
pub async fn pbm_check_compatibility(&self, hubs_to_search: Option<&[crate::types::structs::PbmPlacementHub]>, profile: &crate::types::structs::PbmProfileId) -> Result<Option<Vec<crate::types::structs::PbmPlacementCompatibilityResult>>> {
let input = PbmCheckCompatibilityRequestType {hubs_to_search, profile, };
let bytes_opt = self.client.invoke_optional("pbm", "PbmPlacementSolver", &self.mo_id, "PbmCheckCompatibility", Some(&input)).await?;
match bytes_opt {
Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
None => Ok(None),
}
}
/// Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements* instead in order to retrieve compatibility status for both
/// compute and storage location.
///
/// Performs placement compatibility checking based on a storage profile
/// specification.
///
/// If compatibility checking for a hub does not produce
/// any errors, the hub is considered a viable candidate for virtual
/// machine file storage.
///
/// ***Required privileges:*** StorageProfile.View
///
/// ## Parameters:
///
/// ### hubs_to_search
/// Candidate list of hubs, either datastores or storage pods
/// or a mix. If this parameter is not specified, the Server uses all of the
/// datastores and storage pods for placement compatibility checking.
///
/// ### profile_spec
/// Specification for a capability based profile.
///
/// ## Returns:
///
/// Array of compatibility result objects. The results array contains
/// one entry for each entry in the <code>hubsToSearch</code> list.
/// If a hubs list is not specified, the results array contains one entry
/// for each datastore and storage pod in your vSphere environment.
/// Any errors are described in the results array.
/// - If there is an invalid argument error, the compatibility results
/// will contain <code>InvalidArgument</code> faults indicating that the
/// profile does not exist or that it does not match the requirement type.
/// - If there are errors or warnings during compatibility checking,
/// the compatibility results will contain faults derived from
/// *PbmCompatibilityCheckFault*.
pub async fn pbm_check_compatibility_with_spec(&self, hubs_to_search: Option<&[crate::types::structs::PbmPlacementHub]>, profile_spec: &crate::types::structs::PbmCapabilityProfileCreateSpec) -> Result<Option<Vec<crate::types::structs::PbmPlacementCompatibilityResult>>> {
let input = PbmCheckCompatibilityWithSpecRequestType {hubs_to_search, profile_spec, };
let bytes_opt = self.client.invoke_optional("pbm", "PbmPlacementSolver", &self.mo_id, "PbmCheckCompatibilityWithSpec", Some(&input)).await?;
match bytes_opt {
Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
None => Ok(None),
}
}
/// Performs placement compatibility checking for the specified object to be placed based on its
/// specified set of requirements.
///
/// If compatibility checking for a hub does not produce any
/// errors, the hub is considered a viable candidate for virtual machine storage.
///
/// ***Required privileges:*** StorageProfile.View
///
/// ## Parameters:
///
/// ### hubs_to_search
/// Candidate list of hubs, either datastores or storage pods
/// or a mix. If this parameter is not specified, the Server uses all of the
/// datastores and storage pods for placement compatibility checking.
///
/// ### placement_subject_ref
/// reference to the object being placed. Should be null when a new
/// object is being provisioned. Should be specified when placement compatibility is being checked
/// for an existing object. Supported objects are
/// *virtualMachine*,
/// *virtualMachineAndDisks*,
/// *virtualDiskId*,
/// *virtualDiskUUID*
///
/// ### placement_subject_requirement
/// Requirements including the policy requirements, compute
/// requirements and capacity requirements. It is invalid to specify no requirements. It is also
/// invalid to specify duplicate requirements or multiple conflicting requirements such as
/// specifying both *PbmPlacementCapabilityConstraintsRequirement* and
/// *PbmPlacementCapabilityProfileRequirement*.
///
/// ## Returns:
///
/// Array of compatibility result objects. The results array contains
/// one entry for each entry in the <code>hubsToSearch</code> list.
/// If hubs list is not specified, the results array contains one entry
/// for each datastore and storage pod in your vSphere environment.
/// Any errors are returned in the results array.
/// - If there is an invalid argument error, the compatibility results
/// will contain <code>InvalidArgument</code> faults indicating that the
/// profile does not exist or that it does not match the requirement type.
/// - If there are errors or warnings during compatibility checking,
/// the compatibility results will contain faults derived from
/// *PbmCompatibilityCheckFault*.
///
/// ## Errors:
///
/// ***InvalidArgument***: if <code>placementSubjectRequirement</code> is null or empty or if
/// there are duplicate or multiple conflicting requirements such as
/// *PbmPlacementCapabilityConstraintsRequirement* and *PbmPlacementCapabilityProfileRequirement* both being
/// specified.
///
/// ***PbmFault***: If there is an internal server error.
pub async fn pbm_check_requirements(&self, hubs_to_search: Option<&[crate::types::structs::PbmPlacementHub]>, placement_subject_ref: Option<&crate::types::structs::PbmServerObjectRef>, placement_subject_requirement: Option<&[Box<dyn crate::types::traits::PbmPlacementRequirementTrait>]>) -> Result<Option<Vec<crate::types::structs::PbmPlacementCompatibilityResult>>> {
let input = PbmCheckRequirementsRequestType {hubs_to_search, placement_subject_ref, placement_subject_requirement, };
let bytes_opt = self.client.invoke_optional("pbm", "PbmPlacementSolver", &self.mo_id, "PbmCheckRequirements", Some(&input)).await?;
match bytes_opt {
Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
None => Ok(None),
}
}
/// Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements*
/// instead in order to retrieve both compatible compute and storage location.
///
/// Finds matching placement hubs for the specified requirements profile.
///
/// This
/// method returns only those hubs that match the profile. If this method is
/// invoked for
/// *VVolDefaultProfile*
/// profile, then all the VVOL containers are returned as matching.
///
/// ***Required privileges:*** StorageProfile.View
///
/// ## Parameters:
///
/// ### hubs_to_search
/// Candidate list of hubs, either datastores or storage pods or a
/// mix. If this parameter is not specified, the Server uses all
/// of the datastores and storage pods.
///
/// ### profile
/// Storage requirement profile.
///
/// ## Returns:
///
/// Subset of the <code>hubsToSearch</code> list that satisfies the
/// profile requirements. A storage pod is returned if and only if all
/// its member datastores satisfy the profile requirements, whether
/// the hubs list contains any of the member datastores or not. If a
/// datastore and its storage pod are in the hubs list, and both
/// satisfy the requirements, both are returned.
///
/// ## Errors:
///
/// ***PbmFault***: If there is an internal server error.
pub async fn pbm_query_matching_hub(&self, hubs_to_search: Option<&[crate::types::structs::PbmPlacementHub]>, profile: &crate::types::structs::PbmProfileId) -> Result<Option<Vec<crate::types::structs::PbmPlacementHub>>> {
let input = PbmQueryMatchingHubRequestType {hubs_to_search, profile, };
let bytes_opt = self.client.invoke_optional("pbm", "PbmPlacementSolver", &self.mo_id, "PbmQueryMatchingHub", Some(&input)).await?;
match bytes_opt {
Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
None => Ok(None),
}
}
/// Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements* instead in order to retrieve both compatible compute and storage location.
///
/// Finds matching placement hubs based on a profile creation specification.
///
/// This method returns only those hubs that match the specification.
///
/// ***Required privileges:*** StorageProfile.View
///
/// ## Parameters:
///
/// ### hubs_to_search
/// Candidate list of hubs, either datastores or storage
/// pods or a mix. If this parameter is not specified, the Server uses
/// all of the datastores and storage pods for placement compatibility checking.
///
/// ### create_spec
/// Storage profile creation specification.
///
/// ## Returns:
///
/// Subset of the <code>hubsToSearch</code> list that satisfies the profile
/// requirements. A storage pod is returned if and only if all its member datastores
/// satisfy the profile requirements, whether the hubs list contains
/// any of the member datastores or not. If a datastore and its storage pod
/// are in the hubs list, and both satisfy the requirements, both are returned.
///
/// ## Errors:
///
/// ***PbmFault***: If there is an internal server error.
pub async fn pbm_query_matching_hub_with_spec(&self, hubs_to_search: Option<&[crate::types::structs::PbmPlacementHub]>, create_spec: &crate::types::structs::PbmCapabilityProfileCreateSpec) -> Result<Option<Vec<crate::types::structs::PbmPlacementHub>>> {
let input = PbmQueryMatchingHubWithSpecRequestType {hubs_to_search, create_spec, };
let bytes_opt = self.client.invoke_optional("pbm", "PbmPlacementSolver", &self.mo_id, "PbmQueryMatchingHubWithSpec", Some(&input)).await?;
match bytes_opt {
Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
None => Ok(None),
}
}
}
struct PbmCheckCompatibilityRequestType<'a> {
hubs_to_search: Option<&'a [crate::types::structs::PbmPlacementHub]>,
profile: &'a crate::types::structs::PbmProfileId,
}
impl<'a> miniserde::Serialize for PbmCheckCompatibilityRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(PbmCheckCompatibilityRequestTypeSer { data: self, seq: 0 }))
}
}
struct PbmCheckCompatibilityRequestTypeSer<'b, 'a> {
data: &'b PbmCheckCompatibilityRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for PbmCheckCompatibilityRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
loop {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"PbmCheckCompatibilityRequestType")),
1 => {
let Some(ref val) = self.data.hubs_to_search else { continue; };
return Some((std::borrow::Cow::Borrowed("hubsToSearch"), val as &dyn miniserde::Serialize));
}
2 => return Some((std::borrow::Cow::Borrowed("profile"), &self.data.profile as &dyn miniserde::Serialize)),
_ => return None,
}
}
}
}
struct PbmCheckCompatibilityWithSpecRequestType<'a> {
hubs_to_search: Option<&'a [crate::types::structs::PbmPlacementHub]>,
profile_spec: &'a crate::types::structs::PbmCapabilityProfileCreateSpec,
}
impl<'a> miniserde::Serialize for PbmCheckCompatibilityWithSpecRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(PbmCheckCompatibilityWithSpecRequestTypeSer { data: self, seq: 0 }))
}
}
struct PbmCheckCompatibilityWithSpecRequestTypeSer<'b, 'a> {
data: &'b PbmCheckCompatibilityWithSpecRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for PbmCheckCompatibilityWithSpecRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
loop {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"PbmCheckCompatibilityWithSpecRequestType")),
1 => {
let Some(ref val) = self.data.hubs_to_search else { continue; };
return Some((std::borrow::Cow::Borrowed("hubsToSearch"), val as &dyn miniserde::Serialize));
}
2 => return Some((std::borrow::Cow::Borrowed("profileSpec"), &self.data.profile_spec as &dyn miniserde::Serialize)),
_ => return None,
}
}
}
}
struct PbmCheckRequirementsRequestType<'a> {
hubs_to_search: Option<&'a [crate::types::structs::PbmPlacementHub]>,
placement_subject_ref: Option<&'a crate::types::structs::PbmServerObjectRef>,
placement_subject_requirement: Option<&'a [Box<dyn crate::types::traits::PbmPlacementRequirementTrait>]>,
}
impl<'a> miniserde::Serialize for PbmCheckRequirementsRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(PbmCheckRequirementsRequestTypeSer { data: self, seq: 0 }))
}
}
struct PbmCheckRequirementsRequestTypeSer<'b, 'a> {
data: &'b PbmCheckRequirementsRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for PbmCheckRequirementsRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
loop {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"PbmCheckRequirementsRequestType")),
1 => {
let Some(ref val) = self.data.hubs_to_search else { continue; };
return Some((std::borrow::Cow::Borrowed("hubsToSearch"), val as &dyn miniserde::Serialize));
}
2 => {
let Some(ref val) = self.data.placement_subject_ref else { continue; };
return Some((std::borrow::Cow::Borrowed("placementSubjectRef"), val as &dyn miniserde::Serialize));
}
3 => {
let Some(ref val) = self.data.placement_subject_requirement else { continue; };
return Some((std::borrow::Cow::Borrowed("placementSubjectRequirement"), val as &dyn miniserde::Serialize));
}
_ => return None,
}
}
}
}
struct PbmQueryMatchingHubRequestType<'a> {
hubs_to_search: Option<&'a [crate::types::structs::PbmPlacementHub]>,
profile: &'a crate::types::structs::PbmProfileId,
}
impl<'a> miniserde::Serialize for PbmQueryMatchingHubRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(PbmQueryMatchingHubRequestTypeSer { data: self, seq: 0 }))
}
}
struct PbmQueryMatchingHubRequestTypeSer<'b, 'a> {
data: &'b PbmQueryMatchingHubRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for PbmQueryMatchingHubRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
loop {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"PbmQueryMatchingHubRequestType")),
1 => {
let Some(ref val) = self.data.hubs_to_search else { continue; };
return Some((std::borrow::Cow::Borrowed("hubsToSearch"), val as &dyn miniserde::Serialize));
}
2 => return Some((std::borrow::Cow::Borrowed("profile"), &self.data.profile as &dyn miniserde::Serialize)),
_ => return None,
}
}
}
}
struct PbmQueryMatchingHubWithSpecRequestType<'a> {
hubs_to_search: Option<&'a [crate::types::structs::PbmPlacementHub]>,
create_spec: &'a crate::types::structs::PbmCapabilityProfileCreateSpec,
}
impl<'a> miniserde::Serialize for PbmQueryMatchingHubWithSpecRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(PbmQueryMatchingHubWithSpecRequestTypeSer { data: self, seq: 0 }))
}
}
struct PbmQueryMatchingHubWithSpecRequestTypeSer<'b, 'a> {
data: &'b PbmQueryMatchingHubWithSpecRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for PbmQueryMatchingHubWithSpecRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
loop {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"PbmQueryMatchingHubWithSpecRequestType")),
1 => {
let Some(ref val) = self.data.hubs_to_search else { continue; };
return Some((std::borrow::Cow::Borrowed("hubsToSearch"), val as &dyn miniserde::Serialize));
}
2 => return Some((std::borrow::Cow::Borrowed("createSpec"), &self.data.create_spec as &dyn miniserde::Serialize)),
_ => return None,
}
}
}
}