Модуль kaytus.ksmanage.del_session — удаление сеанса

Примечание

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

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

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

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

Новое в kaytus.ksmanage 1.0.0

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

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

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

Требования

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

Python 3.7+
inManage

Параметры

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

Примечания

Примечание

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

Примеры

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

  tasks:

  - name: "Delete session"
    kaytus.ksmanage.del_session:
      sid: "223"
      provider: "{{ ksmanage }}"

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

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

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

Авторы

WangBaoshan (@ieisystem)

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

© 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/kaytus/ksmanage/del_session_module.html