dellemc.openmanage.ome_device_group – Add devices to a static device group 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_device_group.
New in version 3.3.0: of dellemc.openmanage
Synopsis
- This module allows to add devices to a static device group on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7.5
- netaddr >= 0.7.19
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| device_ids
list / elements=integer
|
List of ID(s) of the device(s) to be added to the device group.
device_ids is mutually exclusive with device_service_tags and ip_addresses.
|
|
| device_service_tags
list / elements=string
|
List of service tag(s) of the device(s) to be added to the device group.
device_service_tags is mutually exclusive with device_ids and ip_addresses.
|
|
| group_id
integer
|
ID of the static device group to which device(s) need to be added.
group_id is mutually exclusive with name.
|
|
| hostname
string / required
|
OpenManage Enterprise IP address or hostname.
|
|
| ip_addresses
list / elements=string
|
List of IPs of the device(s) to be added to the device group.
ip_addresses is mutually exclusive with device_ids and device_service_tags.
Supported IP address range formats:
- 192.35.0.1
- 10.36.0.0-192.36.0.255
- 192.37.0.0/24
- fe80::ffff:ffff:ffff:ffff
- fe80::ffff:192.0.2.0/125
- fe80::ffff:ffff:ffff:1111-fe80::ffff:ffff:ffff:ffff
NOTE Hostname is not supported.
NOTE ip_addresses requires python's netaddr packages to work on IP Addresses.
NOTE This module reports success even if one of the IP addresses provided in the ip_addresses list is available in OpenManage Enterprise.The module reports failure only if none of the IP addresses provided in the list are available in OpenManage Enterprise.
|
|
| name
string
|
Name of the static group to which device(s) need to be added.
name is mutually exclusive with group_id.
|
|
| password
string / required
|
OpenManage Enterprise password.
|
|
| port
integer
|
Default:
443
|
OpenManage Enterprise HTTPS port.
|
| state
string
|
|
present allows to add the device(s) to a static device group.
absent currently, this feature is not supported.
|
| username
string / required
|
OpenManage Enterprise username.
|
Notes
Note
- Run this module from a system that has direct access to Dell EMC OpenManage Enterprise.
- This module supports
check_mode.
Examples
---
- name: Add devices to a static device group by using the group name and device IDs
dellemc.openmanage.ome_device_group:
hostname: "192.168.0.1"
username: "username"
password: "password"
name: "Storage Services"
device_ids:
- 11111
- 11112
- 11113
- name: Add devices to a static device group by using the group name and device service tags
dellemc.openmanage.ome_device_group:
hostname: "192.168.0.1"
username: "username"
password: "password"
name: "Storage Services"
device_service_tags:
- GHRT2RL
- KJHDF3S
- LKIJNG6
- name: Add devices to a static device group by using the group ID and device service tags
dellemc.openmanage.ome_device_group:
hostname: "192.168.0.1"
username: "username"
password: "password"
group_id: 12345
device_service_tags:
- GHRT2RL
- KJHDF3S
- name: Add devices to a static device group by using the group name and IPv4 addresses
dellemc.openmanage.ome_device_group:
hostname: "192.168.0.1"
username: "username"
password: "password"
name: "Storage Services"
ip_addresses:
- 192.35.0.1
- 192.35.0.5
- name: Add devices to a static device group by using the group ID and IPv6 addresses
dellemc.openmanage.ome_device_group:
hostname: "192.168.0.1"
username: "username"
password: "password"
group_id: 12345
ip_addresses:
- fe80::ffff:ffff:ffff:ffff
- fe80::ffff:ffff:ffff:2222
- name: Add devices to a static device group by using the group ID and supported IPv4 and IPv6 address formats.
dellemc.openmanage.ome_device_group:
hostname: "192.168.0.1"
username: "username"
password: "password"
group_id: 12345
ip_addresses:
- 192.35.0.1
- 10.36.0.0-192.36.0.255
- 192.37.0.0/24
- fe80::ffff:ffff:ffff:ffff
- ::ffff:192.0.2.0/125
- fe80::ffff:ffff:ffff:1111-fe80::ffff:ffff:ffff:ffff
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| error_info
dictionary
|
on HTTP error |
Details of the HTTP Error.
Sample:
{'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to process the request because an error occurred.', 'MessageArgs': [], 'MessageId': 'GEN1234', 'RelatedProperties': [], 'Resolution': 'Retry the operation. If the issue persists, contact your system administrator.', 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
|
| group_id
integer
|
success |
ID of the group.
Sample:
21078
|
| ip_addresses_added
list / elements=string
|
success |
IP Addresses which are added to the device group.
Sample:
21078
|
| msg
string
|
always |
Overall status of the device group settings.
Sample:
Successfully added member(s) to the device group.
|
Authors
- Felix Stephen (@felixs88)
- Sajna Shetty(@Sajna-Shetty)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_device_group_module.html