dellemc.openmanage.idrac_syslog 模块 – 在 iDRAC 上启用或禁用 syslog

注意

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

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

要安装它,请使用: ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

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

dellemc.openmanage 2.1.0 中的新增功能

概要

  • 此模块允许启用或禁用 iDRAC syslog。

要求

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

  • omsdk >= 1.2.488

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

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

idrac_ip

字符串 / 必填

iDRAC IP 地址。

idrac_password

别名:idrac_pwd

字符串 / 必填

iDRAC 用户密码。

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

示例:export IDRAC_PASSWORD=password

idrac_port

整数

iDRAC 端口。

默认值: 443

idrac_user

字符串 / 必填

iDRAC 用户名。

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

示例:export IDRAC_USERNAME=username

share_mnt

字符串

具有 Ansible 用户读写权限的网络共享的本地挂载路径。此选项对于网络共享是必需的。

share_name

字符串 / 必填

网络共享或本地路径。

share_password

别名:share_pwd

字符串

网络共享用户密码。此选项对于 CIFS 共享是必需的。

share_user

字符串

网络共享用户名。如果用户是域的一部分,请使用格式 ‘user@domain’ 或 ‘domain\\user’。此选项对于 CIFS 共享是必需的。

syslog

字符串

启用或禁用 iDRAC syslog。

选项

  • "Enabled" ← (默认)

  • "Disabled"

timeout

整数

在 dellemc.openmanage 5.0.0 中添加

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

默认值: 30

validate_certs

布尔值

在 dellemc.openmanage 5.0.0 中添加

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

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

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

选项

  • false

  • true ← (默认)

备注

注意

  • 此模块需要 idrac_user 具有“管理员”权限。

  • 从此模块可以直接访问 Dell iDRAC 的系统运行此模块。

  • 此模块支持 idrac_ip 的 IPv4 和 IPv6 地址。

  • 此模块支持 check_mode

示例

---
- name: Enable iDRAC syslog
  dellemc.openmanage.idrac_syslog:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"
       share_name: "192.168.0.2:/share"
       share_password: "share_user_pwd"
       share_user: "share_user_name"
       share_mnt: "/mnt/share"
       syslog: "Enabled"

- name: Disable iDRAC syslog
  dellemc.openmanage.idrac_syslog:
       idrac_ip: "192.168.0.1"
       idrac_user: "user_name"
       idrac_password: "user_password"
       ca_path: "/path/to/ca_cert.pem"
       share_name: "192.168.0.2:/share"
       share_password: "share_user_pwd"
       share_user: "share_user_name"
       share_mnt: "/mnt/share"
       syslog: "Disabled"

返回值

常用返回值已记录在 此处,以下是此模块特有的字段

描述

error_info

字典

HTTP 错误的详细信息。

返回:HTTP 错误时

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

msg

字符串

syslog导出操作的总体状态。

返回值: 始终返回

示例: "已成功获取syslog。"

syslog_status

字典

syslog操作的作业详情。

返回值: 成功

示例: {"@odata.context": "/redfish/v1/$metadata#DellJob.DellJob", "@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_852940632485", "@odata.type": "#DellJob.v1_0_2.DellJob", "CompletionTime": "2020-03-27T02:27:45", "Description": "作业实例", "EndTime": null, "Id": "JID_852940632485", "JobState": "已完成", "JobType": "ImportConfiguration", "Message": "已成功导入并应用服务器配置配置文件。", "MessageArgs": [], "[email protected]": 0, "MessageId": "SYS053", "Name": "导入配置", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "成功", "TargetSettingsURI": null, "retval": true}

作者

  • Felix Stephen (@felixs88)

  • Anooja Vardhineni (@anooja-vardhineni)