vsphere-automation-vcenter 0.1.0 → 0.2.0

data/docs/DeploymentInstallInitialConfigRemotePscThumbprintApi.md

@@ -16,6 +16,13 @@ Gets the SHA1 thumbprint of the remote PSC.
 ```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::DeploymentInstallInitialConfigRemotePscThumbprintApi.new
 spec_address = 'spec_address_example' # String | The IP address or DNS resolvable name of the remote PSC.
@@ -45,12 +52,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/DeploymentInstallPscReplicatedApi.md

@@ -4,11 +4,11 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**check**](DeploymentInstallPscReplicatedApi.md#check) | **POST** /vcenter/deployment/install/psc/replicated?action=check | Checks whether the provided remote PSC is reachable and can be replicated.
+[**check**](DeploymentInstallPscReplicatedApi.md#check) | **POST** /vcenter/deployment/install/psc/replicated | Checks whether the provided remote PSC is reachable and can be replicated.
 
 
 # **check**
-> VcenterDeploymentInstallPscReplicatedCheckResult check(vcenter_deployment_install_psc_replicated_check)
+> VcenterDeploymentInstallPscReplicatedCheckResult check(action, request_body)
 
 Checks whether the provided remote PSC is reachable and can be replicated.
 
@@ -16,13 +16,21 @@ Checks whether the provided remote PSC is reachable and can be replicated.
 ```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::DeploymentInstallPscReplicatedApi.new
-vcenter_deployment_install_psc_replicated_check = VSphereAutomation::VcenterDeploymentInstallPscReplicatedCheck.new # VcenterDeploymentInstallPscReplicatedCheck | 
+action = 'action_example' # String | action=check
+request_body = VCenter::VcenterDeploymentInstallPscReplicatedCheck.new # VcenterDeploymentInstallPscReplicatedCheck | 
 
 begin
   #Checks whether the provided remote PSC is reachable and can be replicated.
