Модуль fortinet.fortimanager.fmgr_system_geoipoverride — Настройка сопоставления географического местоположения с IP-адресом

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в playbook укажите: fortinet.fortimanager.fmgr_system_geoipoverride.

Новая функция в fortinet.fortimanager 2.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливать в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для успеха.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_geoipoverride словарь	Настройка параметров верхнего уровня.
description строка	Описание.
ip_range список / элементы=словарь	Устарело, переименуйте на ip_range. Диапазон IP-адресов.
end_ip строка	Устарело, переименуйте на end_ip. Конечный IP-адрес диапазона (включительно).
id целое число	Идентификатор записи в таблице диапазонов IP-адресов.
start_ip строка	Устарело, переименуйте на start_ip. Начальный IP-адрес диапазона (включительно).
ip6_range список / элементы=словарь	Устарело, переименуйте на ip6_range. Диапазон IPv6-адресов.
end_ip строка	Устарело, переименуйте на end_ip. Конечный IPv6-адрес диапазона (включительно).
id целое число	Идентификатор записи в таблице диапазонов IPv6-адресов.
start_ip строка	Устарело, переименуйте на start_ip. Начальный IPv6-адрес диапазона (включительно).
name строка / обязательно	Название расположения.
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 помогают в этом.
Для создания или обновления объекта используйте директиву 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: 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 словарь	Результат запроса. Возвращается: всегда
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_system_geoipoverride_module.html