dellemc.openmanage.ome_groups module – Manages static device groups on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 9.8.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_groups
.
New in dellemc.openmanage 3.5.0
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 >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
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: |
|
OpenManage Enterprise password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise HTTPS port. Default: |
|
Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
This module manages only static device groups on Dell 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 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"
ca_path: "/path/to/ca_cert.pem"
name: "group 1"
description: "Group 1 description"
parent_group_name: "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"
ca_path: "/path/to/ca_cert.pem"
group_id: 1234
description: "Group description updated"
parent_group_name: "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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
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: |
|
List of the deleted device group IDs. Returned: when state is Sample: |
|
Details of the device group operation status. Returned: success Sample: |
|
List of the invalid device group IDs or names. Returned: when state is Sample: |
|
Overall status of the device group operation. Returned: always Sample: |