dellemc.openmanage.idrac_session 模块 – 管理 iDRAC 会话

注意

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

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

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

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

dellemc.openmanage 9.2.0 中的新增功能

概要 

此模块允许在 iDRAC 上创建和删除会话。

要求 

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

python >= 3.9.6

参数 

参数	注释
ca_path 路径	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
hostname 别名：idrac_ip 字符串	iDRAC 的 IP 地址或主机名。
password 别名：idrac_password 字符串	iDRAC 的密码。如果未提供密码，则使用环境变量 `IDRAC_PASSWORD`。当 state 为 `present` 时，需要提供password。
端口整数	iDRAC 的端口。默认： `443`
session_id 整数	iDRAC 的会话 ID。当 state 为 `absent` 时，需要提供session_id。
state 字符串	iDRAC 中会话的状态。 `present` 创建会话。 `absent` 删除会话。当 state 为 `present` 时，模块将始终报告发现要应用的更改。选项 `"present"` ←（默认） `"absent"`
超时整数	https 套接字级别的超时时间（以秒为单位）。默认： `30`
username 别名：idrac_user 字符串	iDRAC 的用户名。如果未提供用户名，则使用环境变量 `IDRAC_USERNAME`。当 state 为 `present` 时，需要提供username。
validate_certs 布尔值	如果为 `false`，则不会验证 SSL 证书。仅在个人控制的使用自签名证书的站点上配置 `false`。选项 `false` `true` ←（默认）
x_auth_token 别名：auth_token 字符串	身份验证令牌。当 state 为 `absent` 时，需要提供x_auth_token。

注释 

注意

从可以直接访问 Dell iDRAC 的系统运行此模块。
此模块支持 IPv4 和 IPv6 地址。
此模块支持 check_mode。
当 state 为 present 时，此模块将始终报告发现要应用的更改。

示例 

---
- name: Create a session
  dellemc.openmanage.idrac_session:
    hostname: 198.162.0.1
    username: username
    password: password
    ca_path: "/path/to/ca_cert.pem"
    state: present

- name: Delete a session
  dellemc.openmanage.idrac_session:
    hostname: 198.162.0.1
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    x_auth_token: aed4aa802b748d2f3b31deec00a6b28a
    session_id: 2

- name: Create a session and execute other modules
  block:
    - name: Create a session
      dellemc.openmanage.idrac_session:
        hostname: 198.162.0.1
        username: username
        password: password
        ca_path: "/path/to/ca_cert.pem"
        state: present
        register: authData

    - name: Call idrac_firmware_info module
      dellemc.openmanage.idrac_firmware_info:
        idrac_ip: 198.162.0.1
        ca_path: "/path/to/ca_cert.pem"
        x_auth_token: "{{ authData.x_auth_token }}"

    - name: Call idrac_user_info module
      dellemc.openmanage.idrac_user_info:
        idrac_ip: 198.162.0.1
        ca_path: "/path/to/ca_cert.pem"
        x_auth_token: "{{ authData.x_auth_token }}"
  always:
    - name: Destroy a session
      dellemc.openmanage.idrac_session:
        hostname: 198.162.0.1
        ca_path: "/path/to/ca_cert.pem"
        state: absent
        x_auth_token: "{{ authData.x_auth_token }}"
        session_id: "{{ authData.session_data.Id }}"

返回值 

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

键	描述
error_info 字典	HTTP 错误的详细信息。返回：发生 HTTP 错误时示例： `{"error": {"@Message.ExtendedInfo": [{"Message": "无法完成操作，因为输入了无效的用户名和/或密码，因此身份验证失败。", "MessageArgs": [], "MessageId": "IDRAC.2.9.SYS415", "RelatedProperties": [], "Resolution": "输入有效的用户名和密码，然后重试操作。", "Severity": "警告"}], "code": "Base.1.12.GeneralError", "message": "发生一般错误。有关详细信息，请参阅 ExtendedInfo"}`
msg 字符串	会话操作的状态。返回：总是示例： `"会话已成功创建。"`
session_data 字典	会话详细信息。返回：对于会话创建操作示例: {"@Message.ExtendedInfo": [{"Message": "资源已成功创建。", "MessageArgs": [], "MessageId": "Base.1.12.Created", "RelatedProperties": [], "Resolution": "无。", "Severity": "OK"}, {"Message": "已成功创建新资源。", "MessageArgs": [], "MessageId": "IDRAC.2.9.SYS414", "RelatedProperties": [], "Resolution": "无需响应操作。", "Severity": "信息性"}], "ClientOriginIPAddress": "100.96.37.58", "CreatedTime": "2024-04-05T01:14:01-05:00", "Description": "用户会话", "Id": "74", "Name": "用户会话", "Password": null, "SessionType": "Redfish", "UserName": "root"}
x_auth_token 字符串	身份验证令牌。返回：对于会话创建操作示例: `"d15f17f01cd627c30173b1582642497d"`

作者

Rajshekar P(@rajshekarp87)
Kritika Bhateja (@Kritika-Bhateja-03)