dellemc.openmanage.ome_device_location 模块 – 在 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_location。

dellemc.openmanage 4.2.0 中的新增功能

概要 

此模块允许配置 OpenManage Enterprise Modular 上机箱的设备位置设置。

需求 

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

python >= 3.9.6

参数 

参数	注释
aisle 字符串	机箱的通道。
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
data_center 字符串	机箱的数据中心名称。
device_id 整数	需要更新其设置的机箱的 ID。如果未指定设备 ID，则此模块会更新主机名的位置设置。 device_id 与 device_service_tag 互斥。
device_service_tag 字符串	需要更新其设置的机箱的服务标签。如果未指定设备服务标签，则此模块会更新主机名的位置设置。 device_service_tag 与 device_id 互斥。
hostname 字符串 / 必填	OpenManage Enterprise Modular IP 地址或主机名。
location 字符串	机箱的物理位置。
password 字符串	OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise Modular HTTPS 端口。默认值： `443`
rack 字符串	机箱的机架名称。
rack_slot 整数	机箱的机架插槽号。
room 字符串	机箱所在的房间。
timeout 整数在 dellemc.openmanage 5.0.0 中添加	以秒为单位的套接字级别超时。默认值： `30`
username 字符串	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 Modular 的系统运行此模块。
此模块支持 check_mode。

示例 

---
- name: Update device location settings of a chassis using the device ID.
  dellemc.openmanage.ome_device_location:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 25011
    data_center: data center 1
    room: room 1
    aisle: aisle 1
    rack: rack 1
    rack_slot: 2
    location: location 1

- name: Update device location settings of a chassis using the device service tag.
  dellemc.openmanage.ome_device_location:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: GHRT2RL
    data_center: data center 2
    room: room 7
    aisle: aisle 4
    rack: rack 6
    rack_slot: 22
    location: location 5

- name: Update device location settings of the host chassis.
  dellemc.openmanage.ome_device_location:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    data_center: data center 3
    room: room 3
    aisle: aisle 1
    rack: rack 7
    rack_slot: 10
    location: location 9

返回值 

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

键	描述
error_info 字典	HTTP 错误的详细信息。返回值：HTTP 错误时示例： `{"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误，无法处理请求。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在，请联系您的系统管理员。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。请参阅 ExtendedInfo 获取更多信息。"} }`
location_details 字典	成功更新位置设置时返回。返回值：成功示例： `{"Aisle": "通道 1", "DataCenter": "数据中心 1", "Location": "位置 1", "RackName": "机架 1", "RackSlot": 2, "Room": "房间 1", "SettingType": "Location"}`
msg 字符串	设备位置设置的总体状态。返回值：始终返回示例： `"已成功更新位置设置。"`

作者

Felix Stephen (@felixs88)