community.network.fmgr_device_provision_template – Управляет шаблонами настройки устройств в FortiManager.

Примечание

Этот плагин входит в коллекцию community.network (версия 1.3.0).

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

Для использования в плейбуке укажите: community.network.fmgr_device_provision_template.

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

Обзор

Позволяет редактировать и назначать шаблоны настройки устройств в FortiManager.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_enable_fortiguard строка	Варианты: none direct this-fmg	Включает обновления безопасности FortiGuard по умолчанию.
admin_fortianalyzer_target строка		Настраивает целевой объект faz.
admin_fortiguard_target строка		Настраивает целевой объект fortiguard. admin_enable_fortiguard должен быть установлен в "direct".
admin_gui_theme строка	Варианты: green red blue melongene mariner	Изменяет тему интерфейса администратора.
admin_http_port строка		Номер порта веб-интерфейса администратора без SSL.
admin_https_port строка		Номер порта веб-интерфейса администратора с SSL.
admin_https_redirect строка	Варианты: enable disable	Включает или отключает перенаправление с HTTP на HTTPS.
admin_language строка	Варианты: english simch japanese korean spanish trach french portuguese	Устанавливает язык веб-интерфейса администратора.
admin_switch_controller строка	Варианты: enable disable	Включает или отключает контроллер переключения.
admin_timeout строка		Таймаут администратора в минутах.
adom строка / обязательно		ADOM, к которому должна принадлежать конфигурация.
delete_provisioning_template строка		Если указано, все остальные параметры игнорируются. Указанный шаблон подготовки будет удалён.
device_unique_name строка / обязательно		Уникальное имя устройства, которое вы редактируете.
dns_primary_ipv4 строка		Основной IPv4 DNS-шлюз.
dns_secondary_ipv4 строка		Вторичный IPv4 DNS-шлюз.
dns_suffix строка		Устанавливает суффикс локального домена DNS.
mode строка	Варианты: add ← set delete update	Устанавливает один из трёх режимов управления объектом. Разрешает использование мягких добавлений вместо перезаписи существующих значений.
ntp_auth строка	Варианты: enable disable	Включает или отключает аутентификацию NTP.
ntp_auth_pwd строка		Устанавливает пароль аутентификации NTP.
ntp_server строка		Используется только с custom ntp_type — указывает IP-адрес сервера для синхронизации. Для нескольких серверов — через запятую.
ntp_status строка	Варианты: enable disable	Включает или отключает NTP.
ntp_sync_interval строка		Устанавливает интервал синхронизации NTP в минутах.
ntp_type строка	Варианты: fortiguard custom	Включает серверы fortiguard или пользовательские серверы в качестве источника NTP.
ntp_v3 строка	Варианты: enable disable	Включает или отключает ntpv3 (по умолчанию ntpv4).
provision_targets строка / обязательно		Дружественные имена устройств в FortiManager, которым нужно назначить шаблон подготовки. Список, разделенный запятыми.
provisioning_template строка / обязательно		Шаблон подготовки, который нужно применить (по умолчанию = default).
smtp_conn_sec строка	Варианты: none starttls smtps	Определяет уровень SSL для SMTP.
smtp_password строка		Пароль SMTP.
smtp_port строка		Номер порта SMTP.
smtp_replyto строка		Адрес SMTP ответа.
smtp_server строка		IPv4 адрес SMTP сервера.
smtp_source_ipv4 строка		Исходный IP-адрес SMTP.
smtp_username строка		Имя пользователя SMTP для аутентификации.
smtp_validate_cert строка	Варианты: enable disable	Включает или отключает проверку сертификата для SMTP.
snmp_status строка	Варианты: enable disable	Включает или отключает SNMP глобально.
snmp_v2c_id строка		Первичный ключ для сообщества SNMP. Должен быть уникальным!
snmp_v2c_name строка		Указывает имя сообщества v2c.
snmp_v2c_query_hosts_ipv4 строка		- Разрешенные IPv4-адреса или подсети для запросов SNMP v2c, через запятую ("10.7.220.59 255.255.255.0, 10.7.220.0 255.255.255.0").
snmp_v2c_query_port строка		Устанавливает порт запроса сообщества SNMP v2c.
snmp_v2c_query_status строка	Варианты: enable disable	Включает или отключает указанное сообщество v2c для запросов.
snmp_v2c_status строка	Варианты: enable disable	Включает или отключает указанное сообщество v2c.
snmp_v2c_trap_hosts_ipv4 строка		- IPv4-адреса хостов, которые должны получать SNMP v2c ловушки, через запятую, с маской ("10.7.220.59 255.255.255.255, 10.7.220.60 255.255.255.255").
snmp_v2c_trap_port строка		Устанавливает порт ловушек сообщества SNMP v2c.
snmp_v2c_trap_src_ipv4 строка		Исходный IPv4 адрес ловушек.
snmp_v2c_trap_status строка	Варианты: enable disable	Включает или отключает указанное сообщество v2c для ловушек.
snmpv3_auth_proto строка	Варианты: md5 sha	Протокол аутентификации SNMPv3.
snmpv3_auth_pwd строка		Пароль аутентификации SNMPv3. — в данный момент не зашифрован! Обеспечьте надлежащую защиту файла!
snmpv3_name строка		Имя пользователя SNMPv3.
snmpv3_notify_hosts строка		Список IPv4-хостов, которым нужно отправлять SNMPv3 ловушки. Список IPv4-адресов через запятую.
snmpv3_priv_proto строка	Варианты: aes des aes256 aes256cisco	Протокол защиты SNMPv3.
snmpv3_priv_pwd строка		Пароль защиты SNMPv3. — в данный момент не зашифрован! Обеспечьте надлежащую защиту файла!
snmpv3_queries строка	Варианты: enable disable	Разрешить snmpv3_queries.
snmpv3_query_port строка		Порт запросов SNMPv3.
snmpv3_security_level строка	Варианты: no-auth-no-priv auth-no-priv auth-priv	Уровень защиты SNMPv3.
snmpv3_source_ip строка		Исходный IPv4-адрес SNMPv3 для ловушек.
snmpv3_status строка	Варианты: enable disable	Пользователь SNMPv3 включён или отключён.
snmpv3_trap_rport строка		Удаленный порт ловушек SNMPv3.
snmpv3_trap_status строка	Варианты: enable disable	SNMPv3 ловушки включены или отключены.

