Модуль hitachivantara.vspone_block.vsp.hv_session — управление сеансами в блочных системах хранения VSP.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.vsp.hv_session.

Добавлено в hitachivantara.vspone_block 4.6.0

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

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

Этот модуль позволяет создавать и удалять сеансы.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/session.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Информация, необходимая для установления соединения с системой хранения данных.
address строка / обязательный	IP-адрес или имя хоста системы хранения данных.
api_token строка	Токен для работы с заблокированными ресурсами.
connection_type строка	Тип соединения с системой хранения данных. Варианты: `"direct"` ← (по умолчанию)
password строка	Пароль для аутентификации. Это обязательное поле.
username строка	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь	Параметры сеанса.
alive_time_in_seconds целое число	Время простоя в секундах, по истечении которого срок действия сеанса истекает. Применяется при создании сеанса. Если параметр не указан, используется значение 300. Если значение указано, оно должно находиться в диапазоне от 1 до 300.
authentication_timeout целое число	Тайм-аут обработки аутентификации (в секундах). Применяется при создании сеанса. Укажите это значение, если для аутентификации пользователей используется внешний сервер аутентификации. Измените значение в соответствии с настройками внешней аутентификации системы хранения данных. Если параметр не указан, используется значение 120. Если значение указано, оно должно находиться в диапазоне от 1 до 900.
force логическое значение	Указывает, следует ли принудительно удалять сеансы, созданные другими пользователями, помимо созданного вами сеанса. Этот атрибут может указывать только пользователь, входящий в группу пользователей Administrator (встроенная группа пользователей). При значении true принудительно удаляются сеансы, созданные другими пользователями, помимо созданного вами сеанса. При значении false принудительно удаляется только созданный вами сеанс. Если значение не указано, используется false. Варианты: `false` ← (по умолчанию) `true`
id целое число	Идентификатор сеанса. Обязателен для операции удаления.
token строка	Токен аутентификации сеанса. Обязателен для операции удаления.
state строка	Состояние сеанса. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Определяет, должен ли модуль выполняться в режиме проверки.

Примеры

- name: Create a session
  hitachivantara.vspone_block.sds_block.hv_sds_block_session:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      alive_time_in_seconds: 100

- name: Delete a session
  hitachivantara.vspone_block.sds_block.hv_sds_block_session:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
      state: "absent"
      spec:
        id: "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
session словарь	Информация о сеансе, возвращаемая модулем. Возвращается: всегда
session_id целое число	Уникальный идентификатор сеанса. Возвращается: при успешном выполнении Пример: `15561`
token строка	Токен аутентификации, связанный с сеансом. Возвращается: при успешном выполнении Пример: `"d7c7bd35d3854a9f973d934800fb70ab"`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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/hitachivantara/vspone_block/vsp.hv_session_module.html