vsphere-automation-cis 0.4.5 → 0.4.6

data/docs/CisTaggingTagAssociationDetach.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationDetach
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**object_id** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | 
-
-

data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObject.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationDetachMultipleTagsFromObject
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**object_id** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | 
-**tag_ids** | **Array<String>** | The identifiers of the input tags. | 
-
-

data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObjectResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationDetachMultipleTagsFromObjectResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**CisTaggingTagAssociationBatchResult**](CisTaggingTagAssociationBatchResult.md) |  | 
-
-

data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjects.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationDetachTagFromMultipleObjects
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**object_ids** | [**Array<VapiStdDynamicID>**](VapiStdDynamicID.md) | The identifiers of the input objects. | 
-
-

data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjectsResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationDetachTagFromMultipleObjectsResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**CisTaggingTagAssociationBatchResult**](CisTaggingTagAssociationBatchResult.md) |  | 
-
-

data/docs/CisTaggingTagAssociationListAttachableTags.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachableTags
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**object_id** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | 
-
-

data/docs/CisTaggingTagAssociationListAttachableTagsResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachableTagsResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/CisTaggingTagAssociationListAttachedObjectsOnTags.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachedObjectsOnTags
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tag_ids** | **Array<String>** | The identifiers of the input tags. | 
-
-

data/docs/CisTaggingTagAssociationListAttachedObjectsOnTagsResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachedObjectsOnTagsResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**Array<CisTaggingTagAssociationTagToObjects>**](CisTaggingTagAssociationTagToObjects.md) |  | 
-
-

data/docs/CisTaggingTagAssociationListAttachedObjectsResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachedObjectsResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**Array<VapiStdDynamicID>**](VapiStdDynamicID.md) |  | 
-
-

data/docs/CisTaggingTagAssociationListAttachedTags.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachedTags
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**object_id** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | 
-
-

data/docs/CisTaggingTagAssociationListAttachedTagsOnObjects.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachedTagsOnObjects
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**object_ids** | [**Array<VapiStdDynamicID>**](VapiStdDynamicID.md) | The identifiers of the input objects. | 
-
-

data/docs/CisTaggingTagAssociationListAttachedTagsOnObjectsResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachedTagsOnObjectsResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**Array<CisTaggingTagAssociationObjectToTags>**](CisTaggingTagAssociationObjectToTags.md) |  | 
-
-

data/docs/CisTaggingTagAssociationListAttachedTagsResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationListAttachedTagsResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/CisTaggingTagAssociationObjectToTags.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationObjectToTags
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**object_id** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | 
-**tag_ids** | **Array<String>** | The identifiers of the related tags. | 
-
-

data/docs/CisTaggingTagAssociationTagToObjects.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagAssociationTagToObjects
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tag_id** | **String** | The identifier of the tag. | 
-**object_ids** | [**Array<VapiStdDynamicID>**](VapiStdDynamicID.md) | The identifiers of the related objects. | 
-
-

data/docs/CisTaggingTagCreate.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagCreate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**create_spec** | [**CisTaggingTagCreateSpec**](CisTaggingTagCreateSpec.md) |  | 
-
-

data/docs/CisTaggingTagCreateResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagCreateResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **String** |  | 
-
-

data/docs/CisTaggingTagCreateSpec.md

@@ -1,11 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagCreateSpec
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The display name of the tag. The name must be unique within its category. | 
-**description** | **String** | The description of the tag. | 
-**category_id** | **String** | The unique identifier of the parent category in which this tag will be created. | 
-**tag_id** | **String** | The identifier of the tag. If specified, tag will be created with the specified identifier. This has to be of the tag ManagedObject Id format urn:vmomi:InventoryServiceTag:<id>:GLOBAL The <id> cannot contain special character ':' | [optional] 
-
-

data/docs/CisTaggingTagListResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagListResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/CisTaggingTagListTagsForCategoryResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagListTagsForCategoryResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/CisTaggingTagListUsedTags.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagListUsedTags
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**used_by_entity** | **String** | The field on which the results will be filtered. | 
-
-

data/docs/CisTaggingTagListUsedTagsResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagListUsedTagsResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Array<String>** |  | 
-
-

data/docs/CisTaggingTagModel.md

