Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_vpnmgr_vpntable – таблица Vpnmgr

Примечание

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

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

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

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

Добавлено в 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"

vpnmgr_vpntable

dictionary

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

authmethod

string

Метод аутентификации.

Варианты:

  • "psk"
  • "rsa-signature"
  • "signature"

auto_zone_policy

псевдонимы: auto-zone-policy

string

Автоматическая политика зоны.

Варианты:

  • "disable"
  • "enable"

certificate

any

(список или строка) Сертификат.

description

string

Описание.

dpd

string

DPD.

Варианты:

  • "disable"
  • "enable"
  • "on-idle"
  • "on-demand"

dpd_retrycount

псевдонимы: dpd-retrycount

integer

Количество повторных попыток DPD.

dpd_retryinterval

псевдонимы: dpd-retryinterval

any

(список) Интервал повторных попыток DPD.

fcc_enforcement

псевдонимы: fcc-enforcement

string

Принудительное применение FCC.

Варианты:

  • "disable"
  • "enable"

hub2spoke_zone

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

any

(список или строка) Зона hub-to-spoke.

ike1dhgroup

list / элементы=string

Группа Диффи — Хеллмана для IKE 1.

Варианты:

  • "1"
  • "2"
  • "5"
  • "14"
  • "15"
  • "16"
  • "17"
  • "18"
  • "19"
  • "20"
  • "21"
  • "27"
  • "28"
  • "29"
  • "30"
  • "31"
  • "32"

ike1dpd

string

DPD для IKE 1.

Варианты:

  • "disable"
  • "enable"

ike1keylifesec

integer

Время жизни ключа IKE 1 в секундах.

ike1localid

string

Локальный идентификатор IKE 1.

ike1mode

string

Режим IKE 1.

Варианты:

  • "main"
  • "aggressive"

ike1natkeepalive

integer

Интервал поддержания активности NAT для IKE 1.

ike1nattraversal

string

Обход NAT для IKE 1.

Варианты:

  • "disable"
  • "enable"
  • "forced"

ike1proposal

string

Предложение IKE 1.

Варианты:

  • "des-md5"
  • "des-sha1"
  • "3des-md5"
  • "3des-sha1"
  • "aes128-md5"
  • "aes128-sha1"
  • "aes192-md5"
  • "aes192-sha1"
  • "aes256-md5"
  • "aes256-sha1"
  • "des-sha256"
  • "3des-sha256"
  • "aes128-sha256"
  • "aes192-sha256"
  • "aes256-sha256"
  • "des-sha384"
  • "des-sha512"
  • "3des-sha384"
  • "3des-sha512"
  • "aes128-sha384"
  • "aes128-sha512"
  • "aes192-sha384"
  • "aes192-sha512"
  • "aes256-sha384"
  • "aes256-sha512"
  • "aria128-md5"
  • "aria128-sha1"
  • "aria128-sha256"
  • "aria128-sha384"
  • "aria128-sha512"
  • "aria192-md5"
  • "aria192-sha1"
  • "aria192-sha256"
  • "aria192-sha384"
  • "aria192-sha512"
  • "aria256-md5"
  • "aria256-sha1"
  • "aria256-sha256"
  • "aria256-sha384"
  • "aria256-sha512"
  • "seed-md5"
  • "seed-sha1"
  • "seed-sha256"
  • "seed-sha384"
  • "seed-sha512"
  • "aes128gcm-prfsha1"
  • "aes128gcm-prfsha256"
  • "aes128gcm-prfsha384"
  • "aes128gcm-prfsha512"
  • "aes256gcm-prfsha1"
  • "aes256gcm-prfsha256"
  • "aes256gcm-prfsha384"
  • "aes256gcm-prfsha512"
  • "chacha20poly1305-prfsha1"
  • "chacha20poly1305-prfsha256"
  • "chacha20poly1305-prfsha384"
  • "chacha20poly1305-prfsha512"

ike2autonego

string

Автоматическое согласование IKE 2.

Варианты:

  • "disable"
  • "enable"

ike2dhgroup

list / элементы=string

Группа Диффи — Хеллмана для IKE 2.

Варианты:

  • "1"
  • "2"
  • "5"
  • "14"
  • "15"
  • "16"
  • "17"
  • "18"
  • "19"
  • "20"
  • "21"
  • "27"
  • "28"
  • "29"
  • "30"
  • "31"
  • "32"

ike2keepalive

string

Поддержание активности IKE 2.

Варианты:

  • "disable"
  • "enable"

ike2keylifekbs

integer

Время жизни ключа IKE 2 в КБ.

ike2keylifesec

integer

Время жизни ключа IKE 2 в секундах.

ike2keylifetype

string

Тип времени жизни ключа IKE 2.

Варианты:

  • "seconds"
  • "kbs"
  • "both"

ike2proposal

string

Предложение IKE 2.

