dellemc.openmanage.ome_session 模块 – 管理 OpenManage Enterprise 和 OpenManage Enterprise 模块化会话

注意

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

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

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

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

dellemc.openmanage 9.3.0 中的新增功能

概要 

此模块允许您在 OpenManage Enterprise 和 OpenManage Enterprise Modular 上创建和删除会话。

要求 

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

python >= 3.9.6

参数 

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

注释 

注意

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

示例 

---
- name: Create a session
  dellemc.openmanage.ome_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.ome_session:
    hostname: 198.162.0.1
    ca_path: "/path/to/ca_cert.pem"
    state: absent
    x_auth_token: aed4aa802b748d2f3b31deec00a6b28a
    session_id: 4b48e9ab-809e-4087-b7c4-201a16e0143d

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

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

    - name: Call ome_network_vlan_info module
      dellemc.openmanage.ome_network_vlan_info:
        hostname: 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.ome_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": [], "[email protected]": 0, "MessageId": "IDRAC.2.7.SYS415", "RelatedProperties": [], "[email protected]": 0, "Resolution": "输入有效的用户名和密码，然后重试操作。", "Severity": "Warning"}], "code": "Base.1.12.GeneralError", "message": "发生了一般错误。有关详细信息，请参阅ExtendedInfo。"}}`
msg 字符串	会话操作的状态。返回: 总是示例: `"会话已成功创建。"`
session_data 字典	会话的详细信息。返回: 对于会话创建操作示例: `{"Description": "admin", "DirectoryGroup": [], "Id": "d5c28d8e-1084-4055-9c01-e1051cfee2dd", "IpAddress": "100.198.162.0", "LastAccessedTimeStamp": "2023-07-03 07:22:43.683", "Name": "API", "Password": null, "Roles": ["BACKUP_ADMINISTRATOR"], "StartTimeStamp": "2023-07-03 07:22:43.683", "UserId": 10078, "UserName": "admin"}`
x_auth_token 字符串	身份验证令牌。返回: 对于会话创建操作示例: `"d15f17f01cd627c30173b1582642497d"`

作者

Kritika Bhateja (@Kritika-Bhateja-03)