Модуль fortinet.fortimanager.fmgr_dvm_cmd_changehaseq — Модификация последовательности HA для повышения статуса подчиненного узла до главного в кластере.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в playbook, укажите: fortinet.fortimanager.fmgr_dvm_cmd_changehaseq.

Новое в fortinet.fortimanager 2.0.0

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

Обзор

Этот модуль может настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить для использования.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в True только при несоответствии схемы модуля структуре API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dvm_cmd_changehaseq словарь	Настройка параметров верхнего уровня.
adom строка	Имя или ID ADOM, на котором необходимо выполнить команду.
device строка	Имя или ID целевого кластера HA.
flags список / элементы=строка	create_task - Создать новую задачу в базе данных диспетчера задач. nonblocking - API вернет результат немедленно для неблокирующего вызова. Варианты: `"none"` `"create_task"` `"nonblocking"` `"log_dev"`
new_master строка	Имя или ID нового главного узла HA.
enable_log логическое	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация Ansible-клиента с помощью токена доступа к API forticloud.
rc_failed список / элементы=целое	Список кодов rc, при которых выполнение будет остановлено.
rc_succeeded список / элементы=целое	Список кодов rc, при которых выполнение будет завершено успешно.
workspace_locking_adom строка	ADOM для блокировки при работе в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое	Максимальное время ожидания (в секундах), пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочего пространства реализована в данном модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Обычно, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого кода rc. Вы также можете переопределить условия для завершения ошибкой или успешно с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Modify HA sequence to promote a slave to become the master of the cluster.
      fortinet.fortimanager.fmgr_dvm_cmd_changehaseq:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        dvm_cmd_changehaseq:
          adom: <string>
          device: <string>
          flags:
            - none
            - create_task
            - nonblocking
            - log_dev
          new_master: <string>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_dvm_cmd_changehaseq_module.html