vim_rs 0.4.4

Rust Bindings for the VMware by Broadcom vCenter VI JSON API
Documentation
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
use std::sync::Arc;
use crate::core::client::{VimClient, Result};
/// CertificateManager provides an interface for managing the SSL
/// certificates used by the server.
#[derive(Clone)]
pub struct HostCertificateManager {
    client: Arc<dyn VimClient>,
    mo_id: String,
}
impl HostCertificateManager {
    pub fn new(client: Arc<dyn VimClient>, mo_id: &str) -> Self {
        Self {
            client,
            mo_id: mo_id.to_string(),
        }
    }
    /// Requests the server to generate a certificate-signing
    /// request (CSR) for itself.
    /// 
    /// The CSR is then typically
    /// provided to a Certificate Authority to sign and issue
    /// the SSL certificate for the server. Use *HostCertificateManager.InstallServerCertificate*
    /// to install this certificate.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Parameters:
    ///
    /// ### use_ip_address_as_common_name
    /// if true, use host's
    /// management IP address as CN in the CSR;
    /// otherwise use host's FQDN.
    ///
    /// ### spec
    /// is used to generate CSR for selected
    /// certificate kind.
    /// 
    /// ***Since:*** vSphere API Release 8.0.1.0
    ///
    /// ## Returns:
    ///
    /// CSR in PEM format
    ///
    /// ## Errors:
    ///
    /// ***HostConfigFault***: if there's a problem generating the CSR.
    pub async fn generate_certificate_signing_request(&self, use_ip_address_as_common_name: bool, spec: Option<&crate::types::structs::HostCertificateManagerCertificateSpec>) -> Result<String> {
        let input = GenerateCertificateSigningRequestRequestType {use_ip_address_as_common_name, spec, };
        let bytes = self.client.invoke("", "HostCertificateManager", &self.mo_id, "GenerateCertificateSigningRequest", Some(&input)).await?;
        let result: String = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
        Ok(result)
    }
    /// Requests the server to generate a certificate-signing
    /// request (CSR) for itself.
    /// 
    /// Alternative version similar to *HostCertificateManager.GenerateCertificateSigningRequest*
    /// but takes a Distinguished Name (DN) as a parameter.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Parameters:
    ///
    /// ### distinguished_name
    /// DN to be used as subject in CSR.
    ///
    /// ### spec
    /// is used to generate CSR for selected certificate kind
    /// 
    /// ***Since:*** vSphere API Release 8.0.1.0
    ///
    /// ## Returns:
    ///
    /// CSR in PEM format
    ///
    /// ## Errors:
    ///
    /// ***HostConfigFault***: if there's a problem generating the CSR.
    pub async fn generate_certificate_signing_request_by_dn(&self, distinguished_name: &str, spec: Option<&crate::types::structs::HostCertificateManagerCertificateSpec>) -> Result<String> {
        let input = GenerateCertificateSigningRequestByDnRequestType {distinguished_name, spec, };
        let bytes = self.client.invoke("", "HostCertificateManager", &self.mo_id, "GenerateCertificateSigningRequestByDn", Some(&input)).await?;
        let result: String = crate::core::client::unmarshal(self.client.transport(), &bytes)?;
        Ok(result)
    }
    /// Installs a given SSL certificate on the server.
    /// 
    /// The private key must have been previously generated by *HostCertificateManager.GenerateCertificateSigningRequest* or provided
    /// by *HostCertificateManager.ProvisionServerPrivateKey*.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Parameters:
    ///
    /// ### cert
    /// SSL certificate in PEM format
    ///
    /// ## Errors:
    ///
    /// ***HostConfigFault***: if there's a problem with the input certificate,
    /// or the certificate and key don't match.
    pub async fn install_server_certificate(&self, cert: &str) -> Result<()> {
        let input = InstallServerCertificateRequestType {cert, };
        self.client.invoke_void("", "HostCertificateManager", &self.mo_id, "InstallServerCertificate", Some(&input)).await
    }
    /// Fetches the SSL CRLs of Certificate Authorities that are trusted.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Returns:
    ///
    /// SSL CRLs of trusted CAs in PEM format
    ///
    /// ## Errors:
    ///
    /// ***HostConfigFault***: if there's a problem with the certificate store.
    pub async fn list_ca_certificate_revocation_lists(&self) -> Result<Option<Vec<String>>> {
        let bytes_opt = self.client.invoke_optional("", "HostCertificateManager", &self.mo_id, "ListCACertificateRevocationLists", None).await?;
        match bytes_opt {
            Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
            None => Ok(None),
        }
    }
    /// Fetches the SSL certificates of Certificate Authorities
    /// that are trusted.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Returns:
    ///
    /// SSL certificates of trusted CAs in PEM format
    ///
    /// ## Errors:
    ///
    /// ***HostConfigFault***: if there's a problem with the certificate store.
    pub async fn list_ca_certificates(&self) -> Result<Option<Vec<String>>> {
        let bytes_opt = self.client.invoke_optional("", "HostCertificateManager", &self.mo_id, "ListCACertificates", None).await?;
        match bytes_opt {
            Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
            None => Ok(None),
        }
    }
    /// Instructs the host services affected by SSL credential changes
    /// by *HostCertificateManager.InstallServerCertificate*
    /// or *HostCertificateManager.ReplaceCACertificatesAndCRLs*
    /// to take into account said changes now.
    /// 
    /// Please note, that
    /// old SSL connections typically survive the transition and continue using
    /// old SSL credentials. New SSL connections will use the new SSL credentials.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Parameters:
    ///
    /// ### services
    /// list of services that need to be notified and no
    /// other service would be notified. if not provided all supported
    /// services would be notified.
    /// 
    /// ***Since:*** vSphere API Release 8.0.1.0
    pub async fn notify_affected_services(&self, services: Option<&[String]>) -> Result<()> {
        let input = NotifyAffectedServicesRequestType {services, };
        self.client.invoke_void("", "HostCertificateManager", &self.mo_id, "NotifyAffectedServices", Some(&input)).await
    }
    /// Provisions a given SSL private key on the server for use with a subsequent
    /// SSL certificate installation.
    /// 
    /// The recommended way to update the server private key is via *HostCertificateManager.GenerateCertificateSigningRequest*, which
    /// ensures that the key never leaves the host.
    /// 
    /// The current method is intended for use only in environments that
    /// have special requirements on how their private keys are generated.
    /// 
    /// ***Since:*** vSphere API Release 8.0.3.0
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Parameters:
    ///
    /// ### key
    /// SSL private key in PEM format
    ///
    /// ## Errors:
    ///
    /// ***HostConfigFault***: if there's a problem with the input key.
    pub async fn provision_server_private_key(&self, key: &str) -> Result<()> {
        let input = ProvisionServerPrivateKeyRequestType {key, };
        self.client.invoke_void("", "HostCertificateManager", &self.mo_id, "ProvisionServerPrivateKey", Some(&input)).await
    }
    /// Replaces the trusted Certificate Authority (CA)
    /// certificates and Certification Revocation List (CRL)
    /// used by the server with the provided values.
    /// 
    /// These determine whether the server can verify
    /// the identity of an external entity.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    ///
    /// ## Parameters:
    ///
    /// ### ca_cert
    /// List of SSL certificates, in PEM format,
    /// of all CAs that should be trusted
    ///
    /// ### ca_crl
    /// List of SSL CRLs, in PEM format,
    /// issued by trusted CAs from the above list
    ///
    /// ## Errors:
    ///
    /// ***HostConfigFault***: if there's a problem with the input certificates
    /// or CRLs.
    pub async fn replace_ca_certificates_and_cr_ls(&self, ca_cert: &[String], ca_crl: Option<&[String]>) -> Result<()> {
        let input = ReplaceCaCertificatesAndCrLsRequestType {ca_cert, ca_crl, };
        self.client.invoke_void("", "HostCertificateManager", &self.mo_id, "ReplaceCACertificatesAndCRLs", Some(&input)).await
    }
    /// the CertificateInfos of all known Certificates on
    /// the host
    /// 
    /// ***Since:*** vSphere API Release 8.0.1.0
    /// 
    /// ***Required privileges:*** Certificate.Manage
    pub async fn retrieve_certificate_info_list(&self) -> Result<Option<Vec<crate::types::structs::HostCertificateManagerCertificateInfo>>> {
        let bytes_opt = self.client.invoke_optional("", "HostCertificateManager", &self.mo_id, "RetrieveCertificateInfoList", None).await?;
        match bytes_opt {
            Some(ref b) => Ok(Some(crate::core::client::unmarshal_array(self.client.transport(), b)?)),
            None => Ok(None),
        }
    }
    /// the CertificateInfo of the Host Certificate.
    /// 
    /// ***Required privileges:*** Certificate.Manage
    pub async fn certificate_info(&self) -> Result<crate::types::structs::HostCertificateManagerCertificateInfo> {
        let pv_opt = self.client.fetch_property_raw("", "HostCertificateManager", &self.mo_id, "certificateInfo").await?;
        let pv = pv_opt.ok_or_else(|| crate::core::client::VimError::ParseError("property certificateInfo was empty".to_string()))?;
        let result: crate::types::structs::HostCertificateManagerCertificateInfo = crate::core::client::extract_property(pv)?;
        Ok(result)
    }
}
struct GenerateCertificateSigningRequestRequestType<'a> {
    use_ip_address_as_common_name: bool,
    spec: Option<&'a crate::types::structs::HostCertificateManagerCertificateSpec>,
}

