Try SpotterManages static device groups on OpenManage Enterprise
| "added in version" 3.5.0 of dellemc.openmanage"
Authors: Jagadeesh N V(@jagadeeshnv)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to create, modify, and delete static device groups on OpenManage Enterprise.
---
- 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
name:
description:
- Name of the device group to be created, modified, or deleted.
- If I(state) is absent, multiple names can be provided.
- This option is case insensitive.
- This option is mutually exclusive with I(group_id).
elements: str
type: list
port:
default: 443
description: OpenManage Enterprise HTTPS port.
type: int
state:
choices:
- present
- absent
default: present
description:
- C(present) allows to create or modify a device group.
- C(absent) allows to delete a device group.
type: str
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
group_id:
description:
- ID of the device group to be created, modified, or deleted.
- If I(state) is absent, multiple IDs can be provided.
- This option is mutually exclusive with I(name).
elements: int
type: list
hostname:
description: OpenManage Enterprise IP address or hostname.
required: true
type: str
new_name:
description:
- New name for the existing device group.
- This is applicable only when I(state) is C(present).
type: str
password:
description:
- OpenManage Enterprise password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
description:
description:
- Description for the device group.
- This is applicable only when I(state) is C(present).
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
parent_group_id:
description:
- ID of the parent device group under which the device group to be created or modified.
- This is applicable only when I(state) is C(present).
- This option is mutually exclusive with I(parent_group_name).
type: int
parent_group_name:
default: Static Groups
description:
- Name of the parent device group under which the device group to be created or modified.
- This is applicable only when I(state) is C(present).
- C(NOTE) If device group with such a name does not exist, device group with I(parent_group_name)
is created.
- This option is case insensitive.
- This option is mutually exclusive with I(parent_group_id).
type: str
error_info:
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.
type: dict
group_ids:
description: List of the deleted device group IDs.
elements: int
returned: when I(state) is C(absent)
sample:
- 1234
- 5678
type: list
group_status:
description: 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
type: dict
invalid_groups:
description: List of the invalid device group IDs or names.
elements: str
returned: when I(state) is C(absent)
sample:
- 1234
- 5678
type: list
msg:
description: Overall status of the device group operation.
returned: always
sample: Successfully deleted the device group(s).
type: str