vsphere-automation-appliance 0.1.0 → 0.2.0

data/docs/LocalAccountsPolicyApi.md

@@ -17,6 +17,13 @@ Get the global password policy.
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::LocalAccountsPolicyApi.new
 
@@ -38,17 +45,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
 
 
 
 # **set**
-> set(appliance_local_accounts_policy_set)
+> set(request_body)
 
 Set the global password policy.
 
@@ -56,13 +63,20 @@ Set the global password policy.
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::LocalAccountsPolicyApi.new
-appliance_local_accounts_policy_set = VSphereAutomation::ApplianceLocalAccountsPolicySet.new # ApplianceLocalAccountsPolicySet | 
+request_body = Appliance::ApplianceLocalAccountsPolicySet.new # ApplianceLocalAccountsPolicySet | 
 
 begin
   #Set the global password policy.
-  api_instance.set(appliance_local_accounts_policy_set)
+  api_instance.set(request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LocalAccountsPolicyApi->set: #{e}"
 end
@@ -72,7 +86,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **appliance_local_accounts_policy_set** | [**ApplianceLocalAccountsPolicySet**](ApplianceLocalAccountsPolicySet.md)|  | 
+ **request_body** | [**ApplianceLocalAccountsPolicySet**](ApplianceLocalAccountsPolicySet.md)|  | 
 
 ### Return type
 
@@ -80,12 +94,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
 
 
 

data/docs/LoggingForwardingApi.md

@@ -6,7 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get**](LoggingForwardingApi.md#get) | **GET** /appliance/logging/forwarding | Returns the configuration for forwarding log messages to remote logging servers.
 [**set**](LoggingForwardingApi.md#set) | **PUT** /appliance/logging/forwarding | Sets the configuration for forwarding log messages to remote log servers.
-[**test**](LoggingForwardingApi.md#test) | **POST** /appliance/logging/forwarding?action=test | Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: \"This is a diagnostic log test message from vCenter Server.\"
+[**test**](LoggingForwardingApi.md#test) | **POST** /appliance/logging/forwarding | Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: \"This is a diagnostic log test message from vCenter Server.\"
 
 
 # **get**
@@ -18,6 +18,13 @@ Returns the configuration for forwarding log messages to remote logging servers.
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::LoggingForwardingApi.new
 
@@ -39,17 +46,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
 
 
 
 # **set**
-> set(appliance_logging_forwarding_set)
+> set(request_body)
 
 Sets the configuration for forwarding log messages to remote log servers.
 
@@ -57,13 +64,20 @@ Sets the configuration for forwarding log messages to remote log servers.
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::LoggingForwardingApi.new
-appliance_logging_forwarding_set = VSphereAutomation::ApplianceLoggingForwardingSet.new # ApplianceLoggingForwardingSet | 
+request_body = Appliance::ApplianceLoggingForwardingSet.new # ApplianceLoggingForwardingSet | 
 
 begin
   #Sets the configuration for forwarding log messages to remote log servers.
-  api_instance.set(appliance_logging_forwarding_set)
+  api_instance.set(request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LoggingForwardingApi->set: #{e}"
 end
@@ -73,7 +87,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **appliance_logging_forwarding_set** | [**ApplianceLoggingForwardingSet**](ApplianceLoggingForwardingSet.md)|  | 
+ **request_body** | [**ApplianceLoggingForwardingSet**](ApplianceLoggingForwardingSet.md)|  | 
 
 ### Return type
 
@@ -81,17 +95,17 @@ 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
 
 
 
 # **test**
-> ApplianceLoggingForwardingTestResult test(opts)
+> ApplianceLoggingForwardingTestResult test(action, opts)
 
 Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: \"This is a diagnostic log test message from vCenter Server.\"
 
@@ -99,15 +113,23 @@ Validates the current log forwarding configuration by checking the liveness of t
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::LoggingForwardingApi.new
+action = 'action_example' # String | action=test
 opts = {
-  appliance_logging_forwarding_test: VSphereAutomation::ApplianceLoggingForwardingTest.new # ApplianceLoggingForwardingTest | 
+  request_body: Appliance::ApplianceLoggingForwardingTest.new # ApplianceLoggingForwardingTest | 
 }
 
 begin
   #Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: \"This is a diagnostic log test message from vCenter Server.\"
-  result = api_instance.test(opts)
+  result = api_instance.test(action, opts)
   p result
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling LoggingForwardingApi->test: #{e}"
@@ -118,7 +140,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **appliance_logging_forwarding_test** | [**ApplianceLoggingForwardingTest**](ApplianceLoggingForwardingTest.md)|  | [optional] 
+ **action** | **String**| action=test | 
+ **request_body** | [**ApplianceLoggingForwardingTest**](ApplianceLoggingForwardingTest.md)|  | [optional] 
 
 ### Return type
 
@@ -126,12 +149,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/MonitoringApi.md

@@ -18,6 +18,13 @@ Get monitored item info
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::MonitoringApi.new
 stat_id = 'stat_id_example' # String | statistic item id
@@ -43,12 +50,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
 
 
 
@@ -61,6 +68,13 @@ Get monitored items list
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::MonitoringApi.new
 
@@ -82,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
 
 
 
@@ -100,6 +114,13 @@ Get monitoring data.
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::MonitoringApi.new
 item_names = ['item_names_example'] # Array<String> | monitored item IDs Ex: CPU, MEMORY
@@ -133,12 +154,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/NetworkingApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://<vcenter>/rest*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get**](NetworkingApi.md#get) | **GET** /appliance/networking | Get Networking information for all configured interfaces.
-[**reset**](NetworkingApi.md#reset) | **POST** /appliance/networking?action=reset | Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
+[**reset**](NetworkingApi.md#reset) | **POST** /appliance/networking | Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
 [**update**](NetworkingApi.md#update) | **PATCH** /appliance/networking | Enable or Disable ipv6 on all interfaces
 
 
@@ -18,6 +18,13 @@ Get Networking information for all configured interfaces.
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::NetworkingApi.new
 
@@ -39,17 +46,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
 
 
 
 # **reset**
-> reset
+> reset(action)
 
 Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
 
@@ -57,19 +64,30 @@ Reset and restarts network configuration on all interfaces, also this will renew
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::NetworkingApi.new
+action = 'action_example' # String | action=reset
 
 begin
   #Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
-  api_instance.reset
+  api_instance.reset(action)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling NetworkingApi->reset: #{e}"
 end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **action** | **String**| action=reset | 
 
 ### Return type
 
@@ -77,17 +95,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
 
 
 
 # **update**
-> update(appliance_networking_update)
+> update(request_body)
 
 Enable or Disable ipv6 on all interfaces
 
@@ -95,13 +113,20 @@ Enable or Disable ipv6 on all interfaces
 ```ruby
 # load the gem
 require 'vsphere-automation-appliance'
+# 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::Appliance::NetworkingApi.new
-appliance_networking_update = VSphereAutomation::ApplianceNetworkingUpdate.new # ApplianceNetworkingUpdate | 
+request_body = Appliance::ApplianceNetworkingUpdate.new # ApplianceNetworkingUpdate | 
 
 begin
   #Enable or Disable ipv6 on all interfaces
-  api_instance.update(appliance_networking_update)
+  api_instance.update(request_body)
 rescue VSphereAutomation::ApiError => e
   puts "Exception when calling NetworkingApi->update: #{e}"
 end
@@ -111,7 +136,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **appliance_networking_update** | [**ApplianceNetworkingUpdate**](ApplianceNetworkingUpdate.md)|  | 
+ **request_body** | [**ApplianceNetworkingUpdate**](ApplianceNetworkingUpdate.md)|  | 
 
 ### Return type
 
@@ -119,12 +144,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