pub struct VsanClusterHealthSystem { /* private fields */ }Expand description
The vSAN Cluster Health System exposes the vSAN cluster health service API and serves as an aggregator to collect the result from each of hosts in the vSAN cluster.
Implementations§
Source§impl VsanClusterHealthSystem
impl VsanClusterHealthSystem
pub fn new(client: Arc<dyn VimClient>, mo_id: &str) -> Self
Sourcepub async fn vsan_check_cluster_clomd_liveness(
&self,
hosts: &[String],
esx_root_password: &str,
) -> Result<VsanClusterClomdLivenessResult>
pub async fn vsan_check_cluster_clomd_liveness( &self, hosts: &[String], esx_root_password: &str, ) -> Result<VsanClusterClomdLivenessResult>
Queries the CLOM daemon liveness on all of vSAN hosts
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§Returns:
The vSAN cluster clomd health result
§Errors:
Failure
Sourcepub async fn vsan_cluster_get_hcl_info(
&self,
hosts: &[String],
esx_root_password: &str,
) -> Result<VsanClusterHclInfo>
pub async fn vsan_cluster_get_hcl_info( &self, hosts: &[String], esx_root_password: &str, ) -> Result<VsanClusterHclInfo>
Fetch HCL information about all devices in use by vSAN on all hosts.
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§Returns:
The vSAN cluster HCL information
§Errors:
Failure
Sourcepub async fn vsan_query_cluster_adv_cfg_sync(
&self,
hosts: &[String],
esx_root_password: &str,
options: Option<&[String]>,
) -> Result<Option<Vec<VsanClusterAdvCfgSyncResult>>>
pub async fn vsan_query_cluster_adv_cfg_sync( &self, hosts: &[String], esx_root_password: &str, options: Option<&[String]>, ) -> Result<Option<Vec<VsanClusterAdvCfgSyncResult>>>
Queries vSAN advanced configuration and checks if all of the hosts in a vSAN cluster have consistent advanced configuration options
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§options
list of vsi path for the configuration name
§Returns:
The vSAN cluster advanced configuration consistent result. If empty, indicates all in sync.
§Errors:
Failure
Sourcepub async fn vsan_query_cluster_capture_vsan_pcap(
&self,
hosts: &[String],
esx_root_password: &str,
duration: i32,
vmknic: Option<&[VsanClusterHostVmknicMapping]>,
include_raw_pcap: Option<bool>,
include_igmp: Option<bool>,
cmmds_msg_type_filter: Option<&[String]>,
cmmds_ports: Option<&[i32]>,
cluster_uuid: Option<&str>,
) -> Result<VsanVsanClusterPcapResult>
pub async fn vsan_query_cluster_capture_vsan_pcap( &self, hosts: &[String], esx_root_password: &str, duration: i32, vmknic: Option<&[VsanClusterHostVmknicMapping]>, include_raw_pcap: Option<bool>, include_igmp: Option<bool>, cmmds_msg_type_filter: Option<&[String]>, cmmds_ports: Option<&[i32]>, cluster_uuid: Option<&str>, ) -> Result<VsanVsanClusterPcapResult>
Captures the vSAN cluster multicast network trace to ensure that all of hosts in the cluster can receive multicast packets
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§duration
Duration to watch for packets in second. 1 minute is recommended
§vmknic
The map for host and the vmknic using for vSAN
§include_raw_pcap
True to include the raw pcap data in the result. Default is False
§include_igmp
True to include the IGMP network test data. Default is True
§cmmds_msg_type_filter
The filter for vSAN message type. The network message whose type is not in the filter list will be ignored. All of the supported message types include “MASTER_HEARTBEAT”, “MASTER_UPDATE” and “AGENT_HEARTBEAT”.
§cmmds_ports
The vSAN multicast ports. Unset will use the default vSAN multicast ports.
§cluster_uuid
The vSAN cluster UUID.
§Returns:
The vSAN cluster multicast trace result
§Errors:
Failure
Sourcepub async fn vsan_query_cluster_check_limits(
&self,
hosts: &[String],
esx_root_password: &str,
) -> Result<VsanClusterLimitHealthResult>
pub async fn vsan_query_cluster_check_limits( &self, hosts: &[String], esx_root_password: &str, ) -> Result<VsanClusterLimitHealthResult>
Queries the vSAN cluster component limits, disk space and read cache reservation assuming one host failure
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§Returns:
The vSAN cluster limit health result
§Errors:
Failure
Sourcepub async fn vsan_query_cluster_create_vm_health_test(
&self,
hosts: &[String],
esx_root_password: &str,
timeout: i32,
) -> Result<VsanClusterCreateVmHealthTestResult>
pub async fn vsan_query_cluster_create_vm_health_test( &self, hosts: &[String], esx_root_password: &str, timeout: i32, ) -> Result<VsanClusterCreateVmHealthTestResult>
Executes VM creation test and checks if a tiny VM can be created on each of host of the vSAN cluster
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§timeout
The timeout time for the VM creation test
§Returns:
The vSAN cluster VM creation test result
§Errors:
Failure
Sourcepub async fn vsan_query_cluster_health_system_versions(
&self,
hosts: &[String],
esx_root_password: &str,
) -> Result<VsanClusterHealthSystemVersionResult>
pub async fn vsan_query_cluster_health_system_versions( &self, hosts: &[String], esx_root_password: &str, ) -> Result<VsanClusterHealthSystemVersionResult>
Queries vSAN health service version number string for each host and check if all of them are consistent.
Mark issueFound flag as True if they are not consistent.
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§Returns:
The vSAN cluster health service version result
§Errors:
Failure
Sourcepub async fn vsan_query_cluster_network_perf_test(
&self,
hosts: &[String],
esx_root_password: &str,
multicast: bool,
duration_sec: Option<i32>,
) -> Result<VsanClusterNetworkLoadTestResult>
pub async fn vsan_query_cluster_network_perf_test( &self, hosts: &[String], esx_root_password: &str, multicast: bool, duration_sec: Option<i32>, ) -> Result<VsanClusterNetworkLoadTestResult>
Queries the vSAN network performance and checks if it meets the bandwidth requirements.
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§multicast
True to test vSAN multicast network performance. False to test vSAN unicast network performance.
§duration_sec
The duration time for the Network Performance test. Default is 15 seconds if not set.
§Returns:
The vSAN cluster network performance test result
§Errors:
Failure
Sourcepub async fn vsan_query_cluster_physical_disk_health_summary(
&self,
hosts: &[String],
esx_root_password: &str,
) -> Result<Option<Vec<VsanPhysicalDiskHealthSummary>>>
pub async fn vsan_query_cluster_physical_disk_health_summary( &self, hosts: &[String], esx_root_password: &str, ) -> Result<Option<Vec<VsanPhysicalDiskHealthSummary>>>
Queries the vSAN physical disks health on all of vSAN hosts
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§Returns:
The vSAN physical disks health result. If empty, it indicates there is no connected host in the cluster.
§Errors:
Failure
Sourcepub async fn vsan_query_verify_cluster_network_settings(
&self,
hosts: &[String],
esx_root_password: &str,
) -> Result<VsanClusterNetworkHealthResult>
pub async fn vsan_query_verify_cluster_network_settings( &self, hosts: &[String], esx_root_password: &str, ) -> Result<VsanClusterNetworkHealthResult>
Queries the vSAN cluster network setting and connectivity health status
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§Returns:
The vSAN cluster network health result
§Errors:
Failure
Sourcepub async fn vsan_repair_cluster_immediate_objects(
&self,
hosts: &[String],
esx_root_password: &str,
uuids: Option<&[String]>,
) -> Result<VsanClusterHealthSystemObjectsRepairResult>
pub async fn vsan_repair_cluster_immediate_objects( &self, hosts: &[String], esx_root_password: &str, uuids: Option<&[String]>, ) -> Result<VsanClusterHealthSystemObjectsRepairResult>
Fix absent and degraded components in object immediately.
The result will contain which object have been in queue for repair or failed to be repaired
Required privileges: System.Read
§Parameters:
§hosts
The vSAN hosts
§esx_root_password
The root password for the host. The password should be the same for all of hosts in the vSAN cluster
§uuids
The vSAN objects UUID to be repaired. Unset to repair all of reduced objects in the vSAN cluster
§Returns:
The vSAN cluster object repair result
§Errors:
Failure
Trait Implementations§
Source§impl Clone for VsanClusterHealthSystem
impl Clone for VsanClusterHealthSystem
Source§fn clone(&self) -> VsanClusterHealthSystem
fn clone(&self) -> VsanClusterHealthSystem
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more