Модуль fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping — Настройка виртуального IP-адреса для IPv4.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_firewall_vip_dynamicmapping.
Впервые в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_vip_dynamicmapping словарь | Параметры верхнего уровня. |
|
_scope список / элементы=словарь |
Область. |
|
name строка |
Имя. |
|
vdom строка |
Vdom. |
|
add_nat46_route строка |
Включить/выключить добавление маршрута NAT46. Варианты:
|
|
arp_reply строка |
Ответ ARP. Варианты:
|
|
color целое число |
Цвет. |
|
comment строка |
Комментарий. |
|
dns_mapping_ttl целое число |
TTL для DNS-сопоставления. |
|
extaddr любой |
(список или строка) Адрес внешнего интерфейса. |
|
extintf строка |
Внешний интерфейс. |
|
extip строка |
Внешний IP-адрес. |
|
extport строка |
Внешний порт. |
|
gratuitous_arp_interval целое число |
Интервал ARP-запросов. |
|
gslb_domain_name строка |
Домен для интеграции с FortiGSLB. |
|
gslb_hostname строка |
Имя хоста в заданном домене FortiGSLB. |
|
h2_support строка |
Включить/выключить поддержку HTTP2. Варианты:
|
|
h3_support строка |
Включить/выключить поддержку HTTP3/QUIC. Варианты:
|
|
http-cookie-age integer |
Устарело, переименуйте в http_cookie_age. Время жизни HTTP-cookie. |
|
http-cookie-domain string |
Устарело, переименуйте в http_cookie_domain. Домен HTTP-cookie. |
|
http-cookie-domain-from-host string |
Устарело, переименуйте в http_cookie_domain_from_host. Домен HTTP-cookie от хоста. Choices:
|
|
http-cookie-generation integer |
Устарело, переименуйте в http_cookie_generation. Генерация HTTP-cookie. |
|
http-cookie-path string |
Устарело, переименуйте в http_cookie_path. Путь HTTP-cookie. |
|
string |
Устарело, переименуйте в http_cookie_share. Общий доступ к HTTP-cookie. Choices:
|
|
http-ip-header string |
Устарело, переименуйте в http_ip_header. Заголовок IP HTTP. Choices:
|
|
http-ip-header-name string |
Устарело, переименуйте в http_ip_header_name. Имя заголовка IP HTTP. |
|
http-multiplex string |
Устарело, переименуйте в http_multiplex. HTTP-мультиплексирование. Choices:
|
|
http-multiplex-max-concurrent-request integer |
Устарело, переименуйте в http_multiplex_max_concurrent_request. Максимальное количество одновременных запросов, которые мо… |
|
http-multiplex-max-request integer |
Устарело, переименуйте в http_multiplex_max_request. Максимальное количество запросов, которые может обработать сервер му… |
|
http-multiplex-ttl integer |
Устарело, переименуйте в http_multiplex_ttl. Время жизни для неактивных соединений с серверами. |
|
http-redirect string |
Устарело, переименуйте в http_redirect. HTTP-перенаправление. Choices:
|
|
http-supported-max-version string |
Устарело, переименуйте в http_supported_max_version. Максимально поддерживаемые версии HTTP. Choices:
|
|
https-cookie-secure string |
Устарело, переименуйте в https_cookie_secure. Защищённый HTTPS-cookie. Choices:
|
|
id integer |
Идентификатор. |
|
ipv6-mappedip string |
Устарело, переименуйте в ipv6_mappedip. Диапазон сопоставленных IPv6-адресов. |
|
ipv6-mappedport string |
Устарело, переименуйте в ipv6_mappedport. Диапазон номеров IPv6-портов во внешней сети, к которым… |
|
ldb-method string |
Устарело, переименуйте в ldb_method. Метод LDB. Choices:
|
|
mapped-addr string |
Устарело, переименуйте в mapped_addr. Сопоставленный адрес. |
|
mappedip any |
(list) Mappedip. |
|
mappedport string |
Mappedport. |
|
max-embryonic-connections integer |
Устарело, переименуйте в max_embryonic_connections. Максимальное количество зарождающихся соединений. |
|
monitor any |
(list or str) Монитор. |
|
nat-source-vip string |
Устарело, переименуйте в nat_source_vip. VIP-адрес источника NAT. Choices:
|
|
nat44 string |
Включить/выключить NAT44. Choices:
|
|
nat46 string |
Включить/выключить NAT46. Choices:
|
|
one-click-gslb-server string |
Устарело, переименуйте в one_click_gslb_server. Включить/выключить интеграцию сервера GSLB одним щелчком с FortiGSLB. Choices:
|
|
outlook-web-access string |
Устарело, переименуйте в outlook_web_access. Веб-доступ к Outlook. Choices:
|
|
persistence string |
Сохранение состояния. Choices:
|
|
portforward string |
Переадресация портов. Choices:
|
|
portmapping-type string |
Устарело, переименуйте в portmapping_type. Тип сопоставления портов. Choices:
|
|
protocol string |
Протокол. Choices:
|
|
realservers list / elements=dictionary |
Реальные серверы. |
|
address string |
Адрес. |
|
client-ip any |
(list) Устарело, переименуйте в client_ip. IP-адрес клиента. |
|
health-check-proto string |
Устарело, переименуйте в health_check_proto. Протокол проверки состояния. Choices:
|
|
healthcheck string |
Проверка состояния. Choices:
|
|
holddown-interval integer |
Устарело, переименуйте в holddown_interval. Интервал удержания. |
|
http-host string |
Устарело, переименуйте в http_host. HTTP-хост. |
|
id integer |
Идентификатор. |
|
ip string |
IP-адрес. |
|
max-connections integer |
Устарело, переименуйте в max_connections. Максимальное количество подключений. |
|
monitor any |
(список или строка) Мониторинг. |
|
port integer |
Порт. |
|
seq integer |
Последовательность. |
|
status string |
Статус. Варианты:
|
|
translate-host string |
Устарело, переименуйте в translate_host. Включить/отключить преобразование имени хоста/IP-адреса с виртуального сервера на r… Варианты:
|
|
type string |
Тип. Варианты:
|
|
weight integer |
Вес. |
|
server-type string |
Устарело, переименуйте в server_type. Тип сервера. Варианты:
|
|
service any |
(список или строка) Сервис. |
|
src-filter any |
(список) Устарело, переименуйте в src_filter. Фильтр источника. |
|
src-vip-filter string |
Устарело, переименуйте в src_vip_filter. Включить/отключить использование src-filter для сопоставления назначений для обратного SNA… Варианты:
|
|
srcintf-filter any |
(список) Устарело, переименуйте в srcintf_filter. Фильтр интерфейса источника. |
|
ssl-accept-ffdhe-groups string |
Устарело, переименуйте в ssl_accept_ffdhe_groups. Включить/отключить набор шифров FFDHE для обмена ключами SSL. Варианты:
|
|
ssl-algorithm string |
Устарело, переименуйте в ssl_algorithm. Алгоритм SSL. Варианты:
|
|
ssl-certificate string |
Устарело, переименуйте в ssl_certificate. Сертификат SSL. |
|
ssl-cipher-suites list / elements=dictionary |
Устарело, переименуйте в ssl_cipher_suites. Наборы шифров SSL. |
|
cipher string |
Шифр. Варианты:
|
|
id integer |
Идентификатор. |
|
priority integer |
Приоритет. |
|
versions list / elements=string |
Версии. Варианты:
|
|
ssl-client-fallback string |
Устарело, переименуйте в ssl_client_fallback. Резервный вариант клиента SSL. Варианты:
|
|
ssl-client-rekey-count integer |
Устарело, переименуйте в ssl_client_rekey_count. Количество переключений ключей клиента SSL. |
|
ssl-client-renegotiation string |
Устарело, переименуйте в ssl_client_renegotiation. Переговоры клиента SSL. Варианты:
|
|
ssl-client-session-state-max integer |
Устарело, переименуйте в ssl_client_session_state_max. Максимальное состояние сессии клиента SSL. |
|
ssl-client-session-state-timeout integer |
Устарело, переименуйте в ssl_client_session_state_timeout. Время ожидания состояния сессии клиента SSL. |
|
ssl-client-session-state-type string |
Устарело, переименуйте в ssl_client_session_state_type. Тип состояния сессии клиента SSL. Варианты:
|
|
ssl-dh-bits string |
Устарело, переименуйте в ssl_dh_bits. Биты SSL DH. Варианты:
|
|
ssl-hpkp string |
Устарело, переименуйте в ssl_hpkp. SSL HPKP. Варианты:
|
|
ssl-hpkp-age integer |
Устарело, переименуйте в ssl_hpkp_age. Возраст SSL HPKP. |
|
ssl-hpkp-backup string |
Устарело, переименуйте в ssl_hpkp_backup. Резервная копия SSL HPKP. |
|
ssl-hpkp-include-subdomains string |
Устарело, переименуйте в ssl_hpkp_include_subdomains. Ssl hpkp include subdomains. Варианты:
|
|
ssl-hpkp-primary string |
Устарело, переименуйте в ssl_hpkp_primary. Ssl hpkp primary. |
|
ssl-hpkp-report-uri string |
Устарело, переименуйте в ssl_hpkp_report_uri. Ssl hpkp report uri. |
|
ssl-hsts string |
Устарело, переименуйте в ssl_hsts. Ssl hsts. Варианты:
|
|
ssl-hsts-age integer |
Устарело, переименуйте в ssl_hsts_age. Ssl hsts age. |
|
ssl-hsts-include-subdomains string |
Устарело, переименуйте в ssl_hsts_include_subdomains. Ssl hsts include subdomains. Варианты:
|
|
ssl-http-location-conversion string |
Устарело, переименуйте в ssl_http_location_conversion. Ssl http location conversion. Варианты:
|
|
ssl-http-match-host string |
Устарело, переименуйте в ssl_http_match_host. Ssl http match host. Варианты:
|
|
ssl-max-version string |
Устарело, переименуйте в ssl_max_version. Ssl max version. Варианты:
|
|
ssl-min-version string |
Устарело, переименуйте в ssl_min_version. Ssl min version. Варианты:
|
|
ssl-mode string |
Устарело, переименуйте в ssl_mode. Ssl mode. Варианты:
|
|
ssl-pfs string |
Устарело, переименуйте в ssl_pfs. Ssl pfs. Варианты:
|
|
ssl-send-empty-frags string |
Устарело, переименуйте в ssl_send_empty_frags. Ssl send empty frags. Варианты:
|
|
ssl-server-algorithm string |
Устарело, переименуйте в ssl_server_algorithm. Ssl server algorithm. Варианты:
|
|
ssl-server-max-version string |
Устарело, переименуйте в ssl_server_max_version. Ssl server max version. Варианты:
|
|
ssl-server-min-version string |
Устарело, переименуйте в ssl_server_min_version. Ssl server min version. Варианты:
|
|
ssl-server-renegotiation строка |
Устарело, переименуйте на ssl_server_renegotiation. Включить/выключить безопасное возобновление сессии в соответствии с RFC 5746. Варианты:
|
|
ssl-server-session-state-max целое число |
Устарело, переименуйте на ssl_server_session_state_max. Максимальное состояние сессии SSL сервера. |
|
ssl-server-session-state-timeout целое число |
Устарело, переименуйте на ssl_server_session_state_timeout. Время ожидания состояния сессии SSL сервера. |
|
ssl-server-session-state-type строка |
Устарело, переименуйте на ssl_server_session_state_type. Тип состояния сессии SSL сервера. Варианты:
|
|
status строка |
Включить/выключить VIP. Варианты:
|
|
type строка |
Тип. Варианты:
|
|
uuid строка |
Уникальный идентификатор. |
|
weblogic-server строка |
Устарело, переименуйте на weblogic_server. Сервер Weblogic. Варианты:
|
|
websphere-server строка |
Устарело, переименуйте на websphere_server. Сервер Websphere. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых условия будут считаться проваленными. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых условия будут считаться выполненными. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
vip строка / обязательно | Параметр (vip) в запрошенном URL. |
workspace_locking_adom строка | ADOM для блокировки в режиме работы в рабочей области FortiManager, значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: 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 словарь | Результат запроса. Возвращается: всегда |
|
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_vip_dynamicmapping_module.html