Модуль fortinet.fortimanager.fmgr_application_internetservicecustom_entry – Записи, добавленные в базу данных интернет-сервисов и пользовательскую базу данных.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook, укажите: fortinet.fortimanager.fmgr_application_internetservicecustom_entry.
Новое в fortinet.fortimanager 2.2.0
Краткое описание
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / required | Параметр (adom) в запрошенном URL. |
application_internetservicecustom_entry dictionary | Набор параметров верхнего уровня. |
|
dst string |
Имя адреса назначения. |
|
id integer / required |
Идентификатор записи |
|
port-range list / elements=dictionary |
Устарело, переименуйте в port_range. Диапазон портов. |
|
end-port integer |
Устарело, переименуйте в end_port. Конечный номер порта назначения |
|
id integer |
Идентификатор диапазона портов пользовательской записи. |
|
start-port integer |
Устарело, переименуйте в start_port. Начальный номер порта назначения |
|
protocol integer |
Номер протокола. |
bypass_validation boolean | Устанавливайте в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/Выключить логирование для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
internet-service-custom string | Устарело, используйте «internet_service_custom» |
internet_service_custom string | Параметр (internet-service-custom) в запрошенном URL. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, с которыми будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, с которыми будут переопределены условия успеха. |
state string / required | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom string | ADOM для блокировки FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая 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 помогают в этом.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться неудачей, если возвращается ненулевой код возврата. Вы также можете переопределить условия для сбоя или успеха с помощью параметров 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 database and custom database.
fortinet.fortimanager.fmgr_application_internetservicecustom_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_custom: <your own value>
state: present # <value in [present, absent]>
application_internetservicecustom_entry:
dst: <string>
id: <integer>
port_range:
-
end_port: <integer>
id: <integer>
start_port: <integer>
protocol: <integer>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL-адрес запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API-запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_application_internetservicecustom_entry_module.html
