dellemc.openmanage.ome_groups – Manages static device groups on OpenManage Enterprise
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
To use it in a playbook, specify: dellemc.openmanage.ome_groups
.
New in version 3.5.0: of dellemc.openmanage
Synopsis
This module allows to create, modify, and delete static device groups on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7.5
Parameters
Parameter |
Comments |
---|---|
Description for the device group. This is applicable only when state is |
|
ID of the device group to be created, modified, or deleted. If state is absent, multiple IDs can be provided. This option is mutually exclusive with name. |
|
OpenManage Enterprise IP address or hostname. |
|
Name of the device group to be created, modified, or deleted. If state is absent, multiple names can be provided. This option is case insensitive. This option is mutually exclusive with group_id. |
|
New name for the existing device group. This is applicable only when state is |
|
ID of the parent device group under which the device group to be created or modified. This is applicable only when state is This option is mutually exclusive with parent_group_name. |
|
Name of the parent device group under which the device group to be created or modified. This is applicable only when state is
This option is case insensitive. This option is mutually exclusive with parent_group_id. Default: “Static Groups” |
|
OpenManage Enterprise password. |
|
OpenManage Enterprise HTTPS port. Default: 443 |
|
Choices:
|
|
OpenManage Enterprise username. |
Notes
Note
This module manages only static device groups on Dell EMC OpenManage Enterprise.
If a device group with the name parent_group_name does not exist, a new device group with the same name is created.
Make sure the entered parent group is not the descendant of the provided group.
Run this module from a system that has direct access to Dell EMC OpenManage Enterprise.
This module supports
check_mode
.
Examples
---
- name: Create a new device group
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
name: "group 1"
description: "Group 1 description"
parent: "group parent 1"
- name: Modify a device group using the group ID
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
group_id: 1234
description: "Group description updated"
parent: "group parent 2"
- name: Delete a device group using the device group name
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
state: absent
name: "group 1"
- name: Delete multiple device groups using the group IDs
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
state: absent
group_id:
- 1234
- 5678
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: {“error”: {“@Message.ExtendedInfo”: [{“Message”: “Unable to update group 12345 with the provided parent 54321 because a group/parent relationship already exists.”, “MessageArgs”: [“12345”, “54321”], “MessageId”: “CGRP9013”, “RelatedProperties”: [], “Resolution”: “Make sure the entered parent ID does not create a bidirectional relationship and retry the operation.”, “Severity”: “Warning”}], “code”: “Base.1.0.GeneralError”, “message”: “A general error has occurred. See ExtendedInfo for more information.”}} |
|
List of the deleted device group IDs. Returned: when state is Sample: [1234, 5678] |
|
Details of the device group operation status. Returned: success Sample: {“CreatedBy”: “admin”, “CreationTime”: “2021-01-01 10:10:10.100”, “DefinitionDescription”: “UserDefined”, “DefinitionId”: 400, “Description”: “my group description”, “GlobalStatus”: 5000, “HasAttributes”: false, “Id”: 12123, “IdOwner”: 30, “MembershipTypeId”: 12, “Name”: “group 1”, “ParentId”: 12345, “TypeId”: 3000, “UpdatedBy”: “”, “UpdatedTime”: “2021-01-01 11:11:10.100”, “Visible”: true} |
|
List of the invalid device group IDs or names. Returned: when state is Sample: [1234, 5678] |
|
Overall status of the device group operation. Returned: always Sample: “Successfully deleted the device group(s).” |
Authors
Jagadeesh N V(@jagadeeshnv)