Модуль fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry_portrange — диапазоны портов в пользовательской записи.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_internetservicecustom_entry_portrange.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логический | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log логический | Включить или отключить ведение журнала для задачи. Варианты:
|
entry строка / обязательный | Параметр (entry) в запрошенном URL. |
firewall_internetservicecustom_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-custom строка | Устарел, используйте “internet_service_custom” |
internet_service_custom строка | Параметр (internet-service-custom) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целые числа | Список кодов rc, для которых переопределяются условия неудачного выполнения. |
rc_succeeded список / элементы=целые числа | Список кодов rc, для которых переопределяются условия успешного выполнения. |
revision_note строка | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state строка / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие значения, включая 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 позволяют выполнять эту задачу.
- Обычно выполнение модуля может завершиться с ошибкой при возврате ненулевого значения rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook
hosts: fortimanagers
gather_facts: false
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_internetservicecustom_entry_portrange:
bypass_validation: false
adom: ansible
internet_service_custom: "ansible-test" # name
entry: "1" # id
state: present
firewall_internetservicecustom_entry_portrange:
end_port: 6
id: 1
start_port: 1
- 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 port ranges in the entry
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_internetservicecustom_entry_portrange"
params:
adom: "ansible"
internet_service_custom: "ansible-test" # name
entry: "1" # id
port_range: "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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_internetservicecustom_entry_portrange_module.html
