Spec-Zone.ru › Ansible

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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

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

adom

строка / обязательно

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

bypass_validation

логическое значение

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

Варианты:

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

enable_log

логическое значение

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

Варианты:

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

forticloud_access_token

строка

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

proposed_method

строка

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

Варианты:

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

rc_failed

список / элементы=целое число

Список rc-кодов, с которыми будут переопределены условия завершения задачи с ошибкой.

rc_succeeded

список / элементы=целое число

Список rc-кодов, с которыми будут переопределены условия завершения задачи успешно.

state

строка / обязательно

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

system_sdnconnector

словарь

Установленные параметры верхнего уровня.

_local_cert

строка

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

access-key

строка

Устарело, пожалуйста, переименуйте на access_key. Идентификатор ключа доступа AWS.

alt-resource-ip

строка

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

Варианты:

  • "disable"
  • "enable"

api-key

любой тип

(список) Устарело, пожалуйста, переименуйте на api_key. Ключ API IBM cloud или служебный идентификатор ключа API.

azure-region

строка

Устарело, пожалуйста, переименуйте на azure_region. Регион сервера Azure.

Варианты:

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

client-id

строка

Устарело, пожалуйста, переименуйте на client_id. Идентификатор клиента Azure

client-secret

любой тип

(список) Устарело, пожалуйста, переименуйте на client_secret. Секрет клиента Azure

compartment-id

строка

Устарело, пожалуйста, переименуйте на compartment_id. Идентификатор компармента.

compartment-list

список / элементы=словарь

Устарело, пожалуйста, переименуйте на compartment_list. Список компарментов.

compartment-id

строка

Устарело, пожалуйста, переименуйте на compartment_id. Идентификатор компармента OCI.

compute-generation

целое число

Устарело, пожалуйста, переименуйте на compute_generation. Вычислительное поколение для инфраструктуры IBM cloud.
END_OF_DOCUMENT_MARKER

domain

string

Домен Openstack.

external-account-list

list / elements=dictionary

Устарело, переименуйте в external_account_list. Список внешних учетных записей.

external-id

string

Устарело, переименуйте в external_id. Внешний ID AWS.

region-list

any

(list) Устарело, переименуйте в region_list. Список имен регионов AWS.

role-arn

string

Устарело, переименуйте в role_arn. ARN роли AWS для принятия.

external-ip

list / elements=dictionary

Устарело, переименуйте в external_ip. Внешний IP.

name

string

Имя внешнего IP.

forwarding-rule

list / elements=dictionary

Устарело, переименуйте в forwarding_rule. Правило переадресации.

rule-name

string

Устарело, переименуйте в rule_name. Имя правила переадресации.

target

string

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

gcp-project

string

Устарело, переименуйте в gcp_project. Имя проекта GCP.

gcp-project-list

list / elements=dictionary

Устарело, переименуйте в gcp_project_list. Список проектов GCP.

gcp-zone-list

any

(list) Устарело, переименуйте в gcp_zone_list. Настройка списка зон GCP.

id

string

ID проекта GCP.

group-name

string

Устарело, переименуйте в group_name. Имя группы компьютеров.

ha-status

string

Устарело, переименуйте в ha_status. Включить/отключить использование для службы FortiGate HA.

Варианты:

  • "disable"
  • "enable"

ibm-region

string

Устарело, переименуйте в ibm_region. Имя региона облака IBM.

Варианты:

  • "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"

ibm-region-gen1

string

Устарело, переименуйте в ibm_region_gen1. Регион IBM gen1.

Варианты:

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

ibm-region-gen2

string

Устарело, переименуйте в ibm_region_gen2. Регион IBM gen2.

Варианты:

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

key-passwd

any

(list) Устарело, переименуйте в key_passwd. Пароль от приватного ключа.

last-update

integer

Устарело, переименуйте в last_update. Последнее обновление.

login-endpoint

string

Устарело, переименуйте в login_endpoint. Точка входа Azure Stack.

name

string / required

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

nic

list / elements=dictionary

Nic.

ip

list / elements=dictionary

Ip.

name

string

Имя IP-конфигурации.

public-ip

string

Устарело, переименуйте в public_ip. Имя публичного IP.

resource-group

string

Устарело, переименуйте в resource_group. Группа ресурсов публичного IP Azure.

name

string

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

nsx-cert-fingerprint

string

Устарело, переименуйте в nsx_cert_fingerprint. Отпечаток сертификата NSX.

oci-cert

string

Устарело, переименуйте в oci_cert. Сертификат OCI.

oci-fingerprint

string

Устарело, переименуйте в oci_fingerprint. Отпечаток OCI.

oci-region

string

Устарело, переименуйте в oci_region. Регион сервера OCI.

Варианты:

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

oci-region-list

list / elements=dictionary

Устарело, переименуйте в oci_region_list. Список регионов OCI.

region

string

Регион OCI.

