diff --git a/plugins/modules/activation_key.py b/plugins/modules/activation_key.py index 5b400e3989..798b7c9ffa 100644 --- a/plugins/modules/activation_key.py +++ b/plugins/modules/activation_key.py @@ -168,7 +168,17 @@ service_level: Standard ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + activation_keys: + description: List of activation keys. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/auth_source_ldap.py b/plugins/modules/auth_source_ldap.py index 6b8b9c310e..981a469bbb 100644 --- a/plugins/modules/auth_source_ldap.py +++ b/plugins/modules/auth_source_ldap.py @@ -154,7 +154,18 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + auth_source_ldaps: + description: List of auth sources for LDAP. + type: list + elements: dict +''' + from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicEntityAnsibleModule diff --git a/plugins/modules/compute_resource.py b/plugins/modules/compute_resource.py index cb87402e5e..db3b086486 100644 --- a/plugins/modules/compute_resource.py +++ b/plugins/modules/compute_resource.py @@ -278,7 +278,17 @@ ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + compute_resources: + description: List of compute resources. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicEntityAnsibleModule diff --git a/plugins/modules/config_group.py b/plugins/modules/config_group.py index 2603e681df..c7ea464e91 100644 --- a/plugins/modules/config_group.py +++ b/plugins/modules/config_group.py @@ -58,7 +58,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + config_groups: + description: List of config groups. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule diff --git a/plugins/modules/content_credential.py b/plugins/modules/content_credential.py index f7d5df7354..52d1053679 100644 --- a/plugins/modules/content_credential.py +++ b/plugins/modules/content_credential.py @@ -63,7 +63,17 @@ content: "{{ lookup('file', 'RPM-GPG-KEY-my-repo') }}" ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + content_credentials: + description: List of content credentials. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/content_view.py b/plugins/modules/content_view.py index 801434e021..c98ed5a53e 100644 --- a/plugins/modules/content_view.py +++ b/plugins/modules/content_view.py @@ -125,7 +125,17 @@ latest: true ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + content_views: + description: List of content views. + type: list + elements: dict +''' import copy from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/content_view_filter.py b/plugins/modules/content_view_filter.py index 9ab51c43ac..a402c02b34 100644 --- a/plugins/modules/content_view_filter.py +++ b/plugins/modules/content_view_filter.py @@ -166,7 +166,17 @@ inclusion: True ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + content_view_filters: + description: List of content view filters. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloMixin, ForemanStatelessEntityAnsibleModule diff --git a/plugins/modules/content_view_version.py b/plugins/modules/content_view_version.py index b57ac9825d..2156264881 100644 --- a/plugins/modules/content_view_version.py +++ b/plugins/modules/content_view_version.py @@ -125,7 +125,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + content_view_versions: + description: List of content view versions. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/domain.py b/plugins/modules/domain.py index dd9d7ce9ec..bc60ccfebd 100644 --- a/plugins/modules/domain.py +++ b/plugins/modules/domain.py @@ -72,7 +72,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + domains: + description: List of domains. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicEntityAnsibleModule, NestedParametersMixin diff --git a/plugins/modules/external_usergroup.py b/plugins/modules/external_usergroup.py index 0aad297de3..e559c08a48 100644 --- a/plugins/modules/external_usergroup.py +++ b/plugins/modules/external_usergroup.py @@ -57,7 +57,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + external_usergroups: + description: List of external usergroups. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule diff --git a/plugins/modules/global_parameter.py b/plugins/modules/global_parameter.py index 7aef792983..4b14018570 100644 --- a/plugins/modules/global_parameter.py +++ b/plugins/modules/global_parameter.py @@ -93,7 +93,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + global_parameters: + description: List of global parameters. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule, parameter_value_to_str diff --git a/plugins/modules/hardware_model.py b/plugins/modules/hardware_model.py index 51c93b1c48..f4546f3c77 100644 --- a/plugins/modules/hardware_model.py +++ b/plugins/modules/hardware_model.py @@ -63,7 +63,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + hardware_models: + description: List of hardware models. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule diff --git a/plugins/modules/host.py b/plugins/modules/host.py index b359ece722..ea8e92db53 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -154,7 +154,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + hosts: + description: List of hosts. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( ensure_puppetclasses, diff --git a/plugins/modules/host_collection.py b/plugins/modules/host_collection.py index 240388f099..51f4c61fc3 100644 --- a/plugins/modules/host_collection.py +++ b/plugins/modules/host_collection.py @@ -61,7 +61,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + host_collections: + description: List of host collections. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/hostgroup.py b/plugins/modules/hostgroup.py index 360532c6ed..349cf00485 100644 --- a/plugins/modules/hostgroup.py +++ b/plugins/modules/hostgroup.py @@ -128,7 +128,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + hostgroups: + description: List of hostgroups. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( ensure_puppetclasses, diff --git a/plugins/modules/http_proxy.py b/plugins/modules/http_proxy.py index c34cbc59a2..524038639b 100644 --- a/plugins/modules/http_proxy.py +++ b/plugins/modules/http_proxy.py @@ -71,7 +71,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + http_proxies: + description: List of HTTP proxies. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicEntityAnsibleModule diff --git a/plugins/modules/image.py b/plugins/modules/image.py index 7b2b1a28db..06807ecce7 100644 --- a/plugins/modules/image.py +++ b/plugins/modules/image.py @@ -78,7 +78,17 @@ architecture: "x86_64" ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + images: + description: List of images. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule diff --git a/plugins/modules/installation_medium.py b/plugins/modules/installation_medium.py index 8adac7523b..f5ab8dd2d3 100644 --- a/plugins/modules/installation_medium.py +++ b/plugins/modules/installation_medium.py @@ -73,7 +73,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + media: + description: List of installation media. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicEntityAnsibleModule, OS_LIST diff --git a/plugins/modules/job_template.py b/plugins/modules/job_template.py index 1866c05d18..b5d6af536f 100644 --- a/plugins/modules/job_template.py +++ b/plugins/modules/job_template.py @@ -268,7 +268,21 @@ ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + job_templates: + description: List of job templates. + type: list + elements: dict + template_inputs: + description: List of template inputs associated with the job template. + type: list + elements: dict +''' import os from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( diff --git a/plugins/modules/lifecycle_environment.py b/plugins/modules/lifecycle_environment.py index edcf1a0b9b..679ec96fe3 100644 --- a/plugins/modules/lifecycle_environment.py +++ b/plugins/modules/lifecycle_environment.py @@ -67,7 +67,17 @@ state: "present" ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + lifecycle_environments: + description: List of lifecycle environments. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/location.py b/plugins/modules/location.py index 2b7453e7f1..b018a5086e 100644 --- a/plugins/modules/location.py +++ b/plugins/modules/location.py @@ -90,7 +90,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + locations: + description: List of locations. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule, NestedParametersMixin diff --git a/plugins/modules/operatingsystem.py b/plugins/modules/operatingsystem.py index 0c6c0bee48..c9829c97f8 100644 --- a/plugins/modules/operatingsystem.py +++ b/plugins/modules/operatingsystem.py @@ -148,7 +148,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + operatinsystems: + description: List of operatinsystems. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( diff --git a/plugins/modules/organization.py b/plugins/modules/organization.py index 83475564d2..108192d15d 100644 --- a/plugins/modules/organization.py +++ b/plugins/modules/organization.py @@ -60,7 +60,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + organizations: + description: List of organizations. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule, NestedParametersMixin diff --git a/plugins/modules/os_default_template.py b/plugins/modules/os_default_template.py index 6e72ca7bd7..5c5aae31a4 100644 --- a/plugins/modules/os_default_template.py +++ b/plugins/modules/os_default_template.py @@ -69,7 +69,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + os_default_templates: + description: List of operatingsystem default templates. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule diff --git a/plugins/modules/partition_table.py b/plugins/modules/partition_table.py index 304b0ca37a..2578d2d792 100644 --- a/plugins/modules/partition_table.py +++ b/plugins/modules/partition_table.py @@ -177,7 +177,17 @@ ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + ptables: + description: List of partition tables. + type: list + elements: dict +''' import os diff --git a/plugins/modules/product.py b/plugins/modules/product.py index e4ecd7a188..b4c3280a63 100644 --- a/plugins/modules/product.py +++ b/plugins/modules/product.py @@ -97,7 +97,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + products: + description: List of products. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/provisioning_template.py b/plugins/modules/provisioning_template.py index c1e4b4e184..6948674dff 100644 --- a/plugins/modules/provisioning_template.py +++ b/plugins/modules/provisioning_template.py @@ -204,7 +204,17 @@ ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + provisioning_templates: + description: List of provisioning templates. + type: list + elements: dict +''' import os diff --git a/plugins/modules/puppet_environment.py b/plugins/modules/puppet_environment.py index 35e84c0d53..50be5c6d20 100644 --- a/plugins/modules/puppet_environment.py +++ b/plugins/modules/puppet_environment.py @@ -54,7 +54,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + puppet_environments: + description: List of puppet environments. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( ForemanTaxonomicEntityAnsibleModule, diff --git a/plugins/modules/realm.py b/plugins/modules/realm.py index 251ff8eea9..25b319dac2 100644 --- a/plugins/modules/realm.py +++ b/plugins/modules/realm.py @@ -65,7 +65,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + realms: + description: List of realms. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicEntityAnsibleModule diff --git a/plugins/modules/repository.py b/plugins/modules/repository.py index 31696d7b4e..6e27f5f557 100644 --- a/plugins/modules/repository.py +++ b/plugins/modules/repository.py @@ -193,7 +193,17 @@ gpg_key: RPM-GPG-KEY-my-product2 ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + repositories: + description: List of repositories. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/repository_set.py b/plugins/modules/repository_set.py index 8cea37c231..f6602471c5 100644 --- a/plugins/modules/repository_set.py +++ b/plugins/modules/repository_set.py @@ -188,7 +188,17 @@ var: data ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + repository_sets: + description: List of repository sets. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/role.py b/plugins/modules/role.py index 1ebab9cb35..8bd716de89 100644 --- a/plugins/modules/role.py +++ b/plugins/modules/role.py @@ -76,7 +76,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + roles: + description: List of roles. + type: list + elements: dict +''' import copy diff --git a/plugins/modules/scap_content.py b/plugins/modules/scap_content.py index 6ca00cf029..53576649cd 100644 --- a/plugins/modules/scap_content.py +++ b/plugins/modules/scap_content.py @@ -86,7 +86,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + scap_contents: + description: List of scap contents. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanScapDataStreamModule diff --git a/plugins/modules/scap_tailoring_file.py b/plugins/modules/scap_tailoring_file.py index 149a24af79..080f6db763 100644 --- a/plugins/modules/scap_tailoring_file.py +++ b/plugins/modules/scap_tailoring_file.py @@ -86,7 +86,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + scap_tailoring_files: + description: List of scap tailoring files. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanScapDataStreamModule diff --git a/plugins/modules/scc_account.py b/plugins/modules/scc_account.py index c174217db2..3005498d61 100644 --- a/plugins/modules/scc_account.py +++ b/plugins/modules/scc_account.py @@ -106,7 +106,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + scc_accounts: + description: List of scc accounts. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/smart_class_parameter.py b/plugins/modules/smart_class_parameter.py index 02c4e250bf..967eb790be 100644 --- a/plugins/modules/smart_class_parameter.py +++ b/plugins/modules/smart_class_parameter.py @@ -154,7 +154,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + smart_class_parameters: + description: List of smart class parameters. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule, parameter_value_to_str diff --git a/plugins/modules/snapshot.py b/plugins/modules/snapshot.py index 12c30b2ee2..4fe8f08ed3 100644 --- a/plugins/modules/snapshot.py +++ b/plugins/modules/snapshot.py @@ -95,7 +95,17 @@ state: absent ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + snapshots: + description: List of snapshots. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule diff --git a/plugins/modules/subnet.py b/plugins/modules/subnet.py index 9cb51ea9f6..82d27ca7ca 100644 --- a/plugins/modules/subnet.py +++ b/plugins/modules/subnet.py @@ -178,7 +178,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + subnets: + description: List of subnets. + type: list + elements: dict +''' import traceback from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( diff --git a/plugins/modules/sync_plan.py b/plugins/modules/sync_plan.py index 3edc45839b..8ee6848343 100644 --- a/plugins/modules/sync_plan.py +++ b/plugins/modules/sync_plan.py @@ -92,7 +92,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + sync_plans: + description: List of sync plans. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloEntityAnsibleModule diff --git a/plugins/modules/templates_import.py b/plugins/modules/templates_import.py index 4a8945dd46..95a6564e01 100644 --- a/plugins/modules/templates_import.py +++ b/plugins/modules/templates_import.py @@ -105,7 +105,34 @@ password: "changeme" ''' -RETURN = ''' # ''' +RETURN = ''' +message: + description: Information about the import. + returned: success + type: dict + contains: + repo: + description: Repository, the templates were imported from. + type: str + branch: + description: Branch used in the repository. + type: str +report: + description: Report of the import. + returned: success + type: dict + contains: + changed: + description: List of templates that have been updated. + type: list + new: + description: List of templates that have been created. + type: list +templates: + description: Final state of the templates. + returned: success + type: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanTaxonomicAnsibleModule, _flatten_entity diff --git a/plugins/modules/user.py b/plugins/modules/user.py index 2e1bbc6e13..2325057ac6 100644 --- a/plugins/modules/user.py +++ b/plugins/modules/user.py @@ -311,7 +311,17 @@ ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + users: + description: List of users. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( ForemanTaxonomicEntityAnsibleModule, diff --git a/plugins/modules/usergroup.py b/plugins/modules/usergroup.py index baf4598a0a..0c3d4ec0b1 100644 --- a/plugins/modules/usergroup.py +++ b/plugins/modules/usergroup.py @@ -82,7 +82,17 @@ state: present ''' -RETURN = ''' # ''' +RETURN = ''' +entity: + description: Final state of the affected entities grouped by their type. + returned: success + type: dict + contains: + usergroups: + description: List of usergroups. + type: list + elements: dict +''' from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule