Модуль fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry — Записи, добавленные в базу данных добавления интернет-служб.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Если вы используете пакет ansible, эта коллекция, возможно, уже установлена. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry.
Новая функция в fortinet.fortimanager 2.1.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager. Модуль продолжает выполняться без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_internetserviceaddition_entry словарь | Установленные параметры верхнего уровня. |
|
addr-mode строка |
Устарело, пожалуйста, переименуйте на addr_mode. Режим адреса Варианты:
|
|
id целое число / обязательно |
Идентификатор записи |
|
port-range список / элементы=словарь |
Устарело, пожалуйста, переименуйте на port_range. Диапазон портов. |
|
end-port целое число |
Устарело, пожалуйста, переименуйте на end_port. Целочисленное значение для конечного порта TCP/UDP/SCTP в диапазоне |
|
id целое число |
Пользовательский идентификатор диапазона портов. |
|
start-port целое число |
Устарело, пожалуйста, переименуйте на start_port. Целочисленное значение для начального порта TCP/UDP/SCTP в диапазоне |
|
protocol целое число |
Целочисленное значение для типа протокола, определенного IANA |
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к forticloud API. |
internet-service-addition строка | Устарело, используйте “internet_service_addition” |
internet_service_addition строка | Параметр (internet-service-addition) в запрошенном URL. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с помощью которых будут переопределены условия для ошибки. |
rc_succeeded список / элементы=целое число | Список кодов rc, с помощью которых будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая root. |
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 (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: Entries added to the Internet Service addition database.
fortinet.fortimanager.fmgr_firewall_internetserviceaddition_entry:
# 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>
state: present # <value in [present, absent]>
firewall_internetserviceaddition_entry:
id: <integer>
port_range:
-
end_port: <integer>
id: <integer>
start_port: <integer>
protocol: <integer>
addr_mode: <value in [ipv4, ipv6]>
Значения возврата
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_internetserviceaddition_entry_module.html
