dellemc.openmanage.ome_profile_info 模块 – 检索具有属性详细信息的配置文件

注意

此模块是 dellemc.openmanage 集合(版本 9.9.0)的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install dellemc.openmanage。您需要进一步的要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:dellemc.openmanage.ome_profile_info

dellemc.openmanage 7.2.0 中的新增功能

概要

  • 此模块在 OpenManage Enterprise 或 OpenManage Enterprise Modular 上检索带有属性的配置文件。

要求

执行此模块的主机上需要以下要求。

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。

hostname

字符串 / 必需

OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。

password

字符串

OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。

如果未提供密码,则使用环境变量 OME_PASSWORD

示例:export OME_PASSWORD=password

port

整数

OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。

默认值: 443

profile_id

整数

配置文件的 ID。

这与 *profile_name*、*system_query_options*、*template_id* 和 *template_name* 互斥。

profile_name

字符串

配置文件的名称。

这与 *template_id*、*profile_id*、*system_query_options* 和 *template_name* 互斥。

system_query_options

字典

用于提供支持的 odata 过滤器的选项。

配置文件列表可以根据 ProfileName、TemplateName、TargetTypeId、TargetName、ChassisName、ProfileState、LastRunStatus 或 ProfileModified 进行提取和排序。

这与 *profile_name*、*profile_id*、*template_id* 和 *template_name* 互斥。

注意 如果未提供 *profile_name*、*profile_id*、*template_id* 或 *template_name* 选项,则模块会检索所有配置文件。

template_id

整数

提供模板的 ID 以检索链接到它的配置文件列表。

这与 *profile_name*、*profile_id*、*system_query_options* 和 *template_name* 互斥。

template_name

字符串

提供模板的名称以检索链接到它的配置文件列表。

这与 *profile_name*、*profile_id*、*template_id* 和 *system_query_options* 互斥。

timeout

整数

在 dellemc.openmanage 5.0.0 中添加

套接字级别超时(以秒为单位)。

默认值: 30

username

字符串

OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。

如果未提供用户名,则使用环境变量 OME_USERNAME

示例:export OME_USERNAME=username

validate_certs

布尔值

在 dellemc.openmanage 5.0.0 中添加

如果 false,则不会验证 SSL 证书。

仅在个人控制的站点上使用自签名证书时配置 false

在集合版本 5.0.0 之前,*validate_certs* 默认为 false

选项

  • false

  • true ← (默认)

x_auth_token

字符串

在 dellemc.openmanage 9.3.0 中添加

身份验证令牌。

如果未提供 x_auth_token,则使用环境变量 OME_X_AUTH_TOKEN

示例:export OME_X_AUTH_TOKEN=x_auth_token

注释

注意

  • 在可以直接访问 Dell OpenManage Enterprise 的系统上运行此模块。

  • 此模块支持 check_mode

示例

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

返回值

通用返回值已在此处文档化 此处,以下是此模块特有的字段

描述

error_info

字典

HTTP错误的详细信息。

返回: 当发生HTTP错误时

示例: {"error": {"@Message.ExtendedInfo": [{"Message": "无法处理请求,因为发生错误。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试该操作。如果问题仍然存在,请联系您的系统管理员。", "Severity": "严重"}], "code": "Base.1.0.GeneralError", "message": "发生了一般性错误。有关更多信息,请参见ExtendedInfo。"}}

msg

字符串

配置文件信息检索的状态。

返回: 始终

示例: "成功检索了配置文件信息。"

profile_info

列表 / 元素=字典

有关配置文件的信息。

返回: 成功

示例: [{"AttributeDetails": {"System": {"服务器操作系统": {"ServerOS 1 服务器主机名": 4965}, "服务器拓扑": {"ServerTopology 1 通道名称": 4958, "ServerTopology 1 数据中心名称": 4957, "ServerTopology 1 机架名称": 4959, "ServerTopology 1 机架插槽": 4960, "ServerTopology 1 房间名称": 4963}}, "iDRAC": {"活动目录": {"ActiveDirectory 1 活动目录RAC名称": 4066}, "网卡信息": {"NIC 1 启用VLAN": 4229, "NIC 1 VLAN ID": 4231}}}, "AttributeIdMap": {"4066": {"IsIgnored": true, "IsReadOnly": false, "Value": null}, "4229": {"IsIgnored": false, "IsReadOnly": false, "Value": "已禁用"}, "4231": {"IsIgnored": false, "IsReadOnly": false, "Value": "1"}, "4957": {"IsIgnored": true, "IsReadOnly": false, "Value": "戴尔实验室"}, "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": "二楼"}, "4965": {"IsIgnored": true, "IsReadOnly": false, "Value": "主机名"}}, "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": "来自源模板:(模板)", "ProfileModified": 0, "ProfileName": "配置文件 00001", "ProfileState": 0, "TargetId": 0, "TargetName": null, "TargetTypeId": 0, "TemplateId": 8, "TemplateName": "模板"}]

作者

  • Jagadeesh N V(@jagadeeshnv)