ieisystem.inmanage.del_session модуль — Удаление сессии

Примечание

Этот модуль входит в коллекцию ieisystem.inmanage (версия 2.0.0).

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

Для установки используйте: ansible-galaxy collection install ieisystem.inmanage. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: ieisystem.inmanage.del_session.

Новинка в ieisystem.inmanage 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Удаление сессии на сервере ieisystem.

Требования

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

Python 3.7+
inManage

Параметры

Параметр	Комментарии
host строка	Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
password строка	Указывает пароль для аутентификации подключения к удаленному устройству. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
provider словарь	Объект типа dict, содержащий данные подключения.
host строка	Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
password строка	Указывает пароль для аутентификации подключения к удаленному устройству. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
username строка	Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
sid строка / обязательно	Идентификатор сессии, введите «all», чтобы удалить все сессии.
username строка	Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.

Примечания

Примечание

Не поддерживает check_mode.

Примеры

- name: Delete session test
  hosts: inmanage
  connection: local
  gather_facts: false
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Delete session"
    ieisystem.inmanage.del_session:
      sid: "223"
      provider: "{{ inmanage }}"

Значения возврата

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

Ключ	Описание
changed булево	Проверка, были ли внесены изменения на устройстве. Возвращается: всегда
message строка	Сообщения, возвращаемые после выполнения модуля. Возвращается: всегда
state строка	Статус после выполнения модуля. Возвращается: всегда

Авторы

WangBaoshan (@ieisystem)

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

© 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/ieisystem/inmanage/del_session_module.html