dellemc.openmanage.ome_device_local_access_configuration 模块 – 配置 OpenManage Enterprise Modular 上的本地访问设置。

注意

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

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

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅 需求 以了解详情。

要在 playbook 中使用它，请指定：dellemc.openmanage.ome_device_local_access_configuration。

dellemc.openmanage 4.4.0 中的新增功能

概要

• 此模块允许配置 OpenManage Enterprise Modular 上电源按钮、快速同步、KVM、LCD 和机箱直接访问的本地访问设置。

需求

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

• python >= 3.9.6

参数

参数	注释
ca_path 路径 dellemc.openmanage 5.0.0 中新增	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
chassis_power_button 字典	机箱电源按钮的设置。
disabled_button_lcd_override_pin 字符串	用于更改机箱电源状态的六位数 LCD 覆盖 PIN。 当 enable_lcd_override_pin 为 true 时，这是必需的。 当 disabled_button_lcd_override_pin 为 true 时，模块将始终报告更改。 该值必须用引号括起来。例如：“001100”。
enable_chassis_power_button 布尔值 / 必需	启用或禁用机箱电源按钮。 如果为 false，则无法使用电源按钮打开或关闭机箱。 选项 false true
enable_lcd_override_pin 布尔值	启用或禁用 LCD 覆盖 PIN。 当 enable_chassis_power_button 为 false 时，这是必需的。 选项 false true
device_id 整数	要更新其本地访问配置的机箱的 ID。 如果未指定设备 ID，则此模块将更新 主机名 的本地访问设置。 device_id 与 device_service_tag 互斥。
device_service_tag 字符串	需要更新其本地访问设置的机箱的服务标签。 如果未指定设备服务标签，则此模块将更新 主机名 的本地访问设置。 device_service_tag 与 device_id 互斥。
enable_chassis_direct_access 布尔值	启用或禁用对机箱上 iDRAC 和设备管理模块等管理控制台的访问。 选项 false true
enable_kvm_access 布尔值	启用或禁用键盘、视频和鼠标 (KVM) 接口。 选项 false true
hostname 字符串 / 必需	OpenManage Enterprise Modular 的 IP 地址或主机名。
lcd 字典	LCD 的设置。 如果机箱中不存在 LCD 硬件，则会忽略 lcd 选项。
lcd_access 字符串	使用 LCD 配置快速同步设置的选项。 VIEW_AND_MODIFY 将访问级别设置为查看和修改。 VIEW_ONLY 将访问级别设置为查看。 DISABLED 禁用访问。 选项 "VIEW_AND_MODIFY" "VIEW_ONLY" "DISABLED"
lcd_language 字符串	LCD 上必须显示文本的语言代码。 en 设置英语。 fr 设置法语。 de 设置德语。 es 设置西班牙语。 ja 设置日语。 zh 设置中文。
user_defined 字符串	要在 LCD 主屏幕上显示的文本。系统重置为出厂默认设置时，将显示 LCD 主屏幕。用户定义的文本最多可以包含 62 个字符。
password 字符串	OpenManage Enterprise Modular 密码。 如果未提供密码，则使用环境变量 OME_PASSWORD。 示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise Modular HTTPS 端口。 默认值： 443
quick_sync 字典	快速同步的设置。 如果不存在快速同步硬件，则会忽略 quick_sync 选项。
enable_inactivity_timeout 布尔值	启用或禁用非活动超时。 选项 false true
enable_quick_sync_wifi 布尔值	启用或禁用与机箱的 Wi-Fi 通信路径。 选项 false true
enable_read_authentication 布尔值	启用或禁用使用您的用户凭据登录并在安全数据中心读取库存的选项。 选项 false true
quick_sync_access 字符串	具有管理员权限的用户可以设置以下类型的 quick_sync_access。 READ_WRITE 启用使用快速同步写入配置。 READ_ONLY 启用对 Wi-Fi 和蓝牙低功耗 (BLE) 的只读访问。 DISABLED 禁用通过快速同步读取或写入配置。 选项 "READ_WRITE" "READ_ONLY" "DISABLED"
timeout_limit 整数	以秒或分钟为单位的非活动超时。 范围是 120 到 3600 秒，或 2 到 60 分钟。 当 enable_inactivity_timeout 为 true 时，此选项是必需的。
timeout_limit_unit 字符串	非活动超时限制单位。 SECONDS 将 timeout_limit 设置为秒。 MINUTES 将 timeout_limit 设置为分钟。 当 enable_inactivity_timeout 为 true 时，此选项是必需的。 选项 "SECONDS" 分钟
超时 整数 dellemc.openmanage 5.0.0 中新增	套接字级别的超时时间（秒）。 默认值： 30
用户名 字符串	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

备注

注意

• 从可以直接访问 OpenManage Enterprise Modular 的系统运行此模块。

• 此模块支持 check_mode。

• 当 enable_chassis_power_button 为 true 时，模块将始终报告更改。

示例

---
- name: Configure KVM, direct access and power button settings of the chassis using device ID.
  dellemc.openmanage.ome_device_local_access_configuration:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 25011
    enable_kvm_access: true
    enable_chassis_direct_access: false
    chassis_power_button:
      enable_chassis_power_button: false
      enable_lcd_override_pin: true
      disabled_button_lcd_override_pin: "123456"

- name: Configure Quick sync and LCD settings of the chassis using device service tag.
  dellemc.openmanage.ome_device_local_access_configuration:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: GHRT2RL
    quick_sync:
      quick_sync_access: READ_ONLY
      enable_read_authentication: true
      enable_quick_sync_wifi: true
      enable_inactivity_timeout: true
      timeout_limit: 10
      timeout_limit_unit: MINUTES
    lcd:
      lcd_access: VIEW_ONLY
      lcd_language: en
      user_defined: "LCD Text"

- name: Configure all local access settings of the host chassis.
  dellemc.openmanage.ome_device_local_access_configuration:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_kvm_access: true
    enable_chassis_direct_access: false
    chassis_power_button:
      enable_chassis_power_button: false
      enable_lcd_override_pin: true
      disabled_button_lcd_override_pin: "123456"
    quick_sync:
      quick_sync_access: READ_WRITE
      enable_read_authentication: true
      enable_quick_sync_wifi: true
      enable_inactivity_timeout: true
      timeout_limit: 120
      timeout_limit_unit: SECONDS
    lcd:
      lcd_access: VIEW_MODIFY
      lcd_language: en
      user_defined: "LCD Text"

返回值

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

键	描述
error_info 字典	HTTP 错误的详细信息。 返回：HTTP 错误时 示例： {"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."}}
location_details 字典	成功更新本地访问设置时返回。 返回：成功 示例： {"EnableChassisDirect": false, "EnableChassisPowerButton": false, "EnableKvmAccess": true, "EnableLcdOverridePin": false, "LcdAccess": "VIEW_ONLY", "LcdCustomString": "LCD Text", "LcdLanguage": "en", "LcdOverridePin": "", "LcdPinLength": 6, "LcdPresence": "Present", "LedPresence": "Absent", "QuickSync": {"EnableInactivityTimeout": true, "EnableQuickSyncWifi": false, "EnableReadAuthentication": false, "QuickSyncAccess": "READ_ONLY", "QuickSyncHardware": "Present", "TimeoutLimit": 7, "TimeoutLimitUnit": "MINUTES"}, "SettingType": "LocalAccessConfiguration"}
msg 字符串	设备本地访问设置的整体状态。 返回：始终 示例： "Successfully updated the local access settings."

作者

• Felix Stephen (@felixs88)

• Shivam Sharma (@ShivamSh3)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)