vsphere-automation-cis 0.1.0

data/docs/CisTasksListResultValue.md

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

data/docs/CisTasksResult.md

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

data/docs/FilterSpecTargets.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::CIS::FilterSpecTargets
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The identifier for a resource whose type is specified by {@link #type}. | 
+**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. | 
+
+

data/docs/SessionApi.md

@@ -0,0 +1,131 @@
+# 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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/TaggingCategoryApi.md

@@ -0,0 +1,401 @@
+# VSphereAutomation::CIS::TaggingCategoryApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_to_used_by**](TaggingCategoryApi.md#add_to_used_by) | **POST** /com/vmware/cis/tagging/category/id:{category_id}?~action=add-to-used-by | Adds the {@param.name usedByEntity} to the {@link CategoryModel#usedBy} subscribers {@term set} for the specified category. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes an idempotent no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.
+[**create**](TaggingCategoryApi.md#create) | **POST** /com/vmware/cis/tagging/category | Creates a category. To invoke this {@term operation}, you need the create category privilege.
+[**delete**](TaggingCategoryApi.md#delete) | **DELETE** /com/vmware/cis/tagging/category/id:{category_id} | Deletes an existing category. To invoke this {@term operation}, you need the delete privilege on the category.
+[**get**](TaggingCategoryApi.md#get) | **GET** /com/vmware/cis/tagging/category/id:{category_id} | Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.
+[**list**](TaggingCategoryApi.md#list) | **GET** /com/vmware/cis/tagging/category | Enumerates the categories in the system. To invoke this {@term operation}, you need the read privilege on the individual categories. The {@term list} will only contain those categories for which you have read privileges.
+[**list_used_categories**](TaggingCategoryApi.md#list_used_categories) | **POST** /com/vmware/cis/tagging/category?~action=list-used-categories | Enumerates all categories for which the {@param.name usedByEntity} is part of the {@link CategoryModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual categories.
+[**remove_from_used_by**](TaggingCategoryApi.md#remove_from_used_by) | **POST** /com/vmware/cis/tagging/category/id:{category_id}?~action=remove-from-used-by | Removes the {@param.name usedByEntity} from the {@link CategoryModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is not using this category, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.
+[**revoke_propagating_permissions**](TaggingCategoryApi.md#revoke_propagating_permissions) | **POST** /com/vmware/cis/tagging/category/id:{category_id}?~action=revoke-propagating-permissions | Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this {@term operation}, you need category related privileges (direct or propagating) on the concerned category.
+[**update**](TaggingCategoryApi.md#update) | **PATCH** /com/vmware/cis/tagging/category/id:{category_id} | Updates an existing category. To invoke this {@term operation}, you need the edit privilege on the category.
+
+
+# **add_to_used_by**
+> add_to_used_by(category_id, cis_tagging_category_add_to_used_by)
+
+Adds the {@param.name usedByEntity} to the {@link CategoryModel#usedBy} subscribers {@term set} for the specified category. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes an idempotent no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+category_id = 'category_id_example' # String | The identifier of the input category.
+cis_tagging_category_add_to_used_by = VSphereAutomation::CisTaggingCategoryAddToUsedBy.new # CisTaggingCategoryAddToUsedBy | 
+
+begin
+  #Adds the {@param.name usedByEntity} to the {@link CategoryModel#usedBy} subscribers {@term set} for the specified category. If the {@param.name usedByEntity} is already in the {@term set}, then this becomes an idempotent no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.
+  api_instance.add_to_used_by(category_id, cis_tagging_category_add_to_used_by)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->add_to_used_by: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **String**| The identifier of the input category. | 
+ **cis_tagging_category_add_to_used_by** | [**CisTaggingCategoryAddToUsedBy**](CisTaggingCategoryAddToUsedBy.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **create**
+> CisTaggingCategoryCreateResult create(cis_tagging_category_create)
+
+Creates a category. To invoke this {@term operation}, you need the create category privilege.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+cis_tagging_category_create = VSphereAutomation::CisTaggingCategoryCreate.new # CisTaggingCategoryCreate | 
+
+begin
+  #Creates a category. To invoke this {@term operation}, you need the create category privilege.
+  result = api_instance.create(cis_tagging_category_create)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cis_tagging_category_create** | [**CisTaggingCategoryCreate**](CisTaggingCategoryCreate.md)|  | 
+
+### Return type
+
+[**CisTaggingCategoryCreateResult**](CisTaggingCategoryCreateResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete**
+> delete(category_id)
+
+Deletes an existing category. To invoke this {@term operation}, you need the delete privilege on the category.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+category_id = 'category_id_example' # String | The identifier of category to be deleted.
+
+begin
+  #Deletes an existing category. To invoke this {@term operation}, you need the delete privilege on the category.
+  api_instance.delete(category_id)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **String**| The identifier of category to be deleted. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get**
+> CisTaggingCategoryResult get(category_id)
+
+Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+category_id = 'category_id_example' # String | The identifier of the input category.
+
+begin
+  #Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.
+  result = api_instance.get(category_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **String**| The identifier of the input category. | 
+
+### Return type
+
+[**CisTaggingCategoryResult**](CisTaggingCategoryResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> CisTaggingCategoryListResult list
+
+Enumerates the categories in the system. To invoke this {@term operation}, you need the read privilege on the individual categories. The {@term list} will only contain those categories for which you have read privileges.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+
+begin
+  #Enumerates the categories in the system. To invoke this {@term operation}, you need the read privilege on the individual categories. The {@term list} will only contain those categories for which you have read privileges.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CisTaggingCategoryListResult**](CisTaggingCategoryListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list_used_categories**
+> CisTaggingCategoryListUsedCategoriesResult list_used_categories(cis_tagging_category_list_used_categories)
+
+Enumerates all categories for which the {@param.name usedByEntity} is part of the {@link CategoryModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual categories.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+cis_tagging_category_list_used_categories = VSphereAutomation::CisTaggingCategoryListUsedCategories.new # CisTaggingCategoryListUsedCategories | 
+
+begin
+  #Enumerates all categories for which the {@param.name usedByEntity} is part of the {@link CategoryModel#usedBy} subscribers {@term set}. To invoke this {@term operation}, you need the read privilege on the individual categories.
+  result = api_instance.list_used_categories(cis_tagging_category_list_used_categories)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->list_used_categories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cis_tagging_category_list_used_categories** | [**CisTaggingCategoryListUsedCategories**](CisTaggingCategoryListUsedCategories.md)|  | 
+
+### Return type
+
+[**CisTaggingCategoryListUsedCategoriesResult**](CisTaggingCategoryListUsedCategoriesResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **remove_from_used_by**
+> remove_from_used_by(category_id, cis_tagging_category_remove_from_used_by)
+
+Removes the {@param.name usedByEntity} from the {@link CategoryModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is not using this category, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+category_id = 'category_id_example' # String | The identifier of the input category.
+cis_tagging_category_remove_from_used_by = VSphereAutomation::CisTaggingCategoryRemoveFromUsedBy.new # CisTaggingCategoryRemoveFromUsedBy | 
+
+begin
+  #Removes the {@param.name usedByEntity} from the {@link CategoryModel#usedBy} subscribers {@term set}. If the {@param.name usedByEntity} is not using this category, then this becomes a no-op. To invoke this {@term operation}, you need the modify {@link CategoryModel#usedBy} privilege on the category.
+  api_instance.remove_from_used_by(category_id, cis_tagging_category_remove_from_used_by)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->remove_from_used_by: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **String**| The identifier of the input category. | 
+ **cis_tagging_category_remove_from_used_by** | [**CisTaggingCategoryRemoveFromUsedBy**](CisTaggingCategoryRemoveFromUsedBy.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **revoke_propagating_permissions**
+> revoke_propagating_permissions(category_id)
+
+Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this {@term operation}, you need category related privileges (direct or propagating) on the concerned category.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+category_id = 'category_id_example' # String | The identifier of the input category.
+
+begin
+  #Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this {@term operation}, you need category related privileges (direct or propagating) on the concerned category.
+  api_instance.revoke_propagating_permissions(category_id)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->revoke_propagating_permissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **String**| The identifier of the input category. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update**
+> update(category_id, cis_tagging_category_update)
+
+Updates an existing category. To invoke this {@term operation}, you need the edit privilege on the category.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-cis'
+
+api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
+category_id = 'category_id_example' # String | The identifier of the category to be updated.
+cis_tagging_category_update = VSphereAutomation::CisTaggingCategoryUpdate.new # CisTaggingCategoryUpdate | 
+
+begin
+  #Updates an existing category. To invoke this {@term operation}, you need the edit privilege on the category.
+  api_instance.update(category_id, cis_tagging_category_update)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling TaggingCategoryApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **String**| The identifier of the category to be updated. | 
+ **cis_tagging_category_update** | [**CisTaggingCategoryUpdate**](CisTaggingCategoryUpdate.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+