vsphere-automation-vcenter 0.1.0 → 0.2.0

data/docs/VMApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 
 # **create**
-> VcenterVMCreateResult create(vcenter_vm_create)
+> VcenterVMCreateResult create(request_body)
 
 Creates a virtual machine.
 
@@ -19,13 +19,20 @@ Creates a virtual machine.
 ```ruby
 # load the gem
 require 'vsphere-automation-vcenter'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::VCenter::VMApi.new
-vcenter_vm_create = VSphereAutomation::VcenterVMCreate.new # VcenterVMCreate | 
+request_body = VCenter::VcenterVMCreate.new # VcenterVMCreate | 
 
 begin
   #Creates a virtual machine.
-  result = api_instance.create(vcenter_vm_create)
+  result = api_instance.create(request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling VMApi->create: #{e}"
@@ -36,7 +43,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **vcenter_vm_create** | [**VcenterVMCreate**](VcenterVMCreate.md)|  | 
+ **request_body** | [**VcenterVMCreate**](VcenterVMCreate.md)|  | 
 
 ### Return type
 
@@ -44,12 +51,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -62,6 +69,13 @@ Deletes a virtual machine.
 ```ruby
 # load the gem
 require 'vsphere-automation-vcenter'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::VCenter::VMApi.new
 vm = 'vm_example' # String | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
@@ -86,12 +100,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -104,6 +118,13 @@ Returns information about a virtual machine.
 ```ruby
 # load the gem
 require 'vsphere-automation-vcenter'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::VCenter::VMApi.new
 vm = 'vm_example' # String | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
@@ -129,12 +150,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -147,6 +168,13 @@ Returns information about at most 1000 visible (subject to permission checks) vi
 ```ruby
 # load the gem
 require 'vsphere-automation-vcenter'