Варианты:

  • "null-md5"
  • "null-sha1"
  • "des-null"
  • "3des-null"
  • "des-md5"
  • "des-sha1"
  • "3des-md5"
  • "3des-sha1"
  • "aes128-md5"
  • "aes128-sha1"
  • "aes192-md5"
  • "aes192-sha1"
  • "aes256-md5"
  • "aes256-sha1"
  • "aes128-null"
  • "aes192-null"
  • "aes256-null"
  • "null-sha256"
  • "des-sha256"
  • "3des-sha256"
  • "aes128-sha256"
  • "aes192-sha256"
  • "aes256-sha256"
  • "des-sha384"
  • "des-sha512"
  • "3des-sha384"
  • "3des-sha512"
  • "aes128-sha384"
  • "aes128-sha512"
  • "aes192-sha384"
  • "aes192-sha512"
  • "aes256-sha384"
  • "aes256-sha512"
  • "null-sha384"
  • "null-sha512"
  • "aria128-null"
  • "aria128-md5"
  • "aria128-sha1"
  • "aria128-sha256"
  • "aria128-sha384"
  • "aria128-sha512"
  • "aria192-null"
  • "aria192-md5"
  • "aria192-sha1"
  • "aria192-sha256"
  • "aria192-sha384"
  • "aria192-sha512"
  • "aria256-null"
  • "aria256-md5"
  • "aria256-sha1"
  • "aria256-sha256"
  • "aria256-sha384"
  • "aria256-sha512"
  • "seed-null"
  • "seed-md5"
  • "seed-sha1"
  • "seed-sha256"
  • "seed-sha384"
  • "seed-sha512"
  • "aes128gcm"
  • "aes256gcm"
  • "chacha20poly1305"

ike_version

псевдонимы: ike-version

string

Версия IKE.

Варианты:

  • "1"
  • "2"

inter_vdom

псевдонимы: inter-vdom

string

Между VDOM.

Варианты:

  • "disable"
  • "enable"

intf_mode

псевдонимы: intf-mode

string

Режим интерфейса.

Варианты:

  • "off"
  • "on"

localid_type

псевдонимы: localid-type

string

Тип локального идентификатора.

Варианты:

  • "auto"
  • "fqdn"
  • "user-fqdn"
  • "keyid"
  • "address"
  • "asn1dn"

name

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

Имя.

negotiate_timeout

псевдонимы: negotiate-timeout

integer

Тайм-аут согласования.

network_id

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

integer

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

network_overlay

псевдонимы: network-overlay

string

Сетевая оверлейная сеть.

Варианты:

  • "disable"
  • "enable"

npu_offload

псевдонимы: npu-offload

string

Разгрузка на NPU.

Варианты:

  • "disable"
  • "enable"

pfs

string

Совершенная прямая секретность (PFS).

Варианты:

  • "disable"
  • "enable"

psk_auto_generate

псевдонимы: psk-auto-generate

string

Автоматическая генерация PSK.

Варианты:

  • "disable"
  • "enable"

psksecret

any

(list) Секрет PSK.

replay

string

Защита от повторного воспроизведения.

Варианты:

  • "disable"
  • "enable"

rsa_certificate

псевдонимы: rsa-certificate

string

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

spoke2hub_zone

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

any

(list или str) Зона Spoke2hub.

topology

string

Топология.

Варианты:

  • "meshed"
  • "star"
  • "dialup"

vpn_zone

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

any

(list или str) Зона VPN.

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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Vpnmgr vpntable
      fortinet.fortimanager.fmgr_vpnmgr_vpntable:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        vpnmgr_vpntable:
          name: "your value" # Required variable, string
          # authmethod: <value in [psk, rsa-signature, signature]>
          # auto_zone_policy: <value in [disable, enable]>
          # certificate: <list or string>
          # description: <string>
          # dpd: <value in [disable, enable, on-idle, ...]>
          # dpd_retrycount: <integer>
          # dpd_retryinterval: <list or integer>
          # fcc_enforcement: <value in [disable, enable]>
          # hub2spoke_zone: <list or string>
          # ike_version: <value in [1, 2]>
          # ike1dhgroup: ["1", "2", "5", "14", "15", "16", "17", "18", "19", "20", "21", "27",
          #               "28", "29", "30", "31", "32"]
          # ike1dpd: <value in [disable, enable]>
          # ike1keylifesec: <integer>
          # ike1localid: <string>
          # ike1mode: <value in [main, aggressive]>
          # ike1natkeepalive: <integer>
          # ike1nattraversal: <value in [disable, enable, forced]>
          # ike1proposal: <value in [des-md5, des-sha1, 3des-md5, ...]>
          # ike2autonego: <value in [disable, enable]>
          # ike2dhgroup: ["1", "2", "5", "14", "15", "16", "17", "18", "19", "20", "21", "27",
          #               "28", "29", "30", "31", "32"]
          # ike2keepalive: <value in [disable, enable]>
          # ike2keylifekbs: <integer>
          # ike2keylifesec: <integer>
          # ike2keylifetype: <value in [seconds, kbs, both]>
          # ike2proposal: <value in [null-md5, null-sha1, des-null, ...]>
          # inter_vdom: <value in [disable, enable]>
          # intf_mode: <value in [off, on]>
          # localid_type: <value in [auto, fqdn, user-fqdn, ...]>
          # negotiate_timeout: <integer>
          # npu_offload: <value in [disable, enable]>
          # pfs: <value in [disable, enable]>
          # psk_auto_generate: <value in [disable, enable]>
          # psksecret: <list or string>
          # replay: <value in [disable, enable]>
          # rsa_certificate: <string>
          # spoke2hub_zone: <list or string>
          # topology: <value in [meshed, star, dialup]>
          # vpn_zone: <list or string>
          # network_id: <integer>
          # network_overlay: <value in [disable, enable]>

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

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

Ключ

Описание

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_vpnmgr_vpntable_module.html

Spec-Zone.ru

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