Users Guide

Table 59. ome_template (continued)
Parameter Required Default Choices Comments
• Name: Name of the template. This is mandatory
when I(command) is C(create), C(import), C(clone),
and optional when I(command) is C(modify).
• Description for the template. This is applicable when
I(command) is C(deploy) or C(modify).
• Fqdds: This allows to create [Creates] a template
using components from a specified reference server.
One or more, of the following values must be
specified in a comma-separated string: iDRAC,
System, BIOS, NIC, LifeCycleController, 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
66
Modules for OpenManage Enterprise (OME)