dellemc.openmanage.ome_template_info (9.1.0) — module

Retrieves template details from OpenManage Enterprise

| "added in version" 2.0.0 of dellemc.openmanage"

Authors: Sajna Shetty(@Sajna-Shetty)

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0


Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- 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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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'"

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
    type: int

ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

hostname:
    description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
      hostname.
    required: true
    type: str

password:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular password.
    - If the password is not provided, then the environment variable C(OME_PASSWORD) is
      used.
    - 'Example: export OME_PASSWORD=password'
    required: true
    type: str

username:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular username.
    - If the username is not provided, then the environment variable C(OME_USERNAME) is
      used.
    - 'Example: export OME_USERNAME=username'
    required: true
    type: str

template_id:
    description: Unique Id of the template.
    type: int

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

system_query_options:
    description: Options for pagination of the output.
    suboptions:
      filter:
        description: Filter records by the supported values.
        type: str
    type: dict

Outputs

msg:
  description: Overall template facts status.
  returned: on error
  sample: Failed to fetch the template facts
  type: str
template_info:
  description: 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
  type: dict