Модуль fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry – Записи, добавленные в базу данных «Услуги интернета» и пользовательскую базу данных.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в playbook, укажите: fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry.
Добавлена в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_internetservicecustom_entry словарь | Установленные параметры верхнего уровня. |
|
addr-mode строка |
Устаревшее, пожалуйста, переименуйте в addr_mode. Режим адреса Варианты:
|
|
dst любой |
(список или строка) Адрес или имя группы адресов назначения. |
|
dst6 любой |
(список) Адрес6 или имя группы адресов6 назначения. |
|
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 с помощью токена доступа к API forticloud. |
internet-service-custom строка | Устаревшее, пожалуйста, используйте “internet_service_custom” |
internet_service_custom строка | Параметр (internet-service-custom) в запрошенном 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
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_firewall_internetservicecustom_entry:
bypass_validation: false
adom: ansible
internet-service-custom: "ansible-test" # name
state: present
firewall_internetservicecustom_entry:
# dst: 'ansible'
id: 1
protocol: 2
- 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 entries in the custom internet service
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_internetservicecustom_entry"
params:
adom: "ansible"
internet-service-custom: "ansible-test" # name
entry: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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_internetservicecustom_entry_module.html
