fortinet.fortimanager.fmgr_firewall_vip46_realservers модуль – Реальные серверы.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_vip46_realservers.
Новое в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать под данные источники перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/отключить ведение журнала для задачи. Варианты:
|
firewall_vip46_realservers словарь | Установленные параметры верхнего уровня. |
|
client_ip строка |
Устарело, пожалуйста, переименуйте в client_ip. Ограничить сервер IP-адресом клиента в этом диапазоне. |
|
healthcheck строка |
Проверка работоспособности сервера. Варианты:
|
|
holddown_interval целое число |
Устарело, пожалуйста, переименуйте в holddown_interval. Интервал удержания. |
|
id целое число / обязательно |
Идентификатор реального сервера. |
|
ip строка |
Отображенный IPv6 сервера. |
|
max_connections целое число |
Устарело, пожалуйста, переименуйте в max_connections. Максимальное количество подключений, разрешённых для сервера. |
|
monitor любой |
(список или строка) Мониторы работоспособности. |
|
port целое число |
Порт отображённого сервера. |
|
status строка |
Административный статус сервера. Варианты:
|
|
weight целое число |
Вес. |
forticloud_access_token строка | Авторизуйте Ansible-клиент с токеном доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, с которыми будут переопределены условия для неудачи. |
rc_succeeded список / элементы=целое число | Список rc-кодов, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
vip46 строка / обязательно | Параметр (vip46) в запрошенном URL. |
workspace_locking_adom строка | Область (adom), которая должна быть заблокирована для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корень. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь освободит блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют имя с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- Режим блокировки рабочей области поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться неудачей при возвращении ненулевого rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Real servers.
fortinet.fortimanager.fmgr_firewall_vip46_realservers:
bypass_validation: false
adom: ansible
vip46: "ansible-test-vip46" # name
state: present
firewall_vip46_realservers:
healthcheck: disable
id: 1
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the real servers of IPv4 to IPv6 virtual IP
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_vip46_realservers"
params:
adom: "ansible"
vip46: "ansible-test-vip46" # name
realservers: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на сборку
© 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_firewall_vip46_realservers_module.html
