'; */ // Create a banner if we're not on the official docs site if (location.host == "docs.testing.ansible.com") { document.write('
'); } // Create a banner current_url_path = window.location.pathname; var important = false; var msg = '
'; if (startsWith(current_url_path, "/ansible-core/")) { msg += 'You are reading documentation for Ansible Core, which contains no plugins except for those in ansible.builtin. For documentation of the Ansible package, go to the latest documentation.'; } else if (startsWithOneOf(current_url_path, ["/ansible/latest/", "/ansible/11/"])) { /* temp extra banner to advertise something */ banner += extra_banner; msg += 'This is the latest (stable) Ansible community documentation. For Red Hat Ansible Automation Platform subscriptions, see Life Cycle for version details.'; } else if (startsWith(current_url_path, "/ansible/2.9/")) { msg += 'You are reading the latest Red Hat released version of the Ansible documentation. Community users can use this version, or select latest from the version selector to the left for the most recent community version.'; } else if (startsWith(current_url_path, "/ansible/devel/")) { /* temp extra banner to advertise something */ banner += extra_banner; msg += 'You are reading the devel version of the Ansible documentation - this version is not guaranteed stable. Use the version selection to the left if you want the latest (stable) released version.'; } else { msg += 'You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest (stable) released version.'; /* temp extra banner to advertise something - this is for testing*/ banner += extra_banner; } msg += '
'; banner += important ? '
' : ''; banner += msg; banner += important ? '
' : ''; banner += '
Note
This module is part of the dellemc.openmanage collection (version 9.8.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.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.
New in dellemc.openmanage 2.0.0
Synopsis
This module creates, modifies, deploys, deletes, exports, imports and clones a template on OpenManage Enterprise.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter | Comments |
|---|---|
attributes dictionary | Payload data for the template operations. All the variables in this option are added as payload for Attributes: List of dictionaries of attributes (if any) to be modified in the deployment template. This is applicable when command is Name: Name of the template. This is mandatory when command is Description: Description for the template. This is applicable when command is Fqdds: This allows to create 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, and EventFilters. If none of the values are specified, the default value ‘All’ is selected. This is applicable when I (command) is Options: Options to control device shutdown or end power state post template deployment. This is applicable for Schedule: Provides options to schedule the deployment task immediately, or at a specified time. This is applicable when command is NetworkBootIsoModel: Payload to specify the ISO deployment details. This is applicable when command is Content: The XML content of template. This is applicable when command is Type: Template type ID, indicating the type of device for which configuration is supported, such as chassis and servers. This is applicable when command is TypeId: Template type ID, indicating the type of device for which configuration is supported, such as chassis and servers. This is applicable when command is Refer OpenManage Enterprise API Reference Guide for more details. |
ca_path path added in dellemc.openmanage 5.0.0 | The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
command aliases: state string |
Choices:
|
device_group_names list / elements=string | Specify the list of groups when I (command) is Provide at least one of the mandatory options device_id, device_service_tag, or device_group_names. Default: |
device_id list / elements=integer | Specify the list of targeted device ID(s) when command is Either device_id or device_service_tag is mandatory or both can be applicable. Default: |
device_service_tag list / elements=string | Specify the list of targeted device service tags when I (command) is Either device_id or device_service_tag is mandatory or both can be applicable. Default: |
hostname string / required | OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
job_wait boolean | Provides the option to wait for job completion. This option is applicable when command is Choices:
|
job_wait_timeout integer | The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is Default: |
password string | OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable OME_PASSWORD is used. Example: export OME_PASSWORD=password |
port integer | OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
template_id integer | ID of the existing template. This option is applicable when command is This option is mutually exclusive with template_name. |
template_name string | Name of the existing template. This option is applicable when command is This option is mutually exclusive with template_id. |
template_view_type string | Select the type of view of the OME template. This is applicable when command is Choices:
|
timeout integer added in dellemc.openmanage 5.0.0 | The socket level timeout in seconds. Default: |
username string | OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable OME_USERNAME is used. Example: export OME_USERNAME=username |
validate_certs boolean added in dellemc.openmanage 5.0.0 | If Configure Prior to collection version Choices:
|
x_auth_token string added in dellemc.openmanage 9.3.0 | Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode.
Examples
---- name: Create a template from a reference device dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_id: 25123 attributes: Name: "New Template" Description: "New Template description"- name: Modify template name, description, and attribute value dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "modify" template_id: 12 attributes: Name: "New Custom Template" Description: "Custom Template Description" # Attributes to be modified in the template. # For information on any attribute id, use API /TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails # This section is optional Attributes: - Id: 1234 Value: "Test Attribute" IsIgnored: false- name: Modify template name, description, and attribute using detailed view dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "modify" template_id: 12 attributes: Name: "New Custom Template" Description: "Custom Template Description" Attributes: # Enter the comma separated string as appearing in the Detailed view on GUI # NIC -> NIC.Integrated.1-1-1 -> NIC Configuration -> Wake On LAN1 - DisplayName: 'NIC, NIC.Integrated.1-1-1, NIC Configuration, Wake On LAN' Value: Enabled IsIgnored: false # System -> LCD Configuration -> LCD 1 User Defined String for LCD - DisplayName: 'System, LCD Configuration, LCD 1 User Defined String for LCD' Value: LCD str by OMAM IsIgnored: false- name: Deploy template on multiple devices dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "deploy" template_id: 12 device_id: - 12765 - 10173 device_service_tag: - 'SVTG123' - 'SVTG456'- name: Deploy template on groups dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "deploy" template_id: 12 device_group_names: - server_group_1 - server_group_2- name: Deploy template on multiple devices along with the attributes values to be modified on the target devices dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "deploy" template_id: 12 device_id: - 12765 - 10173 device_service_tag: - 'SVTG123' attributes: # Device specific attributes to be modified during deployment. # For information on any attribute id, use API /TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails # This section is optional Attributes: # specific device where attribute to be modified at deployment run-time. # The DeviceId should be mentioned above in the 'device_id' section. # Service tags not allowed. - DeviceId: 12765 Attributes: - Id: 15645 Value: "0.0.0.0" IsIgnored: false - DeviceId: 10173 Attributes: - Id: 18968, Value: "hostname-1" IsIgnored: false- name: Deploy template and Operating System (OS) on multiple devices dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "deploy" template_id: 12 device_id: - 12765 device_service_tag: - 'SVTG123' attributes: # Include this to install OS on the devices. # This section is optional NetworkBootIsoModel: BootToNetwork: true ShareType: "NFS" IsoTimeout: 1 # allowable values(1,2,4,8,16) in hours IsoPath: "/home/iso_path/filename.iso" ShareDetail: IpAddress: "192.168.0.2" ShareName: "sharename" User: "share_user" Password: "share_password" Options: EndHostPowerState: 1 ShutdownType: 0 TimeToWaitBeforeShutdown: 300 Schedule: RunLater: true RunNow: false- name: "Deploy template on multiple devices and changes the device-level attributes. After the template is deployed,install OS using its image" dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "deploy" template_id: 12 device_id: - 12765 - 10173 device_service_tag: - 'SVTG123' - 'SVTG456' attributes: Attributes: - DeviceId: 12765 Attributes: - Id: 15645 Value: "0.0.0.0" IsIgnored: false - DeviceId: 10173 Attributes: - Id: 18968, Value: "hostname-1" IsIgnored: false NetworkBootIsoModel: BootToNetwork: true ShareType: "NFS" IsoTimeout: 1 # allowable values(1,2,4,8,16) in hours IsoPath: "/home/iso_path/filename.iso" ShareDetail: IpAddress: "192.168.0.2" ShareName: "sharename" User: "share_user" Password: "share_password" Options: EndHostPowerState: 1 ShutdownType: 0 TimeToWaitBeforeShutdown: 300 Schedule: RunLater: true RunNow: false- name: Delete template dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "delete" template_id: 12- name: Export a template dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "export" template_id: 12# Start of example to export template to a local xml file- name: Export template to a local xml file dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "export" template_name: "my_template" register: result- name: Save template into a file ansible.builtin.copy: content: "{{ result.Content}}" dest: "/path/to/exported_template.xml"# End of example to export template to a local xml file- name: Clone a template dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "clone" template_id: 12 attributes: Name: "New Cloned Template Name"- name: Import template from XML content dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "import" attributes: Name: "Imported Template Name" # Template Type from TemplateService/TemplateTypes Type: 2 # xml string content Content: "<SystemConfiguration Model=\"PowerEdge R940\" ServiceTag=\"SVCTAG1\" 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</Component>\n</SystemConfiguration>\n"- name: Import template from local XML file dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "import" attributes: Name: "Imported Template Name" Type: 2 Content: "{{ lookup('ansible.builtin.file', '/path/to/xmlfile') }}"- name: "Deploy template and Operating System (OS) on multiple devices." dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "deploy" template_id: 12 device_id: - 12765 device_service_tag: - 'SVTG123' attributes: # Include this to install OS on the devices. # This section is optional NetworkBootIsoModel: BootToNetwork: true ShareType: "CIFS" IsoTimeout: 1 # allowable values(1,2,4,8,16) in hours IsoPath: "/home/iso_path/filename.iso" ShareDetail: IpAddress: "192.168.0.2" ShareName: "sharename" User: "share_user" Password: "share_password" Options: EndHostPowerState: 1 ShutdownType: 0 TimeToWaitBeforeShutdown: 300 Schedule: RunLater: true RunNow: false- name: Create a compliance template from reference device dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "create" device_service_tag: - "SVTG123" template_view_type: "Compliance" attributes: Name: "Configuration Compliance" Description: "Configuration Compliance Template" Fqdds: "BIOS"- name: Import a compliance template from XML file dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" command: "import" template_view_type: "Compliance" attributes: Name: "Configuration Compliance" Content: "{{ lookup('ansible.builtin.file', './test.xml') }}" Type: 2- name: Create a template from a reference device with Job wait as false dellemc.openmanage.ome_template: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_id: 25123 attributes: Name: "New Template" Description: "New Template description" Fqdds: iDRAC,BIOS, job_wait: false
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
Content string | XML content of the exported template. This content can be written to a xml file. Returned: success, when command is Sample: |
devices_assigned dictionary | Mapping of devices with the templates already deployed on them. Returned: command is Sample: |
error_info dictionary | Details of the HTTP Error. Returned: on HTTP error Sample: |
msg string | Overall status of the template operation. Returned: always Sample: |
return_id integer | ID of the template for Returned: success, when command is Sample: |
TemplateId integer | ID of the template for Returned: success, when command is Sample: |
Authors
Jagadeesh N V (@jagadeeshnv)
Husniya Hameed (@husniya_hameed)
Kritika Bhateja (@Kritika-Bhateja)
