модуль fortinet.fortimanager.fmgr_system_sdnconnector_routetable_route — Настройка маршрута Azure.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в сценарии, укажите: fortinet.fortimanager.fmgr_system_sdnconnector_routetable_route.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия завершения с ошибкой. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного завершения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
route-table string | Устарел, используйте «route_table» |
route_table string | Параметр (route-table) в запрошенном URL. |
sdn-connector string | Устарел, используйте «sdn_connector» |
sdn_connector string | Параметр (sdn-connector) в запрошенном URL. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
system_sdnconnector_routetable_route dictionary | Параметры верхнего уровня. |
|
name string / обязательный |
Имя маршрута. |
|
next_hop псевдонимы: next-hop string |
Адрес следующего узла. |
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.
- Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой 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: Configure Azure route.
fortinet.fortimanager.fmgr_system_sdnconnector_routetable_route:
bypass_validation: false
adom: ansible
sdn_connector: ansible-test-sdn # name
route_table: ansible-test-routetable # name
state: present
system_sdnconnector_routetable_route:
name: ansible-routetable-route
next_hop: ansible-test
- 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 routes of Azure route table
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_sdnconnector_routetable_route"
params:
adom: "ansible"
sdn_connector: "ansible-test-sdn" # name
route_table: "ansible-test-routetable" # name
route: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, характерные только для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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_system_sdnconnector_routetable_route_module.html