-  result = api_instance.check(vcenter_deployment_install_psc_replicated_check)
+  result = api_instance.check(action, request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling DeploymentInstallPscReplicatedApi->check: #{e}"
@@ -33,7 +41,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **vcenter_deployment_install_psc_replicated_check** | [**VcenterDeploymentInstallPscReplicatedCheck**](VcenterDeploymentInstallPscReplicatedCheck.md)|  | 
+ **action** | **String**| action=check | 
+ **request_body** | [**VcenterDeploymentInstallPscReplicatedCheck**](VcenterDeploymentInstallPscReplicatedCheck.md)|  | 
 
 ### Return type
 
@@ -41,12 +50,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
 
 
 

data/docs/DeploymentInstallPscStandaloneApi.md

@@ -4,11 +4,11 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**check**](DeploymentInstallPscStandaloneApi.md#check) | **POST** /vcenter/deployment/install/psc/standalone?action=check | Checks that the information to configure a non-replicated PSC satisfies the requirements.
+[**check**](DeploymentInstallPscStandaloneApi.md#check) | **POST** /vcenter/deployment/install/psc/standalone | Checks that the information to configure a non-replicated PSC satisfies the requirements.
 
 
 # **check**
-> VcenterDeploymentInstallPscStandaloneCheckResult check(vcenter_deployment_install_psc_standalone_check)
+> VcenterDeploymentInstallPscStandaloneCheckResult check(action, request_body)
 
 Checks that the information to configure a non-replicated PSC satisfies the requirements.
 
@@ -16,13 +16,21 @@ Checks that the information to configure a non-replicated PSC satisfies the requ
 ```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::DeploymentInstallPscStandaloneApi.new
-vcenter_deployment_install_psc_standalone_check = VSphereAutomation::VcenterDeploymentInstallPscStandaloneCheck.new # VcenterDeploymentInstallPscStandaloneCheck | 
+action = 'action_example' # String | action=check
+request_body = VCenter::VcenterDeploymentInstallPscStandaloneCheck.new # VcenterDeploymentInstallPscStandaloneCheck | 
 
 begin
   #Checks that the information to configure a non-replicated PSC satisfies the requirements.
-  result = api_instance.check(vcenter_deployment_install_psc_standalone_check)
+  result = api_instance.check(action, request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling DeploymentInstallPscStandaloneApi->check: #{e}"
@@ -33,7 +41,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **vcenter_deployment_install_psc_standalone_check** | [**VcenterDeploymentInstallPscStandaloneCheck**](VcenterDeploymentInstallPscStandaloneCheck.md)|  | 
+ **action** | **String**| action=check | 
+ **request_body** | [**VcenterDeploymentInstallPscStandaloneCheck**](VcenterDeploymentInstallPscStandaloneCheck.md)|  | 
 
 ### Return type
 
@@ -41,12 +50,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
 
 
 

data/docs/DeploymentInstallRemotePscApi.md

@@ -4,11 +4,11 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**check**](DeploymentInstallRemotePscApi.md#check) | **POST** /vcenter/deployment/install/remote-psc?action=check | Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.
+[**check**](DeploymentInstallRemotePscApi.md#check) | **POST** /vcenter/deployment/install/remote-psc | Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.
 
 
 # **check**
-> VcenterDeploymentInstallRemotePscCheckResult check(vcenter_deployment_install_remote_psc_check)
+> VcenterDeploymentInstallRemotePscCheckResult check(action, request_body)
 
 Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.
 
@@ -16,13 +16,21 @@ Checks whether the remote PSC is reachable and the deployed vCenter Server can b
 ```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::DeploymentInstallRemotePscApi.new
-vcenter_deployment_install_remote_psc_check = VSphereAutomation::VcenterDeploymentInstallRemotePscCheck.new # VcenterDeploymentInstallRemotePscCheck | 
+action = 'action_example' # String | action=check
+request_body = VCenter::VcenterDeploymentInstallRemotePscCheck.new # VcenterDeploymentInstallRemotePscCheck | 
 
 begin
   #Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC.
-  result = api_instance.check(vcenter_deployment_install_remote_psc_check)
+  result = api_instance.check(action, request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling DeploymentInstallRemotePscApi->check: #{e}"
@@ -33,7 +41,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **vcenter_deployment_install_remote_psc_check** | [**VcenterDeploymentInstallRemotePscCheck**](VcenterDeploymentInstallRemotePscCheck.md)|  | 
+ **action** | **String**| action=check | 
+ **request_body** | [**VcenterDeploymentInstallRemotePscCheck**](VcenterDeploymentInstallRemotePscCheck.md)|  | 
 
 ### Return type
 
@@ -41,12 +50,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
 
 
 

data/docs/DeploymentQuestionApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**answer**](DeploymentQuestionApi.md#answer) | **POST** /vcenter/deployment/question?action=answer | Supply answer to the raised question.
+[**answer**](DeploymentQuestionApi.md#answer) | **POST** /vcenter/deployment/question | Supply answer to the raised question.
 [**get**](DeploymentQuestionApi.md#get) | **GET** /vcenter/deployment/question | Get the question that was raised during the configuration.
 
 
 # **answer**
-> answer(vcenter_deployment_question_answer)
+> answer(action, request_body)
 
 Supply answer to the raised question.
 
@@ -17,13 +17,21 @@ Supply answer to the raised question.
 ```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::DeploymentQuestionApi.new
-vcenter_deployment_question_answer = VSphereAutomation::VcenterDeploymentQuestionAnswer.new # VcenterDeploymentQuestionAnswer | 
+action = 'action_example' # String | action=answer
+request_body = VCenter::VcenterDeploymentQuestionAnswer.new # VcenterDeploymentQuestionAnswer | 
 
 begin
   #Supply answer to the raised question.
-  api_instance.answer(vcenter_deployment_question_answer)
+  api_instance.answer(action, request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling DeploymentQuestionApi->answer: #{e}"
 end
@@ -33,7 +41,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **vcenter_deployment_question_answer** | [**VcenterDeploymentQuestionAnswer**](VcenterDeploymentQuestionAnswer.md)|  | 
+ **action** | **String**| action=answer | 
+ **request_body** | [**VcenterDeploymentQuestionAnswer**](VcenterDeploymentQuestionAnswer.md)|  | 
 
 ### Return type
 
@@ -41,12 +50,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
@@ -59,6 +68,13 @@ Get the question that was raised during the configuration.
 ```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::DeploymentQuestionApi.new
 
@@ -80,12 +96,12 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 

data/docs/DeploymentUpgradeApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://<vcenter>/rest*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**cancel**](DeploymentUpgradeApi.md#cancel) | **POST** /vcenter/deployment/upgrade?action=cancel | Cancel the appliance upgrade that is in progress.
+[**cancel**](DeploymentUpgradeApi.md#cancel) | **POST** /vcenter/deployment/upgrade | Cancel the appliance upgrade that is in progress.
 [**check**](DeploymentUpgradeApi.md#check) | **POST** /vcenter/deployment/upgrade?action=check | Run sanity checks using the UpgradeSpec parameters passed.
 [**get**](DeploymentUpgradeApi.md#get) | **GET** /vcenter/deployment/upgrade | Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
 [**start**](DeploymentUpgradeApi.md#start) | **POST** /vcenter/deployment/upgrade?action=start | Start the appliance installation.
 
 
 # **cancel**
-> cancel
+> cancel(action)
 
 Cancel the appliance upgrade that is in progress.
 
@@ -19,19 +19,30 @@ Cancel the appliance upgrade that is in progress.
 ```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::DeploymentUpgradeApi.new
+action = 'action_example' # String | action=cancel
 
 begin
   #Cancel the appliance upgrade that is in progress.
-  api_instance.cancel
+  api_instance.cancel(action)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling DeploymentUpgradeApi->cancel: #{e}"
 end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **action** | **String**| action=cancel | 
 
 ### Return type
 
@@ -39,17 +50,17 @@ 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
 
 
 
 # **check**
-> VcenterDeploymentUpgradeCheckResult check(vcenter_deployment_upgrade_check)
+> VcenterDeploymentUpgradeCheckResult check(request_body)
 
 Run sanity checks using the UpgradeSpec parameters passed.
 
@@ -57,13 +68,20 @@ Run sanity checks using the UpgradeSpec parameters passed.
 ```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::DeploymentUpgradeApi.new
-vcenter_deployment_upgrade_check = VSphereAutomation::VcenterDeploymentUpgradeCheck.new # VcenterDeploymentUpgradeCheck | 
+request_body = VCenter::VcenterDeploymentUpgradeCheck.new # VcenterDeploymentUpgradeCheck | 
 
 begin
   #Run sanity checks using the UpgradeSpec parameters passed.
-  result = api_instance.check(vcenter_deployment_upgrade_check)
+  result = api_instance.check(request_body)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling DeploymentUpgradeApi->check: #{e}"
@@ -74,7 +92,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **vcenter_deployment_upgrade_check** | [**VcenterDeploymentUpgradeCheck**](VcenterDeploymentUpgradeCheck.md)|  | 
+ **request_body** | [**VcenterDeploymentUpgradeCheck**](VcenterDeploymentUpgradeCheck.md)|  | 
 
 ### Return type
 
@@ -82,12 +100,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
 
 
 
@@ -100,6 +118,13 @@ Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
 ```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::DeploymentUpgradeApi.new
 
@@ -121,17 +146,17 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: */*
+ - **Accept**: application/json
 
 
 
 # **start**
-> start(vcenter_deployment_upgrade_start)
+> start(request_body)
 
 Start the appliance installation.
 
@@ -139,13 +164,20 @@ Start the appliance installation.
 ```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::DeploymentUpgradeApi.new
-vcenter_deployment_upgrade_start = VSphereAutomation::VcenterDeploymentUpgradeStart.new # VcenterDeploymentUpgradeStart | 
+request_body = VCenter::VcenterDeploymentUpgradeStart.new # VcenterDeploymentUpgradeStart | 
 
 begin
   #Start the appliance installation.
-  api_instance.start(vcenter_deployment_upgrade_start)
+  api_instance.start(request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling DeploymentUpgradeApi->start: #{e}"
 end
@@ -155,7 +187,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **vcenter_deployment_upgrade_start** | [**VcenterDeploymentUpgradeStart**](VcenterDeploymentUpgradeStart.md)|  | 
+ **request_body** | [**VcenterDeploymentUpgradeStart**](VcenterDeploymentUpgradeStart.md)|  | 
 
 ### Return type
 
@@ -163,12 +195,12 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: */*
+ - **Accept**: application/json