syslog_certificate строка		Сертификат, используемый для связи с сервером Syslog, если включено шифрование.
syslog_enc_algorithm строка	Варианты: high low disable ← high-medium	Включить/выключить надежное syslogging с шифрованием TLS. выбор \| high \| Связь SSL с алгоритмами шифрования высокой сложности. выбор \| low \| SSL-связь с алгоритмами шифрования низкой сложности. выбор \| disable \| Отключить SSL-связь. выбор \| high-medium \| SSL-связь с алгоритмами шифрования высокой и средней сложности.
syslog_facility строка	Варианты: kernel user mail daemon auth syslog ← lpr news uucp cron authpriv ftp ntp audit alert clock local0 local1 local2 local3 local4 local5 local6 local7	Удаленная служба syslog. выбор \| kernel \| Сообщения ядра. выбор \| user \| Случайные сообщения уровня пользователя. выбор \| mail \| Почтовая система. выбор \| daemon \| Системные демоны. выбор \| auth \| Сообщения безопасности/авторизации. выбор \| syslog \| Сообщения, сгенерированные внутри syslog. выбор \| lpr \| Подсистема принтеров. выбор \| news \| Подсистема сетевых новостей. выбор \| uucp \| Подсистема сетевых новостей. выбор \| cron \| Демон часов. выбор \| authpriv \| Сообщения безопасности/авторизации (приватные). выбор \| ftp \| Демон FTP. выбор \| ntp \| Демон NTP. выбор \| audit \| Аудит журналов. выбор \| alert \| Оповещение о журнале. выбор \| clock \| Демон часов. выбор \| local0 \| Зарезервировано для локального использования. выбор \| local1 \| Зарезервировано для локального использования. выбор \| local2 \| Зарезервировано для локального использования. выбор \| local3 \| Зарезервировано для локального использования. выбор \| local4 \| Зарезервировано для локального использования. выбор \| local5 \| Зарезервировано для локального использования. выбор \| local6 \| Зарезервировано для локального использования. выбор \| local7 \| Зарезервировано для локального использования.
syslog_filter строка	Варианты: emergency alert critical error warning notification information debug	Устанавливает уровень ведения журнала для syslog.
syslog_mode строка	Варианты: udp ← legacy-reliable reliable	Удаленный журнал syslog по UDP/Надежному TCP. выбор \| udp \| Включить syslogging по UDP. выбор \| legacy-reliable \| Включить традиционное надежное syslogging по RFC3195 (Надежная доставка для Syslog). выбор \| reliable \| Включить надежное syslogging по RFC6587 (Передача сообщений Syslog по TCP).
syslog_port строка		Порт syslog, который будет установлен.
syslog_server строка		Сервер, на который будут отправлены syslogs.
syslog_status строка	Варианты: enable disable	Включает или отключает syslogs.

Примечания

Примечание

Полная документация по адресу https://ftnt-ansible-docs.readthedocs.io/en/latest/.

Примеры

- name: SET SNMP SYSTEM INFO
  community.network.fmgr_device_provision_template:
    provisioning_template: "default"
    snmp_status: "enable"
    mode: "set"

