Модуль dellemc.openmanage.idrac_session — управление сеансами iDRAC

Примечание

Этот модуль входит в коллекцию dellemc.openmanage (версия 10.0.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.idrac_session.

Новое в dellemc.openmanage 9.2.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет создавать и удалять сеансы на iDRAC.

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path path	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.
hostname псевдонимы: idrac_ip string	IP-адрес или имя узла iDRAC.
password псевдонимы: idrac_password string	Пароль iDRAC. Если пароль не указан, используется переменная среды `IDRAC_PASSWORD`. password является обязательным, если state имеет значение `present`.
port integer	Порт iDRAC. По умолчанию: `443`
session_id string	Идентификатор сеанса iDRAC. session_id является обязательным, если state имеет значение `absent`.
state string	Состояние сеанса в iDRAC. `present` создаёт сеанс. `absent` удаляет сеанс. Модуль всегда сообщает об обнаруженных изменениях, которые необходимо применить, если state имеет значение `present`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Тайм-аут уровня HTTPS-сокета в секундах. По умолчанию: `30`
username псевдонимы: idrac_user string	Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. username является обязательным, если state имеет значение `present`.
validate_certs boolean	Если установлено значение `false`, SSL-сертификаты не проверяются. Настраивайте `false` только на сайтах под личным контролем, где используются самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
x_auth_token псевдонимы: auth_token string	x_auth_token является обязательным, если state имеет значение `absent`.

Примечания

Примечание

Запускайте этот модуль в системе, имеющей прямой доступ к 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 dictionary	Сведения об ошибке HTTP. Возвращается: при ошибке HTTP Пример: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the operation because an invalid username and/or password is entered, and therefore authentication failed.", "MessageArgs": [], "MessageId": "IDRAC.2.9.SYS415", "RelatedProperties": [], "Resolution": "Enter valid user name and password and retry the operation.", "Severity": "Warning"}], "code": "Base.1.12.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information"}}`
msg string	Состояние операции с сеансом. Возвращается: всегда Пример: `"The session has been created successfully."`
session_data dictionary	Сведения о сеансе. Возвращается: при создании сеанса Пример: {"@Message.ExtendedInfo": [{"Message": "The resource has been created successfully.", "MessageArgs": [], "MessageId": "Base.1.12.Created", "RelatedProperties": [], "Resolution": "None.", "Severity": "OK"}, {"Message": "A new resource is successfully created.", "MessageArgs": [], "MessageId": "IDRAC.2.9.SYS414", "RelatedProperties": [], "Resolution": "No response action is required.", "Severity": "Informational"}], "ClientOriginIPAddress": "100.96.37.58", "CreatedTime": "2024-04-05T01:14:01-05:00", "Description": "User Session", "Id": "74", "Name": "User Session", "Password": null, "SessionType": "Redfish", "UserName": "root"}
x_auth_token string	Токен аутентификации. Возвращается: при создании сеанса Пример: `"d15f17f01cd627c30173b1582642497d"`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/openmanage/idrac_session_module.html