Модуль fortinet.fortimanager.fmgr_firewall_gtp_ieremovepolicy — политика удаления IE.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_gtp_ieremovepolicy.
Добавлено в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логический | Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log логический | Включить или отключить ведение журнала для задачи. Варианты:
|
firewall_gtp_ieremovepolicy словарь | Параметры верхнего уровня. |
|
id целое число / обязательный |
Идентификатор. |
|
remove_ies псевдонимы: remove-ies список / элементы=строка |
Информационные элементы GTP, которые следует удалить. Варианты:
|
|
sgsn_addr псевдонимы: sgsn-addr строка |
Имя адреса SGSN. |
|
sgsn_addr6 псевдонимы: sgsn-addr6 строка |
Имя адреса IPv6 SGSN. |
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
gtp строка / обязательный | Параметр (gtp) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, которыми будут переопределены условия ошибки. |
rc_succeeded список / элементы=целое число | Список кодов rc, которыми будут переопределены условия успешного выполнения. |
revision_note строка | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state строка / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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: IE remove policy.
fortinet.fortimanager.fmgr_firewall_gtp_ieremovepolicy:
bypass_validation: false
adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
gtp: "ansible-test" # name
state: present
firewall_gtp_ieremovepolicy:
id: 1
remove_ies:
- apn-restriction
- rat-type
- rai
- uli
- imei
sgsn_addr: "your_value"
- 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 IE remove policys in the GTP
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_gtp_ieremovepolicy"
params:
adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
gtp: "ansible-test" # name
ie_remove_policy: "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_gtp_ieremovepolicy_module.html
