vsphere-automation-appliance 0.1.0

data/docs/LoggingForwardingApi.md

@@ -0,0 +1,137 @@
+# VSphereAutomation::Appliance::LoggingForwardingApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+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.\"
+
+
+# **get**
+> ApplianceLoggingForwardingResult get
+
+Returns the configuration for forwarding log messages to remote logging servers.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::LoggingForwardingApi.new
+
+begin
+  #Returns the configuration for forwarding log messages to remote logging servers.
+  result = api_instance.get
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LoggingForwardingApi->get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApplianceLoggingForwardingResult**](ApplianceLoggingForwardingResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **set**
+> set(appliance_logging_forwarding_set)
+
+Sets the configuration for forwarding log messages to remote log servers.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::LoggingForwardingApi.new
+appliance_logging_forwarding_set = VSphereAutomation::ApplianceLoggingForwardingSet.new # ApplianceLoggingForwardingSet | 
+
+begin
+  #Sets the configuration for forwarding log messages to remote log servers.
+  api_instance.set(appliance_logging_forwarding_set)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LoggingForwardingApi->set: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appliance_logging_forwarding_set** | [**ApplianceLoggingForwardingSet**](ApplianceLoggingForwardingSet.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **test**
+> ApplianceLoggingForwardingTestResult test(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.\"
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::LoggingForwardingApi.new
+opts = {
+  appliance_logging_forwarding_test: VSphereAutomation::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)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LoggingForwardingApi->test: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appliance_logging_forwarding_test** | [**ApplianceLoggingForwardingTest**](ApplianceLoggingForwardingTest.md)|  | [optional] 
+
+### Return type
+
+[**ApplianceLoggingForwardingTestResult**](ApplianceLoggingForwardingTestResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/MonitoringApi.md

@@ -0,0 +1,144 @@
+# VSphereAutomation::Appliance::MonitoringApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](MonitoringApi.md#get) | **GET** /appliance/monitoring/{stat_id} | Get monitored item info
+[**list**](MonitoringApi.md#list) | **GET** /appliance/monitoring | Get monitored items list
+[**query**](MonitoringApi.md#query) | **GET** /appliance/monitoring/query | Get monitoring data.
+
+
+# **get**
+> ApplianceMonitoringResult get(stat_id)
+
+Get monitored item info
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::MonitoringApi.new
+stat_id = 'stat_id_example' # String | statistic item id
+
+begin
+  #Get monitored item info
+  result = api_instance.get(stat_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MonitoringApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stat_id** | **String**| statistic item id | 
+
+### Return type
+
+[**ApplianceMonitoringResult**](ApplianceMonitoringResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> ApplianceMonitoringListResult list
+
+Get monitored items list
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::MonitoringApi.new
+
+begin
+  #Get monitored items list
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MonitoringApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApplianceMonitoringListResult**](ApplianceMonitoringListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **query**
+> ApplianceMonitoringQueryResult query(item_names, item_interval, item_function, item_start_time, item_end_time)
+
+Get monitoring data.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::MonitoringApi.new
+item_names = ['item_names_example'] # Array<String> | monitored item IDs Ex: CPU, MEMORY
+item_interval = 'item_interval_example' # String | {@name IntervalType} {@term enumerated type} Defines interval between the values in hours and mins,                    for which aggregation will apply
+item_function = 'item_function_example' # String | {@name FunctionType} {@term enumerated type} Defines aggregation function
+item_start_time = 'item_start_time_example' # String | Start time in UTC
+item_end_time = 'item_end_time_example' # String | End time in UTC
+
+begin
+  #Get monitoring data.
+  result = api_instance.query(item_names, item_interval, item_function, item_start_time, item_end_time)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MonitoringApi->query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **item_names** | [**Array&lt;String&gt;**](String.md)| monitored item IDs Ex: CPU, MEMORY | 
+ **item_interval** | **String**| {@name IntervalType} {@term enumerated type} Defines interval between the values in hours and mins,                    for which aggregation will apply | 
+ **item_function** | **String**| {@name FunctionType} {@term enumerated type} Defines aggregation function | 
+ **item_start_time** | **String**| Start time in UTC | 
+ **item_end_time** | **String**| End time in UTC | 
+
+### Return type
+
+[**ApplianceMonitoringQueryResult**](ApplianceMonitoringQueryResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/NetworkingApi.md

@@ -0,0 +1,130 @@
+# VSphereAutomation::Appliance::NetworkingApi
+
+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.
+[**update**](NetworkingApi.md#update) | **PATCH** /appliance/networking | Enable or Disable ipv6 on all interfaces
+
+
+# **get**
+> ApplianceNetworkingResult get
+
+Get Networking information for all configured interfaces.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::NetworkingApi.new
+
+begin
+  #Get Networking information for all configured interfaces.
+  result = api_instance.get
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling NetworkingApi->get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApplianceNetworkingResult**](ApplianceNetworkingResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **reset**
+> reset
+
+Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::NetworkingApi.new
+
+begin
+  #Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
+  api_instance.reset
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling NetworkingApi->reset: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update**
+> update(appliance_networking_update)
+
+Enable or Disable ipv6 on all interfaces
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::NetworkingApi.new
+appliance_networking_update = VSphereAutomation::ApplianceNetworkingUpdate.new # ApplianceNetworkingUpdate | 
+
+begin
+  #Enable or Disable ipv6 on all interfaces
+  api_instance.update(appliance_networking_update)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling NetworkingApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appliance_networking_update** | [**ApplianceNetworkingUpdate**](ApplianceNetworkingUpdate.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/NetworkingDnsDomainsApi.md

@@ -0,0 +1,134 @@
+# VSphereAutomation::Appliance::NetworkingDnsDomainsApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add**](NetworkingDnsDomainsApi.md#add) | **POST** /appliance/networking/dns/domains | Add domain to DNS search domains.
+[**list**](NetworkingDnsDomainsApi.md#list) | **GET** /appliance/networking/dns/domains | Get list of DNS search domains.
+[**set**](NetworkingDnsDomainsApi.md#set) | **PUT** /appliance/networking/dns/domains | Set DNS search domains.
+
+
+# **add**
+> add(appliance_networking_dns_domains_add)
+
+Add domain to DNS search domains.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::NetworkingDnsDomainsApi.new
+appliance_networking_dns_domains_add = VSphereAutomation::ApplianceNetworkingDnsDomainsAdd.new # ApplianceNetworkingDnsDomainsAdd | 
+
+begin
+  #Add domain to DNS search domains.
+  api_instance.add(appliance_networking_dns_domains_add)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling NetworkingDnsDomainsApi->add: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appliance_networking_dns_domains_add** | [**ApplianceNetworkingDnsDomainsAdd**](ApplianceNetworkingDnsDomainsAdd.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list**
+> ApplianceNetworkingDnsDomainsListResult list
+
+Get list of DNS search domains.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::NetworkingDnsDomainsApi.new
+
+begin
+  #Get list of DNS search domains.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling NetworkingDnsDomainsApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApplianceNetworkingDnsDomainsListResult**](ApplianceNetworkingDnsDomainsListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **set**
+> set(appliance_networking_dns_domains_set)
+
+Set DNS search domains.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-appliance'
+
+api_instance = VSphereAutomation::Appliance::NetworkingDnsDomainsApi.new
+appliance_networking_dns_domains_set = VSphereAutomation::ApplianceNetworkingDnsDomainsSet.new # ApplianceNetworkingDnsDomainsSet | 
+
+begin
+  #Set DNS search domains.
+  api_instance.set(appliance_networking_dns_domains_set)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling NetworkingDnsDomainsApi->set: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appliance_networking_dns_domains_set** | [**ApplianceNetworkingDnsDomainsSet**](ApplianceNetworkingDnsDomainsSet.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+