+# setup authorization
+VSphereAutomation::Configuration.new.tap do |config|
+  # Configure API key authorization: api_key
+  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
+end
 
 api_instance = VSphereAutomation::VCenter::VMApi.new
 opts = {
@@ -188,12 +216,12 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 

data/docs/VcenterCertificateManagementVcenterTlsCsrCreate.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsCsrCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**spec** | [**VcenterCertificateManagementVcenterTlsCsrSpec**](VcenterCertificateManagementVcenterTlsCsrSpec.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTlsCsrCreateResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsCsrCreateResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VcenterCertificateManagementVcenterTlsCsrInfo**](VcenterCertificateManagementVcenterTlsCsrInfo.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTlsCsrInfo.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsCsrInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**csr** | **String** | Certificate Signing Request in PEM format. | 
+
+

data/docs/VcenterCertificateManagementVcenterTlsCsrSpec.md

@@ -0,0 +1,16 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsCsrSpec
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key_size** | **Integer** | keySize will take 2048 bits if not modified. | [optional] 
+**common_name** | **String** | commonName will take PNID if not modified. | [optional] 
+**organization** | **String** | Organization field in certificate subject | 
+**organization_unit** | **String** | Organization unit field in certificate subject | 
+**locality** | **String** | Locality field in certificate subject | 
+**state_or_province** | **String** | State field in certificate subject | 
+**country** | **String** | Country field in certificate subject | 
+**email_address** | **String** | Email field in Certificate extensions | 
+**subject_alt_name** | **Array<String>** | subjectAltName is list of Dns Names and Ip addresses | [optional] 
+
+

data/docs/VcenterCertificateManagementVcenterTlsInfo.md

@@ -0,0 +1,21 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **Integer** | Version (version number) value from the certificate. | 
+**serial_number** | **String** | SerialNumber value from the certificate. | 
+**signature_algorithm** | **String** | Signature algorithm name from the certificate. | 
+**issuer_dn** | **String** | Issuer (issuer distinguished name) value from the certificate. | 
+**valid_from** | **DateTime** | validFrom specify the start date of the certificate. | 
+**valid_to** | **DateTime** | validTo specify the end date of the certificate. | 
+**subject_dn** | **String** | Subject (subject distinguished name) value from the certificate. | 
+**thumbprint** | **String** | Thumbprint value from the certificate. | 
+**basic_constraints** | **Integer** | Certificate constraints path length from the critical BasicConstraints extension, (OID = 2.5.29.19). | 
+**key_usage** | **Array<String>** | Collection of keyusage contained in the certificate. | 
+**extended_key_usage** | **Array<String>** | Collection of extended keyusage that contains details for which the certificate can be used for. | 
+**subject_alternative_name** | **Array<String>** | Collection of subject alternative names. | 
+**authority_information_access_uri** | **Array<String>** | Collection of authority information access URI. | 
+**cert** | **String** | TLS certificate in PEM format. | 
+
+

data/docs/VcenterCertificateManagementVcenterTlsRenew.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsRenew
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**duration** | **Integer** | The duration (in days) of the new TLS certificate. The duration should be less than or equal to 730 days. If unset, the duration will be 730 days (two years). | [optional] 
+
+

data/docs/VcenterCertificateManagementVcenterTlsResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VcenterCertificateManagementVcenterTlsInfo**](VcenterCertificateManagementVcenterTlsInfo.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTlsSet.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsSet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**spec** | [**VcenterCertificateManagementVcenterTlsSpec**](VcenterCertificateManagementVcenterTlsSpec.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTlsSpec.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTlsSpec
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cert** | **String** | Certificate string in PEM format. | 
+**key** | **String** | Private key string in PEM format. If unset, defaults to use the private key from VECS store. | [optional] 
+
+

data/docs/VcenterCertificateManagementVcenterTrustedRootChainsCreate.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTrustedRootChainsCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**spec** | [**VcenterCertificateManagementVcenterTrustedRootChainsCreateSpec**](VcenterCertificateManagementVcenterTrustedRootChainsCreateSpec.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTrustedRootChainsCreateResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTrustedRootChainsCreateResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTrustedRootChainsCreateSpec.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTrustedRootChainsCreateSpec
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cert_chain** | [**VcenterCertificateManagementX509CertChain**](VcenterCertificateManagementX509CertChain.md) |  | 
+**chain** | **String** | Unique identifier for this trusted root. Client can specify at creation as long as it is unique, otherwise one will be generated. An example of a client providing the identifier would be if this trusted root is associated with a VC trust. In this case the identifier would be the domain id. A unique id will be generated if not given. | [optional] 
+
+

data/docs/VcenterCertificateManagementVcenterTrustedRootChainsInfo.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTrustedRootChainsInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cert_chain** | [**VcenterCertificateManagementX509CertChain**](VcenterCertificateManagementX509CertChain.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTrustedRootChainsListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTrustedRootChainsListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**Array<VcenterCertificateManagementVcenterTrustedRootChainsSummary>**](VcenterCertificateManagementVcenterTrustedRootChainsSummary.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTrustedRootChainsResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTrustedRootChainsResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VcenterCertificateManagementVcenterTrustedRootChainsInfo**](VcenterCertificateManagementVcenterTrustedRootChainsInfo.md) |  | 
+
+

data/docs/VcenterCertificateManagementVcenterTrustedRootChainsSummary.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementVcenterTrustedRootChainsSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chain** | **String** | Unique identifier for chain. | 
+
+

data/docs/VcenterCertificateManagementX509CertChain.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VCenter::VcenterCertificateManagementX509CertChain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cert_chain** | **Array<String>** | Certificate chain in base64 format | 
+
+

data/docs/VcenterClusterSummary.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cluster** | **String** | Identifier of the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource. | 
 **name** | **String** | Name of the cluster. | 
-**ha_enabled** | **BOOLEAN** | Flag indicating whether the vSphere HA feature is enabled for the cluster. | 
-**drs_enabled** | **BOOLEAN** | Flag indicating whether the vSphere DRS service is enabled for the cluster. | 
+**ha_enabled** | **Boolean** | Flag indicating whether the vSphere HA feature is enabled for the cluster. | 
+**drs_enabled** | **Boolean** | Flag indicating whether the vSphere DRS service is enabled for the cluster. | 
 
 

data/docs/VcenterDatastoreInfo.md

@@ -5,9 +5,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the datastore. | 
 **type** | [**VcenterDatastoreType**](VcenterDatastoreType.md) |  | 
-**accessible** | **BOOLEAN** | Whether or not this datastore is accessible. | 
+**accessible** | **Boolean** | Whether or not this datastore is accessible. | 
 **free_space** | **Integer** | Available space of this datastore, in bytes.   The server periodically updates this value.  This field will be unset if the available space of this datastore is not known. | [optional] 
-**multiple_host_access** | **BOOLEAN** | Whether or not ore than one host in the datacenter has been configured with access to the datastore. | 
-**thin_provisioning_supported** | **BOOLEAN** | Whether or not the datastore supports thin provisioning on a per file basis. When thin provisioning is used, backing storage is lazily allocated. | 
+**multiple_host_access** | **Boolean** | Whether or not ore than one host in the datacenter has been configured with access to the datastore. | 
+**thin_provisioning_supported** | **Boolean** | Whether or not the datastore supports thin provisioning on a per file basis. When thin provisioning is used, backing storage is lazily allocated. | 
 
 

data/docs/VcenterDeploymentHistoryMigrationSpec.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data_set** | [**VcenterDeploymentHistoryMigrationOption**](VcenterDeploymentHistoryMigrationOption.md) |  | 
-**defer_import** | **BOOLEAN** | Defines how vCenter history will be migrated. If set to true, vCenter history will be migrated separately after successful upgrade or migration, otherwise it will be migrated along with core data during the upgrade or migration process. | [optional] 
+**defer_import** | **Boolean** | Defines how vCenter history will be migrated. If set to true, vCenter history will be migrated separately after successful upgrade or migration, otherwise it will be migrated along with core data during the upgrade or migration process. | [optional] 
 
 

data/docs/VcenterDeploymentImportHistoryInfo.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **parent** | **String** | Parent of the current task. | [optional] 
 **target** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | [optional] 
 **status** | [**CisTaskStatus**](CisTaskStatus.md) |  | 
-**cancelable** | **BOOLEAN** | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. | 
+**cancelable** | **Boolean** | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. | 
 **error** | **String** | Description of the error if the operation status is \"FAILED\". | [optional] 
 **start_time** | **DateTime** | Time when the operation is started. | [optional] 
 **end_time** | **DateTime** | Time when the operation is completed. | [optional] 

data/docs/VcenterDeploymentInfo.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **parent** | **String** | Parent of the current task. | [optional] 
 **target** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | [optional] 
 **status** | [**CisTaskStatus**](CisTaskStatus.md) |  | 
-**cancelable** | **BOOLEAN** | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. | 
+**cancelable** | **Boolean** | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. | 
 **error** | **String** | Description of the error if the operation status is \"FAILED\". | [optional] 
 **start_time** | **DateTime** | Time when the operation is started. | [optional] 
 **end_time** | **DateTime** | Time when the operation is completed. | [optional] 

data/docs/VcenterDeploymentInfoSubtasks.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**value** | [**VcenterDeploymentTask**](VcenterDeploymentTask.md) |  | [optional] 
 **key** | **String** |  | [optional] 
+**value** | [**VcenterDeploymentTask**](VcenterDeploymentTask.md) |  | [optional] 
 
 

data/docs/VcenterDeploymentInstallInstallSpec.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **vcsa_embedded** | [**VcenterDeploymentInstallVcsaEmbeddedSpec**](VcenterDeploymentInstallVcsaEmbeddedSpec.md) |  | [optional] 
 **psc** | [**VcenterDeploymentInstallPscSpec**](VcenterDeploymentInstallPscSpec.md) |  | [optional] 
 **vcsa_external** | [**VcenterDeploymentRemotePscSpec**](VcenterDeploymentRemotePscSpec.md) |  | [optional] 
-**auto_answer** | **BOOLEAN** | Use the default option for any questions that may come up during appliance configuration. | [optional] 
+**auto_answer** | **Boolean** | Use the default option for any questions that may come up during appliance configuration. | [optional] 
 
 

data/docs/VcenterDeploymentInstallPscSpec.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **standalone** | [**VcenterDeploymentStandalonePscSpec**](VcenterDeploymentStandalonePscSpec.md) |  | [optional] 
 **replicated** | [**VcenterDeploymentReplicatedPscSpec**](VcenterDeploymentReplicatedPscSpec.md) |  | [optional] 
-**ceip_enabled** | **BOOLEAN** | Customer experience improvement program should be enabled or disabled. | 
+**ceip_enabled** | **Boolean** | Customer experience improvement program should be enabled or disabled. | 
 
 

data/docs/VcenterDeploymentInstallVcsaEmbeddedSpec.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **standalone** | [**VcenterDeploymentStandaloneSpec**](VcenterDeploymentStandaloneSpec.md) |  | [optional] 
 **replicated** | [**VcenterDeploymentReplicatedSpec**](VcenterDeploymentReplicatedSpec.md) |  | [optional] 
-**ceip_enabled** | **BOOLEAN** | Whether CEIP should be enabled or disabled. | 
+**ceip_enabled** | **Boolean** | Whether CEIP should be enabled or disabled. | 
 
 

data/docs/VcenterDeploymentLocationSpec.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **hostname** | **String** | The IP address or DNS resolvable name of the container. | 
 **https_port** | **Integer** | The HTTPS port of the container. | [optional] 
 **ssl_thumbprint** | **String** | SHA1 thumbprint of the server SSL certificate will be used for verification. | [optional] 
-**ssl_verify** | **BOOLEAN** | SSL verification should be enabled or disabled. If {@name #sslVerify} is true and and {@name #sslThumbprint} is {@term unset}, the CA certificate will be used for verification. If {@name #sslVerify} is true and {@name #sslThumbprint} is set then the thumbprint will be used for verification. No verification will be performed if {@name #sslVerify} value is set to false. | [optional] 
+**ssl_verify** | **Boolean** | SSL verification should be enabled or disabled. If {@name #sslVerify} is true and and {@name #sslThumbprint} is {@term unset}, the CA certificate will be used for verification. If {@name #sslVerify} is true and {@name #sslThumbprint} is set then the thumbprint will be used for verification. No verification will be performed if {@name #sslVerify} value is set to false. | [optional] 
 **username** | **String** | The administrator account on the host. | 
 **password** | **String** | The administrator account password. | 
 

data/docs/VcenterDeploymentRemotePscSpec.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **https_port** | **Integer** | The HTTPS port of the external PSC appliance. | [optional] 
 **sso_admin_password** | **String** | The SSO administrator account password. | 
 **ssl_thumbprint** | **String** | SHA1 thumbprint of the server SSL certificate will be used for verification when ssl_verify field is set to true. | [optional] 
-**ssl_verify** | **BOOLEAN** | SSL verification should be enabled or disabled. If {@name #sslVerify} is true and and {@name #sslThumbprint} is {@term unset}, the CA certificate will be used for verification. If {@name #sslVerify} is true and {@name #sslThumbprint} is set then the thumbprint will be used for verification. No verification will be performed if {@name #sslVerify} value is set to false. | [optional] 
+**ssl_verify** | **Boolean** | SSL verification should be enabled or disabled. If {@name #sslVerify} is true and and {@name #sslThumbprint} is {@term unset}, the CA certificate will be used for verification. If {@name #sslVerify} is true and {@name #sslThumbprint} is set then the thumbprint will be used for verification. No verification will be performed if {@name #sslVerify} value is set to false. | [optional]