Модуль fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping — настройка виртуального IP-адреса для IPv4.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
firewall_vip_dynamicmapping dictionary | Набор параметров верхнего уровня. |
|
_scope list / elements=dictionary |
Область действия. |
|
name string |
Имя. |
|
vdom string |
VDOM. |
|
add_nat46_route aliases: add-nat46-route string |
Включить или отключить добавление маршрута NAT46. Варианты:
|
|
arp_reply aliases: arp-reply string |
Ответ ARP. Варианты:
|
|
client_cert aliases: client-cert string |
Включить или отключить запрос сертификата клиента. Варианты:
|
|
color integer |
Цвет. |
|
comment string |
Комментарий. |
|
dns_mapping_ttl aliases: dns-mapping-ttl integer |
Время жизни сопоставления DNS. |
|
empty_cert_action aliases: empty-cert-action string |
Действие при отсутствии сертификата клиента. Варианты:
|
|
extaddr any |
(список или строка) Внешний адрес. |
|
extintf string |
Внешний интерфейс. |
|
extip string |
Внешний IP-адрес. |
|
extport string |
Внешний порт. |
|
gratuitous_arp_interval aliases: gratuitous-arp-interval integer |
Интервал отправки gratuitous ARP. |
|
gslb_domain_name aliases: gslb-domain-name string |
Домен, используемый при интеграции с FortiGSLB. |
|
gslb_hostname aliases: gslb-hostname string |
Имя хоста, используемое в настроенном домене FortiGSLB. |
|
h2_support aliases: h2-support string |
Включить или отключить поддержку HTTP/2 Варианты:
|
|
h3_support aliases: h3-support string |
Включить или отключить поддержку HTTP/3/QUIC Варианты:
|
|
http_cookie_age aliases: http-cookie-age integer |
Срок действия cookie HTTP. |
|
http_cookie_domain aliases: http-cookie-domain string |
Домен cookie HTTP. |
|
http_cookie_domain_from_host aliases: http-cookie-domain-from-host string |
Получать домен cookie HTTP из имени хоста. Варианты:
|
|
http_cookie_generation aliases: http-cookie-generation integer |
Генерация файлов cookie HTTP. |
|
http_cookie_path aliases: http-cookie-path string |
Путь файла cookie HTTP. |
|
http_cookie_share aliases: http-cookie-share string |
Общий доступ к файлу cookie HTTP. Варианты:
|
|
http_ip_header aliases: http-ip-header string |
Заголовок IP HTTP. Варианты:
|
|
http_ip_header_name aliases: http-ip-header-name string |
Имя заголовка IP HTTP. |
|
http_multiplex aliases: http-multiplex string |
Мультиплексирование HTTP. Варианты:
|
|
http_multiplex_max_concurrent_request aliases: http-multiplex-max-concurrent-request integer |
Максимальное количество одновременных запросов, которые может обрабатывать сервер мультиплексирования |
|
http_multiplex_max_request aliases: http-multiplex-max-request integer |
Максимальное количество запросов, которые сервер мультиплексирования может обработать до отключения сеансов |
|
http_multiplex_ttl aliases: http-multiplex-ttl integer |
Время жизни неактивных подключений к серверам. |
|
http_redirect aliases: http-redirect string |
Перенаправление HTTP. Варианты:
|
|
http_supported_max_version aliases: http-supported-max-version string |
Максимальная поддерживаемая версия HTTP. Варианты:
|
|
https_cookie_secure aliases: https-cookie-secure string |
Атрибут Secure файла cookie HTTPS. Варианты:
|
|
id integer |
Идентификатор. |
|
ipv6_mappedip aliases: ipv6-mappedip string |
Диапазон сопоставленных IPv6-адресов. |
|
ipv6_mappedport aliases: ipv6-mappedport string |
Диапазон номеров портов IPv6 в сети назначения, которому сопоставляется диапазон внешних номеров портов. |
|
ldb_method aliases: ldb-method string |
Метод LDB. Варианты:
|
|
mapped_addr aliases: mapped-addr string |
Сопоставленный адрес. |
|
mappedip any |
(список) Сопоставленный IP-адрес. |
|
mappedport string |
Сопоставленный порт. |
|
max_embryonic_connections aliases: max-embryonic-connections integer |
Максимальное количество незавершённых подключений. |
|
monitor any |
(список или строка) Монитор. |
|
nat44 string |
Включить/отключить NAT44. Варианты:
|
|
nat46 string |
Включить/отключить NAT46. Варианты:
|
|
nat_source_vip aliases: nat-source-vip string |
Исходный VIP для NAT. Варианты:
|
|
one_click_gslb_server aliases: one-click-gslb-server string |
Включение/отключение интеграции сервера GSLB одним нажатием с FortiGSLB. Варианты:
|
|
outlook_web_access aliases: outlook-web-access string |
Веб-доступ Outlook. Варианты:
|
|
persistence string |
Сохранение состояния. Варианты:
|
|
portforward string |
Перенаправление портов. Варианты:
|
|
portmapping_type aliases: portmapping-type string |
Тип сопоставления портов. Варианты:
|
|
protocol string |
Протокол. Варианты:
|
|
realservers list / elements=dictionary |
Реальные серверы. |
|
address string |
Адрес. |
|
client_ip aliases: client-ip any |
(список) IP-адрес клиента. |
|
health_check_proto aliases: health-check-proto string |
Протокол проверки работоспособности. Варианты:
|
|
healthcheck string |
Проверка работоспособности. Варианты:
|
|
holddown_interval aliases: holddown-interval integer |
Интервал ожидания. |
|
http_host aliases: http-host string |
Хост HTTP. |
|
id integer |
Идентификатор. |
|
ip string |
IP-адрес. |
|
max_connections aliases: max-connections integer |
Максимальное количество подключений. |
|
monitor any |
(список или строка) Монитор. |
|
port integer |
Порт. |
|
seq integer |
Порядковый номер. |
|
status string |
Статус. Варианты:
|
|
translate_host aliases: translate-host string |
Включение/отключение преобразования имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты:
|
|
type string |
Тип. Варианты:
|
|
verify_cert aliases: verify-cert string |
Проверка сертификата. Варианты:
|
|
weight integer |
Вес. |
|
server_type aliases: server-type string |
Тип сервера. Варианты:
|
|
service any |
(список или строка) Служба. |
|
src_filter aliases: src-filter any |
(list) Фильтр источника. |
|
src_vip_filter aliases: src-vip-filter string |
Включить или отключить использование src-filter для сопоставления адресатов с правилом обратного SNAT. Варианты:
|
|
srcintf_filter aliases: srcintf-filter any |
(list) Фильтр интерфейса источника. |
|
ssl_accept_ffdhe_groups aliases: ssl-accept-ffdhe-groups string |
Включить или отключить набор шифров FFDHE для обмена ключами SSL. Варианты:
|
|
ssl_algorithm aliases: ssl-algorithm string |
Алгоритм SSL. Варианты:
|
|
ssl_certificate aliases: ssl-certificate string |
Сертификат SSL. |
|
ssl_cipher_suites aliases: ssl-cipher-suites list / elements=dictionary |
Наборы шифров SSL. |
|
cipher string |
Шифр. Варианты:
|
|
id integer |
Идентификатор. |
|
priority integer |
Приоритет. |
|
versions list / elements=string |
Версии. Варианты:
|
|
ssl_client_fallback aliases: ssl-client-fallback string |
Резервный режим клиента SSL. Варианты:
|
|
ssl_client_rekey_count aliases: ssl-client-rekey-count integer |
Количество повторных согласований ключей клиента SSL. |
|
ssl_client_renegotiation aliases: ssl-client-renegotiation string |
Повторное согласование SSL со стороны клиента. Варианты:
|
|
ssl_client_session_state_max aliases: ssl-client-session-state-max integer |
Максимальное количество состояний сеансов клиента SSL. |
|
ssl_client_session_state_timeout aliases: ssl-client-session-state-timeout integer |
Время ожидания состояния сеанса клиента SSL. |
|
ssl_client_session_state_type aliases: ssl-client-session-state-type string |
Тип состояния сеанса клиента SSL. Варианты:
|
|
ssl_dh_bits aliases: ssl-dh-bits string |
Размер ключа DH для SSL. Варианты:
|
|
ssl_hpkp aliases: ssl-hpkp string |
HPKP для SSL. Варианты:
|
|
ssl_hpkp_age aliases: ssl-hpkp-age integer |
Срок действия SSL HPKP. |
|
ssl_hpkp_backup aliases: ssl-hpkp-backup string |
Резервный ключ SSL HPKP. |
|
ssl_hpkp_include_subdomains aliases: ssl-hpkp-include-subdomains string |
Включать поддомены в SSL HPKP. Варианты:
|
|
ssl_hpkp_primary aliases: ssl-hpkp-primary string |
Основной ключ SSL HPKP. |
|
ssl_hpkp_report_uri aliases: ssl-hpkp-report-uri string |
URI для отчётов SSL HPKP. |
|
ssl_hsts aliases: ssl-hsts string |
SSL HSTS. Варианты:
|
|
ssl_hsts_age aliases: ssl-hsts-age integer |
Срок действия SSL HSTS. |
|
ssl_hsts_include_subdomains aliases: ssl-hsts-include-subdomains string |
Включать поддомены в SSL HSTS. Варианты:
|
|
ssl_http_location_conversion aliases: ssl-http-location-conversion string |
Преобразование HTTP-заголовка Location для SSL. Варианты:
|
|
ssl_http_match_host aliases: ssl-http-match-host string |
Сопоставление имени хоста HTTP для SSL. Варианты:
|
|
ssl_max_version aliases: ssl-max-version string |
Максимальная версия SSL. Варианты:
|
|
ssl_min_version aliases: ssl-min-version string |
Минимальная версия SSL. Варианты:
|
|
ssl_mode aliases: ssl-mode string |
Режим SSL. Варианты:
|
|
ssl_pfs aliases: ssl-pfs string |
Совершенная прямая секретность (PFS) для SSL. Варианты:
|
|
ssl_send_empty_frags aliases: ssl-send-empty-frags string |
Отправка пустых фрагментов SSL. Варианты:
|
|
ssl_server_algorithm aliases: ssl-server-algorithm string |
Алгоритм SSL-сервера. Варианты:
|
|
ssl_server_max_version aliases: ssl-server-max-version string |
Максимальная версия SSL-сервера. Варианты:
|
|
ssl_server_min_version aliases: ssl-server-min-version string |
Минимальная версия SSL-сервера. Варианты:
|
|
ssl_server_renegotiation aliases: ssl-server-renegotiation string |
Включение или отключение безопасного повторного согласования в соответствии с RFC 5746. Варианты:
|
|
ssl_server_session_state_max aliases: ssl-server-session-state-max integer |
Максимальное количество состояний сеансов SSL-сервера. |
|
ssl_server_session_state_timeout aliases: ssl-server-session-state-timeout integer |
Тайм-аут состояния сеанса SSL-сервера. |
|
ssl_server_session_state_type aliases: ssl-server-session-state-type string |
Тип состояния сеанса SSL-сервера. Варианты:
|
|
status string |
Включить или отключить VIP. Варианты:
|
|
type string |
Тип. Варианты:
|
|
user_agent_detect aliases: user-agent-detect string |
Включить или отключить определение типа устройства по HTTP user-agent, если клиентский сертификат не предоставлен. Варианты:
|
|
uuid string |
UUID. |
|
vip_id aliases: vip-id integer |
Идентификатор VIP. |
|
weblogic_server aliases: weblogic-server string |
Сервер WebLogic. Варианты:
|
|
websphere_server aliases: websphere-server string |
Сервер WebSphere. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, с помощью которого переопределяются условия ошибки. |
rc_succeeded list / элементы=integer | Список кодов rc, с помощью которого переопределяются условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
vip string / обязательный | Параметр (vip) в запрошенном URL. |
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; в качестве значения можно указать global и другие ADOM, включая root. |
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.
- Обычно выполнение модуля завершается ошибкой при возврате ненулевого значения rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure dynamic mappings of virtual IP for IPv4
fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping:
bypass_validation: false
adom: ansible
vip: "ansible-test-vip" # name
state: present
firewall_vip_dynamicmapping:
_scope: # Required
- name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
arp_reply: enable
color: 2
comment: "ansible-comment"
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 dynamic mappings of virtual IP for IPv4
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_vip_dynamicmapping"
params:
adom: "ansible"
vip: "ansible-test-vip" # name
dynamic_mapping: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 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/fortinet/fortimanager/fmgr_firewall_vip_dynamicmapping_module.html