Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_sdnconnector — настройка подключения к SDN Connector.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_sdnconnector.

Добавлено в fortinet.fortimanager 2.0.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределенный метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание создать, обновить или удалить объект.

Варианты:

  • "present"
  • "absent"

system_sdnconnector

dictionary

Набор параметров верхнего уровня.

_local_cert

string

Локальный сертификат.

access_key

псевдонимы: access-key

string

Идентификатор ключа доступа AWS.

alt_resource_ip

псевдонимы: alt-resource-ip

string

Включить/отключить альтернативный IP-адрес ресурса AWS.

Варианты:

  • "disable"
  • "enable"

api_key

псевдонимы: api-key

any

(список) Ключ API IBM Cloud или ключ API идентификатора службы.

azure_region

псевдонимы: azure-region

string

Регион сервера Azure.

Варианты:

  • "global"
  • "china"
  • "germany"
  • "usgov"
  • "local"

client_id

псевдонимы: client-id

string

Идентификатор клиента Azure

client_secret

псевдонимы: client-secret

any

(список) Секрет клиента Azure

compartment_id

псевдонимы: compartment-id

string

Идентификатор компартмента.

compartment_list

псевдонимы: compartment-list

list / elements=dictionary

Список компартментов.

compartment_id

псевдонимы: compartment-id

string

Идентификатор компартмента OCI.

compute_generation

псевдонимы: compute-generation

integer

Поколение вычислительных ресурсов для инфраструктуры IBM Cloud.

domain

string

Домен OpenStack.

external_account_list

псевдонимы: external-account-list

list / elements=dictionary

Список внешних учетных записей.

external_id

псевдонимы: external-id

string

Внешний идентификатор AWS.

region_list

псевдонимы: region-list

any

(список) Список названий регионов AWS.

role_arn

псевдонимы: role-arn

string

ARN роли AWS, которую необходимо принять.

external_ip

псевдонимы: external-ip

list / elements=dictionary

Внешний IP-адрес.

name

string

Имя внешнего IP-адреса.

forwarding_rule

псевдонимы: forwarding-rule

list / elements=dictionary

Правило переадресации.

rule_name

псевдонимы: rule-name

string

Имя правила переадресации.

target

string

Имя целевого экземпляра.

gcp_project

псевдонимы: gcp-project

string

Название проекта GCP.

gcp_project_list

псевдонимы: gcp-project-list

list / elements=dictionary

Список проектов GCP.

gcp_zone_list

псевдонимы: gcp-zone-list

any

(список) Настройка списка зон GCP.

id

string

Идентификатор проекта GCP.

group_name

псевдонимы: group-name

string

Имя группы компьютеров.

ha_status

псевдонимы: ha-status

string

Включить/отключить использование службы FortiGate HA.

Варианты:

  • "disable"
  • "enable"

ibm_region

псевдонимы: ibm-region

string

Название региона IBM Cloud.

Варианты:

  • "us-south"
  • "us-east"
  • "germany"
  • "great-britain"
  • "japan"
  • "australia"
  • "dallas"
  • "washington-dc"
  • "london"
  • "frankfurt"
  • "sydney"
  • "tokyo"
  • "osaka"
  • "toronto"
  • "sao-paulo"
  • "dallas-private"
  • "washington-dc-private"
  • "london-private"
  • "frankfurt-private"
  • "sydney-private"
  • "tokyo-private"
  • "osaka-private"
  • "toronto-private"
  • "sao-paulo-private"
  • "madrid"
  • "madrid-private"

ibm_region_gen1

псевдонимы: ibm-region-gen1

string

Регион IBM поколения 1.

Варианты:

  • "us-south"
  • "us-east"
  • "germany"
  • "great-britain"
  • "japan"
  • "australia"

ibm_region_gen2

псевдонимы: ibm-region-gen2

string

Регион IBM поколения 2.

Варианты:

  • "us-south"
  • "us-east"
  • "great-britain"

key_passwd

псевдонимы: key-passwd

any

(список) Пароль закрытого ключа.

last_update

псевдонимы: last-update

integer

Время последнего обновления.

login_endpoint

псевдонимы: login-endpoint

string

Конечная точка входа Azure Stack.

message_server_port

псевдонимы: message-server-port

integer

Номер порта HTTP сервера сообщений SAP.

microsoft_365

псевдонимы: microsoft-365

string

Включить использование в качестве коннектора Microsoft 365.

Варианты:

  • "disable"
  • "enable"

name

string / обязательный

Имя коннектора SDN.

nic

list / elements=dictionary

Сетевой интерфейс.

ip

list / elements=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

Имя однорангового сетевого интерфейса.

nsx_cert_fingerprint

aliases: nsx-cert-fingerprint

string

Отпечаток сертификата NSX.

oci_cert

aliases: oci-cert

string

Сертификат OCI.

oci_fingerprint

aliases: oci-fingerprint

string

Отпечаток OCI.

oci_region

aliases: oci-region

string

Регион сервера OCI.

Варианты:

  • "phoenix"
  • "ashburn"
  • "frankfurt"
  • "london"
  • "toronto"

oci_region_list

aliases: oci-region-list