oci-region-type

string

Устарело, переименуйте в oci_region_type. Тип региона OCI.

Варианты:

  • "commercial"
  • "government"

password

any

(list) Пароль удаленного SDN-коннектора в качестве учетных данных для входа.

private-key

string

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

proxy

string

Прокси SDN.

region

string

Имя региона AWS.

resource-group

string

Устарело, переименуйте в resource_group. Группа ресурсов Azure.

resource-url

string

Устарело, переименуйте в resource_url. URL-адрес ресурса Azure Stack.

rest-interface

string

Устарело, переименуйте в rest_interface. Имя интерфейса для прослушивания REST-сервиса.

Варианты:

  • "mgmt"
  • "sync"

rest-password

any

(list) Устарело, переименуйте в rest_password. Пароль для REST-сервиса.

rest-sport

integer

Устарело, переименуйте в rest_sport. Порт доступа REST-сервиса.

rest-ssl

string

Устарело, переименуйте в rest_ssl. Rest ssl.

Choices:

  • "disable"
  • "enable"

route

list / elements=dictionary

Маршрут.

name

string

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

route-table

list / elements=dictionary

Устарело, переименуйте в route_table. Таблица маршрутизации.

name

string

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

resource-group

string

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

route

list / elements=dictionary

Маршрут.

name

string

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

next-hop

string

Устарело, переименуйте в next_hop. Адрес следующего перехода.

subscription-id

string

Устарело, переименуйте в subscription_id. ID подписки таблицы маршрутизации Azure.

secret-key

any

(list) Устарело, переименуйте в secret_key. Секретный ключ доступа AWS.

secret-token

string

Устарело, переименуйте в secret_token. Секретный токен учетной записи службы Kubernetes.

server

string

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

server-ca-cert

string

Устарело, переименуйте в server_ca_cert. Доверять только тем серверам, сертификат которых напрямую/косвенно подписан…

server-cert

string

Устарело, переименуйте в server_cert. Доверять только тем серверам, которые содержат этот сертификат.

server-ip

string

Устарело, переименуйте в server_ip. IP-адрес удаленного SDN-коннектора.

server-list

any

(list) Устарело, переименуйте в server_list. Список серверных адресов удаленного SDN-коннектора.

server-port

integer

Устарело, переименуйте в server_port. Номер порта удаленного SDN-коннектора.

service-account

string

Устарело, переименуйте в service_account. Электронная почта учетной записи службы GCP.

status

string

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

Choices:

  • "disable"
  • "enable"

subscription-id

string

Устарело, переименуйте в subscription_id. ID подписки Azure.

tenant-id

string

Устарело, переименуйте в tenant_id. ID клиента.

тип

строка

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

Варианты:

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

интервал-обновления

целое число

Устаревшее, пожалуйста, переименуйте на update_interval. Интервал обновления динамического объекта

обновление

целое число

Обновление.

использовать-метаданные-iam

строка

Устаревшее, пожалуйста, переименуйте на use_metadata_iam. Включить/выключить использование роли IAM из метаданных для вызова API.

Варианты:

  • "disable"
  • "enable"

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

строка

Устаревшее, пожалуйста, переименуйте на user_id. Идентификатор пользователя.

имя-пользователя

строка

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

пароль-vcenter

любой

(список) Устаревшее, пожалуйста, переименуйте на vcenter_password. Пароль сервера VCenter для карантина NSX.

сервер-vcenter

строка

Устаревшее, пожалуйста, переименуйте на vcenter_server. Адрес сервера VCenter для карантина NSX.

имя-пользователя-vcenter

строка

Устаревшее, пожалуйста, переименуйте на vcenter_username. Имя пользователя сервера VCenter для карантина NSX.

проверка-сертификата

строка

Устаревшее, пожалуйста, переименуйте на verify_certificate. Включить/выключить проверку сертификата сервера.

Варианты:

  • "disable"
  • "enable"

url-изображения-vmx

строка

Устаревшее, пожалуйста, переименуйте на vmx_image_url. URL веб-хостированного изображения VMX.

имя-службы-vmx

строка

Устаревшее, пожалуйста, переименуйте на vmx_service_name. Имя службы VMX.

id-vpc

строка

Устаревшее, пожалуйста, переименуйте на vpc_id. Идентификатор AWS VPC.

блокировка_рабочего_пространства_adom

строка

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

срок_блокировки_рабочего_пространства

целое число

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

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

Примечания

Примечание

  • Начиная с версии 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 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

словарь

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

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

request_url

строка

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

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

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

response_code

целое число

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

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

Пример: 0

response_data

список / элементы=строка

Ответ API.

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

response_message

строка

Дескриптивное сообщение ответа API.

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

Пример: "OK."

system_information

словарь

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

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

rc

целое число

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

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

Пример: 0

version_check_warning

список / элементы=строка

Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–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_module.html

Spec-Zone.ru

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