vsphere-automation-cis 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +11 -1
- data/Gemfile.lock +39 -36
- data/README.md +14 -7
- data/Rakefile +8 -0
- data/docs/CisTaggingTagAssociationBatchResult.md +1 -1
- data/docs/CisTaskInfo.md +1 -1
- data/docs/CisTasksGetSpec.md +2 -2
- data/docs/CisTasksListResultValue.md +1 -1
- data/docs/FilterSpecTargets.md +1 -1
- data/docs/SessionApi.md +26 -6
- data/docs/TaggingCategoryApi.md +104 -39
- data/docs/TaggingTagApi.md +118 -44
- data/docs/TaggingTagAssociationApi.md +145 -64
- data/docs/TasksApi.md +40 -17
- data/lib/vsphere-automation-cis/api/session_api.rb +10 -12
- data/lib/vsphere-automation-cis/api/tagging_category_api.rb +79 -70
- data/lib/vsphere-automation-cis/api/tagging_tag_api.rb +96 -76
- data/lib/vsphere-automation-cis/api/tagging_tag_association_api.rb +140 -120
- data/lib/vsphere-automation-cis/api/tasks_api.rb +33 -24
- data/lib/vsphere-automation-cis/api_client.rb +9 -5
- data/lib/vsphere-automation-cis/api_error.rb +4 -6
- data/lib/vsphere-automation-cis/configuration.rb +18 -6
- data/lib/vsphere-automation-cis/models/cis_session_create_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_session_info.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_session_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_add_to_used_by.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create_spec.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_used_categories.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_used_categories_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_model.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_model_cardinality.rb +6 -8
- data/lib/vsphere-automation-cis/models/cis_tagging_category_remove_from_used_by.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_update.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_category_update_spec.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_add_to_used_by.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_multiple_tags_to_object.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_tag_to_multiple_objects.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_batch_result.rb +5 -7
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_multiple_tags_from_object.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_tag_from_multiple_objects.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attachable_tags.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attachable_tags_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_on_tags.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_on_tags_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_on_objects.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_on_objects_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_object_to_tags.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_tag_to_objects.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create_spec.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_tags_for_category_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_used_tags.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_used_tags_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_model.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_remove_from_used_by.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_update.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_update_spec.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_task_info.rb +5 -7
- data/lib/vsphere-automation-cis/models/cis_task_progress.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_task_status.rb +9 -11
- data/lib/vsphere-automation-cis/models/cis_tasks_filter_spec.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tasks_get_spec.rb +6 -8
- data/lib/vsphere-automation-cis/models/cis_tasks_list_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/cis_tasks_list_result_value.rb +17 -19
- data/lib/vsphere-automation-cis/models/cis_tasks_result.rb +4 -6
- data/lib/vsphere-automation-cis/models/filter_spec_targets.rb +23 -25
- data/lib/vsphere-automation-cis/models/vapi_std_dynamic_id.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_already_exists.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_already_exists_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_error_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_invalid_argument.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_invalid_argument_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_allowed_in_current_state.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_allowed_in_current_state_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_found.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_found_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_resource_inaccessible.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_resource_inaccessible_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_service_unavailable.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_service_unavailable_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthenticated.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthenticated_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthorized.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthorized_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unsupported.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unsupported_error.rb +4 -6
- data/lib/vsphere-automation-cis/models/vapi_std_localizable_message.rb +4 -6
- data/lib/vsphere-automation-cis/version.rb +5 -7
- data/lib/vsphere-automation-cis.rb +7 -9
- data/pkg/vsphere-automation-cis-0.2.0.gem +0 -0
- data/spec/api/session_api_spec.rb +4 -6
- data/spec/api/tagging_category_api_spec.rb +10 -11
- data/spec/api/tagging_tag_api_spec.rb +11 -11
- data/spec/api/tagging_tag_association_api_spec.rb +16 -16
- data/spec/api/tasks_api_spec.rb +9 -10
- data/spec/api_client_spec.rb +4 -6
- data/spec/configuration_spec.rb +4 -6
- data/spec/models/cis_session_create_result_spec.rb +4 -6
- data/spec/models/cis_session_info_spec.rb +4 -6
- data/spec/models/cis_session_result_spec.rb +4 -6
- data/spec/models/cis_tagging_category_add_to_used_by_spec.rb +4 -6
- data/spec/models/cis_tagging_category_create_result_spec.rb +4 -6
- data/spec/models/cis_tagging_category_create_spec.rb +4 -6
- data/spec/models/cis_tagging_category_create_spec_spec.rb +4 -6
- data/spec/models/cis_tagging_category_list_result_spec.rb +4 -6
- data/spec/models/cis_tagging_category_list_used_categories_result_spec.rb +4 -6
- data/spec/models/cis_tagging_category_list_used_categories_spec.rb +4 -6
- data/spec/models/cis_tagging_category_model_cardinality_spec.rb +4 -6
- data/spec/models/cis_tagging_category_model_spec.rb +4 -6
- data/spec/models/cis_tagging_category_remove_from_used_by_spec.rb +4 -6
- data/spec/models/cis_tagging_category_result_spec.rb +4 -6
- data/spec/models/cis_tagging_category_update_spec.rb +4 -6
- data/spec/models/cis_tagging_category_update_spec_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_add_to_used_by_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_attach_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_batch_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_detach_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attached_objects_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attached_tags_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_list_attached_tags_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_object_to_tags_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_association_tag_to_objects_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_create_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_create_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_create_spec_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_list_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_list_tags_for_category_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_list_used_tags_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_list_used_tags_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_model_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_remove_from_used_by_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_result_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_update_spec.rb +4 -6
- data/spec/models/cis_tagging_tag_update_spec_spec.rb +4 -6
- data/spec/models/cis_task_info_spec.rb +4 -6
- data/spec/models/cis_task_progress_spec.rb +4 -6
- data/spec/models/cis_task_status_spec.rb +4 -6
- data/spec/models/cis_tasks_filter_spec_spec.rb +4 -6
- data/spec/models/cis_tasks_get_spec_spec.rb +4 -6
- data/spec/models/cis_tasks_list_result_spec.rb +4 -6
- data/spec/models/cis_tasks_list_result_value_spec.rb +6 -8
- data/spec/models/cis_tasks_result_spec.rb +4 -6
- data/spec/models/filter_spec_targets_spec.rb +6 -8
- data/spec/models/vapi_std_dynamic_id_spec.rb +4 -6
- data/spec/models/vapi_std_errors_already_exists_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_already_exists_spec.rb +4 -6
- data/spec/models/vapi_std_errors_error_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_invalid_argument_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_invalid_argument_spec.rb +4 -6
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_spec.rb +4 -6
- data/spec/models/vapi_std_errors_not_found_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_not_found_spec.rb +4 -6
- data/spec/models/vapi_std_errors_resource_inaccessible_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_resource_inaccessible_spec.rb +4 -6
- data/spec/models/vapi_std_errors_service_unavailable_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_service_unavailable_spec.rb +4 -6
- data/spec/models/vapi_std_errors_unauthenticated_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_unauthenticated_spec.rb +4 -6
- data/spec/models/vapi_std_errors_unauthorized_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_unauthorized_spec.rb +4 -6
- data/spec/models/vapi_std_errors_unsupported_error_spec.rb +4 -6
- data/spec/models/vapi_std_errors_unsupported_spec.rb +4 -6
- data/spec/models/vapi_std_localizable_message_spec.rb +4 -6
- data/spec/spec_helper.rb +4 -6
- data/vsphere-automation-cis.gemspec +11 -14
- metadata +18 -32
@@ -6,7 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**attach**](TaggingTagAssociationApi.md#attach) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=attach | Attaches the given tag to the input object. The tag needs to meet the cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
8
8
|
[**attach_multiple_tags_to_object**](TaggingTagAssociationApi.md#attach_multiple_tags_to_object) | **POST** /com/vmware/cis/tagging/tag-association?~action=attach-multiple-tags-to-object | Attaches the given tags to the input object. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege on each tag.
|
9
|
-
[**attach_tag_to_multiple_objects**](TaggingTagAssociationApi.md#attach_tag_to_multiple_objects) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}
|
9
|
+
[**attach_tag_to_multiple_objects**](TaggingTagAssociationApi.md#attach_tag_to_multiple_objects) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id} | Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
10
10
|
[**detach**](TaggingTagAssociationApi.md#detach) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach | Detaches the tag from the given object. If the tag is already removed from the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
11
11
|
[**detach_multiple_tags_from_object**](TaggingTagAssociationApi.md#detach_multiple_tags_from_object) | **POST** /com/vmware/cis/tagging/tag-association?~action=detach-multiple-tags-from-object | Detaches the given tags from the input object. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege each tag.
|
12
12
|
[**detach_tag_from_multiple_objects**](TaggingTagAssociationApi.md#detach_tag_from_multiple_objects) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach-tag-from-multiple-objects | Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
@@ -14,11 +14,11 @@ Method | HTTP request | Description
|
|
14
14
|
[**list_attached_objects**](TaggingTagAssociationApi.md#list_attached_objects) | **POST** /com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=list-attached-objects | Fetches the {@term list} of attached objects for the given tag. To invoke this {@term operation}, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.
|
15
15
|
[**list_attached_objects_on_tags**](TaggingTagAssociationApi.md#list_attached_objects_on_tags) | **POST** /com/vmware/cis/tagging/tag-association?~action=list-attached-objects-on-tags | Fetches the {@term list} of {@link TagToObjects} describing the input tag identifiers and the objects they are attached to. To invoke this {@term operation}, you need the read privilege on each input tag. The {@link TagToObjects#objectIds} will only contain those objects for which you have the read privilege.
|
16
16
|
[**list_attached_tags**](TaggingTagAssociationApi.md#list_attached_tags) | **POST** /com/vmware/cis/tagging/tag-association?~action=list-attached-tags | Fetches the {@term list} of tags attached to the given object. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have the read privileges.
|
17
|
-
[**list_attached_tags_on_objects**](TaggingTagAssociationApi.md#list_attached_tags_on_objects) | **POST** /com/vmware/cis/tagging/tag-association
|
17
|
+
[**list_attached_tags_on_objects**](TaggingTagAssociationApi.md#list_attached_tags_on_objects) | **POST** /com/vmware/cis/tagging/tag-association | Fetches the {@term list} of {@link ObjectToTags} describing the input object identifiers and the tags attached to each object. To invoke this {@term operation}, you need the read privilege on each input object. The {@link ObjectToTags#tagIds} will only contain those tags for which you have the read privilege.
|
18
18
|
|
19
19
|
|
20
20
|
# **attach**
|
21
|
-
> attach(tag_id,
|
21
|
+
> attach(tag_id, request_body)
|
22
22
|
|
23
23
|
Attaches the given tag to the input object. The tag needs to meet the cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
24
24
|
|
@@ -26,14 +26,21 @@ Attaches the given tag to the input object. The tag needs to meet the cardinalit
|
|
26
26
|
```ruby
|
27
27
|
# load the gem
|
28
28
|
require 'vsphere-automation-cis'
|
29
|
+
# setup authorization
|
30
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
31
|
+
# Configure API key authorization: api_key
|
32
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
35
|
+
end
|
29
36
|
|
30
37
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
31
38
|
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
32
|
-
|
39
|
+
request_body = CIS::CisTaggingTagAssociationAttach.new # CisTaggingTagAssociationAttach |
|
33
40
|
|
34
41
|
begin
|
35
42
|
#Attaches the given tag to the input object. The tag needs to meet the cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
36
|
-
api_instance.attach(tag_id,
|
43
|
+
api_instance.attach(tag_id, request_body)
|
37
44
|
rescue VSphereAutomation::ApiError => e
|
38
45
|
puts "Exception when calling TaggingTagAssociationApi->attach: #{e}"
|
39
46
|
end
|
@@ -44,7 +51,7 @@ end
|
|
44
51
|
Name | Type | Description | Notes
|
45
52
|
------------- | ------------- | ------------- | -------------
|
46
53
|
**tag_id** | **String**| The identifier of the input tag. |
|
47
|
-
**
|
54
|
+
**request_body** | [**CisTaggingTagAssociationAttach**](CisTaggingTagAssociationAttach.md)| |
|
48
55
|
|
49
56
|
### Return type
|
50
57
|
|
@@ -52,17 +59,17 @@ nil (empty response body)
|
|
52
59
|
|
53
60
|
### Authorization
|
54
61
|
|
55
|
-
|
62
|
+
[api_key](../README.md#api_key)
|
56
63
|
|
57
64
|
### HTTP request headers
|
58
65
|
|
59
66
|
- **Content-Type**: application/json
|
60
|
-
- **Accept**:
|
67
|
+
- **Accept**: application/json
|
61
68
|
|
62
69
|
|
63
70
|
|
64
71
|
# **attach_multiple_tags_to_object**
|
65
|
-
> CisTaggingTagAssociationAttachMultipleTagsToObjectResult attach_multiple_tags_to_object(
|
72
|
+
> CisTaggingTagAssociationAttachMultipleTagsToObjectResult attach_multiple_tags_to_object(request_body)
|
66
73
|
|
67
74
|
Attaches the given tags to the input object. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege on each tag.
|
68
75
|
|
@@ -70,13 +77,20 @@ Attaches the given tags to the input object. If a tag is already attached to the
|
|
70
77
|
```ruby
|
71
78
|
# load the gem
|
72
79
|
require 'vsphere-automation-cis'
|
80
|
+
# setup authorization
|
81
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
82
|
+
# Configure API key authorization: api_key
|
83
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
84
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
86
|
+
end
|
73
87
|
|
74
88
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
75
|
-
|
89
|
+
request_body = CIS::CisTaggingTagAssociationAttachMultipleTagsToObject.new # CisTaggingTagAssociationAttachMultipleTagsToObject |
|
76
90
|
|
77
91
|
begin
|
78
92
|
#Attaches the given tags to the input object. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege on each tag.
|
79
|
-
result = api_instance.attach_multiple_tags_to_object(
|
93
|
+
result = api_instance.attach_multiple_tags_to_object(request_body)
|
80
94
|
p result
|
81
95
|
rescue VSphereAutomation::ApiError => e
|
82
96
|
puts "Exception when calling TaggingTagAssociationApi->attach_multiple_tags_to_object: #{e}"
|
@@ -87,7 +101,7 @@ end
|
|
87
101
|
|
88
102
|
Name | Type | Description | Notes
|
89
103
|
------------- | ------------- | ------------- | -------------
|
90
|
-
**
|
104
|
+
**request_body** | [**CisTaggingTagAssociationAttachMultipleTagsToObject**](CisTaggingTagAssociationAttachMultipleTagsToObject.md)| |
|
91
105
|
|
92
106
|
### Return type
|
93
107
|
|
@@ -95,17 +109,17 @@ Name | Type | Description | Notes
|
|
95
109
|
|
96
110
|
### Authorization
|
97
111
|
|
98
|
-
|
112
|
+
[api_key](../README.md#api_key)
|
99
113
|
|
100
114
|
### HTTP request headers
|
101
115
|
|
102
116
|
- **Content-Type**: application/json
|
103
|
-
- **Accept**:
|
117
|
+
- **Accept**: application/json
|
104
118
|
|
105
119
|
|
106
120
|
|
107
121
|
# **attach_tag_to_multiple_objects**
|
108
|
-
> CisTaggingTagAssociationAttachTagToMultipleObjectsResult attach_tag_to_multiple_objects(tag_id,
|
122
|
+
> CisTaggingTagAssociationAttachTagToMultipleObjectsResult attach_tag_to_multiple_objects(tag_id, action, request_body)
|
109
123
|
|
110
124
|
Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
111
125
|
|
@@ -113,14 +127,22 @@ Attaches the given tag to the input objects. If a tag is already attached to the
|
|
113
127
|
```ruby
|
114
128
|
# load the gem
|
115
129
|
require 'vsphere-automation-cis'
|
130
|
+
# setup authorization
|
131
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
132
|
+
# Configure API key authorization: api_key
|
133
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
134
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
135
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
136
|
+
end
|
116
137
|
|
117
138
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
118
139
|
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
119
|
-
|
140
|
+
action = 'action_example' # String | ~action=attach-tag-to-multiple-objects
|
141
|
+
request_body = CIS::CisTaggingTagAssociationAttachTagToMultipleObjects.new # CisTaggingTagAssociationAttachTagToMultipleObjects |
|
120
142
|
|
121
143
|
begin
|
122
144
|
#Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
123
|
-
result = api_instance.attach_tag_to_multiple_objects(tag_id,
|
145
|
+
result = api_instance.attach_tag_to_multiple_objects(tag_id, action, request_body)
|
124
146
|
p result
|
125
147
|
rescue VSphereAutomation::ApiError => e
|
126
148
|
puts "Exception when calling TaggingTagAssociationApi->attach_tag_to_multiple_objects: #{e}"
|
@@ -132,7 +154,8 @@ end
|
|
132
154
|
Name | Type | Description | Notes
|
133
155
|
------------- | ------------- | ------------- | -------------
|
134
156
|
**tag_id** | **String**| The identifier of the input tag. |
|
135
|
-
**
|
157
|
+
**action** | **String**| ~action=attach-tag-to-multiple-objects |
|
158
|
+
**request_body** | [**CisTaggingTagAssociationAttachTagToMultipleObjects**](CisTaggingTagAssociationAttachTagToMultipleObjects.md)| |
|
136
159
|
|
137
160
|
### Return type
|
138
161
|
|
@@ -140,17 +163,17 @@ Name | Type | Description | Notes
|
|
140
163
|
|
141
164
|
### Authorization
|
142
165
|
|
143
|
-
|
166
|
+
[api_key](../README.md#api_key)
|
144
167
|
|
145
168
|
### HTTP request headers
|
146
169
|
|
147
170
|
- **Content-Type**: application/json
|
148
|
-
- **Accept**:
|
171
|
+
- **Accept**: application/json
|
149
172
|
|
150
173
|
|
151
174
|
|
152
175
|
# **detach**
|
153
|
-
> detach(tag_id,
|
176
|
+
> detach(tag_id, request_body)
|
154
177
|
|
155
178
|
Detaches the tag from the given object. If the tag is already removed from the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
156
179
|
|
@@ -158,14 +181,21 @@ Detaches the tag from the given object. If the tag is already removed from the o
|
|
158
181
|
```ruby
|
159
182
|
# load the gem
|
160
183
|
require 'vsphere-automation-cis'
|
184
|
+
# setup authorization
|
185
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
186
|
+
# Configure API key authorization: api_key
|
187
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
188
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
189
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
190
|
+
end
|
161
191
|
|
162
192
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
163
193
|
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
164
|
-
|
194
|
+
request_body = CIS::CisTaggingTagAssociationDetach.new # CisTaggingTagAssociationDetach |
|
165
195
|
|
166
196
|
begin
|
167
197
|
#Detaches the tag from the given object. If the tag is already removed from the object, then this {@term operation} is a no-op and an error will not be thrown. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on the object.
|
168
|
-
api_instance.detach(tag_id,
|
198
|
+
api_instance.detach(tag_id, request_body)
|
169
199
|
rescue VSphereAutomation::ApiError => e
|
170
200
|
puts "Exception when calling TaggingTagAssociationApi->detach: #{e}"
|
171
201
|
end
|
@@ -176,7 +206,7 @@ end
|
|
176
206
|
Name | Type | Description | Notes
|
177
207
|
------------- | ------------- | ------------- | -------------
|
178
208
|
**tag_id** | **String**| The identifier of the input tag. |
|
179
|
-
**
|
209
|
+
**request_body** | [**CisTaggingTagAssociationDetach**](CisTaggingTagAssociationDetach.md)| |
|
180
210
|
|
181
211
|
### Return type
|
182
212
|
|
@@ -184,17 +214,17 @@ nil (empty response body)
|
|
184
214
|
|
185
215
|
### Authorization
|
186
216
|
|
187
|
-
|
217
|
+
[api_key](../README.md#api_key)
|
188
218
|
|
189
219
|
### HTTP request headers
|
190
220
|
|
191
221
|
- **Content-Type**: application/json
|
192
|
-
- **Accept**:
|
222
|
+
- **Accept**: application/json
|
193
223
|
|
194
224
|
|
195
225
|
|
196
226
|
# **detach_multiple_tags_from_object**
|
197
|
-
> CisTaggingTagAssociationDetachMultipleTagsFromObjectResult detach_multiple_tags_from_object(
|
227
|
+
> CisTaggingTagAssociationDetachMultipleTagsFromObjectResult detach_multiple_tags_from_object(request_body)
|
198
228
|
|
199
229
|
Detaches the given tags from the input object. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege each tag.
|
200
230
|
|
@@ -202,13 +232,20 @@ Detaches the given tags from the input object. If a tag is already removed from
|
|
202
232
|
```ruby
|
203
233
|
# load the gem
|
204
234
|
require 'vsphere-automation-cis'
|
235
|
+
# setup authorization
|
236
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
237
|
+
# Configure API key authorization: api_key
|
238
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
239
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
240
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
241
|
+
end
|
205
242
|
|
206
243
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
207
|
-
|
244
|
+
request_body = CIS::CisTaggingTagAssociationDetachMultipleTagsFromObject.new # CisTaggingTagAssociationDetachMultipleTagsFromObject |
|
208
245
|
|
209
246
|
begin
|
210
247
|
#Detaches the given tags from the input object. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the read privilege on the object and the attach tag privilege each tag.
|
211
|
-
result = api_instance.detach_multiple_tags_from_object(
|
248
|
+
result = api_instance.detach_multiple_tags_from_object(request_body)
|
212
249
|
p result
|
213
250
|
rescue VSphereAutomation::ApiError => e
|
214
251
|
puts "Exception when calling TaggingTagAssociationApi->detach_multiple_tags_from_object: #{e}"
|
@@ -219,7 +256,7 @@ end
|
|
219
256
|
|
220
257
|
Name | Type | Description | Notes
|
221
258
|
------------- | ------------- | ------------- | -------------
|
222
|
-
**
|
259
|
+
**request_body** | [**CisTaggingTagAssociationDetachMultipleTagsFromObject**](CisTaggingTagAssociationDetachMultipleTagsFromObject.md)| |
|
223
260
|
|
224
261
|
### Return type
|
225
262
|
|
@@ -227,17 +264,17 @@ Name | Type | Description | Notes
|
|
227
264
|
|
228
265
|
### Authorization
|
229
266
|
|
230
|
-
|
267
|
+
[api_key](../README.md#api_key)
|
231
268
|
|
232
269
|
### HTTP request headers
|
233
270
|
|
234
271
|
- **Content-Type**: application/json
|
235
|
-
- **Accept**:
|
272
|
+
- **Accept**: application/json
|
236
273
|
|
237
274
|
|
238
275
|
|
239
276
|
# **detach_tag_from_multiple_objects**
|
240
|
-
> CisTaggingTagAssociationDetachTagFromMultipleObjectsResult detach_tag_from_multiple_objects(tag_id,
|
277
|
+
> CisTaggingTagAssociationDetachTagFromMultipleObjectsResult detach_tag_from_multiple_objects(tag_id, request_body)
|
241
278
|
|
242
279
|
Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
243
280
|
|
@@ -245,14 +282,21 @@ Detaches the given tag from the input objects. If a tag is already removed from
|
|
245
282
|
```ruby
|
246
283
|
# load the gem
|
247
284
|
require 'vsphere-automation-cis'
|
285
|
+
# setup authorization
|
286
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
287
|
+
# Configure API key authorization: api_key
|
288
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
289
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
290
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
291
|
+
end
|
248
292
|
|
249
293
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
250
294
|
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
251
|
-
|
295
|
+
request_body = CIS::CisTaggingTagAssociationDetachTagFromMultipleObjects.new # CisTaggingTagAssociationDetachTagFromMultipleObjects |
|
252
296
|
|
253
297
|
begin
|
254
298
|
#Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual {@term operation} is a no-op and an error will not be added to {@link BatchResult#errorMessages}. To invoke this {@term operation}, you need the attach tag privilege on the tag and the read privilege on each object.
|
255
|
-
result = api_instance.detach_tag_from_multiple_objects(tag_id,
|
299
|
+
result = api_instance.detach_tag_from_multiple_objects(tag_id, request_body)
|
256
300
|
p result
|
257
301
|
rescue VSphereAutomation::ApiError => e
|
258
302
|
puts "Exception when calling TaggingTagAssociationApi->detach_tag_from_multiple_objects: #{e}"
|
@@ -264,7 +308,7 @@ end
|
|
264
308
|
Name | Type | Description | Notes
|
265
309
|
------------- | ------------- | ------------- | -------------
|
266
310
|
**tag_id** | **String**| The identifier of the input tag. |
|
267
|
-
**
|
311
|
+
**request_body** | [**CisTaggingTagAssociationDetachTagFromMultipleObjects**](CisTaggingTagAssociationDetachTagFromMultipleObjects.md)| |
|
268
312
|
|
269
313
|
### Return type
|
270
314
|
|
@@ -272,17 +316,17 @@ Name | Type | Description | Notes
|
|
272
316
|
|
273
317
|
### Authorization
|
274
318
|
|
275
|
-
|
319
|
+
[api_key](../README.md#api_key)
|
276
320
|
|
277
321
|
### HTTP request headers
|
278
322
|
|
279
323
|
- **Content-Type**: application/json
|
280
|
-
- **Accept**:
|
324
|
+
- **Accept**: application/json
|
281
325
|
|
282
326
|
|
283
327
|
|
284
328
|
# **list_attachable_tags**
|
285
|
-
> CisTaggingTagAssociationListAttachableTagsResult list_attachable_tags(
|
329
|
+
> CisTaggingTagAssociationListAttachableTagsResult list_attachable_tags(request_body)
|
286
330
|
|
287
331
|
Fetches the {@term list} of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) constructs. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have read privileges.
|
288
332
|
|
@@ -290,13 +334,20 @@ Fetches the {@term list} of attachable tags for the given object, omitting the t
|
|
290
334
|
```ruby
|
291
335
|
# load the gem
|
292
336
|
require 'vsphere-automation-cis'
|
337
|
+
# setup authorization
|
338
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
339
|
+
# Configure API key authorization: api_key
|
340
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
341
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
342
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
343
|
+
end
|
293
344
|
|
294
345
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
295
|
-
|
346
|
+
request_body = CIS::CisTaggingTagAssociationListAttachableTags.new # CisTaggingTagAssociationListAttachableTags |
|
296
347
|
|
297
348
|
begin
|
298
349
|
#Fetches the {@term list} of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality ({@link CategoryModel#cardinality}) and associability ({@link CategoryModel#associableTypes}) constructs. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have read privileges.
|
299
|
-
result = api_instance.list_attachable_tags(
|
350
|
+
result = api_instance.list_attachable_tags(request_body)
|
300
351
|
p result
|
301
352
|
rescue VSphereAutomation::ApiError => e
|
302
353
|
puts "Exception when calling TaggingTagAssociationApi->list_attachable_tags: #{e}"
|
@@ -307,7 +358,7 @@ end
|
|
307
358
|
|
308
359
|
Name | Type | Description | Notes
|
309
360
|
------------- | ------------- | ------------- | -------------
|
310
|
-
**
|
361
|
+
**request_body** | [**CisTaggingTagAssociationListAttachableTags**](CisTaggingTagAssociationListAttachableTags.md)| |
|
311
362
|
|
312
363
|
### Return type
|
313
364
|
|
@@ -315,12 +366,12 @@ Name | Type | Description | Notes
|
|
315
366
|
|
316
367
|
### Authorization
|
317
368
|
|
318
|
-
|
369
|
+
[api_key](../README.md#api_key)
|
319
370
|
|
320
371
|
### HTTP request headers
|
321
372
|
|
322
373
|
- **Content-Type**: application/json
|
323
|
-
- **Accept**:
|
374
|
+
- **Accept**: application/json
|
324
375
|
|
325
376
|
|
326
377
|
|
@@ -333,6 +384,13 @@ Fetches the {@term list} of attached objects for the given tag. To invoke this {
|
|
333
384
|
```ruby
|
334
385
|
# load the gem
|
335
386
|
require 'vsphere-automation-cis'
|
387
|
+
# setup authorization
|
388
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
389
|
+
# Configure API key authorization: api_key
|
390
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
391
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
392
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
393
|
+
end
|
336
394
|
|
337
395
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
338
396
|
tag_id = 'tag_id_example' # String | The identifier of the input tag.
|
@@ -358,17 +416,17 @@ Name | Type | Description | Notes
|
|
358
416
|
|
359
417
|
### Authorization
|
360
418
|
|
361
|
-
|
419
|
+
[api_key](../README.md#api_key)
|
362
420
|
|
363
421
|
### HTTP request headers
|
364
422
|
|
365
423
|
- **Content-Type**: Not defined
|
366
|
-
- **Accept**:
|
424
|
+
- **Accept**: application/json
|
367
425
|
|
368
426
|
|
369
427
|
|
370
428
|
# **list_attached_objects_on_tags**
|
371
|
-
> CisTaggingTagAssociationListAttachedObjectsOnTagsResult list_attached_objects_on_tags(
|
429
|
+
> CisTaggingTagAssociationListAttachedObjectsOnTagsResult list_attached_objects_on_tags(request_body)
|
372
430
|
|
373
431
|
Fetches the {@term list} of {@link TagToObjects} describing the input tag identifiers and the objects they are attached to. To invoke this {@term operation}, you need the read privilege on each input tag. The {@link TagToObjects#objectIds} will only contain those objects for which you have the read privilege.
|
374
432
|
|
@@ -376,13 +434,20 @@ Fetches the {@term list} of {@link TagToObjects} describing the input tag identi
|
|
376
434
|
```ruby
|
377
435
|
# load the gem
|
378
436
|
require 'vsphere-automation-cis'
|
437
|
+
# setup authorization
|
438
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
439
|
+
# Configure API key authorization: api_key
|
440
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
441
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
442
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
443
|
+
end
|
379
444
|
|
380
445
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
381
|
-
|
446
|
+
request_body = CIS::CisTaggingTagAssociationListAttachedObjectsOnTags.new # CisTaggingTagAssociationListAttachedObjectsOnTags |
|
382
447
|
|
383
448
|
begin
|
384
449
|
#Fetches the {@term list} of {@link TagToObjects} describing the input tag identifiers and the objects they are attached to. To invoke this {@term operation}, you need the read privilege on each input tag. The {@link TagToObjects#objectIds} will only contain those objects for which you have the read privilege.
|
385
|
-
result = api_instance.list_attached_objects_on_tags(
|
450
|
+
result = api_instance.list_attached_objects_on_tags(request_body)
|
386
451
|
p result
|
387
452
|
rescue VSphereAutomation::ApiError => e
|
388
453
|
puts "Exception when calling TaggingTagAssociationApi->list_attached_objects_on_tags: #{e}"
|
@@ -393,7 +458,7 @@ end
|
|
393
458
|
|
394
459
|
Name | Type | Description | Notes
|
395
460
|
------------- | ------------- | ------------- | -------------
|
396
|
-
**
|
461
|
+
**request_body** | [**CisTaggingTagAssociationListAttachedObjectsOnTags**](CisTaggingTagAssociationListAttachedObjectsOnTags.md)| |
|
397
462
|
|
398
463
|
### Return type
|
399
464
|
|
@@ -401,17 +466,17 @@ Name | Type | Description | Notes
|
|
401
466
|
|
402
467
|
### Authorization
|
403
468
|
|
404
|
-
|
469
|
+
[api_key](../README.md#api_key)
|
405
470
|
|
406
471
|
### HTTP request headers
|
407
472
|
|
408
473
|
- **Content-Type**: application/json
|
409
|
-
- **Accept**:
|
474
|
+
- **Accept**: application/json
|
410
475
|
|
411
476
|
|
412
477
|
|
413
478
|
# **list_attached_tags**
|
414
|
-
> CisTaggingTagAssociationListAttachedTagsResult list_attached_tags(
|
479
|
+
> CisTaggingTagAssociationListAttachedTagsResult list_attached_tags(request_body)
|
415
480
|
|
416
481
|
Fetches the {@term list} of tags attached to the given object. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have the read privileges.
|
417
482
|
|
@@ -419,13 +484,20 @@ Fetches the {@term list} of tags attached to the given object. To invoke this {@
|
|
419
484
|
```ruby
|
420
485
|
# load the gem
|
421
486
|
require 'vsphere-automation-cis'
|
487
|
+
# setup authorization
|
488
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
489
|
+
# Configure API key authorization: api_key
|
490
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
491
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
492
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
493
|
+
end
|
422
494
|
|
423
495
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
424
|
-
|
496
|
+
request_body = CIS::CisTaggingTagAssociationListAttachedTags.new # CisTaggingTagAssociationListAttachedTags |
|
425
497
|
|
426
498
|
begin
|
427
499
|
#Fetches the {@term list} of tags attached to the given object. To invoke this {@term operation}, you need the read privilege on the input object. The {@term list} will only contain those tags for which you have the read privileges.
|
428
|
-
result = api_instance.list_attached_tags(
|
500
|
+
result = api_instance.list_attached_tags(request_body)
|
429
501
|
p result
|
430
502
|
rescue VSphereAutomation::ApiError => e
|
431
503
|
puts "Exception when calling TaggingTagAssociationApi->list_attached_tags: #{e}"
|
@@ -436,7 +508,7 @@ end
|
|
436
508
|
|
437
509
|
Name | Type | Description | Notes
|
438
510
|
------------- | ------------- | ------------- | -------------
|
439
|
-
**
|
511
|
+
**request_body** | [**CisTaggingTagAssociationListAttachedTags**](CisTaggingTagAssociationListAttachedTags.md)| |
|
440
512
|
|
441
513
|
### Return type
|
442
514
|
|
@@ -444,17 +516,17 @@ Name | Type | Description | Notes
|
|
444
516
|
|
445
517
|
### Authorization
|
446
518
|
|
447
|
-
|
519
|
+
[api_key](../README.md#api_key)
|
448
520
|
|
449
521
|
### HTTP request headers
|
450
522
|
|
451
523
|
- **Content-Type**: application/json
|
452
|
-
- **Accept**:
|
524
|
+
- **Accept**: application/json
|
453
525
|
|
454
526
|
|
455
527
|
|
456
528
|
# **list_attached_tags_on_objects**
|
457
|
-
> CisTaggingTagAssociationListAttachedTagsOnObjectsResult list_attached_tags_on_objects(
|
529
|
+
> CisTaggingTagAssociationListAttachedTagsOnObjectsResult list_attached_tags_on_objects(action, request_body)
|
458
530
|
|
459
531
|
Fetches the {@term list} of {@link ObjectToTags} describing the input object identifiers and the tags attached to each object. To invoke this {@term operation}, you need the read privilege on each input object. The {@link ObjectToTags#tagIds} will only contain those tags for which you have the read privilege.
|
460
532
|
|
@@ -462,13 +534,21 @@ Fetches the {@term list} of {@link ObjectToTags} describing the input object ide
|
|
462
534
|
```ruby
|
463
535
|
# load the gem
|
464
536
|
require 'vsphere-automation-cis'
|
537
|
+
# setup authorization
|
538
|
+
VSphereAutomation::Configuration.new.tap do |config|
|
539
|
+
# Configure API key authorization: api_key
|
540
|
+
config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
|
541
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
542
|
+
#config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
|
543
|
+
end
|
465
544
|
|
466
545
|
api_instance = VSphereAutomation::CIS::TaggingTagAssociationApi.new
|
467
|
-
|
546
|
+
action = 'action_example' # String | ~action=list-attached-tags-on-objects
|
547
|
+
request_body = CIS::CisTaggingTagAssociationListAttachedTagsOnObjects.new # CisTaggingTagAssociationListAttachedTagsOnObjects |
|
468
548
|
|
469
549
|
begin
|
470
550
|
#Fetches the {@term list} of {@link ObjectToTags} describing the input object identifiers and the tags attached to each object. To invoke this {@term operation}, you need the read privilege on each input object. The {@link ObjectToTags#tagIds} will only contain those tags for which you have the read privilege.
|
471
|
-
result = api_instance.list_attached_tags_on_objects(
|
551
|
+
result = api_instance.list_attached_tags_on_objects(action, request_body)
|
472
552
|
p result
|
473
553
|
rescue VSphereAutomation::ApiError => e
|
474
554
|
puts "Exception when calling TaggingTagAssociationApi->list_attached_tags_on_objects: #{e}"
|
@@ -479,7 +559,8 @@ end
|
|
479
559
|
|
480
560
|
Name | Type | Description | Notes
|
481
561
|
------------- | ------------- | ------------- | -------------
|
482
|
-
**
|
562
|
+
**action** | **String**| ~action=list-attached-tags-on-objects |
|
563
|
+
**request_body** | [**CisTaggingTagAssociationListAttachedTagsOnObjects**](CisTaggingTagAssociationListAttachedTagsOnObjects.md)| |
|
483
564
|
|
484
565
|
### Return type
|
485
566
|
|
@@ -487,12 +568,12 @@ Name | Type | Description | Notes
|
|
487
568
|
|
488
569
|
### Authorization
|
489
570
|
|
490
|
-
|
571
|
+
[api_key](../README.md#api_key)
|
491
572
|
|
492
573
|
### HTTP request headers
|
493
574
|
|
494
575
|
- **Content-Type**: application/json
|
495
|
-
- **Accept**:
|
576
|
+
- **Accept**: application/json
|
496
577
|
|
497
578
|
|
498
579
|
|