Users Guide
Table Of Contents
- Dell EMC OpenManage Ansible Modules Version 4.0.0 User’s Guide
- Contents
- Overview
- Getting Started
- Modules for iDRAC
- How OpenManage Ansible Modules work with iDRAC
- Running your first iDRAC Playbook
- Updating Firmware
- Configuring PowerEdge Servers
- Deploying operating system
- Server Inventory
- Server administration tasks
- Storage controller
- Modules for OpenManage Enterprise (OME)
- How OpenManage Ansible Modules work with OME
- Running your first OME Playbook
- Manage Devices
- Manage device configuration templates
- Template Service
- Manage the device firmware
- Manage jobs
- Manage users
- Manage identity pool
- Manage application settings
- Manage network configuration
- Manage fabrics
- Manage Profiles
- Device discovery
- Manage Chassis
- Manage Active Directory service and user groups
- Diagnostics
- Modules for Redfish APIs
- Deprecated modules
Table 30. ome_template_identity_pool (continued)
Parameter Required Default Choices Comments
port False 443 NA Target HTTPS port
template_name True NA NA Name of the template
to which an identity
pool is attached to or
detached from.
identity_pool_name False NA NA 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.
Return Values
msg:
type: str
description: Overall identity pool status of the attach or detach operation.
returned: always
sample: Successfully attached identity pool to template.
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
type: dict
sample: {
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"MessageId": "GEN1234",
"RelatedProperties": [],
"Message": "Unable to process the request because an error occurred.",
"MessageArgs": [],
"Severity": "Critical",
"Resolution": "Retry the operation. If the issue persists, contact your system
administrator."
}
]
}
}
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
Modules for OpenManage Enterprise (OME)
75