dellemc.openmanage.ome_profile_info module – Retrieve profiles with attribute details
Note
This module is part of the dellemc.openmanage collection (version 9.9.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_profile_info.
New in dellemc.openmanage 7.2.0
Synopsis
This module retrieve profiles with attributes on OpenManage Enterprise or OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Id of the profile. This is mutually exclusive with profile_name, system_query_options, template_id, and template_name. |
|
Name of the profile. This is mutually exclusive with template_id, profile_id, system_query_options, and template_name. |
|
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 profile_name, profile_id, template_id, and template_name.
|
|
Provide the ID of the template to retrieve the list of profile(s) linked to it. This is mutually exclusive with profile_name, profile_id, system_query_options, and template_name. |
|
Provide the name of the template to retrieve the list of profile(s) linked to it. This is mutually exclusive with profile_name, profile_id, template_id, and system_query_options. |
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
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 on a system that has direct access to Dell OpenManage Enterprise.
This module supports
check_mode.
Examples
---
- 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"
- 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
- 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
- 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
- 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
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Status of profile information retrieval. Returned: always Sample: |
|
Information about the profile. Returned: success Sample: |