dellemc.openmanage.ome_template_info module – Retrieves template details from OpenManage Enterprise

Note

This module is part of the dellemc.openmanage collection (version 5.5.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_info.

New in dellemc.openmanage 2.0.0

Synopsis

  • This module retrieves the list and details of all the templates on OpenManage Enterprise.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8.6

Parameters

Parameter

Comments

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.

hostname

string / required

OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.

password

string / required

OpenManage Enterprise or OpenManage Enterprise Modular password.

port

integer

OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.

Default: 443

system_query_options

dictionary

Options for pagination of the output.

filter

string

Filter records by the supported values.

template_id

integer

Unique Id of the template.

timeout

integer

added in dellemc.openmanage 5.0.0

The socket level timeout in seconds.

Default: 30

username

string / required

OpenManage Enterprise or OpenManage Enterprise Modular username.

validate_certs

boolean

added in dellemc.openmanage 5.0.0

If False, the SSL certificates will not be validated.

Configure False only on personally controlled sites where self-signed certificates are used.

Prior to collection version 5.0.0, the validate_certs is False by default.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Run this module from a system that has direct access to DellEMC OpenManage Enterprise.

  • This module supports check_mode.

Examples

---
- name: Retrieve basic details of all templates
  dellemc.openmanage.ome_template_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve details of a specific template identified by its template ID
  dellemc.openmanage.ome_template_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_id: 1

- name: Get filtered template info based on name
  dellemc.openmanage.ome_template_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    system_query_options:
      filter: "Name eq 'new template'"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Overall template facts status.

Returned: on error

Sample: "Failed to fetch the template facts"

template_info

dictionary

Details of the templates.

Returned: success

Sample: {"192.168.0.1": {"CreatedBy": "system", "CreationTime": "1970-01-31 00:00:56.372144", "Description": "Tune workload for Performance Optimized Virtualization", "HasIdentityAttributes": false, "Id": 1, "IdentityPoolId": 0, "IsBuiltIn": true, "IsPersistencePolicyValid": false, "IsStatelessAvailable": false, "LastUpdatedBy": null, "LastUpdatedTime": "1970-01-31 00:00:56.372144", "Name": "iDRAC Enable Performance Profile for Virtualization", "SourceDeviceId": 0, "Status": 0, "TaskId": 0, "TypeId": 2, "ViewTypeId": 4}}

Authors

  • Sajna Shetty(@Sajna-Shetty)