Модуль fortinet.fortimanager.fmgr_system_geoipoverride — настройка сопоставления географического местоположения с IP-адресом
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_system_geoipoverride.
Добавлено в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием.
Параметры
Параметр | Описание |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов возврата, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов возврата, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
system_geoipoverride dictionary | Набор параметров верхнего уровня. |
|
description string |
Описание. |
|
ip6_range псевдонимы: ip6-range list / элементы=dictionary |
Диапазон IPv6. |
|
end_ip псевдонимы: end-ip string |
Конечный IP-адрес диапазона включительно |
|
id integer |
Идентификатор отдельной записи в таблице диапазонов IPv6. |
|
start_ip псевдонимы: start-ip string |
Начальный IP-адрес диапазона включительно |
|
ip_range псевдонимы: ip-range list / элементы=dictionary |
Диапазон IP-адресов. |
|
end_ip псевдонимы: end-ip string |
Конечный IP-адрес диапазона включительно |
|
id integer |
Идентификатор отдельной записи в таблице диапазонов IP-адресов. |
|
start_ip псевдонимы: start-ip string |
Начальный IP-адрес диапазона включительно |
|
name string / обязательный |
Название местоположения. |
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: Create the geoip
fortinet.fortimanager.fmgr_system_geoipoverride:
adom: ansible
state: present
system_geoipoverride:
name: ansible-test-geoipoverride
- name: Table of IP ranges assigned to country.
fortinet.fortimanager.fmgr_system_geoipoverride_iprange:
bypass_validation: false
adom: ansible
geoip_override: ansible-test-geoipoverride # name
state: present
system_geoipoverride_iprange:
end_ip: 222.222.222.25
id: 1
start_ip: 222.222.222.2
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=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_system_geoipoverride_module.html