impl<'a> miniserde::Serialize for GenerateCertificateSigningRequestRequestType<'a> {
    fn begin(&self) -> miniserde::ser::Fragment<'_> {
        miniserde::ser::Fragment::Map(Box::new(GenerateCertificateSigningRequestRequestTypeSer { data: self, seq: 0 }))
    }
}

struct GenerateCertificateSigningRequestRequestTypeSer<'b, 'a> {
    data: &'b GenerateCertificateSigningRequestRequestType<'a>,
    seq: usize,
}

impl<'b, 'a> miniserde::ser::Map for GenerateCertificateSigningRequestRequestTypeSer<'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"), &"GenerateCertificateSigningRequestRequestType")),
                1 => return Some((std::borrow::Cow::Borrowed("useIpAddressAsCommonName"), &self.data.use_ip_address_as_common_name as &dyn miniserde::Serialize)),
                2 => {
                    let Some(ref val) = self.data.spec else { continue; };
                    return Some((std::borrow::Cow::Borrowed("spec"), val as &dyn miniserde::Serialize));
                }
                _ => return None,
            }
        }
    }
}
struct GenerateCertificateSigningRequestByDnRequestType<'a> {
    distinguished_name: &'a str,
    spec: Option<&'a crate::types::structs::HostCertificateManagerCertificateSpec>,
}

