Модуль dellemc.openmanage.ome_session – Управление сессиями OpenManage Enterprise и OpenManage Enterprise Modular

Примечание

Этот модуль является частью коллекции dellemc.openmanage (версия 9.7.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 path	Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации (CA), который будет использоваться для проверки.
hostname string	IP-адрес или имя хоста OpenManage Enterprise.
password string	Пароль OpenManage Enterprise. Если пароль не указан, используется переменная среды `OME_PASSWORD`. password обязателен, когда state равен `present`.
port integer	Порт OpenManage Enterprise. По умолчанию: `443`
session_id string	Идентификатор сессии OpenManage Enterprise. session_id обязателен, когда state равен `absent`.
state string	Состояние сессии в OpenManage Enterprise. `present` создает сессию. `absent` удаляет сессию. Модуль всегда будет сообщать об изменениях, которые должны быть применены, когда state равен `present`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Тайм-аут на уровне сокета HTTPS в секундах. По умолчанию: `30`
username string	Имя пользователя OpenManage Enterprise. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. username обязателен, когда state равен `present`.
validate_certs boolean	Если `false`, SSL-сертификаты не будут проверяться. Настраивайте `false` только на лично контролируемых сайтах, где используются самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)
x_auth_token алиасы: auth_token string	Токен аутентификации. x_auth_token обязателен, когда state равен `absent`.

Примечания

Примечание

Запускайте этот модуль с системы, имеющей прямой доступ к 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": "Unable to complete the operation because an invalid username and/or password is entered, and therefore authentication failed.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.7.SYS415", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "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 словарь	Детали сессии. Возвращается: Для операции создания сессии Пример: `{"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)

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

© 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/ome_session_module.html