dellemc.openmanage.idrac_attributes 模块 – 配置 iDRAC 属性。

注意

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

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

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

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

dellemc.openmanage 6.0.0 中的新增功能

概要

  • 此模块允许配置 iDRAC 属性。

要求

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

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

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

idrac_attributes

字典

iDRAC 属性和值的字典。 这些属性应为集成戴尔远程访问控制器属性注册表的一部分。 要查看 iDRAC9 及更高版本中属性注册表中的属性列表,请参阅 https://I(idrac_ip/redfish/v1/Managers/iDRAC.Embedded.1/Oem/Dell/DellAttributes/iDRAC.Embedded.1) 和 https://I(idrac_ip/redfish/v1/Registries/ManagerAttributeRegistry)。

对于基于 iDRAC8 的服务器,从服务器配置配置文件派生管理器属性名称。 如果服务器配置配置文件中的管理器属性名称为 .#(例如,“SNMP.1#AgentCommunity”),则 Redfish 的等效属性名称为 ..(例如,“SNMP.1.AgentCommunity”)。

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

lifecycle_controller_attributes

字典

生命周期控制器属性和值的字典。 这些属性应为集成戴尔远程访问控制器属性注册表的一部分。要查看 iDRAC9 及更高版本中属性注册表中的属性列表,请参阅 https://I(idrac_ip/redfish/v1/Managers/iDRAC.Embedded.1/Oem/Dell/DellAttributes/LifecycleController.Embedded.1) 和 https://I(idrac_ip/redfish/v1/Registries/ManagerAttributeRegistry)。

对于基于 iDRAC8 的服务器,从服务器配置配置文件派生管理器属性名称。 如果服务器配置配置文件中的管理器属性名称为 .#(例如,“LCAttributes.1#AutoUpdate”),则 Redfish 的等效属性名称为 ..(例如,“LCAttributes.1.AutoUpdate”)。

resource_id

字符串

资源的 Redfish ID。

system_attributes

字典

系统属性和值的字典。 这些属性应为集成戴尔远程访问控制器属性注册表的一部分。 要查看 iDRAC9 及更高版本中属性注册表中的属性列表,请参阅 https://I(idrac_ip/redfish/v1/Managers/iDRAC.Embedded.1/Oem/Dell/DellAttributes/System.Embedded.1) 和 https://I(idrac_ip/redfish/v1/Registries/ManagerAttributeRegistry)。

对于基于 iDRAC8 的服务器,从服务器配置配置文件派生管理器属性名称。 如果服务器配置配置文件中的管理器属性名称为 .#(例如,“ThermalSettings.1#ThermalProfile”),则 Redfish 的等效属性名称为 ..(例如,“ThermalSettings.1.ThermalProfile”)。

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 ←(默认)

x_auth_token

字符串

在 dellemc.openmanage 9.3.0 中添加

身份验证令牌。

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

示例:export IDRAC_X_AUTH_TOKEN=x_auth_token

说明

注意

  • 请在可以直接访问戴尔 iDRAC 的系统上运行此模块。

  • 此模块支持 check_mode

  • 对于基于 iDRAC8 的服务器,不会验证为属性提供的值。请确保传递适当的值。

示例

---
- name: Configure iDRAC attributes
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      SNMP.1.AgentCommunity: public

- name: Configure System attributes
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    system_attributes:
      ThermalSettings.1.ThermalProfile: Sound Cap

- name: Configure Lifecycle Controller attributes
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    lifecycle_controller_attributes:
      LCAttributes.1.AutoUpdate: Enabled

- name: Configure the iDRAC attributes for email alert settings.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      EmailAlert.1.CustomMsg: Display Message
      EmailAlert.1.Enable: Enabled
      EmailAlert.1.Address: [email protected]

- name: Configure the iDRAC attributes for SNMP alert settings.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      SNMPAlert.1.Destination: 192.168.0.2
      SNMPAlert.1.State: Enabled
      SNMPAlert.1.SNMPv3Username: username

- name: Configure the iDRAC attributes for SMTP alert settings.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      RemoteHosts.1.SMTPServerIPAddress: 192.168.0.3
      RemoteHosts.1.SMTPAuthentication: Enabled
      RemoteHosts.1.SMTPPort: 25
      RemoteHosts.1.SMTPUserName: username
      RemoteHosts.1.SMTPPassword: password

- name: Configure the iDRAC attributes for webserver settings.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      WebServer.1.SSLEncryptionBitLength: 128-Bit or higher
      WebServer.1.TLSProtocol: TLS 1.1 and Higher

- name: Configure the iDRAC attributes for SNMP settings.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      SNMP.1.SNMPProtocol: All
      SNMP.1.AgentEnable: Enabled
      SNMP.1.TrapFormat: SNMPv1
      SNMP.1.AlertPort: 162
      SNMP.1.AgentCommunity: public

- name: Configure the iDRAC LC attributes for collecting system inventory.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    lifecycle_controller_attributes:
      LCAttributes.1.CollectSystemInventoryOnRestart: Enabled

- name: Configure the iDRAC system attributes for LCD configuration.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    system_attributes:
      LCD.1.Configuration: Service Tag
      LCD.1.vConsoleIndication: Enabled
      LCD.1.FrontPanelLocking: Full-Access
      LCD.1.UserDefinedString: custom string

- name: Configure the iDRAC attributes for Timezone settings.
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      Time.1.Timezone: CST6CDT
      NTPConfigGroup.1.NTPEnable: Enabled
      NTPConfigGroup.1.NTP1: 192.168.0.5
      NTPConfigGroup.1.NTP2: 192.168.0.6
      NTPConfigGroup.1.NTP3: 192.168.0.7

- name: Configure all attributes
  dellemc.openmanage.idrac_attributes:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    idrac_attributes:
      SNMP.1.AgentCommunity: test
      SNMP.1.AgentEnable: Enabled
      SNMP.1.DiscoveryPort: 161
    system_attributes:
      ServerOS.1.HostName: demohostname
    lifecycle_controller_attributes:
      LCAttributes.1.AutoUpdate: Disabled

返回值

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

描述

error_info

字典

操作的错误信息。

返回:当属性值无效时。

示例: {"error": {"@Message.ExtendedInfo": [{"Message": "属性 LCAttributes.1.BIOSRTDRequested 的值 'false' 的类型与属性可以接受的类型不同。", "MessageArgs": ["false", "LCAttributes.1.BIOSRTDRequested"], "[email protected]": 2, "MessageId": "Base.1.12.PropertyValueTypeError", "RelatedProperties": ["#/Attributes/LCAttributes.1.BIOSRTDRequested"], "[email protected]": 1, "Resolution": "如果操作失败,请更正请求正文中属性的值并重新提交请求。", "Severity": "Warning"}], "code": "Base.1.12.GeneralError", "message": "发生了一般错误。请参阅 ExtendedInfo 以获取更多信息"}}

invalid_attributes

字典

提供的无效属性的字典。

返回:当属性或值无效时。

示例: {"LCAttributes.1.AutoUpdate": "枚举的无效值。", "LCAttributes.1.StorageHealthRollupStatus": "只读属性,不能修改。", "SNMP.1.AlertPort": "不是有效的整数。", "SNMP.1.AlertPorty": "属性不存在。", "SysLog.1.PowerLogInterval": "整数超出有效范围。", "ThermalSettings.1.AirExhaustTemp": "枚举的无效值。"}

msg

字符串

属性更新操作的状态。

返回:始终

示例: "成功更新了属性。"

作者

  • Husniya Abdul Hameed (@husniya-hameed)

  • Felix Stephen (@felixs88)