Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_vpnmgr_vpntable модуль – Vpnmgr vpntable

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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

строка

Токен для доступа к 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"

vpnmgr_vpntable

словарь

Настройка параметров верхнего уровня.

authmethod

строка

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

Варианты:

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

auto_zone_policy

строка

Устарело, пожалуйста, переименуйте на auto_zone_policy. Автоматическая политика зоны.

Варианты:

  • "disable"
  • "enable"

certificate

любой

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

description

строка

Описание.

dpd

строка

Dpd.

Варианты:

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

dpd_retrycount

целое число

Устарело, пожалуйста, переименуйте на dpd_retrycount. Повтор попыток dpd.

dpd_retryinterval

любой

(список) Устарело, пожалуйста, переименуйте на dpd_retryinterval. Интервал повтора попыток dpd.

fcc_enforcement

строка

Устарело, пожалуйста, переименуйте на fcc_enforcement. Принудительное выполнение FCC.

Варианты:

  • "disable"
  • "enable"

hub2spoke_zone

любой

(список или строка) Устарело, пожалуйста, переименуйте на hub2spoke_zone. Зона hub2spoke.

ike_version

строка

Устарело, пожалуйста, переименуйте на ike_version. Версия IKE.

Варианты:

  • "1"
  • "2"

ike1dhgroup

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

Ike1dhgroup.

Выбор:

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

ike1dpd

строка

Ike1dpd.

Выбор:

  • "disable"
  • "enable"

ike1keylifesec

целое число

Ike1keylifesec.

ike1localid

строка

Ike1localid.

ike1mode

строка

Ike1mode.

Выбор:

  • "main"
  • "aggressive"

ike1natkeepalive

целое число

Ike1natkeepalive.

ike1nattraversal

строка

Ike1nattraversal.

Выбор:

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

ike1proposal

строка

Ike1proposal.

Выбор:

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

строка

Ike2autonego.

Выбор:

  • "disable"
  • "enable"

ike2dhgroup

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

Ike2dhgroup.

Выбор:

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

ike2keepalive

строка

Ike2keepalive.

Выбор:

  • "disable"
  • "enable"

ike2keylifekbs

целое число

Ike2keylifekbs.

ike2keylifesec

целое число

Ike2keylifesec.

ike2keylifetype

строка

Ike2keylifetype.

Выбор:

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

ike2proposal

string

Ike2proposal.

Choices:

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

inter-vdom

string

Устарело, переименуйте в inter_vdom. Inter vdom.

Choices:

  • "disable"
  • "enable"

intf-mode

string

Устарело, переименуйте в intf_mode. Intf mode.

Choices:

  • "off"
  • "on"

localid-type

string

Устарело, переименуйте в localid_type. Localid type.

Choices:

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

name

string / required

Имя.

negotiate-timeout

integer

Устарело, переименуйте в negotiate_timeout. Время ожидания согласования.

network-id

integer

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

network-overlay

string

Устарело, переименуйте в network_overlay. Наложение сети.

Choices:

  • "disable"
  • "enable"

npu-offload

string

Устарело, переименуйте в npu_offload. Npu offload.

Choices:

  • "disable"
  • "enable"

pfs

string

Pfs.

Choices:

  • "disable"
  • "enable"

psk-auto-generate

string

Устарело, переименуйте в psk_auto_generate. Автоматическая генерация PSK.

Choices:

  • "disable"
  • "enable"

psksecret

any

(list) Psksecret.

replay

string

Запись повторных запросов.

Choices:

  • "disable"
  • "enable"

rsa-certificate

string

Устарело, переименуйте в rsa_certificate. RSA сертификат.

spoke2hub-zone

any

(list or str) Устарело, переименуйте в spoke2hub_zone. Зона spoke2hub.

topology

string

Топология.

Choices:

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

vpn-zone

any

(list or str) Устарело, переименуйте в vpn_zone. VPN зона.

workspace_locking_adom

строка

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

workspace_locking_timeout

целое число

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

По умолчанию: 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Vpnmgr vpntable
      fortinet.fortimanager.fmgr_vpnmgr_vpntable:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        vpnmgr_vpntable:
          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, ...]>
          name: <string>
          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

словарь

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

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

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

Spec-Zone.ru

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