vsphere-automation-vapi 0.1.0

data/docs/MetadataAuthenticationPackageApi.md

@@ -0,0 +1,92 @@
+# VSphereAutomation::VAPI::MetadataAuthenticationPackageApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](MetadataAuthenticationPackageApi.md#get) | **GET** /com/vmware/vapi/metadata/authentication/package/id:{package_id} | Retrieves authentication information about the package element corresponding to {@param.name packageId}.
+[**list**](MetadataAuthenticationPackageApi.md#list) | **GET** /com/vmware/vapi/metadata/authentication/package | Returns the identifiers for the package elements that have authentication information.
+
+
+# **get**
+> VapiMetadataAuthenticationPackageResult get(package_id)
+
+Retrieves authentication information about the package element corresponding to {@param.name packageId}.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataAuthenticationPackageApi.new
+package_id = 'package_id_example' # String | Identifier of the package element.
+
+begin
+  #Retrieves authentication information about the package element corresponding to {@param.name packageId}.
+  result = api_instance.get(package_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataAuthenticationPackageApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_id** | **String**| Identifier of the package element. | 
+
+### Return type
+
+[**VapiMetadataAuthenticationPackageResult**](VapiMetadataAuthenticationPackageResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataAuthenticationPackageListResult list
+
+Returns the identifiers for the package elements that have authentication information.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataAuthenticationPackageApi.new
+
+begin
+  #Returns the identifiers for the package elements that have authentication information.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataAuthenticationPackageApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataAuthenticationPackageListResult**](VapiMetadataAuthenticationPackageListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataAuthenticationServiceApi.md

@@ -0,0 +1,92 @@
+# VSphereAutomation::VAPI::MetadataAuthenticationServiceApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](MetadataAuthenticationServiceApi.md#get) | **GET** /com/vmware/vapi/metadata/authentication/service/id:{service_id} | Retrieves authentication information about the service element corresponding to {@param.name serviceId}.
+[**list**](MetadataAuthenticationServiceApi.md#list) | **GET** /com/vmware/vapi/metadata/authentication/service | Returns the identifiers for the service elements that have authentication information.
+
+
+# **get**
+> VapiMetadataAuthenticationServiceResult get(service_id)
+
+Retrieves authentication information about the service element corresponding to {@param.name serviceId}.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataAuthenticationServiceApi.new
+service_id = 'service_id_example' # String | Identifier of the service element.
+
+begin
+  #Retrieves authentication information about the service element corresponding to {@param.name serviceId}.
+  result = api_instance.get(service_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataAuthenticationServiceApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_id** | **String**| Identifier of the service element. | 
+
+### Return type
+
+[**VapiMetadataAuthenticationServiceResult**](VapiMetadataAuthenticationServiceResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataAuthenticationServiceListResult list
+
+Returns the identifiers for the service elements that have authentication information.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataAuthenticationServiceApi.new
+
+begin
+  #Returns the identifiers for the service elements that have authentication information.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataAuthenticationServiceApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataAuthenticationServiceListResult**](VapiMetadataAuthenticationServiceListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataAuthenticationServiceOperationApi.md

@@ -0,0 +1,98 @@
+# VSphereAutomation::VAPI::MetadataAuthenticationServiceOperationApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](MetadataAuthenticationServiceOperationApi.md#get) | **POST** /com/vmware/vapi/metadata/authentication/service/operation/id:{service_id}?~action=get | Retrieves the authentication information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
+[**list**](MetadataAuthenticationServiceOperationApi.md#list) | **GET** /com/vmware/vapi/metadata/authentication/service/operation | Returns the identifiers for the operation elements contained in the service element corresponding to {@param.name serviceId} that have authentication information.
+
+
+# **get**
+> VapiMetadataAuthenticationServiceOperationResult get(service_id, vapi_metadata_authentication_service_operation_get)
+
+Retrieves the authentication information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataAuthenticationServiceOperationApi.new
+service_id = 'service_id_example' # String | Identifier of the service element.
+vapi_metadata_authentication_service_operation_get = VSphereAutomation::VapiMetadataAuthenticationServiceOperationGet.new # VapiMetadataAuthenticationServiceOperationGet | 
+
+begin
+  #Retrieves the authentication information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
+  result = api_instance.get(service_id, vapi_metadata_authentication_service_operation_get)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataAuthenticationServiceOperationApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_id** | **String**| Identifier of the service element. | 
+ **vapi_metadata_authentication_service_operation_get** | [**VapiMetadataAuthenticationServiceOperationGet**](VapiMetadataAuthenticationServiceOperationGet.md)|  | 
+
+### Return type
+
+[**VapiMetadataAuthenticationServiceOperationResult**](VapiMetadataAuthenticationServiceOperationResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataAuthenticationServiceOperationListResult list(service_id)
+
+Returns the identifiers for the operation elements contained in the service element corresponding to {@param.name serviceId} that have authentication information.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataAuthenticationServiceOperationApi.new
+service_id = 'service_id_example' # String | Identifier of the service element.
+
+begin
+  #Returns the identifiers for the operation elements contained in the service element corresponding to {@param.name serviceId} that have authentication information.
+  result = api_instance.list(service_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataAuthenticationServiceOperationApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_id** | **String**| Identifier of the service element. | 
+
+### Return type
+
+[**VapiMetadataAuthenticationServiceOperationListResult**](VapiMetadataAuthenticationServiceOperationListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataCliCommandApi.md

@@ -0,0 +1,138 @@
+# VSphereAutomation::VAPI::MetadataCliCommandApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fingerprint**](MetadataCliCommandApi.md#fingerprint) | **POST** /com/vmware/vapi/metadata/cli/command?~action=fingerprint | Returns the aggregate fingerprint of all the command metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.
+[**get**](MetadataCliCommandApi.md#get) | **POST** /com/vmware/vapi/metadata/cli/command?~action=get | Retrieves information about a command including information about how to execute that command.
+[**list**](MetadataCliCommandApi.md#list) | **GET** /com/vmware/vapi/metadata/cli/command | Returns the identifiers of all commands, or commands in a specific namespace.
+
+
+# **fingerprint**
+> VapiMetadataCliCommandFingerprintResult fingerprint
+
+Returns the aggregate fingerprint of all the command metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataCliCommandApi.new
+
+begin
+  #Returns the aggregate fingerprint of all the command metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.
+  result = api_instance.fingerprint
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataCliCommandApi->fingerprint: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataCliCommandFingerprintResult**](VapiMetadataCliCommandFingerprintResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get**
+> VapiMetadataCliCommandResult get(vapi_metadata_cli_command_get)
+
+Retrieves information about a command including information about how to execute that command.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataCliCommandApi.new
+vapi_metadata_cli_command_get = VSphereAutomation::VapiMetadataCliCommandGet.new # VapiMetadataCliCommandGet | 
+
+begin
+  #Retrieves information about a command including information about how to execute that command.
+  result = api_instance.get(vapi_metadata_cli_command_get)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataCliCommandApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vapi_metadata_cli_command_get** | [**VapiMetadataCliCommandGet**](VapiMetadataCliCommandGet.md)|  | 
+
+### Return type
+
+[**VapiMetadataCliCommandResult**](VapiMetadataCliCommandResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataCliCommandListResult list(opts)
+
+Returns the identifiers of all commands, or commands in a specific namespace.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataCliCommandApi.new
+opts = {
+  path: 'path_example' # String | The dot-separated path of the namespace for which command identifiers should be returned.
+}
+
+begin
+  #Returns the identifiers of all commands, or commands in a specific namespace.
+  result = api_instance.list(opts)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataCliCommandApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**| The dot-separated path of the namespace for which command identifiers should be returned. | [optional] 
+
+### Return type
+
+[**VapiMetadataCliCommandListResult**](VapiMetadataCliCommandListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataCliNamespaceApi.md

@@ -0,0 +1,132 @@
+# VSphereAutomation::VAPI::MetadataCliNamespaceApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fingerprint**](MetadataCliNamespaceApi.md#fingerprint) | **POST** /com/vmware/vapi/metadata/cli/namespace?~action=fingerprint | Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.
+[**get**](MetadataCliNamespaceApi.md#get) | **POST** /com/vmware/vapi/metadata/cli/namespace?~action=get | Retreives information about a namespace including information about children of that namespace.
+[**list**](MetadataCliNamespaceApi.md#list) | **GET** /com/vmware/vapi/metadata/cli/namespace | Returns the identifiers of all namespaces registered with the infrastructure.
+
+
+# **fingerprint**
+> VapiMetadataCliNamespaceFingerprintResult fingerprint
+
+Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataCliNamespaceApi.new
+
+begin
+  #Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources. <p> The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.
+  result = api_instance.fingerprint
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataCliNamespaceApi->fingerprint: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataCliNamespaceFingerprintResult**](VapiMetadataCliNamespaceFingerprintResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get**
+> VapiMetadataCliNamespaceResult get(vapi_metadata_cli_namespace_get)
+
+Retreives information about a namespace including information about children of that namespace.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataCliNamespaceApi.new
+vapi_metadata_cli_namespace_get = VSphereAutomation::VapiMetadataCliNamespaceGet.new # VapiMetadataCliNamespaceGet | 
+
+begin
+  #Retreives information about a namespace including information about children of that namespace.
+  result = api_instance.get(vapi_metadata_cli_namespace_get)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataCliNamespaceApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vapi_metadata_cli_namespace_get** | [**VapiMetadataCliNamespaceGet**](VapiMetadataCliNamespaceGet.md)|  | 
+
+### Return type
+
+[**VapiMetadataCliNamespaceResult**](VapiMetadataCliNamespaceResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataCliNamespaceListResult list
+
+Returns the identifiers of all namespaces registered with the infrastructure.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataCliNamespaceApi.new
+
+begin
+  #Returns the identifiers of all namespaces registered with the infrastructure.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataCliNamespaceApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataCliNamespaceListResult**](VapiMetadataCliNamespaceListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+