fortinet.fortimanager.fmgr_system_sdnconnector_routetable модуль — Настройка таблицы маршрутизации Azure.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_sdnconnector_routetable.
Добавлен в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить, используя данные из источников, перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log булево | Включение/выключение ведения журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успеха. |
sdn-connector строка | Устаревшее значение, используйте «sdn_connector» |
sdn_connector строка | Параметр (sdn-connector) в запрошенном URL. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
system_sdnconnector_routetable словарь | Настройка параметров верхнего уровня. |
|
name строка / обязательно |
Имя таблицы маршрутизации. |
|
resource_group строка |
Устаревшее значение, используйте resource_group. Ресурсная группа таблицы маршрутизации Azure. |
|
route список / элементы=словарь |
Маршрут. |
|
name строка |
Название маршрута. |
|
next_hop строка |
Устаревшее значение, используйте next_hop. Адрес следующего узла. |
|
subscription_id строка |
Устаревшее значение, используйте subscription_id. Идентификатор подписки таблицы маршрутизации Azure. |
workspace_locking_adom строка | Область ADOM для блокировки FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным или другим, включая корневой. |
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: Configure Azure route table.
fortinet.fortimanager.fmgr_system_sdnconnector_routetable:
bypass_validation: false
adom: ansible
sdn-connector: ansible-test-sdn # name
state: present
system_sdnconnector_routetable: # available only when type is set to 'azure' in sdn-connector
name: ansible-test-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 Azure route tables
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_sdnconnector_routetable" # available only when type is set to 'azure' in sdn-connector
params:
adom: "ansible"
sdn-connector: "ansible-test-sdn" # name
route-table: "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_system_sdnconnector_routetable_module.html