impl<'a> miniserde::Serialize for GenerateCertificateSigningRequestByDnRequestType<'a> {
    fn begin(&self) -> miniserde::ser::Fragment<'_> {
        miniserde::ser::Fragment::Map(Box::new(GenerateCertificateSigningRequestByDnRequestTypeSer { data: self, seq: 0 }))
    }
}

struct GenerateCertificateSigningRequestByDnRequestTypeSer<'b, 'a> {
    data: &'b GenerateCertificateSigningRequestByDnRequestType<'a>,
    seq: usize,
}

impl<'b, 'a> miniserde::ser::Map for GenerateCertificateSigningRequestByDnRequestTypeSer<'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"), &"GenerateCertificateSigningRequestByDnRequestType")),
                1 => return Some((std::borrow::Cow::Borrowed("distinguishedName"), &self.data.distinguished_name as &dyn miniserde::Serialize)),
                2 => {
                    let Some(ref val) = self.data.spec else { continue; };
                    return Some((std::borrow::Cow::Borrowed("spec"), val as &dyn miniserde::Serialize));
                }
                _ => return None,
            }
        }
    }
}
struct InstallServerCertificateRequestType<'a> {
    cert: &'a str,
}

impl<'a> miniserde::Serialize for InstallServerCertificateRequestType<'a> {
    fn begin(&self) -> miniserde::ser::Fragment<'_> {
        miniserde::ser::Fragment::Map(Box::new(InstallServerCertificateRequestTypeSer { data: self, seq: 0 }))
    }
}

