dellemc.openmanage.ome_profile_info (9.1.0) — module

Retrieve profiles with attribute details

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

Authors: Jagadeesh N V(@jagadeeshnv)

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 retrieve profiles with attributes on OpenManage Enterprise or OpenManage Enterprise Modular.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Retrieve all profiles
  dellemc.openmanage.ome_profile_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 profile using the name
  dellemc.openmanage.ome_profile_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    profile_name: eprof 00001
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Retrieve profile using the id
  dellemc.openmanage.ome_profile_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    profile_id: 10129
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Retrieve the profiles using the template name
  dellemc.openmanage.ome_profile_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_name: t2
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Retrieve the profiles using the template id
  dellemc.openmanage.ome_profile_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_id: 11
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Retrieve the profiles based on the odata filters
  dellemc.openmanage.ome_profile_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    system_query_options:
      filter: TemplateName eq 'mytemplate'
      orderby: ProfileState

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

profile_id:
    description:
    - Id of the profile.
    - This is mutually exclusive with I(profile_name), I(system_query_options), I(template_id),
      and I(template_name).
    type: int

template_id:
    description:
    - Provide the ID of the template to retrieve the list of profile(s) linked to it.
    - This is mutually exclusive with I(profile_name), I(profile_id), I(system_query_options),
      and I(template_name).
    type: int

profile_name:
    description:
    - Name of the profile.
    - This is mutually exclusive with I(template_id), I(profile_id), I(system_query_options),
      and I(template_name).
    type: str

template_name:
    description:
    - Provide the name of the template to retrieve the list of profile(s) linked to it.
    - This is mutually exclusive with I(profile_name), I(profile_id), I(template_id),
      and I(system_query_options).
    type: str

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:
    - Option for providing supported odata filters.
    - The profile list can be fetched and sorted based on ProfileName, TemplateName, TargetTypeId,
      TargetName, ChassisName, ProfileState, LastRunStatus, or ProfileModified.
    - This is mutually exclusive with I(profile_name), I(profile_id), I(template_id),
      and I(template_name).
    - C(Note) If I(profile_name), I(profile_id), I(template_id), or I(template_name) option
      is not provided, the module retrieves all the profiles.
    type: dict

Outputs

error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to process the request because an error occurred.
        MessageArgs: []
        MessageId: GEN1234
        RelatedProperties: []
        Resolution: Retry the operation. If the issue persists, contact your system
          administrator.
        Severity: Critical
      code: Base.1.0.GeneralError
      message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
msg:
  description: Status of profile information retrieval.
  returned: always
  sample: Successfully retrieved the profile information.
  type: str
profile_info:
  description: Information about the profile.
  elements: dict
  returned: success
  sample:
  - AttributeDetails:
      System:
        Server Operating System:
          ServerOS 1 Server Host Name: 4965
        Server Topology:
          ServerTopology 1 Aisle Name: 4958
          ServerTopology 1 Data Center Name: 4957
          ServerTopology 1 Rack Name: 4959
          ServerTopology 1 Rack Slot: 4960
          ServerTopology 1 Room Name: 4963
      iDRAC:
        Active Directory:
          ActiveDirectory 1 Active Directory RAC Name: 4066
        NIC Information:
          NIC 1 Enable VLAN: 4229
          NIC 1 VLAN ID: 4231
    AttributeIdMap:
      '4066':
        IsIgnored: true
        IsReadOnly: false
        Value: null
      '4229':
        IsIgnored: false
        IsReadOnly: false
        Value: Disabled
      '4231':
        IsIgnored: false
        IsReadOnly: false
        Value: '1'
      '4957':
        IsIgnored: true
        IsReadOnly: false
        Value: Dell LAB
      '4958':
        IsIgnored: true
        IsReadOnly: false
        Value: null
      '4959':
        IsIgnored: true
        IsReadOnly: false
        Value: OMAMDEV
      '4960':
        IsIgnored: true
        IsReadOnly: false
        Value: 10A
      '4963':
        IsIgnored: true
        IsReadOnly: false
        Value: second floor
      '4965':
        IsIgnored: true
        IsReadOnly: false
        Value: hostname
    ChassisId: 0
    ChassisName: null
    CreatedBy: admin
    CreatedDate: '2019-09-26 13:56:41.924966'
    DataSchemaId: 8
    DeploymentTaskId: 0
    DeviceIdInSlot: 0
    EditedBy: null
    GroupId: 0
    GroupName: null
    Id: 71460
    LastDeployDate: ''
    LastEditDate: '2020-12-11 08:27:20.500564'
    LastRunStatus: 2200
    NetworkBootToIso: null
    ProfileDescription: 'from source template: (Template)'
    ProfileModified: 0
    ProfileName: Profile 00001
    ProfileState: 0
    TargetId: 0
    TargetName: null
    TargetTypeId: 0
    TemplateId: 8
    TemplateName: Template
  type: list