Модуль fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry_portrange – Диапазоны портов в пользовательской записи.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry_portrange.

Новое в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
entry строка / обязательно	Параметр (entry) в запрошенном URL.
firewall_internetserviceaddition_entry_portrange словарь	Установленные параметры верхнего уровня.
end_port целое число	Устарело, пожалуйста, переименуйте на end_port. Целочисленное значение конечного порта TCP/UDP/SCTP назначения в диапазоне
id целое число / обязательно	Идентификатор пользовательского диапазона портов.
start_port целое число	Устарело, пожалуйста, переименуйте на start_port. Целочисленное значение начального порта TCP/UDP/SCTP назначения в диапазоне
forticloud_access_token строка	Авторизовать Ansible-клиента с токеном доступа к API forticloud.
internet_service_addition строка	Устарело, пожалуйста, используйте “internet_service_addition”
internet_service_addition строка	Параметр (internet-service-addition) в запрошенном URL.
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`

END_OF_DOCUMENT_MARKER

Примечания

Примечание

Начиная с версии 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Port ranges in the custom entry.
      fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry_portrange:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        internet_service_addition: <your own value>
        entry: <your own value>
        state: present # <value in [present, absent]>
        firewall_internetserviceaddition_entry_portrange:
          end_port: <integer>
          id: <integer>
          start_port: <integer>

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

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

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