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

From Get docs
Ansible/docs/2.11/collections/dellemc/openmanage/ome template info module


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

Note

This plugin is part of the dellemc.openmanage collection (version 3.0.0).

To install it use: ansible-galaxy collection install dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.ome_template_info.


New in version 2.0.0: of dellemc.openmanage


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 >= 2.7.5

Parameters

Parameter Choices/Defaults Comments

hostname

string / required

Target IP address or hostname.

password

string / required

Target user password.

port

integer

Default:

443

Target HTTPS port.

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.

username

string / required

Target username.



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"

- 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"
    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"
    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 Returned Description

msg

string

on error

Overall template facts status.


Sample:

Failed to fetch the template facts

template_info

dictionary

success

Details of the templates.


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': None, '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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/ome_template_info_module.html