RubyGems - vsphere-automation-vapi - Versions diffs - 0.4.5 → 0.4.6 - Mend

vsphere-automation-vapi 0.4.5 → 0.4.6

Files changed (330) hide show

data/docs/MetadataAuthenticationPackageApi.md DELETED

@@ -1,106 +0,0 @@
-# VSphereAutomation::VAPI::MetadataAuthenticationPackageApi
-All URIs are relative to *https://&lt;vcenter&gt;/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'
-# 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::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
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **list**
-> VapiMetadataAuthenticationPackageListResult list
-Returns the identifiers for the package elements that have authentication information.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# 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::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
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataAuthenticationServiceApi.md DELETED

@@ -1,106 +0,0 @@
-# VSphereAutomation::VAPI::MetadataAuthenticationServiceApi
-All URIs are relative to *https://&lt;vcenter&gt;/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'
-# 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::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
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **list**
-> VapiMetadataAuthenticationServiceListResult list
-Returns the identifiers for the service elements that have authentication information.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# 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::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
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataAuthenticationServiceOperationApi.md DELETED

@@ -1,112 +0,0 @@
-# VSphereAutomation::VAPI::MetadataAuthenticationServiceOperationApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](MetadataAuthenticationServiceOperationApi.md#get) | **POST** /com/vmware/vapi/metadata/authentication/service/operation/id:{service_id}?~action&#x3D;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, request_body)
-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'
-# 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::VAPI::MetadataAuthenticationServiceOperationApi.new
-service_id = 'service_id_example' # String | Identifier of the service element.
-request_body = VAPI::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, request_body)
-  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. |
- **request_body** | [**VapiMetadataAuthenticationServiceOperationGet**](VapiMetadataAuthenticationServiceOperationGet.md)|  |
-### Return type
-[**VapiMetadataAuthenticationServiceOperationResult**](VapiMetadataAuthenticationServiceOperationResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **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'
-# 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::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
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataCliCommandApi.md DELETED

@@ -1,159 +0,0 @@
-# VSphereAutomation::VAPI::MetadataCliCommandApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**fingerprint**](MetadataCliCommandApi.md#fingerprint) | **POST** /com/vmware/vapi/metadata/cli/command?~action&#x3D;fingerprint | Returns the aggregate fingerprint of all the command metadata from all the metadata sources. &lt;p&gt; 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&#x3D;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'
-# 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::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
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **get**
-> VapiMetadataCliCommandResult get(request_body)
-Retrieves information about a command including information about how to execute that command.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# 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::VAPI::MetadataCliCommandApi.new
-request_body = VAPI::VapiMetadataCliCommandGet.new # VapiMetadataCliCommandGet |
-begin
-  #Retrieves information about a command including information about how to execute that command.
-  result = api_instance.get(request_body)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataCliCommandApi->get: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **request_body** | [**VapiMetadataCliCommandGet**](VapiMetadataCliCommandGet.md)|  |
-### Return type
-[**VapiMetadataCliCommandResult**](VapiMetadataCliCommandResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-# **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'
-# 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::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
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json