dellemc.openmanage.ome_template_identity_pool – Attach or detach an identity pool to a requested template 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_template_identity_pool.
New in version 2.0.0: of dellemc.openmanage
Synopsis
- This module allows to- - Attach an identity pool to a requested template on OpenManage Enterprise. - Detach an identity pool from a requested template on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7.5
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| hostname
string / required
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
|
|
| identity_pool_name
string
|
Name of the identity pool. - To attach an identity pool to a template, provide the name of the identity pool. - This option is not applicable when detaching an identity pool from a template.
|
|
| password
string / required
|
OpenManage Enterprise or OpenManage Enterprise Modular password.
|
|
| port
integer
|
Default:
443
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
|
| template_name
string / required
|
Name of the template to which an identity pool is attached or detached.
|
|
| username
string / required
|
OpenManage Enterprise or OpenManage Enterprise Modular username.
|
Notes
Note
- Run this module from a system that has direct access to DellEMC OpenManage Enterprise.
- This module does not support
check_mode.
Examples
---
- name: Attach an identity pool to a template
dellemc.openmanage.ome_template_identity_pool:
hostname: "192.168.0.1"
username: "username"
password: "password"
template_name: template_name
identity_pool_name: identity_pool_name
- name: Detach an identity pool from a template
dellemc.openmanage.ome_template_identity_pool:
hostname: "192.168.0.1"
username: "username"
password: "password"
template_name: template_name
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.'}}
|
| msg
string
|
always |
Overall identity pool status of the attach or detach operation.
Sample:
Successfully attached identity pool to template.
|
Authors
- Felix Stephen (@felixs88)
© 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_template_identity_pool_module.html