- name: SET SNMP SYSTEM INFO ANSIBLE ADOM
  community.network.fmgr_device_provision_template:
    provisioning_template: "default"
    snmp_status: "enable"
    mode: "set"
    adom: "ansible"

- name: SET SNMP SYSTEM INFO different template (SNMPv2)
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    snmp_status: "enable"
    mode: "set"
    adom: "ansible"
    snmp_v2c_query_port: "162"
    snmp_v2c_trap_port: "161"
    snmp_v2c_status: "enable"
    snmp_v2c_trap_status: "enable"
    snmp_v2c_query_status: "enable"
    snmp_v2c_name: "ansibleV2c"
    snmp_v2c_id: "1"
    snmp_v2c_trap_src_ipv4: "10.7.220.41"
    snmp_v2c_trap_hosts_ipv4: "10.7.220.59 255.255.255.255, 10.7.220.60 255.255.255.255"
    snmp_v2c_query_hosts_ipv4: "10.7.220.59 255.255.255.255, 10.7.220.0 255.255.255.0"

- name: SET SNMP SYSTEM INFO different template (SNMPv3)
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    snmp_status: "enable"
    mode: "set"
    adom: "ansible"
    snmpv3_auth_proto: "sha"
    snmpv3_auth_pwd: "fortinet"
    snmpv3_name: "ansibleSNMPv3"
    snmpv3_notify_hosts: "10.7.220.59,10.7.220.60"
    snmpv3_priv_proto: "aes256"
    snmpv3_priv_pwd: "fortinet"
    snmpv3_queries: "enable"
    snmpv3_query_port: "161"
    snmpv3_security_level: "auth_priv"
    snmpv3_source_ip: "0.0.0.0"
    snmpv3_status: "enable"
    snmpv3_trap_rport: "162"
    snmpv3_trap_status: "enable"

- name: SET SYSLOG INFO
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    mode: "set"
    adom: "ansible"
    syslog_server: "10.7.220.59"
    syslog_port: "514"
    syslog_mode: "disable"
    syslog_status: "enable"
    syslog_filter: "information"

- name: SET NTP TO FORTIGUARD
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    mode: "set"
    adom: "ansible"
    ntp_status: "enable"
    ntp_sync_interval: "60"
    type: "fortiguard"

- name: SET NTP TO CUSTOM SERVER
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    mode: "set"
    adom: "ansible"
    ntp_status: "enable"
    ntp_sync_interval: "60"
    ntp_type: "custom"
    ntp_server: "10.7.220.32,10.7.220.1"
    ntp_auth: "enable"
    ntp_auth_pwd: "fortinet"
    ntp_v3: "disable"

- name: SET ADMIN GLOBAL SETTINGS
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    mode: "set"
    adom: "ansible"
    admin_https_redirect: "enable"
    admin_https_port: "4433"
    admin_http_port: "8080"
    admin_timeout: "30"
    admin_language: "english"
    admin_switch_controller: "enable"
    admin_gui_theme: "blue"
    admin_enable_fortiguard: "direct"
    admin_fortiguard_target: "10.7.220.128"
    admin_fortianalyzer_target: "10.7.220.61"

- name: SET CUSTOM SMTP SERVER
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    mode: "set"
    adom: "ansible"
    smtp_username: "ansible"
    smtp_password: "fortinet"
    smtp_port: "25"
    smtp_replyto: "ansible@do-not-reply.com"
    smtp_conn_sec: "starttls"
    smtp_server: "10.7.220.32"
    smtp_source_ipv4: "0.0.0.0"
    smtp_validate_cert: "disable"

- name: SET DNS SERVERS
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    mode: "set"
    adom: "ansible"
    dns_suffix: "ansible.local"
    dns_primary_ipv4: "8.8.8.8"
    dns_secondary_ipv4: "4.4.4.4"

- name: SET PROVISIONING TEMPLATE DEVICE TARGETS IN FORTIMANAGER
  community.network.fmgr_device_provision_template:
    provisioning_template: "ansibleTest"
    mode: "set"
    adom: "ansible"
    provision_targets: "FGT1, FGT2"

- name: DELETE ENTIRE PROVISIONING TEMPLATE
  community.network.fmgr_device_provision_template:
    delete_provisioning_template: "ansibleTest"
    mode: "delete"
    adom: "ansible"

Значения возврата

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

Ключ	Возвращаемое значение	Описание
api_result строка	всегда	полный ответ API, включает код состояния и сообщение

Авторы

Luke Weighall (@lweighall)
Andrew Welsh (@Ghilli3)
Jim Huber (@p4r4n0y1ng)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/fmgr_device_provision_template_module.html