list / elements=dictionary

Список регионов OCI.

region

string

Регион OCI.

oci_region_type

aliases: oci-region-type

string

Тип региона OCI.

Варианты:

  • "commercial"
  • "government"

par_id

aliases: par-id

string

Идентификатор диапазона публичных адресов.

password

any

(список) Пароль удаленного SDN-коннектора, используемый для входа.

private_key

aliases: private-key

string

Закрытый ключ сервисной учетной записи GCP.

proxy

string

Прокси-сервер SDN.

region

string

Название региона AWS.

resource_group

aliases: resource-group

string

Группа ресурсов Azure.

resource_url

aliases: resource-url

string

URL ресурса Azure Stack.

rest_interface

aliases: rest-interface

string

Имя интерфейса, на котором будет ожидать запросы служба REST.

Варианты:

  • "mgmt"
  • "sync"

rest_password

aliases: rest-password

any

(список) Пароль для службы REST.

rest_sport

aliases: rest-sport

integer

Порт доступа к службе REST

rest_ssl

aliases: rest-ssl

string

SSL для REST.

Варианты:

  • "disable"
  • "enable"

route

list / elements=dictionary

Маршрут.

name

string

Имя маршрута.

route_table

aliases: route-table

list / elements=dictionary

Таблица маршрутизации.

name

string

Имя таблицы маршрутизации.

resource_group

aliases: resource-group

string

Группа ресурсов таблицы маршрутизации Azure.

route

list / elements=dictionary

Маршрут.

name

string

Имя маршрута.

next_hop

aliases: next-hop

string

Адрес следующего узла.

subscription_id

aliases: subscription-id

string

Идентификатор подписки для таблицы маршрутизации Azure.

secret_key

aliases: secret-key

any

(список) Секретный ключ доступа AWS.

secret_token

aliases: secret-token

string

Секретный токен сервисной учетной записи Kubernetes.

server

string

Адрес сервера удаленного SDN-коннектора.

server_ca_cert

aliases: server-ca-cert

string

Доверять только тем серверам, сертификаты которых непосредственно или косвенно подписаны этим сертификатом.

server_cert

aliases: server-cert

string

Доверять только серверам, содержащим этот сертификат.

server_ip

aliases: server-ip

string

IP-адрес удаленного SDN-коннектора.

server_list

aliases: server-list

any

(список) Список адресов серверов удаленного SDN-коннектора.

server_port

aliases: server-port

integer

Номер порта удаленного SDN-коннектора.

service_account

aliases: service-account

string

Адрес электронной почты сервисной учетной записи GCP.

status

string

Включить или отключить подключение к удаленному SDN-коннектору.

Варианты:

  • "disable"
  • "enable"

subscription_id

aliases: subscription-id

string

Идентификатор подписки Azure.

tenant_id

aliases: tenant-id

string

Идентификатор клиента

type

string

Тип SDN-коннектора.

Варианты:

  • "aci"
  • "aws"
  • "nsx"
  • "nuage"
  • "azure"
  • "gcp"
  • "oci"
  • "openstack"
  • "kubernetes"
  • "vmware"
  • "acs"
  • "alicloud"
  • "sepm"
  • "aci-direct"
  • "ibm"
  • "nutanix"
  • "sap"

update_interval

aliases: update-interval

integer

Интервал обновления динамических объектов

updating

integer

Обновление.

use_metadata_iam

aliases: use-metadata-iam

string

Включить или отключить использование роли IAM из метаданных для вызова API.

Варианты:

  • "disable"
  • "enable"

user_id

aliases: user-id

string

Идентификатор пользователя.

username

string

Имя пользователя удаленного SDN-коннектора, используемое для входа.

vcenter_password

aliases: vcenter-password

any

(список) Пароль сервера VCenter для изоляции NSX.

vcenter_server

aliases: vcenter-server

string

Адрес сервера VCenter для изоляции NSX.

vcenter_username

aliases: vcenter-username

string

Имя пользователя сервера VCenter для изоляции NSX.

vdom

any

(список) Имя виртуального домена удаленного SDN-коннектора.

verify_certificate

aliases: verify-certificate

string

Включить или отключить проверку сертификата сервера.

Варианты:

  • "disable"
  • "enable"

vmx_image_url

aliases: vmx-image-url

string

URL размещенного в Интернете образа VMX.

vmx_service_name

aliases: vmx-service-name

string

Имя службы VMX.

vpc_id

aliases: vpc-id

string

Идентификатор VPC в AWS.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства. В качестве значения можно указать global и другие варианты, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 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 connection to SDN Connector.
      fortinet.fortimanager.fmgr_system_sdnconnector:
        bypass_validation: false
        adom: ansible
        state: present
        system_sdnconnector:
          azure_region: global # <value in [global, china, germany, ...]>
          # compartment_id: 1
          name: ansible-test-sdn
          password: fortinet
          server: ALL
          status: disable
          type: aws # <value in [aci, aws, nsx, ...]>

- 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 connections to SDN Connector
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_sdnconnector"
          params:
            adom: "ansible"
            sdn_connector: "your_value"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описательное сообщение в ответе API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager.

Возвращается: при сложном условии

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API