Модуль fortinet.fortimanager.fmgr_system_sdnconnector_nic – Настройка сетевого интерфейса Azure.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_sdnconnector_nic.
Добавлено в 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 | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
sdn-connector string | Устарел, используйте “sdn_connector” |
sdn_connector string | Параметр (sdn-connector) в запрошенном URL. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
system_sdnconnector_nic dictionary | Набор параметров верхнего уровня. |
|
ip list / элементы типа dictionary |
IP-адрес. |
|
name string |
Имя конфигурации IP. |
|
private_ip псевдонимы: private-ip string |
Частный IP-адрес. |
|
public_ip псевдонимы: public-ip string |
Имя общедоступного IP-адреса. |
|
resource_group псевдонимы: resource-group string |
Группа ресурсов общедоступного IP-адреса Azure. |
|
name string / обязательный |
Имя сетевого интерфейса. |
|
peer_nic псевдонимы: peer-nic string |
Имя однорангового сетевого интерфейса. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку workspace. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов задаются в формате snake_case. Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; для этого используются параметры верхнего уровня 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 network interface.
fortinet.fortimanager.fmgr_system_sdnconnector_nic:
bypass_validation: false
adom: ansible
sdn_connector: ansible-test-sdn # name
state: present
system_sdnconnector_nic: # available only when type is set to 'azure' in sdn-connector
name: ansible-test-nic
- 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 network interfaces
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_sdnconnector_nic" # available only when type is set to 'azure' in sdn-connector
params:
adom: "ansible"
sdn_connector: "ansible-test-sdn" # name
nic: "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_nic_module.html
