fortinet.fortimanager.fmgr_firewall_internetservicecustom модуль — Настройка пользовательских интернет-сервисов.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только в случае расхождений схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_internetservicecustom словарь	Параметры верхнего уровня.
comment строка	Комментарий.
disable_entry список / элементы=словарь	Устарело, пожалуйста, переименуйте на disable_entry. Отключить запись.
id целое число	Идентификатор записи для отключения.
ip_range список / элементы=словарь	Устарело, пожалуйста, переименуйте на ip_range. Диапазон IP-адресов.
end_ip строка	Устарело, пожалуйста, переименуйте на end_ip. Конечный IP-адрес.
id целое число	Идентификатор диапазона записи для отключения.
start_ip строка	Устарело, пожалуйста, переименуйте на start_ip. Начальный IP-адрес.
port любой	(список) Целочисленное значение порта TCP/IP
protocol целое число	Целочисленное значение типа протокола, определенного IANA
entry список / элементы=словарь	Запись.
addr_mode строка	Устарело, пожалуйста, переименуйте на addr_mode. Режим адресации Варианты: `"ipv4"` `"ipv6"`
dst любой	(список или строка) Адрес назначения или имя группы адресов.
dst6 любой	(список) Адрес назначения IPv6 или имя группы адресов IPv6.
id целое число	Идентификатор записи.
port_range список / элементы=словарь	Устарело, пожалуйста, переименуйте на port_range. Диапазон портов.
end_port целое число	Устарело, пожалуйста, переименуйте на end_port. Целое значение конечного порта назначения TCP/UDP/SCTP в диапазоне.
id целое число	Идентификатор пользовательского диапазона портов.

start-port целое число	Устаревшее, пожалуйста, переименуйте его в start_port. Целочисленное значение для начального TCP/UDP/SCTP порта назначения в диапазоне
protocol целое число	Целочисленное значение для типа протокола, как определено IANA
id целое число	Идентификатор интернет-службы.
master-service-id строка	Устаревшее, пожалуйста, переименуйте его в master_service_id. Идентификатор интернет-службы в базе данных интернет-служб.
name строка / обязательно	Имя интернет-службы.
reputation целое число	Уровень репутации пользовательской интернет-службы.
forticloud_access_token строка	Авторизуйте клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выбори: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Выбори: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
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: Configure custom Internet Services via Generic Module.
      fortinet.fortimanager.fmgr_generic:
        method: "set"
        params:
          - url: "/pm/config/adom/ansible/obj/firewall/internet-service-custom"
            data:
              - name: "ansible-test"
                comment: "ansible-comment"
    - name: Configure custom Internet Services.
      when: false
      fortinet.fortimanager.fmgr_firewall_internetservicecustom:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_internetservicecustom:
          comment: "ansible-comment"
          name: "ansible-test"

- 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 custom Internet Services
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_internetservicecustom"
          params:
            adom: "ansible"
            internet-service-custom: "your_value"

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
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_firewall_internetservicecustom_module.html