Модуль kaytus.ksmanage.session_info – Получение информации о сеансе онлайн

Примечание

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

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

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

Для использования в книге задач укажите: kaytus.ksmanage.session_info.

Новый в kaytus.ksmanage 1.0.0

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

Обзор

Получение информации о сеансе онлайн на сервере kaytus.

Требования

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

Python 3.7+
inManage

Параметры

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

Примечания

Примечание

Поддерживает check_mode.

Примеры

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

  tasks:

  - name: "Get session information"
    kaytus.ksmanage.session_info:
      provider: "{{ ksmanage }}"

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

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

Ключ	Описание
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/kaytus/ksmanage/session_info_module.html