struct InstallServerCertificateRequestTypeSer<'b, 'a> {
    data: &'b InstallServerCertificateRequestType<'a>,
    seq: usize,
}

impl<'b, 'a> miniserde::ser::Map for InstallServerCertificateRequestTypeSer<'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"), &"InstallServerCertificateRequestType")),
            1 => return Some((std::borrow::Cow::Borrowed("cert"), &self.data.cert as &dyn miniserde::Serialize)),
            _ => return None,
        }
    }
}
struct NotifyAffectedServicesRequestType<'a> {
    services: Option<&'a [String]>,
}

impl<'a> miniserde::Serialize for NotifyAffectedServicesRequestType<'a> {
    fn begin(&self) -> miniserde::ser::Fragment<'_> {
        miniserde::ser::Fragment::Map(Box::new(NotifyAffectedServicesRequestTypeSer { data: self, seq: 0 }))
    }
}

struct NotifyAffectedServicesRequestTypeSer<'b, 'a> {
    data: &'b NotifyAffectedServicesRequestType<'a>,
    seq: usize,
}

impl<'b, 'a> miniserde::ser::Map for NotifyAffectedServicesRequestTypeSer<'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"), &"NotifyAffectedServicesRequestType")),
                1 => {
                    let Some(ref val) = self.data.services else { continue; };
                    return Some((std::borrow::Cow::Borrowed("services"), val as &dyn miniserde::Serialize));
                }
                _ => return None,
            }
        }
    }
}
struct ProvisionServerPrivateKeyRequestType<'a> {
    key: &'a str,
}

impl<'a> miniserde::Serialize for ProvisionServerPrivateKeyRequestType<'a> {
    fn begin(&self) -> miniserde::ser::Fragment<'_> {
        miniserde::ser::Fragment::Map(Box::new(ProvisionServerPrivateKeyRequestTypeSer { data: self, seq: 0 }))
    }
}

struct ProvisionServerPrivateKeyRequestTypeSer<'b, 'a> {
    data: &'b ProvisionServerPrivateKeyRequestType<'a>,
    seq: usize,
}

impl<'b, 'a> miniserde::ser::Map for ProvisionServerPrivateKeyRequestTypeSer<'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"), &"ProvisionServerPrivateKeyRequestType")),
            1 => return Some((std::borrow::Cow::Borrowed("key"), &self.data.key as &dyn miniserde::Serialize)),
            _ => return None,
        }
    }
}
struct ReplaceCaCertificatesAndCrLsRequestType<'a> {
    ca_cert: &'a [String],
    ca_crl: Option<&'a [String]>,
}

impl<'a> miniserde::Serialize for ReplaceCaCertificatesAndCrLsRequestType<'a> {
    fn begin(&self) -> miniserde::ser::Fragment<'_> {
        miniserde::ser::Fragment::Map(Box::new(ReplaceCaCertificatesAndCrLsRequestTypeSer { data: self, seq: 0 }))
    }
}

struct ReplaceCaCertificatesAndCrLsRequestTypeSer<'b, 'a> {
    data: &'b ReplaceCaCertificatesAndCrLsRequestType<'a>,
    seq: usize,
}

impl<'b, 'a> miniserde::ser::Map for ReplaceCaCertificatesAndCrLsRequestTypeSer<'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"), &"ReplaceCACertificatesAndCRLsRequestType")),
                1 => return Some((std::borrow::Cow::Borrowed("caCert"), &self.data.ca_cert as &dyn miniserde::Serialize)),
                2 => {
                    let Some(ref val) = self.data.ca_crl else { continue; };
                    return Some((std::borrow::Cow::Borrowed("caCrl"), val as &dyn miniserde::Serialize));
                }
                _ => return None,
            }
        }
    }
}