Модуль kaytus.ksmanage.edit_service – Настройка параметров службы

Примечание

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

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

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

Для использования в плейбуке укажите: kaytus.ksmanage.edit_service.

Добавлена в kaytus.ksmanage 1.0.0

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

Описание

Настройка параметров службы на сервере kaytus.

Требования

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

Python 3.7+
inManage

Параметры

Параметр	Комментарии
host строка	Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
interface строка	Отображает интерфейс, на котором работает служба. Пользователь может выбрать любой из доступных интерфейсов. Этот параметр поддерживается только моделью M5. Варианты: `"eth0"` `"eth1"` `"both"` `"bond0"`
non_secure_port целое число	Используется для настройки номера порта без шифрования для службы. Значение порта находится в диапазоне от 1 до 65535.
password строка	Указывает пароль для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
provider словарь	Объект словаря, содержащий данные подключения.
host строка	Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
password строка	Указывает пароль для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
username строка	Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
secure_port целое число	Используется для настройки номера порта с шифрованием для службы. Значение порта находится в диапазоне от 1 до 65535.
service_name строка / обязательный	Отображает имя службы выбранного слота (только для чтения). Вариант vnc не поддерживается в M5. Вариант fd-media/telnet/snmp не поддерживается в M6. Варианты: `"web"` `"kvm"` `"cd-media"` `"fd-media"` `"hd-media"` `"ssh"` `"telnet"` `"solssh"` `"snmp"` `"vnc"`
state строка	Отображает текущий статус службы: активный или неактивный. Отметьте этот параметр для запуска неактивной службы. Варианты: `"active"` `"inactive"`
timeout целое число	Отображает значение таймаута сессии для службы. Для служб веб, SSH и telnet пользователь может настроить значение таймаута сессии. Значение таймаута для веб-службы находится в диапазоне от 300 до 1800 секунд. Значение таймаута для SSH и Telnet находится в диапазоне от 60 до 1800 секунд. Значение таймаута должно быть кратно 60 секундам.
username строка	Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.

Примечания

Примечание

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

Примеры

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

  tasks:

  - name: "Edit kvm"
    kaytus.ksmanage.edit_service:
      service_name: "kvm"
      state: "active"
      timeout: "1200"
      provider: "{{ ksmanage }}"

END_OF_DOCUMENT_MARKER

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

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

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

Авторы

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/edit_service_module.html