vsphere-automation-cis 0.4.2 → 0.4.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (190) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +20 -0
  3. data/lib/vsphere-automation-cis/api_client.rb +260 -0
  4. data/lib/vsphere-automation-cis/api_error.rb +34 -0
  5. data/lib/vsphere-automation-cis/configuration.rb +212 -0
  6. data/lib/vsphere-automation-cis/version.rb +1 -1
  7. metadata +13 -280
  8. data/Gemfile +0 -13
  9. data/Gemfile.lock +0 -78
  10. data/README.md +0 -180
  11. data/Rakefile +0 -18
  12. data/docs/CisSessionCreateResult.md +0 -8
  13. data/docs/CisSessionInfo.md +0 -10
  14. data/docs/CisSessionResult.md +0 -8
  15. data/docs/CisTaggingCategoryAddToUsedBy.md +0 -8
  16. data/docs/CisTaggingCategoryCreate.md +0 -8
  17. data/docs/CisTaggingCategoryCreateResult.md +0 -8
  18. data/docs/CisTaggingCategoryCreateSpec.md +0 -12
  19. data/docs/CisTaggingCategoryListResult.md +0 -8
  20. data/docs/CisTaggingCategoryListUsedCategories.md +0 -8
  21. data/docs/CisTaggingCategoryListUsedCategoriesResult.md +0 -8
  22. data/docs/CisTaggingCategoryModel.md +0 -13
  23. data/docs/CisTaggingCategoryModelCardinality.md +0 -7
  24. data/docs/CisTaggingCategoryRemoveFromUsedBy.md +0 -8
  25. data/docs/CisTaggingCategoryResult.md +0 -8
  26. data/docs/CisTaggingCategoryUpdate.md +0 -8
  27. data/docs/CisTaggingCategoryUpdateSpec.md +0 -11
  28. data/docs/CisTaggingTagAddToUsedBy.md +0 -8
  29. data/docs/CisTaggingTagAssociationAttach.md +0 -8
  30. data/docs/CisTaggingTagAssociationAttachMultipleTagsToObject.md +0 -9
  31. data/docs/CisTaggingTagAssociationAttachMultipleTagsToObjectResult.md +0 -8
  32. data/docs/CisTaggingTagAssociationAttachTagToMultipleObjects.md +0 -8
  33. data/docs/CisTaggingTagAssociationAttachTagToMultipleObjectsResult.md +0 -8
  34. data/docs/CisTaggingTagAssociationBatchResult.md +0 -9
  35. data/docs/CisTaggingTagAssociationDetach.md +0 -8
  36. data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObject.md +0 -9
  37. data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObjectResult.md +0 -8
  38. data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjects.md +0 -8
  39. data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjectsResult.md +0 -8
  40. data/docs/CisTaggingTagAssociationListAttachableTags.md +0 -8
  41. data/docs/CisTaggingTagAssociationListAttachableTagsResult.md +0 -8
  42. data/docs/CisTaggingTagAssociationListAttachedObjectsOnTags.md +0 -8
  43. data/docs/CisTaggingTagAssociationListAttachedObjectsOnTagsResult.md +0 -8
  44. data/docs/CisTaggingTagAssociationListAttachedObjectsResult.md +0 -8
  45. data/docs/CisTaggingTagAssociationListAttachedTags.md +0 -8
  46. data/docs/CisTaggingTagAssociationListAttachedTagsOnObjects.md +0 -8
  47. data/docs/CisTaggingTagAssociationListAttachedTagsOnObjectsResult.md +0 -8
  48. data/docs/CisTaggingTagAssociationListAttachedTagsResult.md +0 -8
  49. data/docs/CisTaggingTagAssociationObjectToTags.md +0 -9
  50. data/docs/CisTaggingTagAssociationTagToObjects.md +0 -9
  51. data/docs/CisTaggingTagCreate.md +0 -8
  52. data/docs/CisTaggingTagCreateResult.md +0 -8
  53. data/docs/CisTaggingTagCreateSpec.md +0 -11
  54. data/docs/CisTaggingTagListResult.md +0 -8
  55. data/docs/CisTaggingTagListTagsForCategoryResult.md +0 -8
  56. data/docs/CisTaggingTagListUsedTags.md +0 -8
  57. data/docs/CisTaggingTagListUsedTagsResult.md +0 -8
  58. data/docs/CisTaggingTagModel.md +0 -12
  59. data/docs/CisTaggingTagRemoveFromUsedBy.md +0 -8
  60. data/docs/CisTaggingTagResult.md +0 -8
  61. data/docs/CisTaggingTagUpdate.md +0 -8
  62. data/docs/CisTaggingTagUpdateSpec.md +0 -9
  63. data/docs/CisTaskInfo.md +0 -19
  64. data/docs/CisTaskProgress.md +0 -10
  65. data/docs/CisTaskStatus.md +0 -7
  66. data/docs/CisTasksFilterSpec.md +0 -12
  67. data/docs/CisTasksGetSpec.md +0 -9
  68. data/docs/CisTasksListResult.md +0 -8
  69. data/docs/CisTasksListResultValue.md +0 -9
  70. data/docs/CisTasksResult.md +0 -8
  71. data/docs/FilterSpecTargets.md +0 -9
  72. data/docs/SessionApi.md +0 -151
  73. data/docs/TaggingCategoryApi.md +0 -464
  74. data/docs/TaggingTagApi.md +0 -515
  75. data/docs/TaggingTagAssociationApi.md +0 -575
  76. data/docs/TasksApi.md +0 -180
  77. data/docs/VapiStdDynamicID.md +0 -9
  78. data/docs/VapiStdErrorsAlreadyExists.md +0 -9
  79. data/docs/VapiStdErrorsAlreadyExistsError.md +0 -9
  80. data/docs/VapiStdErrorsError.md +0 -9
  81. data/docs/VapiStdErrorsErrorError.md +0 -9
  82. data/docs/VapiStdErrorsInvalidArgument.md +0 -9
  83. data/docs/VapiStdErrorsInvalidArgumentError.md +0 -9
  84. data/docs/VapiStdErrorsNotAllowedInCurrentState.md +0 -9
  85. data/docs/VapiStdErrorsNotAllowedInCurrentStateError.md +0 -9
  86. data/docs/VapiStdErrorsNotFound.md +0 -9
  87. data/docs/VapiStdErrorsNotFoundError.md +0 -9
  88. data/docs/VapiStdErrorsResourceInaccessible.md +0 -9
  89. data/docs/VapiStdErrorsResourceInaccessibleError.md +0 -9
  90. data/docs/VapiStdErrorsServiceUnavailable.md +0 -9
  91. data/docs/VapiStdErrorsServiceUnavailableError.md +0 -9
  92. data/docs/VapiStdErrorsUnauthenticated.md +0 -9
  93. data/docs/VapiStdErrorsUnauthenticatedError.md +0 -9
  94. data/docs/VapiStdErrorsUnauthorized.md +0 -9
  95. data/docs/VapiStdErrorsUnauthorizedError.md +0 -9
  96. data/docs/VapiStdErrorsUnsupported.md +0 -9
  97. data/docs/VapiStdErrorsUnsupportedError.md +0 -9
  98. data/docs/VapiStdLocalizableMessage.md +0 -10
  99. data/git_push.sh +0 -55
  100. data/pkg/vsphere-automation-cis-0.4.1.gem +0 -0
  101. data/pkg/vsphere-automation-cis-0.4.2.gem +0 -0
  102. data/spec/api/session_api_spec.rb +0 -62
  103. data/spec/api/tagging_category_api_spec.rb +0 -132
  104. data/spec/api/tagging_tag_api_spec.rb +0 -143
  105. data/spec/api/tagging_tag_association_api_spec.rb +0 -156
  106. data/spec/api/tasks_api_spec.rb +0 -72
  107. data/spec/models/cis_session_create_result_spec.rb +0 -37
  108. data/spec/models/cis_session_info_spec.rb +0 -49
  109. data/spec/models/cis_session_result_spec.rb +0 -37
  110. data/spec/models/cis_tagging_category_add_to_used_by_spec.rb +0 -37
  111. data/spec/models/cis_tagging_category_create_result_spec.rb +0 -37
  112. data/spec/models/cis_tagging_category_create_spec.rb +0 -37
  113. data/spec/models/cis_tagging_category_create_spec_spec.rb +0 -61
  114. data/spec/models/cis_tagging_category_list_result_spec.rb +0 -37
  115. data/spec/models/cis_tagging_category_list_used_categories_result_spec.rb +0 -37
  116. data/spec/models/cis_tagging_category_list_used_categories_spec.rb +0 -37
  117. data/spec/models/cis_tagging_category_model_cardinality_spec.rb +0 -31
  118. data/spec/models/cis_tagging_category_model_spec.rb +0 -67
  119. data/spec/models/cis_tagging_category_remove_from_used_by_spec.rb +0 -37
  120. data/spec/models/cis_tagging_category_result_spec.rb +0 -37
  121. data/spec/models/cis_tagging_category_update_spec.rb +0 -37
  122. data/spec/models/cis_tagging_category_update_spec_spec.rb +0 -55
  123. data/spec/models/cis_tagging_tag_add_to_used_by_spec.rb +0 -37
  124. data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result_spec.rb +0 -37
  125. data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_spec.rb +0 -43
  126. data/spec/models/cis_tagging_tag_association_attach_spec.rb +0 -37
  127. data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result_spec.rb +0 -37
  128. data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_spec.rb +0 -37
  129. data/spec/models/cis_tagging_tag_association_batch_result_spec.rb +0 -43
  130. data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result_spec.rb +0 -37
  131. data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_spec.rb +0 -43
  132. data/spec/models/cis_tagging_tag_association_detach_spec.rb +0 -37
  133. data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result_spec.rb +0 -37
  134. data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_spec.rb +0 -37
  135. data/spec/models/cis_tagging_tag_association_list_attachable_tags_result_spec.rb +0 -37
  136. data/spec/models/cis_tagging_tag_association_list_attachable_tags_spec.rb +0 -37
  137. data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_result_spec.rb +0 -37
  138. data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_spec.rb +0 -37
  139. data/spec/models/cis_tagging_tag_association_list_attached_objects_result_spec.rb +0 -37
  140. data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_result_spec.rb +0 -37
  141. data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_spec.rb +0 -37
  142. data/spec/models/cis_tagging_tag_association_list_attached_tags_result_spec.rb +0 -37
  143. data/spec/models/cis_tagging_tag_association_list_attached_tags_spec.rb +0 -37
  144. data/spec/models/cis_tagging_tag_association_object_to_tags_spec.rb +0 -43
  145. data/spec/models/cis_tagging_tag_association_tag_to_objects_spec.rb +0 -43
  146. data/spec/models/cis_tagging_tag_create_result_spec.rb +0 -37
  147. data/spec/models/cis_tagging_tag_create_spec.rb +0 -37
  148. data/spec/models/cis_tagging_tag_create_spec_spec.rb +0 -55
  149. data/spec/models/cis_tagging_tag_list_result_spec.rb +0 -37
  150. data/spec/models/cis_tagging_tag_list_tags_for_category_result_spec.rb +0 -37
  151. data/spec/models/cis_tagging_tag_list_used_tags_result_spec.rb +0 -37
  152. data/spec/models/cis_tagging_tag_list_used_tags_spec.rb +0 -37
  153. data/spec/models/cis_tagging_tag_model_spec.rb +0 -61
  154. data/spec/models/cis_tagging_tag_remove_from_used_by_spec.rb +0 -37
  155. data/spec/models/cis_tagging_tag_result_spec.rb +0 -37
  156. data/spec/models/cis_tagging_tag_update_spec.rb +0 -37
  157. data/spec/models/cis_tagging_tag_update_spec_spec.rb +0 -43
  158. data/spec/models/cis_task_info_spec.rb +0 -103
  159. data/spec/models/cis_task_progress_spec.rb +0 -49
  160. data/spec/models/cis_task_status_spec.rb +0 -31
  161. data/spec/models/cis_tasks_filter_spec_spec.rb +0 -61
  162. data/spec/models/cis_tasks_get_spec_spec.rb +0 -43
  163. data/spec/models/cis_tasks_list_result_spec.rb +0 -37
  164. data/spec/models/cis_tasks_list_result_value_spec.rb +0 -43
  165. data/spec/models/cis_tasks_result_spec.rb +0 -37
  166. data/spec/models/filter_spec_targets_spec.rb +0 -43
  167. data/spec/models/vapi_std_dynamic_id_spec.rb +0 -43
  168. data/spec/models/vapi_std_errors_already_exists_error_spec.rb +0 -43
  169. data/spec/models/vapi_std_errors_already_exists_spec.rb +0 -43
  170. data/spec/models/vapi_std_errors_error_error_spec.rb +0 -43
  171. data/spec/models/vapi_std_errors_error_spec.rb +0 -43
  172. data/spec/models/vapi_std_errors_invalid_argument_error_spec.rb +0 -43
  173. data/spec/models/vapi_std_errors_invalid_argument_spec.rb +0 -43
  174. data/spec/models/vapi_std_errors_not_allowed_in_current_state_error_spec.rb +0 -43
  175. data/spec/models/vapi_std_errors_not_allowed_in_current_state_spec.rb +0 -43
  176. data/spec/models/vapi_std_errors_not_found_error_spec.rb +0 -43
  177. data/spec/models/vapi_std_errors_not_found_spec.rb +0 -43
  178. data/spec/models/vapi_std_errors_resource_inaccessible_error_spec.rb +0 -43
  179. data/spec/models/vapi_std_errors_resource_inaccessible_spec.rb +0 -43
  180. data/spec/models/vapi_std_errors_service_unavailable_error_spec.rb +0 -43
  181. data/spec/models/vapi_std_errors_service_unavailable_spec.rb +0 -43
  182. data/spec/models/vapi_std_errors_unauthenticated_error_spec.rb +0 -43
  183. data/spec/models/vapi_std_errors_unauthenticated_spec.rb +0 -43
  184. data/spec/models/vapi_std_errors_unauthorized_error_spec.rb +0 -43
  185. data/spec/models/vapi_std_errors_unauthorized_spec.rb +0 -43
  186. data/spec/models/vapi_std_errors_unsupported_error_spec.rb +0 -43
  187. data/spec/models/vapi_std_errors_unsupported_spec.rb +0 -43
  188. data/spec/models/vapi_std_localizable_message_spec.rb +0 -49
  189. data/spec/spec_helper.rb +0 -110
  190. data/vsphere-automation-cis.gemspec +0 -39
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagListResult
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **Array<String>** | |
7
-
8
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagListTagsForCategoryResult
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **Array<String>** | |
7
-
8
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagListUsedTags
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **used_by_entity** | **String** | The field on which the results will be filtered. |
7
-
8
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagListUsedTagsResult
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **Array<String>** | |
7
-
8
-
@@ -1,12 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagModel
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | The unique identifier of the tag. |
7
- **category_id** | **String** | The identifier of the parent category in which this tag will be created. |
8
- **name** | **String** | The display name of the tag. |
9
- **description** | **String** | The description of the tag. |
10
- **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}. |
11
-
12
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagRemoveFromUsedBy
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **used_by_entity** | **String** | The name of the user to be removed from the {@link TagModel#usedBy} {@term set}. |
7
-
8
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagResult
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | [**CisTaggingTagModel**](CisTaggingTagModel.md) | |
7
-
8
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagUpdate
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **update_spec** | [**CisTaggingTagUpdateSpec**](CisTaggingTagUpdateSpec.md) | |
7
-
8
-
@@ -1,9 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaggingTagUpdateSpec
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | The display name of the tag. | [optional]
7
- **description** | **String** | The description of the tag. | [optional]
8
-
9
-
@@ -1,19 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaskInfo
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **progress** | [**CisTaskProgress**](CisTaskProgress.md) | | [optional]
7
- **description** | [**VapiStdLocalizableMessage**](VapiStdLocalizableMessage.md) | |
8
- **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. |
9
- **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. |
10
- **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]
11
- **target** | [**VapiStdDynamicID**](VapiStdDynamicID.md) | | [optional]
12
- **status** | [**CisTaskStatus**](CisTaskStatus.md) | |
13
- **cancelable** | **Boolean** | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. |
14
- **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]
15
- **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]
16
- **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]
17
- **user** | **String** | Name of the user who performed the operation. This field will be unset if the operation is performed by the system. | [optional]
18
-
19
-
@@ -1,10 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaskProgress
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **total** | **Integer** | Total amount of the work for the operation. |
7
- **completed** | **Integer** | The amount of work completed for the operation. The value can only be incremented. |
8
- **message** | [**VapiStdLocalizableMessage**](VapiStdLocalizableMessage.md) | |
9
-
10
-
@@ -1,7 +0,0 @@
1
- # VSphereAutomation::CIS::CisTaskStatus
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
-
7
-
@@ -1,12 +0,0 @@
1
- # VSphereAutomation::CIS::CisTasksFilterSpec
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **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]
7
- **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]
8
- **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]
9
- **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]
10
- **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]
11
-
12
-
@@ -1,9 +0,0 @@
1
- # VSphereAutomation::CIS::CisTasksGetSpec
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **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]
7
- **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]
8
-
9
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTasksListResult
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | [**Array<CisTasksListResultValue>**](CisTasksListResultValue.md) | |
7
-
8
-
@@ -1,9 +0,0 @@
1
- # VSphereAutomation::CIS::CisTasksListResultValue
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **key** | **String** | | [optional]
7
- **value** | [**CisTaskInfo**](CisTaskInfo.md) | | [optional]
8
-
9
-
@@ -1,8 +0,0 @@
1
- # VSphereAutomation::CIS::CisTasksResult
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | [**CisTaskInfo**](CisTaskInfo.md) | |
7
-
8
-
@@ -1,9 +0,0 @@
1
- # VSphereAutomation::CIS::FilterSpecTargets
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **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. |
7
- **id** | **String** | The identifier for a resource whose type is specified by {@link #type}. |
8
-
9
-
@@ -1,151 +0,0 @@
1
- # VSphereAutomation::CIS::SessionApi
2
-
3
- All URIs are relative to *https://<vcenter>/rest*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**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.
8
- [**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.
9
- [**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.
10
-
11
-
12
- # **create**
13
- > CisSessionCreateResult create(vmware_use_header_authn)
14
-
15
- 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.
16
-
17
- ### Example
18
- ```ruby
19
- # load the gem
20
- require 'vsphere-automation-cis'
21
- # setup authorization
22
- VSphereAutomation::Configuration.new.tap do |config|
23
- # Configure HTTP basic authorization: basic_auth
24
- config.username = 'YOUR USERNAME'
25
- config.password = 'YOUR PASSWORD'
26
- end
27
-
28
- api_instance = VSphereAutomation::CIS::SessionApi.new
29
- vmware_use_header_authn = 'vmware_use_header_authn_example' # String | Custom header to protect against CSRF attacks in browser based clients
30
-
31
- begin
32
- #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.
33
- result = api_instance.create(vmware_use_header_authn)
34
- p result
35
- rescue VSphereAutomation::ApiError => e
36
- puts "Exception when calling SessionApi->create: #{e}"
37
- end
38
- ```
39
-
40
- ### Parameters
41
-
42
- Name | Type | Description | Notes
43
- ------------- | ------------- | ------------- | -------------
44
- **vmware_use_header_authn** | **String**| Custom header to protect against CSRF attacks in browser based clients |
45
-
46
- ### Return type
47
-
48
- [**CisSessionCreateResult**](CisSessionCreateResult.md)
49
-
50
- ### Authorization
51
-
52
- [basic_auth](../README.md#basic_auth)
53
-
54
- ### HTTP request headers
55
-
56
- - **Content-Type**: Not defined
57
- - **Accept**: application/json
58
-
59
-
60
-
61
- # **delete**
62
- > delete
63
-
64
- Terminates the validity of a session token. This is the equivalent of log out. A session identifier is expected as part of the request.
65
-
66
- ### Example
67
- ```ruby
68
- # load the gem
69
- require 'vsphere-automation-cis'
70
- # setup authorization
71
- VSphereAutomation::Configuration.new.tap do |config|
72
- # Configure API key authorization: api_key
73
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
74
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
75
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
76
- end
77
-
78
- api_instance = VSphereAutomation::CIS::SessionApi.new
79
-
80
- begin
81
- #Terminates the validity of a session token. This is the equivalent of log out. A session identifier is expected as part of the request.
82
- api_instance.delete
83
- rescue VSphereAutomation::ApiError => e
84
- puts "Exception when calling SessionApi->delete: #{e}"
85
- end
86
- ```
87
-
88
- ### Parameters
89
- This endpoint does not need any parameter.
90
-
91
- ### Return type
92
-
93
- nil (empty response body)
94
-
95
- ### Authorization
96
-
97
- [api_key](../README.md#api_key)
98
-
99
- ### HTTP request headers
100
-
101
- - **Content-Type**: Not defined
102
- - **Accept**: application/json
103
-
104
-
105
-
106
- # **get**
107
- > CisSessionResult get
108
-
109
- 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.
110
-
111
- ### Example
112
- ```ruby
113
- # load the gem
114
- require 'vsphere-automation-cis'
115
- # setup authorization
116
- VSphereAutomation::Configuration.new.tap do |config|
117
- # Configure API key authorization: api_key
118
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
119
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
121
- end
122
-
123
- api_instance = VSphereAutomation::CIS::SessionApi.new
124
-
125
- begin
126
- #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.
127
- result = api_instance.get
128
- p result
129
- rescue VSphereAutomation::ApiError => e
130
- puts "Exception when calling SessionApi->get: #{e}"
131
- end
132
- ```
133
-
134
- ### Parameters
135
- This endpoint does not need any parameter.
136
-
137
- ### Return type
138
-
139
- [**CisSessionResult**](CisSessionResult.md)
140
-
141
- ### Authorization
142
-
143
- [api_key](../README.md#api_key)
144
-
145
- ### HTTP request headers
146
-
147
- - **Content-Type**: Not defined
148
- - **Accept**: application/json
149
-
150
-
151
-
@@ -1,464 +0,0 @@
1
- # VSphereAutomation::CIS::TaggingCategoryApi
2
-
3
- All URIs are relative to *https://<vcenter>/rest*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**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.
8
- [**create**](TaggingCategoryApi.md#create) | **POST** /com/vmware/cis/tagging/category | Creates a category. To invoke this {@term operation}, you need the create category privilege.
9
- [**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.
10
- [**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.
11
- [**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.
12
- [**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.
13
- [**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.
14
- [**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.
15
- [**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.
16
-
17
-
18
- # **add_to_used_by**
19
- > add_to_used_by(category_id, request_body)
20
-
21
- 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.
22
-
23
- ### Example
24
- ```ruby
25
- # load the gem
26
- require 'vsphere-automation-cis'
27
- # setup authorization
28
- VSphereAutomation::Configuration.new.tap do |config|
29
- # Configure API key authorization: api_key
30
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
31
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
33
- end
34
-
35
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
36
- category_id = 'category_id_example' # String | The identifier of the input category.
37
- request_body = CIS::CisTaggingCategoryAddToUsedBy.new # CisTaggingCategoryAddToUsedBy |
38
-
39
- begin
40
- #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.
41
- api_instance.add_to_used_by(category_id, request_body)
42
- rescue VSphereAutomation::ApiError => e
43
- puts "Exception when calling TaggingCategoryApi->add_to_used_by: #{e}"
44
- end
45
- ```
46
-
47
- ### Parameters
48
-
49
- Name | Type | Description | Notes
50
- ------------- | ------------- | ------------- | -------------
51
- **category_id** | **String**| The identifier of the input category. |
52
- **request_body** | [**CisTaggingCategoryAddToUsedBy**](CisTaggingCategoryAddToUsedBy.md)| |
53
-
54
- ### Return type
55
-
56
- nil (empty response body)
57
-
58
- ### Authorization
59
-
60
- [api_key](../README.md#api_key)
61
-
62
- ### HTTP request headers
63
-
64
- - **Content-Type**: application/json
65
- - **Accept**: application/json
66
-
67
-
68
-
69
- # **create**
70
- > CisTaggingCategoryCreateResult create(request_body)
71
-
72
- Creates a category. To invoke this {@term operation}, you need the create category privilege.
73
-
74
- ### Example
75
- ```ruby
76
- # load the gem
77
- require 'vsphere-automation-cis'
78
- # setup authorization
79
- VSphereAutomation::Configuration.new.tap do |config|
80
- # Configure API key authorization: api_key
81
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
82
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
83
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
84
- end
85
-
86
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
87
- request_body = CIS::CisTaggingCategoryCreate.new # CisTaggingCategoryCreate |
88
-
89
- begin
90
- #Creates a category. To invoke this {@term operation}, you need the create category privilege.
91
- result = api_instance.create(request_body)
92
- p result
93
- rescue VSphereAutomation::ApiError => e
94
- puts "Exception when calling TaggingCategoryApi->create: #{e}"
95
- end
96
- ```
97
-
98
- ### Parameters
99
-
100
- Name | Type | Description | Notes
101
- ------------- | ------------- | ------------- | -------------
102
- **request_body** | [**CisTaggingCategoryCreate**](CisTaggingCategoryCreate.md)| |
103
-
104
- ### Return type
105
-
106
- [**CisTaggingCategoryCreateResult**](CisTaggingCategoryCreateResult.md)
107
-
108
- ### Authorization
109
-
110
- [api_key](../README.md#api_key)
111
-
112
- ### HTTP request headers
113
-
114
- - **Content-Type**: application/json
115
- - **Accept**: application/json
116
-
117
-
118
-
119
- # **delete**
120
- > delete(category_id)
121
-
122
- Deletes an existing category. To invoke this {@term operation}, you need the delete privilege on the category.
123
-
124
- ### Example
125
- ```ruby
126
- # load the gem
127
- require 'vsphere-automation-cis'
128
- # setup authorization
129
- VSphereAutomation::Configuration.new.tap do |config|
130
- # Configure API key authorization: api_key
131
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
132
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
133
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
134
- end
135
-
136
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
137
- category_id = 'category_id_example' # String | The identifier of category to be deleted.
138
-
139
- begin
140
- #Deletes an existing category. To invoke this {@term operation}, you need the delete privilege on the category.
141
- api_instance.delete(category_id)
142
- rescue VSphereAutomation::ApiError => e
143
- puts "Exception when calling TaggingCategoryApi->delete: #{e}"
144
- end
145
- ```
146
-
147
- ### Parameters
148
-
149
- Name | Type | Description | Notes
150
- ------------- | ------------- | ------------- | -------------
151
- **category_id** | **String**| The identifier of category to be deleted. |
152
-
153
- ### Return type
154
-
155
- nil (empty response body)
156
-
157
- ### Authorization
158
-
159
- [api_key](../README.md#api_key)
160
-
161
- ### HTTP request headers
162
-
163
- - **Content-Type**: Not defined
164
- - **Accept**: application/json
165
-
166
-
167
-
168
- # **get**
169
- > CisTaggingCategoryResult get(category_id)
170
-
171
- Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.
172
-
173
- ### Example
174
- ```ruby
175
- # load the gem
176
- require 'vsphere-automation-cis'
177
- # setup authorization
178
- VSphereAutomation::Configuration.new.tap do |config|
179
- # Configure API key authorization: api_key
180
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
181
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
182
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
183
- end
184
-
185
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
186
- category_id = 'category_id_example' # String | The identifier of the input category.
187
-
188
- begin
189
- #Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.
190
- result = api_instance.get(category_id)
191
- p result
192
- rescue VSphereAutomation::ApiError => e
193
- puts "Exception when calling TaggingCategoryApi->get: #{e}"
194
- end
195
- ```
196
-
197
- ### Parameters
198
-
199
- Name | Type | Description | Notes
200
- ------------- | ------------- | ------------- | -------------
201
- **category_id** | **String**| The identifier of the input category. |
202
-
203
- ### Return type
204
-
205
- [**CisTaggingCategoryResult**](CisTaggingCategoryResult.md)
206
-
207
- ### Authorization
208
-
209
- [api_key](../README.md#api_key)
210
-
211
- ### HTTP request headers
212
-
213
- - **Content-Type**: Not defined
214
- - **Accept**: application/json
215
-
216
-
217
-
218
- # **list**
219
- > CisTaggingCategoryListResult list
220
-
221
- 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.
222
-
223
- ### Example
224
- ```ruby
225
- # load the gem
226
- require 'vsphere-automation-cis'
227
- # setup authorization
228
- VSphereAutomation::Configuration.new.tap do |config|
229
- # Configure API key authorization: api_key
230
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
231
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
232
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
233
- end
234
-
235
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
236
-
237
- begin
238
- #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.
239
- result = api_instance.list
240
- p result
241
- rescue VSphereAutomation::ApiError => e
242
- puts "Exception when calling TaggingCategoryApi->list: #{e}"
243
- end
244
- ```
245
-
246
- ### Parameters
247
- This endpoint does not need any parameter.
248
-
249
- ### Return type
250
-
251
- [**CisTaggingCategoryListResult**](CisTaggingCategoryListResult.md)
252
-
253
- ### Authorization
254
-
255
- [api_key](../README.md#api_key)
256
-
257
- ### HTTP request headers
258
-
259
- - **Content-Type**: Not defined
260
- - **Accept**: application/json
261
-
262
-
263
-
264
- # **list_used_categories**
265
- > CisTaggingCategoryListUsedCategoriesResult list_used_categories(request_body)
266
-
267
- 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.
268
-
269
- ### Example
270
- ```ruby
271
- # load the gem
272
- require 'vsphere-automation-cis'
273
- # setup authorization
274
- VSphereAutomation::Configuration.new.tap do |config|
275
- # Configure API key authorization: api_key
276
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
277
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
278
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
279
- end
280
-
281
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
282
- request_body = CIS::CisTaggingCategoryListUsedCategories.new # CisTaggingCategoryListUsedCategories |
283
-
284
- begin
285
- #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.
286
- result = api_instance.list_used_categories(request_body)
287
- p result
288
- rescue VSphereAutomation::ApiError => e
289
- puts "Exception when calling TaggingCategoryApi->list_used_categories: #{e}"
290
- end
291
- ```
292
-
293
- ### Parameters
294
-
295
- Name | Type | Description | Notes
296
- ------------- | ------------- | ------------- | -------------
297
- **request_body** | [**CisTaggingCategoryListUsedCategories**](CisTaggingCategoryListUsedCategories.md)| |
298
-
299
- ### Return type
300
-
301
- [**CisTaggingCategoryListUsedCategoriesResult**](CisTaggingCategoryListUsedCategoriesResult.md)
302
-
303
- ### Authorization
304
-
305
- [api_key](../README.md#api_key)
306
-
307
- ### HTTP request headers
308
-
309
- - **Content-Type**: application/json
310
- - **Accept**: application/json
311
-
312
-
313
-
314
- # **remove_from_used_by**
315
- > remove_from_used_by(category_id, request_body)
316
-
317
- 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.
318
-
319
- ### Example
320
- ```ruby
321
- # load the gem
322
- require 'vsphere-automation-cis'
323
- # setup authorization
324
- VSphereAutomation::Configuration.new.tap do |config|
325
- # Configure API key authorization: api_key
326
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
327
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
328
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
329
- end
330
-
331
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
332
- category_id = 'category_id_example' # String | The identifier of the input category.
333
- request_body = CIS::CisTaggingCategoryRemoveFromUsedBy.new # CisTaggingCategoryRemoveFromUsedBy |
334
-
335
- begin
336
- #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.
337
- api_instance.remove_from_used_by(category_id, request_body)
338
- rescue VSphereAutomation::ApiError => e
339
- puts "Exception when calling TaggingCategoryApi->remove_from_used_by: #{e}"
340
- end
341
- ```
342
-
343
- ### Parameters
344
-
345
- Name | Type | Description | Notes
346
- ------------- | ------------- | ------------- | -------------
347
- **category_id** | **String**| The identifier of the input category. |
348
- **request_body** | [**CisTaggingCategoryRemoveFromUsedBy**](CisTaggingCategoryRemoveFromUsedBy.md)| |
349
-
350
- ### Return type
351
-
352
- nil (empty response body)
353
-
354
- ### Authorization
355
-
356
- [api_key](../README.md#api_key)
357
-
358
- ### HTTP request headers
359
-
360
- - **Content-Type**: application/json
361
- - **Accept**: application/json
362
-
363
-
364
-
365
- # **revoke_propagating_permissions**
366
- > revoke_propagating_permissions(category_id)
367
-
368
- 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.
369
-
370
- ### Example
371
- ```ruby
372
- # load the gem
373
- require 'vsphere-automation-cis'
374
- # setup authorization
375
- VSphereAutomation::Configuration.new.tap do |config|
376
- # Configure API key authorization: api_key
377
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
378
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
379
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
380
- end
381
-
382
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
383
- category_id = 'category_id_example' # String | The identifier of the input category.
384
-
385
- begin
386
- #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.
387
- api_instance.revoke_propagating_permissions(category_id)
388
- rescue VSphereAutomation::ApiError => e
389
- puts "Exception when calling TaggingCategoryApi->revoke_propagating_permissions: #{e}"
390
- end
391
- ```
392
-
393
- ### Parameters
394
-
395
- Name | Type | Description | Notes
396
- ------------- | ------------- | ------------- | -------------
397
- **category_id** | **String**| The identifier of the input category. |
398
-
399
- ### Return type
400
-
401
- nil (empty response body)
402
-
403
- ### Authorization
404
-
405
- [api_key](../README.md#api_key)
406
-
407
- ### HTTP request headers
408
-
409
- - **Content-Type**: Not defined
410
- - **Accept**: application/json
411
-
412
-
413
-
414
- # **update**
415
- > update(category_id, request_body)
416
-
417
- Updates an existing category. To invoke this {@term operation}, you need the edit privilege on the category.
418
-
419
- ### Example
420
- ```ruby
421
- # load the gem
422
- require 'vsphere-automation-cis'
423
- # setup authorization
424
- VSphereAutomation::Configuration.new.tap do |config|
425
- # Configure API key authorization: api_key
426
- config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
427
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
428
- #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
429
- end
430
-
431
- api_instance = VSphereAutomation::CIS::TaggingCategoryApi.new
432
- category_id = 'category_id_example' # String | The identifier of the category to be updated.
433
- request_body = CIS::CisTaggingCategoryUpdate.new # CisTaggingCategoryUpdate |
434
-
435
- begin
436
- #Updates an existing category. To invoke this {@term operation}, you need the edit privilege on the category.
437
- api_instance.update(category_id, request_body)
438
- rescue VSphereAutomation::ApiError => e
439
- puts "Exception when calling TaggingCategoryApi->update: #{e}"
440
- end
441
- ```
442
-
443
- ### Parameters
444
-
445
- Name | Type | Description | Notes
446
- ------------- | ------------- | ------------- | -------------
447
- **category_id** | **String**| The identifier of the category to be updated. |
448
- **request_body** | [**CisTaggingCategoryUpdate**](CisTaggingCategoryUpdate.md)| |
449
-
450
- ### Return type
451
-
452
- nil (empty response body)
453
-
454
- ### Authorization
455
-
456
- [api_key](../README.md#api_key)
457
-
458
- ### HTTP request headers
459
-
460
- - **Content-Type**: application/json
461
- - **Accept**: application/json
462
-
463
-
464
-