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
use std::sync::Arc;
use crate::core::client::{VimClient, Result};
/// Represents a storage location for virtual machine files.
///
/// A storage location can be a
/// VMFS volume, a directory on Network Attached Storage, or a local file system path.
///
/// A datastore is platform-independent and host-independent. Therefore, datastores do
/// not change when the virtual machines they contain are moved between hosts. The scope
/// of a datastore is a datacenter; the datastore is uniquely named within the
/// datacenter.
///
/// Any reference to a virtual machine or file accessed by any host within the
/// datacenter must use a datastore path. A datastore path has the form
/// "\[<datastore>\] <path>", where <datastore> is the datastore name,
/// and <path> is a slash-delimited path from the root of the datastore. An
/// example datastore path is "\[storage\] path/to/config.vmx".
///
/// You may use the following characters in a path, but not in a datastore name:
/// slash (/), backslash (\\), and percent (%).
///
/// All references to files in the VIM API are implicitly done using datastore paths.
///
/// When a client creates a virtual machine, it may specify the name of
/// the datastore, omitting the path; the system, meaning VirtualCenter or the host,
/// automatically assigns filenames and creates directories on the given datastore. For
/// example, specifying My\_Datastore as a location for a virtual machine called MyVm
/// results in a datastore location of My\_Datastore\\MyVm\\MyVm.vmx.
///
/// Datastores are configured per host. As part of host configuration, a HostSystem can
/// be configured to mount a set of network drives. Multiple hosts
/// may be configured to point to the same storage location. There exists only one
/// Datastore object per Datacenter, for each such shared location. Each Datastore
/// object keeps a reference to the set of hosts that have mounted the datastore. A
/// Datastore object can be removed only if no hosts currently have the datastore
/// mounted.
///
/// Thus, managing datastores is done both at the host level and the datacenter level.
/// Each host is configured explicitly with the set of datastores it can access. At the
/// datacenter, a view of the datastores across the datacenter is shown.
#[derive(Clone)]
pub struct Datastore {
client: Arc<dyn VimClient>,
mo_id: String,
}
impl Datastore {
pub fn new(client: Arc<dyn VimClient>, mo_id: &str) -> Self {
Self {
client,
mo_id: mo_id.to_string(),
}
}
/// Destroys this object, deleting its contents and removing it from its parent
/// folder (if any).
///
/// NOTE: The appropriate privilege must be held on the parent of the destroyed
/// entity as well as the entity itself.
/// This method can throw one of several exceptions. The exact set of exceptions
/// depends on the kind of entity that is being removed. See comments for
/// each entity for more information on destroy behavior.
///
/// ***Required privileges:*** System.Read
///
/// ## Returns:
///
/// This method returns a *Task* object with which to monitor the
/// operation.
///
/// Refers instance of *Task*.
///
/// ## Errors:
///
/// Failure
pub async fn destroy_task(&self) -> Result<crate::types::structs::ManagedObjectReference> {
let bytes = self.client.invoke("", "Datastore", &self.mo_id, "Destroy_Task", None).await?;
let result: crate::types::structs::ManagedObjectReference = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
Ok(result)
}
/// Deprecated as of VI API 2.5 do not use this method. This method throws
/// *ResourceInUse*. Datastores are automatically
/// removed when no longer in use, so this method is unnecessary.
///
/// Removes a datastore.
///
/// A datastore can be removed only if it is not currently used
/// by any host or virtual machine.
///
/// ***Required privileges:*** Datastore.Delete
///
/// ## Errors:
///
/// ***ResourceInUse***: if one or more hosts or virtual machines are configured
/// to use the datastore.
pub async fn destroy_datastore(&self) -> Result<()> {
self.client.invoke_void("", "Datastore", &self.mo_id, "DestroyDatastore", None).await
}
/// Puts the datastore in maintenance mode.
///
/// While this task is running and when the
/// datastore is in maintenance mode, no virtual machines can be powered on and no
/// provisioning operations can be performed on the datastore. Once the call
/// completes, it is safe to remove datastore without disrupting any virtual machines.
///
/// The task completes once there are no virtual machines on the datastore
/// and no provisioning operations in progress on the datastore. The operation does not
/// directly initiate any operations to evacuate or power-down powered-on virtual machines.
/// However, if the datastore is part of a storage pod with VMware Storage DRS enabled,
/// Storage DRS provides migration recommendations to evacuate the virtual
/// machines. If Storage DRS is in fully-automatic mode, these are automatically scheduled.
/// The task is cancellable.
/// This method returns a *StoragePlacementResult* object, which includes
/// a *Task* object with which to monitor the operation, and a list of recommendations
/// and faults generated by Storage DRS when it tries to evacuate the virtual machines
/// on the datastore. The recommendations and faults fields are set only if the datastore is
/// a part of a storage pod with Storage DRS enabled.
///
/// ***Required privileges:*** Datastore.Config
///
/// ## Errors:
///
/// ***InvalidState***: if the datastore is already in maintenance mode.
///
/// ***RequestCanceled***: if the operation is canceled.
pub async fn datastore_enter_maintenance_mode(&self) -> Result<crate::types::structs::StoragePlacementResult> {
let bytes = self.client.invoke("", "Datastore", &self.mo_id, "DatastoreEnterMaintenanceMode", None).await?;
let result: crate::types::structs::StoragePlacementResult = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
Ok(result)
}
/// Takes the datastore out of maintenance mode.
///
/// The task is cancellable.
///
/// ***Required privileges:*** Datastore.Config
///
/// ## Returns:
///
/// This method returns a *Task* object with which to monitor the
/// operation.
///
/// Refers instance of *Task*.
///
/// ## Errors:
///
/// ***InvalidState***: if the datastore is not in maintenance mode.
pub async fn datastore_exit_maintenance_mode_task(&self) -> Result<crate::types::structs::ManagedObjectReference> {
let bytes = self.client.invoke("", "Datastore", &self.mo_id, "DatastoreExitMaintenanceMode_Task", None).await?;
let result: crate::types::structs::ManagedObjectReference = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
Ok(result)
}
/// Check whether clustered VMDK feature is enabled on this datastore.
///
/// ***Required privileges:*** System.Read
///
/// ## Returns:
///
/// true if clustered VMDK feature is enabled. false otherwise.
///
/// ## Errors:
///
/// ***InvalidDatastore***: if the given datastore is not valid.
pub async fn is_clustered_vmdk_enabled(&self) -> Result<bool> {
let bytes = self.client.invoke("", "Datastore", &self.mo_id, "IsClusteredVmdkEnabled", None).await?;
let result: bool = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
Ok(result)
}
/// Explicitly refreshes free-space and capacity values in *Datastore.summary*
/// and *Datastore.info*.
///
/// ***Required privileges:*** System.Read
///
/// ## Errors:
///
/// ***NotFound***: if the datastore or its underlying volume is not found.
///
/// ***HostConfigFault***: if unable to get the current system information
/// for the datastore.
pub async fn refresh_datastore(&self) -> Result<()> {
self.client.invoke_void("", "Datastore", &self.mo_id, "RefreshDatastore", None).await
}
/// Refreshes all storage related information including free-space, capacity,
/// and detailed usage of virtual machines.
///
/// Updated values are available
/// in *Datastore.summary* and *Datastore.info*.
///
/// ***Required privileges:*** System.Read
pub async fn refresh_datastore_storage_info(&self) -> Result<()> {
self.client.invoke_void("", "Datastore", &self.mo_id, "RefreshDatastoreStorageInfo", None).await
}
/// Reload the entity state.
///
/// Clients only need to call this method
/// if they changed some external state that affects the service
/// without using the Web service interface to perform the change.
/// For example, hand-editing a virtual machine configuration file
/// affects the configuration of the associated virtual machine but
/// the service managing the virtual machine might not monitor the
/// file for changes. In this case, after such an edit, a client
/// would call "reload" on the associated virtual machine to ensure
/// the service and its clients have current data for the
/// virtual machine.
///
/// ***Required privileges:*** System.Read
pub async fn reload(&self) -> Result<()> {
self.client.invoke_void("", "Datastore", &self.mo_id, "Reload", None).await
}
/// Renames this managed entity.
///
/// Any % (percent) character used in this name parameter
/// must be escaped, unless it is used to start an escape
/// sequence. Clients may also escape any other characters in
/// this name parameter.
///
/// See also *ManagedEntity.name*.
///
/// ***Required privileges:*** Datastore.Rename
///
/// ## Parameters:
///
/// ### new_name
/// -
///
/// ## Returns:
///
/// This method returns a *Task* object with which to monitor the
/// operation.
///
/// Refers instance of *Task*.
///
/// ## Errors:
///
/// ***DuplicateName***: If another object in the same folder has the target name.
///
/// ***InvalidName***: If the new name is not a valid entity name.
pub async fn rename_task(&self, new_name: &str) -> Result<crate::types::structs::ManagedObjectReference> {
let input = RenameRequestType {new_name, };
let bytes = self.client.invoke("", "Datastore", &self.mo_id, "Rename_Task", Some(&input)).await?;
let result: crate::types::structs::ManagedObjectReference = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
Ok(result)
}
/// Deprecated as of vSphere API 4.0, use *ManagedEntity.Rename_Task*.
///
/// Renames a datastore.
///
/// ***Required privileges:*** Datastore.Rename
///
/// ## Parameters:
///
/// ### new_name
/// The new name to assign to the datastore.
///
/// ## Errors:
///
/// ***DuplicateName***: if another datastore in this datacenter already
/// has the same name.
///
/// ***InvalidName***: if the name is not a valid datastore name.
pub async fn rename_datastore(&self, new_name: &str) -> Result<()> {
let input = RenameDatastoreRequestType {new_name, };
self.client.invoke_void("", "Datastore", &self.mo_id, "RenameDatastore", Some(&input)).await
}
/// Assigns a value to a custom field.
///
/// The setCustomValue method requires
/// whichever updatePrivilege is defined as one of the
/// *CustomFieldDef.fieldInstancePrivileges*
/// for the CustomFieldDef whose value is being changed.
///
/// ## Parameters:
///
/// ### key
/// The name of the field whose value is to be updated.
///
/// ### value
/// Value to be assigned to the custom field.
pub async fn set_custom_value(&self, key: &str, value: &str) -> Result<()> {
let input = SetCustomValueRequestType {key, value, };
self.client.invoke_void("", "Datastore", &self.mo_id, "setCustomValue", Some(&input)).await
}
/// Scan a VVol storage container to update file paths and objectID pointers
/// embedded in virtual machine files on a given storage container.
///
/// ***Required privileges:*** Datastore.UpdateVirtualMachineFiles
///
/// ## Parameters:
///
/// ### failover_pair
/// Mapping of source to target storage container
/// as well as source to target VVol IDs.
///
/// ## Returns:
///
/// This method returns a *Task* object with which to monitor
/// the operation. The *TaskInfo.result* property in the
/// *Task* contains a
/// *VVolVmConfigFileUpdateResult* object, which
/// provides a list of successfully updated virtual machine
/// config files and a list of virtual machine config files
/// that failed to update, for all virtual machine config files
/// failed over onto the VVol storage container from the source
/// containers in the failover pair.
///
/// Refers instance of *Task*.
///
/// ## Errors:
///
/// ***NotSupported***: if all hosts attached to this datastore do not
/// support updating VVol Virtual Machine Files.
///
/// ***PlatformConfigFault***: if any error related to platform
/// occurs during the operation.
///
/// ***TaskInProgress***: if the datastore is busy, for example, while
/// another task is updating the datastore.
///
/// ***InvalidDatastore***: if the operation cannot be performed due to
/// some error with the datastore.
pub async fn update_v_vol_virtual_machine_files_task(&self, failover_pair: Option<&[crate::types::structs::DatastoreVVolContainerFailoverPair]>) -> Result<crate::types::structs::ManagedObjectReference> {
let input = UpdateVVolVirtualMachineFilesRequestType {failover_pair, };
let bytes = self.client.invoke("", "Datastore", &self.mo_id, "UpdateVVolVirtualMachineFiles_Task", Some(&input)).await?;
let result: crate::types::structs::ManagedObjectReference = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
Ok(result)
}
/// Update file paths embedded in virtual machine files on the datastore.
///
/// This can be called after the file system corresponding to the datastore
/// has been resignatured or remounted. Any MountPathDatastorePairs
/// where the new path is the same as the original file path will be ignored.
///
/// This method is only supported by vCenter server. Also, this method requires
/// that the datastore is *accessible* from
/// at least one host (ESX version 4.1 or above) in vCenter server.
///
/// While this operation is in progress, it is important that users do not
/// initiate any operations that might read or write to any files on the
/// datastore, such as registering a virtual machine with files residing
/// on the datastore, or performing any virtual disk operations on any files
/// in the datastore. These operations can potentially cause spurious file
/// update failures, while at the same time they can prevent virtual machine
/// files from being updated correctly.
///
/// If users intend to update multiple datastores using this method, it is
/// strongly advised that the users do not initiate any operations that
/// might read or write to files on any of the datastores, until all of
/// them have been updated. The files of a single virtual machine can
/// reside on multiple datastores, and thus all the involved datastores
/// should be updated, before the virtual machine is considered updated
/// completely.
///
/// ***Required privileges:*** Datastore.UpdateVirtualMachineFiles
///
/// ## Parameters:
///
/// ### mount_path_datastore_mapping
/// Old mount path to datastore mapping.
///
/// ## Returns:
///
/// This method returns a *Task* object with which to monitor the
/// operation. The *TaskInfo.result* property in the
/// *Task* contains an *UpdateVirtualMachineFilesResult*
/// object, upon success, which is a list of virtual machines files the
/// server has attempted to update but failed to update. When there are too
/// many failed files, only a subset of failed files will be returned.
///
/// Refers instance of *Task*.
///
/// ## Errors:
///
/// ***InvalidArgument***: if old mount path is mapped to more than one datastores,
/// or if any of the datastore being mapped can not be found.
///
/// ***NotSupported***: if all hosts attached to this datastore do not support
/// updating virtual machine files.
///
/// ***ResourceInUse***: if there exists a registered virtual machine in the volume.
///
/// ***PlatformConfigFault***: if any error related to platform
/// occurs during the operation.
///
/// ***TaskInProgress***: if the datastore is busy, for example, while another task
/// is updating the datastore after volume resignaturing
/// or remounting.
///
/// ***InvalidDatastore***: if the operation cannot be performed due to some error
/// with the datastore; typically a specific subclass
/// of the fault is reported.
pub async fn update_virtual_machine_files_task(&self, mount_path_datastore_mapping: &[crate::types::structs::DatastoreMountPathDatastorePair]) -> Result<crate::types::structs::ManagedObjectReference> {
let input = UpdateVirtualMachineFilesRequestType {mount_path_datastore_mapping, };
let bytes = self.client.invoke("", "Datastore", &self.mo_id, "UpdateVirtualMachineFiles_Task", Some(&input)).await?;
let result: crate::types::structs::ManagedObjectReference = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
Ok(result)
}
/// Whether alarm actions are enabled for this entity.
///
/// True if enabled; false otherwise.
///
/// ***Required privileges:*** System.Read
pub async fn alarm_actions_enabled(&self) -> Result<Option<bool>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "alarmActionsEnabled").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// List of custom field definitions that are valid for the object's type.
///
/// The fields are sorted by *CustomFieldDef.name*.
///
/// ***Required privileges:*** System.View
pub async fn available_field(&self) -> Result<Option<Vec<crate::types::structs::CustomFieldDef>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "availableField").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// DatastoreBrowser used to browse this datastore.
///
/// ## Returns:
///
/// Refers instance of *HostDatastoreBrowser*.
pub async fn browser(&self) -> Result<crate::types::structs::ManagedObjectReference> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "browser").await?;
let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property browser was empty".to_string()))?;
let result: crate::types::structs::ManagedObjectReference = crate::core::client::extract_property(pv)?;
Ok(result)
}
/// Capabilities of this datastore.
pub async fn capability(&self) -> Result<crate::types::structs::DatastoreCapability> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "capability").await?;
let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property capability was empty".to_string()))?;
let result: crate::types::structs::DatastoreCapability = crate::core::client::extract_property(pv)?;
Ok(result)
}
/// Current configuration issues that have been detected for this entity.
///
/// Typically,
/// these issues have already been logged as events. The entity stores these
/// events as long as they are still current. The
/// *configStatus* property provides an overall status
/// based on these events.
pub async fn config_issue(&self) -> Result<Option<Vec<crate::types::structs::Event>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "configIssue").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// The configStatus indicates whether or not the system has detected a configuration
/// issue involving this entity.
///
/// For example, it might have detected a
/// duplicate IP address or MAC address, or a host in a cluster
/// might be out of compliance. The meanings of the configStatus values are:
/// - red: A problem has been detected involving the entity.
/// - yellow: A problem is about to occur or a transient condition
/// has occurred (For example, reconfigure fail-over policy).
/// - green: No configuration issues have been detected.
/// - gray: The configuration status of the entity is not being monitored.
///
/// A green status indicates only that a problem has not been detected;
/// it is not a guarantee that the entity is problem-free.
///
/// The *configIssue* property contains a list of the
/// problems that have been detected.
/// In releases after vSphere API 5.0, vSphere Servers might not
/// generate property collector update notifications for this property.
/// To obtain the latest value of the property, you can use
/// PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
/// If you use the PropertyCollector.WaitForUpdatesEx method, specify
/// an empty string for the version parameter. Any other version value will not
/// produce any property values as no updates are generated.
pub async fn config_status(&self) -> Result<crate::types::enums::ManagedEntityStatusEnum> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "configStatus").await?;
let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property configStatus was empty".to_string()))?;
let result: crate::types::enums::ManagedEntityStatusEnum = crate::core::client::extract_property(pv)?;
Ok(result)
}
/// Custom field values.
///
/// ***Required privileges:*** System.View
pub async fn custom_value(&self) -> Result<Option<Vec<Box<dyn crate::types::traits::CustomFieldValueTrait>>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "customValue").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// A set of alarm states for alarms that apply to this managed entity.
///
/// The set includes alarms defined on this entity
/// and alarms inherited from the parent entity,
/// or from any ancestors in the inventory hierarchy.
///
/// Alarms are inherited if they can be triggered by this entity or its descendants.
/// This set does not include alarms that are defined on descendants of this entity.
///
/// ***Required privileges:*** System.View
pub async fn declared_alarm_state(&self) -> Result<Option<Vec<crate::types::structs::AlarmState>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "declaredAlarmState").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// List of operations that are disabled, given the current runtime
/// state of the entity.
///
/// For example, a power-on operation always fails if a
/// virtual machine is already powered on. This list can be used by clients to
/// enable or disable operations in a graphical user interface.
///
/// Note: This list is determined by the current runtime state of an entity,
/// not by its permissions.
///
/// This list may include the following operations for a HostSystem:
/// - *HostSystem.EnterMaintenanceMode_Task*
/// - *HostSystem.ExitMaintenanceMode_Task*
/// - *HostSystem.RebootHost_Task*
/// - *HostSystem.ShutdownHost_Task*
/// - *HostSystem.ReconnectHost_Task*
/// - *HostSystem.DisconnectHost_Task*
///
/// This list may include the following operations for a VirtualMachine:
/// - *VirtualMachine.AnswerVM*
/// - *ManagedEntity.Rename_Task*
/// - *VirtualMachine.CloneVM_Task*
/// - *VirtualMachine.PowerOffVM_Task*
/// - *VirtualMachine.PowerOnVM_Task*
/// - *VirtualMachine.SuspendVM_Task*
/// - *VirtualMachine.ResetVM_Task*
/// - *VirtualMachine.ReconfigVM_Task*
/// - *VirtualMachine.RelocateVM_Task*
/// - *VirtualMachine.MigrateVM_Task*
/// - *VirtualMachine.CustomizeVM_Task*
/// - *VirtualMachine.ShutdownGuest*
/// - *VirtualMachine.StandbyGuest*
/// - *VirtualMachine.RebootGuest*
/// - *VirtualMachine.CreateSnapshot_Task*
/// - *VirtualMachine.RemoveAllSnapshots_Task*
/// - *VirtualMachine.RevertToCurrentSnapshot_Task*
/// - *VirtualMachine.MarkAsTemplate*
/// - *VirtualMachine.MarkAsVirtualMachine*
/// - *VirtualMachine.ResetGuestInformation*
/// - *VirtualMachine.MountToolsInstaller*
/// - *VirtualMachine.UnmountToolsInstaller*
/// - *ManagedEntity.Destroy_Task*
/// - *VirtualMachine.UpgradeVM_Task*
/// - *VirtualMachine.ExportVm*
///
/// This list may include the following operations for a ResourcePool:
/// - *ResourcePool.ImportVApp*
/// - *ResourcePool.CreateChildVM_Task*
/// - *ResourcePool.UpdateConfig*
/// - *Folder.CreateVM_Task*
/// - *ManagedEntity.Destroy_Task*
/// - *ManagedEntity.Rename_Task*
///
/// This list may include the following operations for a VirtualApp:
/// - *ManagedEntity.Destroy_Task*
/// - *VirtualApp.CloneVApp_Task*
/// - *VirtualApp.unregisterVApp_Task*
/// - *VirtualApp.ExportVApp*
/// - *VirtualApp.PowerOnVApp_Task*
/// - *VirtualApp.PowerOffVApp_Task*
/// - *VirtualApp.UpdateVAppConfig*
///
/// In releases after vSphere API 5.0, vSphere Servers might not
/// generate property collector update notifications for this property.
/// To obtain the latest value of the property, you can use
/// PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
/// If you use the PropertyCollector.WaitForUpdatesEx method, specify
/// an empty string for the version parameter. Any other version value will not
/// produce any property values as no updates are generated.
pub async fn disabled_method(&self) -> Result<Option<Vec<String>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "disabledMethod").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// Access rights the current session has to this entity.
///
/// ***Required privileges:*** System.View
pub async fn effective_role(&self) -> Result<Option<Vec<i32>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "effectiveRole").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// Hosts attached to this datastore.
pub async fn host(&self) -> Result<Option<Vec<crate::types::structs::DatastoreHostMount>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "host").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// Specific information about the datastore.
pub async fn info(&self) -> Result<Box<dyn crate::types::traits::DatastoreInfoTrait>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "info").await?;
let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property info was empty".to_string()))?;
let result: Box<dyn crate::types::traits::DatastoreInfoTrait> = crate::core::client::extract_property(pv)?;
Ok(result)
}
/// Deprecated as of vSphere8.0 U3, and there is no replacement for it.
///
/// Configuration of storage I/O resource management for the datastore.
///
/// Currently we only support storage I/O resource management on VMFS volumes
/// of a datastore.
///
/// This configuration may not be available if the datastore is not accessible
/// from any host, or if the datastore does not have VMFS volume.
/// The configuration can be modified using the method
/// *StorageResourceManager.ConfigureDatastoreIORM_Task*
pub async fn iorm_configuration(&self) -> Result<Option<crate::types::structs::StorageIormInfo>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "iormConfiguration").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// Name of this entity, unique relative to its parent.
///
/// Any / (slash), \\ (backslash), character used in this
/// name element will be escaped. Similarly, any % (percent) character used in
/// this name element will be escaped, unless it is used to start an escape
/// sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or
/// %5c, and a percent is escaped as %25.
///
/// ***Required privileges:*** System.View
pub async fn name(&self) -> Result<String> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "name").await?;
let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property name was empty".to_string()))?;
let result: String = crate::core::client::extract_property(pv)?;
Ok(result)
}
/// General health of this managed entity.
///
/// The overall status of the managed entity is computed as the worst status
/// among its alarms and the configuration issues detected on the entity.
/// The status is reported as one of the following values:
/// - red: The entity has alarms or configuration issues with a red status.
/// - yellow: The entity does not have alarms or configuration issues with a
/// red status, and has at least one with a yellow status.
/// - green: The entity does not have alarms or configuration issues with a
/// red or yellow status, and has at least one with a green status.
/// - gray: All of the entity's alarms have a gray status and the
/// configuration status of the entity is not being monitored.
///
/// In releases after vSphere API 5.0, vSphere Servers might not
/// generate property collector update notifications for this property.
/// To obtain the latest value of the property, you can use
/// PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
/// If you use the PropertyCollector.WaitForUpdatesEx method, specify
/// an empty string for the version parameter. Any other version value will not
/// produce any property values as no updates are generated.
pub async fn overall_status(&self) -> Result<crate::types::enums::ManagedEntityStatusEnum> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "overallStatus").await?;
let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property overallStatus was empty".to_string()))?;
let result: crate::types::enums::ManagedEntityStatusEnum = crate::core::client::extract_property(pv)?;
Ok(result)
}
/// Parent of this entity.
///
/// This value is null for the root object and for
/// *VirtualMachine* objects that are part of
/// a *VirtualApp*.
///
/// ***Required privileges:*** System.View
///
/// ## Returns:
///
/// Refers instance of *ManagedEntity*.
pub async fn parent(&self) -> Result<Option<crate::types::structs::ManagedObjectReference>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "parent").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// List of permissions defined for this entity.
pub async fn permission(&self) -> Result<Option<Vec<crate::types::structs::Permission>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "permission").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// The set of recent tasks operating on this managed entity.
///
/// This is a subset
/// of *TaskManager.recentTask* belong to this entity. A task in this
/// list could be in one of the four states: pending, running, success or error.
///
/// This property can be used to deduce intermediate power states for
/// a virtual machine entity. For example, if the current powerState is "poweredOn"
/// and there is a running task performing the "suspend" operation, then the virtual
/// machine's intermediate state might be described as "suspending."
///
/// Most tasks (such as power operations) obtain exclusive access to the virtual
/// machine, so it is unusual for this list to contain more than one running task.
/// One exception, however, is the task of cloning a virtual machine.
/// In releases after vSphere API 5.0, vSphere Servers might not
/// generate property collector update notifications for this property.
/// To obtain the latest value of the property, you can use
/// PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
/// If you use the PropertyCollector.WaitForUpdatesEx method, specify
/// an empty string for the version parameter. Any other version value will not
/// produce any property values as no updates are generated.
///
/// ## Returns:
///
/// Refers instances of *Task*.
pub async fn recent_task(&self) -> Result<Option<Vec<crate::types::structs::ManagedObjectReference>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "recentTask").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// Global properties of the datastore.
pub async fn summary(&self) -> Result<crate::types::structs::DatastoreSummary> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "summary").await?;
let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property summary was empty".to_string()))?;
let result: crate::types::structs::DatastoreSummary = crate::core::client::extract_property(pv)?;
Ok(result)
}
/// The set of tags associated with this managed entity.
///
/// Experimental. Subject to change.
///
/// ***Required privileges:*** System.View
pub async fn tag(&self) -> Result<Option<Vec<crate::types::structs::Tag>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "tag").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// A set of alarm states for alarms triggered by this entity
/// or by its descendants.
///
/// Triggered alarms are propagated up the inventory hierarchy
/// so that a user can readily tell when a descendant has triggered an alarm.
/// In releases after vSphere API 5.0, vSphere Servers might not
/// generate property collector update notifications for this property.
/// To obtain the latest value of the property, you can use
/// PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
/// If you use the PropertyCollector.WaitForUpdatesEx method, specify
/// an empty string for the version parameter. Any other version value will not
/// produce any property values as no updates are generated.
///
/// ***Required privileges:*** System.View
pub async fn triggered_alarm_state(&self) -> Result<Option<Vec<crate::types::structs::AlarmState>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "triggeredAlarmState").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// List of custom field values.
///
/// Each value uses a key to associate
/// an instance of a *CustomFieldStringValue* with
/// a custom field definition.
///
/// ***Required privileges:*** System.View
pub async fn value(&self) -> Result<Option<Vec<Box<dyn crate::types::traits::CustomFieldValueTrait>>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "value").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
/// Virtual machines stored on this datastore.
///
/// ## Returns:
///
/// Refers instances of *VirtualMachine*.
pub async fn vm(&self) -> Result<Option<Vec<crate::types::structs::ManagedObjectReference>>> {
let pv_opt = self.client.fetch_property_raw("", "Datastore", &self.mo_id, "vm").await?;
match pv_opt {
Some(pv) => Ok(Some(crate::core::client::extract_property(pv)?)),
None => Ok(None),
}
}
}
struct RenameRequestType<'a> {
new_name: &'a str,
}
impl<'a> miniserde::Serialize for RenameRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(RenameRequestTypeSer { data: self, seq: 0 }))
}
}
struct RenameRequestTypeSer<'b, 'a> {
data: &'b RenameRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for RenameRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"RenameRequestType")),
1 => return Some((std::borrow::Cow::Borrowed("newName"), &self.data.new_name as &dyn miniserde::Serialize)),
_ => return None,
}
}
}
struct RenameDatastoreRequestType<'a> {
new_name: &'a str,
}
impl<'a> miniserde::Serialize for RenameDatastoreRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(RenameDatastoreRequestTypeSer { data: self, seq: 0 }))
}
}
struct RenameDatastoreRequestTypeSer<'b, 'a> {
data: &'b RenameDatastoreRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for RenameDatastoreRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"RenameDatastoreRequestType")),
1 => return Some((std::borrow::Cow::Borrowed("newName"), &self.data.new_name as &dyn miniserde::Serialize)),
_ => return None,
}
}
}
struct SetCustomValueRequestType<'a> {
key: &'a str,
value: &'a str,
}
impl<'a> miniserde::Serialize for SetCustomValueRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(SetCustomValueRequestTypeSer { data: self, seq: 0 }))
}
}
struct SetCustomValueRequestTypeSer<'b, 'a> {
data: &'b SetCustomValueRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for SetCustomValueRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"setCustomValueRequestType")),
1 => return Some((std::borrow::Cow::Borrowed("key"), &self.data.key as &dyn miniserde::Serialize)),
2 => return Some((std::borrow::Cow::Borrowed("value"), &self.data.value as &dyn miniserde::Serialize)),
_ => return None,
}
}
}
struct UpdateVVolVirtualMachineFilesRequestType<'a> {
failover_pair: Option<&'a [crate::types::structs::DatastoreVVolContainerFailoverPair]>,
}
impl<'a> miniserde::Serialize for UpdateVVolVirtualMachineFilesRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(UpdateVVolVirtualMachineFilesRequestTypeSer { data: self, seq: 0 }))
}
}
struct UpdateVVolVirtualMachineFilesRequestTypeSer<'b, 'a> {
data: &'b UpdateVVolVirtualMachineFilesRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for UpdateVVolVirtualMachineFilesRequestTypeSer<'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"), &"UpdateVVolVirtualMachineFilesRequestType")),
1 => {
let Some(ref val) = self.data.failover_pair else { continue; };
return Some((std::borrow::Cow::Borrowed("failoverPair"), val as &dyn miniserde::Serialize));
}
_ => return None,
}
}
}
}
struct UpdateVirtualMachineFilesRequestType<'a> {
mount_path_datastore_mapping: &'a [crate::types::structs::DatastoreMountPathDatastorePair],
}
impl<'a> miniserde::Serialize for UpdateVirtualMachineFilesRequestType<'a> {
fn begin(&self) -> miniserde::ser::Fragment<'_> {
miniserde::ser::Fragment::Map(Box::new(UpdateVirtualMachineFilesRequestTypeSer { data: self, seq: 0 }))
}
}
struct UpdateVirtualMachineFilesRequestTypeSer<'b, 'a> {
data: &'b UpdateVirtualMachineFilesRequestType<'a>,
seq: usize,
}
impl<'b, 'a> miniserde::ser::Map for UpdateVirtualMachineFilesRequestTypeSer<'b, 'a> {
fn next(&mut self) -> Option<(std::borrow::Cow<'_, str>, &dyn miniserde::Serialize)> {
let seq = self.seq;
self.seq += 1;
match seq {
0 => return Some((std::borrow::Cow::Borrowed("_typeName"), &"UpdateVirtualMachineFilesRequestType")),
1 => return Some((std::borrow::Cow::Borrowed("mountPathDatastoreMapping"), &self.data.mount_path_datastore_mapping as &dyn miniserde::Serialize)),
_ => return None,
}
}
}