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 29. ome_template (continued)
Parameter Required Default Choices Comments
RAID, EventFilters, and All. If none of the values
are specified, the default value 'All' is selected.
This is applicable when I (command) is C(create).
● Options: Allows to control device shutdown or
end power state during template deployment.
This is applicable when I(command) is C(deploy).
● Schedule: Provides options to schedule the
deployment task immediately, or at a specified
time. This is applicable when I (command) is
C(deploy).
● NetworkBootIsoModel: Payload to specify the
ISO deployment details. This is applicable when
I(command) is C(deploy).
● Attributes: List of dictionaries of attributes (if
any) to be modified in the deployment template.
This is applicable for when I(command) is
C(deploy) and C(modify).
● Content: The XML content of template. This is
applicable when I(command) is C(import).
● Type: Template type ID, indicating the type of
device for which configuration is supported, such
as chassis and servers. This is applicable when
I(command) is C(import).
● TypeId: Template type ID, indicating the type of
device for which configuration is supported, such
as chassis and servers. This is applicable when
I(command) is C(create).
NOTE:
See OpenManage Enterprise API
Reference Guide for more details.
Return Values
msg:
description: Overall status of the template operation.
returned: always
type: str
sample: "Successfully created a template with ID 123"
return_id:
description: ID of the template used for C(create), C(modify), C(import), and C(clone)
or task created in case of C(deploy).
returned: on success
type: int
sample: 12
TemplateId:
description: ID of the template for C(export).
returned: success, when I(command) is C(export)
type: int
sample: 13
Content:
description: XML content of the exported template.
returned: success, when I(command) is C(export)
type: str
sample: "<SystemConfiguration Model=\"PowerEdge R940\" ServiceTag=\"DG22TR2\"
TimeStamp=\"Tue Sep 24 09:20:57.872551
2019\">\n<Component FQDD=\"AHCI.Slot.6-1\">\n<Attribute
Name=\"RAIDresetConfig\">True</Attribute>\n<Attribute
Name=\"RAIDforeignConfig\">Clear</Attribute>\n</Component>\n<Component
FQDD=\"Disk.Direct.0-0:AHCI.Slot.6-1\">\n
<Attribute Name=\"RAIDPDState\">Ready</Attribute>\n<Attribute
Name=\"RAIDHotSpareStatus\">No</Attribute>\n
</Component>\n<Component FQDD=\"Disk.Direct.1-1:AHCI.Slot.6-1\">\n<Attribute
Name=\"RAIDPDState\">Ready
</Attribute>\n<Attribute Name=\"RAIDHotSpareStatus\">No</Attribute>\n</
70
Modules for OpenManage Enterprise (OME)