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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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 путь	Файл PEM (Privacy Enhanced Mail), содержащий сертификат CA, который будет использоваться для валидации.
hostname псевдонимы: idrac_ip строка	IP-адрес или имя хоста iDRAC.
password псевдонимы: idrac_password строка	Пароль iDRAC. Если пароль не указан, используется переменная среды `IDRAC_PASSWORD`. password требуется, когда state равен `present`.
port целое число	Порт iDRAC. По умолчанию: `443`
session_id целое число	Идентификатор сессии iDRAC. session_id требуется, когда state равен `absent`.
state строка	Состояние сессии iDRAC. `present` создает сессию. `absent` удаляет сессию. Модуль всегда отражает внесенные изменения при state равном `present`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Таймаут уровня сокета https в секундах. По умолчанию: `30`
username псевдонимы: idrac_user строка	Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. username требуется, когда state равен `present`.
validate_certs булево	Если `false`, сертификаты SSL не будут проверены. Настраивайте `false` только на контролируемых вами сайтах, где используются самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)
x_auth_token псевдонимы: auth_token строка	Токен аутентификации. 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 словарь	Подробности 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 строка	Статус операции с сеансом. Возвращается: всегда Пример: `"The session has been created successfully."`
session_data словарь	Подробности сеанса. Возвращается: Для операции создания сеанса Пример: {"@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 строка	Токен аутентификации. Возвращается: Для операции создания сеанса Пример: `"d15f17f01cd627c30173b1582642497d"`

Авторы

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

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

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