dellemc.openmanage.ome_firmware_baseline 模块 – 在 OpenManage Enterprise 或 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_firmware_baseline。

dellemc.openmanage 2.0.0 中的新增功能

概要 

此模块允许在 OpenManage Enterprise 或 OpenManage Enterprise Modular 上创建、修改或删除固件基线。

要求 

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

python >= 3.9.6

参数 

参数	注释
baseline_description 字符串	正在创建的基线的描述。
baseline_id 整数在 dellemc.openmanage 3.4.0 中添加	现有基线的 ID。此选项与 baseline_name 互斥。
baseline_name 字符串	基线的名称。此选项与 baseline_id 互斥。
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
catalog_name 字符串	要与基线关联的目录的名称。
device_group_names 列表 / 元素=字符串	组名称列表。此选项与 device_ids 和 device_service_tags 互斥。
device_ids 列表 / 元素=整数	设备 ID 列表。此选项与 device_service_tags 和 device_group_names 互斥。
device_service_tags 列表 / 元素=字符串	设备服务标签列表。此选项与 device_ids 和 device_group_names 互斥。
downgrade_enabled 布尔值	指示是否允许基线中设备的固件降级。如果未在基线创建期间提供，则此值默认设置为 `true`。选择 `false` `true`
filter_no_reboot_required 布尔值在 dellemc.openmanage 8.1.0 中添加	仅选择不需要重新启动的组件，允许创建仅包含目标设备不需要重新启动的目标设备的组件的固件/驱动程序基线。选择 `false` `true`
hostname 字符串 / 必需	OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。
is_64_bit 布尔值	指示存储库是否包含 64 位 DUP。如果未在基线创建期间提供，则此值默认设置为 `true`。选择 `false` `true`
job_wait 布尔值在 dellemc.openmanage 3.4.0 中添加	提供等待作业完成的选项。当 state 为 `present` 时，此选项适用。选择 `false` `true` ← (默认)
job_wait_timeout 整数在 dellemc.openmanage 3.4.0 中添加	job_wait 的最大等待时间（以秒为单位）。作业仅在此持续时间内被跟踪。当 job_wait 为 `true` 时，此选项适用。默认值: `600`
new_baseline_name 字符串在 dellemc.openmanage 3.4.0 中添加	基线的新名称。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。默认值: `443`
state 字符串在 dellemc.openmanage 3.4.0 中添加	`present` 创建或修改基线。 `absent` 删除现有基线。选择 `"present"` ← (默认) `"absent"`
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 或 OpenManage Enterprise Modular 的系统运行此模块。
device_group_names 选项不适用于 OpenManage Enterprise Modular。
此模块支持 check_mode。

示例 

---
- name: Create baseline for device IDs
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "baseline_name"
    baseline_description: "baseline_description"
    catalog_name: "catalog_name"
    device_ids:
      - 1010
      - 2020

- name: Create baseline for device IDs with no reboot required
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "baseline_name"
    baseline_description: "baseline_description"
    catalog_name: "catalog_name"
    filter_no_reboot_required: true
    device_ids:
      - 1010
      - 2020

- name: Create baseline for servicetags
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "baseline_name"
    baseline_description: "baseline_description"
    catalog_name: "catalog_name"
    device_service_tags:
      - "SVCTAG1"
      - "SVCTAG2"

- name: Create baseline for servicetags with no reboot required
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "baseline_name"
    baseline_description: "baseline_description"
    catalog_name: "catalog_name"
    filter_no_reboot_required: true
    device_service_tags:
      - "SVCTAG1"
      - "SVCTAG2"

- name: Create baseline for device groups without job tracking
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "baseline_name"
    baseline_description: "baseline_description"
    catalog_name: "catalog_name"
    device_group_names:
      - "Group1"
      - "Group2"
    job_wait: false

- name: Modify an existing baseline
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "existing_baseline_name"
    new_baseline_name: "new_baseline_name"
    baseline_description: "new baseline_description"
    catalog_name: "catalog_other"
    device_group_names:
      - "Group3"
      - "Group4"
      - "Group5"
    downgrade_enabled: false
    is_64_bit: true

- name: Modify no reboot filter in existing baseline
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline_name: "existing_baseline_name"
    new_baseline_name: "new_baseline_name"
    filter_no_reboot_required: true

- name: Delete a baseline
  dellemc.openmanage.ome_firmware_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    baseline_name: "baseline_name"

返回值 

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

键	描述
baseline_id 整数	已删除基线的 ID。返回：当state为`absent`时示例：`10123`
baseline_status 字典	基线状态的详细信息。返回：成功示例：`{"CatalogId": 123, "Description": "BASELINE DESCRIPTION", "DeviceComplianceReports": [], "DowngradeEnabled": true, "FilterNoRebootRequired": true, "Id": 23, "Is64Bit": true, "Name": "my_baseline", "RepositoryId": 123, "RepositoryName": "catalog123", "RepositoryType": "HTTP", "Targets": [{"Id": 10083, "Type": {"Id": 1000, "Name": "DEVICE"}}, {"Id": 10076, "Type": {"Id": 1000, "Name": "DEVICE"}}], "TaskId": 11235, "TaskStatusId": 2060}`
error_info 字典	http 错误的详细信息。返回：当出现 http 错误时示例：`{"error": {"@Message.ExtendedInfo": [{"Message": "无法检索基线列表，因为输入的设备 ID 无效", "Resolution": "请确保输入的设备 ID 有效，然后重试操作。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。有关更多信息，请参见 ExtendedInfo。"}}`
job_id 整数	基线任务的作业 ID。返回：当基线作业处于运行状态时示例：`10123`
msg 字符串	固件基线操作的总体状态。返回：总是示例：`"已成功创建固件基线。"`

作者

Jagadeesh N V(@jagadeeshnv)
Kritika Bhateja (@Kritika-Bhateja-03)