dellemc.openmanage.ome_template_identity_pool module – Attach or detach an identity pool to a requested template on OpenManage Enterprise
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
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_template_identity_pool
.
New in dellemc.openmanage 2.0.0
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 >= 3.8.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
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. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Name of the template to which an identity pool is attached or detached. |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. |
|
If Configure Prior to collection version Choices:
|
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
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"
ca_path: "/path/to/ca_cert.pem"
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"
ca_path: "/path/to/ca_cert.pem"
template_name: template_name
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: |
|
Overall identity pool status of the attach or detach operation. Returned: always Sample: |