Skip to content

Commit

Permalink
vmware_category: Improve documentation (ansible-collections#1938) (an…
Browse files Browse the repository at this point in the history
…sible-collections#1945)

vmware_category: Improve documentation (ansible-collections#1938)

SUMMARY
Improve the documentation of the parameter category_cardinality.
Backport of ansible-collections#1938
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
vmware_category
  • Loading branch information
mariolenz authored Dec 7, 2023
1 parent 0342339 commit 478be64
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions plugins/modules/vmware_category.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@
description:
- The category cardinality.
- This parameter is ignored, when updating existing category.
- V(single) means an object can only be assigned one of the tags in this category.
For example, if a O(category_name=Operating System), then different tags of this category would be "Windows", "Linux", and so on.
In this case a VM object can be assigned only one of these tags and hence the cardinality of the associated category here is V(single).
- V(multiple) means an object can be assigned several of the tags in this category.
For example, if a O(category_name=Server), then different tags of this category would be "AppServer", "DatabaseServer" and so on.
In this case a VM object can be assigned more than one of the above tags and hence the cardinality of the associated category here is V(multiple).
choices: ['multiple', 'single']
default: 'multiple'
type: str
Expand Down

0 comments on commit 478be64

Please sign in to comment.