@@ -1,12 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagModel
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The unique identifier of the tag. | 
-**category_id** | **String** | The identifier of the parent category in which this tag will be created. | 
-**name** | **String** | The display name of the tag. | 
-**description** | **String** | The description of the tag. | 
-**used_by** | **Array<String>** | The {@term set} of users that can use this tag. To add users to this, you need to have the edit privilege on the tag. Similarly, to unsubscribe from this tag, you need the edit privilege on the tag. You should not modify other users subscription from this {@term set}. | 
-
-

data/docs/CisTaggingTagRemoveFromUsedBy.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagRemoveFromUsedBy
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**used_by_entity** | **String** | The name of the user to be removed from the {@link TagModel#usedBy} {@term set}. | 
-
-

data/docs/CisTaggingTagResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**CisTaggingTagModel**](CisTaggingTagModel.md) |  | 
-
-

data/docs/CisTaggingTagUpdate.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagUpdate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**update_spec** | [**CisTaggingTagUpdateSpec**](CisTaggingTagUpdateSpec.md) |  | 
-
-

data/docs/CisTaggingTagUpdateSpec.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::CIS::CisTaggingTagUpdateSpec
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The display name of the tag. | [optional] 
-**description** | **String** | The description of the tag. | [optional] 
-
-

data/docs/CisTaskInfo.md

@@ -1,19 +0,0 @@
-# VSphereAutomation::CIS::CisTaskInfo
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**progress** | [**CisTaskProgress**](CisTaskProgress.md) |  | [optional] 
-**description** | [**VapiStdLocalizableMessage**](VapiStdLocalizableMessage.md) |  | 
-**service** | **String** | Identifier of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: vapi.service. | 
-**operation** | **String** | Identifier of the operation associated with the task. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: vapi.operation. | 
-**parent** | **String** | Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: cis.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: cis.task. | [optional] 
-**target** | [**VapiStdDynamicID**](VapiStdDynamicID.md) |  | [optional] 
-**status** | [**CisTaskStatus**](CisTaskStatus.md) |  | 
-**cancelable** | **Boolean** | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. | 
-**error** | **String** | Description of the error if the operation status is \"FAILED\". If unset the description of why the operation failed will be included in the result of the operation (see Info.result). | [optional] 
-**start_time** | **DateTime** | Time when the operation is started. This field is optional and it is only relevant when the value of CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED. | [optional] 
-**end_time** | **DateTime** | Time when the operation is completed. This field is optional and it is only relevant when the value of CommonInfo.status is one of SUCCEEDED or FAILED. | [optional] 
-**user** | **String** | Name of the user who performed the operation. This field will be unset if the operation is performed by the system. | [optional] 
-
-

data/docs/CisTaskProgress.md

@@ -1,10 +0,0 @@
-# VSphereAutomation::CIS::CisTaskProgress
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total** | **Integer** | Total amount of the work for the operation. | 
-**completed** | **Integer** | The amount of work completed for the operation. The value can only be incremented. | 
-**message** | [**VapiStdLocalizableMessage**](VapiStdLocalizableMessage.md) |  | 
-
-

data/docs/CisTaskStatus.md

@@ -1,7 +0,0 @@
-# VSphereAutomation::CIS::CisTaskStatus
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/CisTasksFilterSpec.md

@@ -1,12 +0,0 @@
-# VSphereAutomation::CIS::CisTasksFilterSpec
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tasks** | **Array<String>** | Identifiers of tasks that can match the filter. This field may be unset if Tasks.FilterSpec.services is specified. Currently all tasks must be from the same provider. If unset or empty, tasks with any identifier will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: cis.task. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: cis.task. | [optional] 
-**services** | **Array<String>** | Identifiers of services. Tasks created by operations in these services match the filter (see CommonInfo.service). This field may be unset if Tasks.FilterSpec.tasks is specified. Currently all services must be from the same provider. If this field is unset or empty, tasks for all services will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: vapi.service. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: vapi.service. | [optional] 
-**status** | [**Array<CisTaskStatus>**](CisTaskStatus.md) | Status that a task must have to match the filter (see CommonInfo.status). If unset or empty, tasks with any status match the filter. | [optional] 
-**targets** | [**Array<VapiStdDynamicID>**](VapiStdDynamicID.md) | Identifiers of the targets the operation for the associated task created or was performed on (see CommonInfo.target). If unset or empty, tasks associated with operations on any target match the filter. | [optional] 
-**users** | **Array<String>** | Users who must have initiated the operation for the associated task to match the filter (see CommonInfo.user). If unset or empty, tasks associated with operations initiated by any user match the filter. | [optional] 
-
-

data/docs/CisTasksGetSpec.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::CIS::CisTasksGetSpec
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**return_all** | **Boolean** | If true, all data, including operation-specific data, will be returned, otherwise only the data described in Info will be returned. If unset, only the data described in Info will be returned. | [optional] 
-**exclude_result** | **Boolean** | If true, the result will not be included in the task information, otherwise it will be included. If unset, the result of the operation will be included in the task information. | [optional] 
-
-

data/docs/CisTasksListResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTasksListResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**Array<CisTasksListResultValue>**](CisTasksListResultValue.md) |  | 
-
-

data/docs/CisTasksListResultValue.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::CIS::CisTasksListResultValue
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**key** | **String** |  | [optional] 
-**value** | [**CisTaskInfo**](CisTaskInfo.md) |  | [optional] 
-
-

data/docs/CisTasksResult.md

@@ -1,8 +0,0 @@
-# VSphereAutomation::CIS::CisTasksResult
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | [**CisTaskInfo**](CisTaskInfo.md) |  | 
-
-

data/docs/FilterSpecTargets.md

@@ -1,9 +0,0 @@
-# VSphereAutomation::CIS::FilterSpecTargets
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | The type of resource being identified (for example {@code com.acme.Person}). <p> {@term Services} that contain {@term operations} for creating and deleting resources typically contain a {@term constant} specifying the resource type for the resources being created and deleted. The API metamodel metadata {@term services} include a {@term service} that allows retrieving all the known resource types. | 
-**id** | **String** | The identifier for a resource whose type is specified by {@link #type}. | 
-
-

data/docs/SessionApi.md

@@ -1,151 +0,0 @@
-# VSphereAutomation::CIS::SessionApi
-
-All URIs are relative to *https://<vcenter>/rest*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](SessionApi.md#create) | **POST** /com/vmware/cis/session | Creates a session with the API. This is the equivalent of login. This operation exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.
-[**delete**](SessionApi.md#delete) | **DELETE** /com/vmware/cis/session | Terminates the validity of a session token. This is the equivalent of log out.   A session identifier is expected as part of the request.    
-[**get**](SessionApi.md#get) | **POST** /com/vmware/cis/session?~action=get | Returns information about the current session. This operation expects a valid session identifier to be supplied.   A side effect of invoking this operation may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other operation in the API will also update the session's last accessed time.    This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities. 
-
-
-# **create**
-> CisSessionCreateResult create(vmware_use_header_authn)
-
-Creates a session with the API. This is the equivalent of login. This operation exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.
-
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-cis'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure HTTP basic authorization: basic_auth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = VSphereAutomation::CIS::SessionApi.new
-vmware_use_header_authn = 'vmware_use_header_authn_example' # String | Custom header to protect against CSRF attacks in browser based clients
-
-begin
-  #Creates a session with the API. This is the equivalent of login. This operation exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.
-  result = api_instance.create(vmware_use_header_authn)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling SessionApi->create: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **vmware_use_header_authn** | **String**| Custom header to protect against CSRF attacks in browser based clients | 
-
-### Return type
-
-[**CisSessionCreateResult**](CisSessionCreateResult.md)
-
-### Authorization
-
-[basic_auth](../README.md#basic_auth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **delete**
-> delete
-
-Terminates the validity of a session token. This is the equivalent of log out.   A session identifier is expected as part of the request.    
-
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-cis'
-# 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::CIS::SessionApi.new
-
-begin
-  #Terminates the validity of a session token. This is the equivalent of log out.   A session identifier is expected as part of the request.    
-  api_instance.delete
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling SessionApi->delete: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get**
-> CisSessionResult get
-
-Returns information about the current session. This operation expects a valid session identifier to be supplied.   A side effect of invoking this operation may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other operation in the API will also update the session's last accessed time.    This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities. 
-
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-cis'
-# 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::CIS::SessionApi.new
-
-begin
-  #Returns information about the current session. This operation expects a valid session identifier to be supplied.   A side effect of invoking this operation may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other operation in the API will also update the session's last accessed time.    This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities. 
-  result = api_instance.get
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling SessionApi->get: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**CisSessionResult**](CisSessionResult.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-