Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_fmupdate_fdssetting – Настройка параметров FortiGuard.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_fmupdate_fdssetting.

Добавлена в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bypass_validation
boolean
    Варианты:
  • нет ←
  • да
устанавливается только в том случае, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
fmupdate_fdssetting
словарь
настройка параметров верхнего уровня
fds-clt-ssl-protocol
строка
    Варианты:
  • sslv3
  • tlsv1.0
  • tlsv1.1
  • tlsv1.2 ←
Версия протокола SSL для подключения к серверу fds (по умолчанию = tlsv1.2).
sslv3 - устанавливает SSLv3 как клиентскую версию.
tlsv1.0 - устанавливает TLSv1.0 как клиентскую версию.
tlsv1.1 - устанавливает TLSv1.1 как клиентскую версию.
tlsv1.2 - устанавливает TLSv1.2 как клиентскую версию (по умолчанию).
fds-ssl-protocol
строка
    Варианты:
  • sslv3
  • tlsv1.0
  • tlsv1.1
  • tlsv1.2 ←
Версия протокола SSL для получения соединения fgt (по умолчанию = tlsv1.2).
sslv3 - устанавливает SSLv3 как минимальную версию.
tlsv1.0 - устанавливает TLSv1.0 как минимальную версию.
tlsv1.1 - устанавливает TLSv1.1 как минимальную версию.
tlsv1.2 - устанавливает TLSv1.2 как минимальную версию (по умолчанию).
fmtr-log
строка
    Варианты:
  • emergency
  • alert
  • critical
  • error
  • warn
  • notice
  • info ←
  • debug
  • disable
Уровень ведения журнала fmtr
emergency - Уровень ведения журнала - emergency
alert - Уровень ведения журнала - alert
critical - Уровень ведения журнала - critical
error - Уровень ведения журнала - error
warn - Уровень ведения журнала - warn
notice - Уровень ведения журнала - notice
info - Уровень ведения журнала - info
debug - Уровень ведения журнала - debug
disable - Отключение ведения журнала linkd
linkd-log
строка
    Варианты:
  • emergency
  • alert
  • critical
  • error
  • warn
  • notice
  • info ←
  • debug
  • disable
Уровень ведения журнала linkd (по умолчанию = info).
emergency - Уровень ведения журнала - emergency
alert - Уровень ведения журнала - alert
critical - Уровень ведения журнала - critical
error - Уровень ведения журнала - error
warn - Уровень ведения журнала - warn
notice - Уровень ведения журнала - notice
info - Уровень ведения журнала - info
debug - Уровень ведения журнала - debug
disable - Отключение ведения журнала linkd
max-av-ips-version
целое число
Значение по умолчанию:
20
Максимальное количество загружаемых полных версий пакетов AV/IPS (1 - 1000, по умолчанию = 20).
max-work
целое число
Значение по умолчанию:
1
Максимальное количество рабочих процессов для обработки запросов на загрузку (1 - 32, по умолчанию = 1).
push-override
словарь
нет описания
ip
строка
Значение по умолчанию:
"0.0.0.0"
Внешний или виртуальный IP-адрес устройства NAT, которое будет пересылать сообщения push на устройство FortiManager.
port
целое число
Значение по умолчанию:
9443
Порт приема на устройстве NAT (1 - 65535, по умолчанию = 9443).
status
строка
    Варианты:
  • выключить ←
  • включить
Включение/выключение push-обновлений для клиентов (по умолчанию = выключить).
выключить - Отключить настройку.
включить - Включить настройку.
push-override-to-client
словарь
нет описания
announce-ip
список / элементы=строка
нет описания
id
целое число
Значение по умолчанию:
0
Идентификатор объявляемого IP-адреса (1 - 10).
ip
строка
Значение по умолчанию:
"0.0.0.0"
Объявляемый IPv4-адрес.
port
целое число
Значение по умолчанию:
8890
Порт объявляемого IP (1 - 65535, по умолчанию = 8890).
status
строка
    Варианты:
  • выключить ←
  • включить
Включение/выключение push-обновлений (по умолчанию = выключить).
выключить - Отключить настройку.
включить - Включить настройку.
send_report
строка
    Варианты:
  • выключить
  • включить ←
Отправка отчета/fssi на сервер fds.
выключить - Отключить настройку.
включить - Включить настройку.
send_setup
строка
    Варианты:
  • выключить ←
  • включить
Пересылка настройки на сервер fds.
выключить - Отключить настройку.
включить - Включить настройку.
server-override
словарь
нет описания
servlist
список / элементы=строка
нет описания
id
целое число
Значение по умолчанию:
0
Идентификатор сервера для переопределения (1 - 10).
ip
строка
Значение по умолчанию:
"0.0.0.0"
IPv4-адрес сервера для переопределения.
ip6
строка
Значение по умолчанию:
"::"
IPv6-адрес сервера для переопределения.
port
целое число
Значение по умолчанию:
443
Номер порта для связи с FortiGuard (1 - 65535, по умолчанию = 443).
service-type
список / элементы=строка
    Варианты:
  • fds
  • fct
нет описания
status
строка
    Варианты:
  • выключить ←
  • включить
Статус переопределения.
выключить - Отключить настройку.
включить - Включить настройку.
system-support-fct
список / элементы=строка
    Варианты:
  • 4.x
  • 5.0
  • 5.2
  • 5.4
  • 5.6
  • 6.0
нет описания
system-support-fgt
список / элементы=строка
    Варианты:
  • 5.4
  • 5.6
  • 6.0
  • 6.2
нет описания
system-support-fml
список / элементы=строка
    Варианты:
  • 4.x
  • 5.x
  • 6.x
нет описания
system-support-fsa
список / элементы=строка
    Варианты:
  • 1.x
  • 2.x
  • 3.x
нет описания
system-support-fsw
список / элементы=строка
    Варианты:
  • 5.4
  • 5.6
  • 6.0
  • 6.2
нет описания
umsvc-log
строка
    Варианты:
  • emergency
  • alert
  • critical
  • error
  • warn
  • notice
  • info ←
  • debug
  • disable
Уровень ведения журнала um_service (по умолчанию = info).
emergency - Уровень ведения журнала - emergency
alert - Уровень ведения журнала - alert
critical - Уровень ведения журнала - critical
error - Уровень ведения журнала - error
warn - Уровень ведения журнала - warn
notice - Уровень ведения журнала - notice
info - Уровень ведения журнала - info
debug - Уровень ведения журнала - debug
disable - Отключение ведения журнала linkd
unreg-dev-option
string
    Варианты:
  • ignore
  • svc-only
  • svc-only ←
установите параметр для отключения устройств
ignore - Игнорировать все не зарегистрированные устройства.
svc-only - Разрешить запросы обновления без добавления устройства.
add-service - Добавить не зарегистрированные устройства и разрешить запрос обновления.
update-schedule
dictionary
нет описания
day
string
    Варианты:
  • Sunday
  • Monday ←
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
Настройте день, в который произойдёт обновление, если частота еженедельная (Sunday - Saturday, по умолчанию = Monday).
Sunday - Обновление каждое воскресенье.
Monday - Обновление каждое понедельник.
Tuesday - Обновление каждое вторник.
Wednesday - Обновление каждое среда.
Thursday - Обновление каждое четверг.
Friday - Обновление каждое пятница.
Saturday - Обновление каждое субботу.
frequency
string
    Варианты:
  • every ←
  • daily
  • weekly
Настройте частоту обновления: every - интервал времени, daily - ежедневно, weekly - еженедельно (по умолчанию = every).
every - Интервал времени.
daily - Ежедневно.
weekly - Еженедельно.
status
string
    Варианты:
  • disable
  • enable ←
Включить/отключить запланированные обновления.
disable - Отключить настройку.
enable - Включить настройку.
time
string
нет описания
User-Agent
string
Значение по умолчанию:
"Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)"
Настройте строку User-Agent.
wanip-query-mode
string
    Варианты:
  • disable ←
  • ipify
режим запроса публичного IP
disable - Не запрашивать публичный IP
ipify - Получить публичный IP через https://api.ipify.org
rc_failed
list / elements=string
список rc кодов, при которых условия выполнения будут отклонены
rc_succeeded
list / elements=string
список rc кодов, при которых условия выполнения будут приняты
state
string / required
    Варианты:
  • present
  • absent
директива для создания, обновления или удаления объекта
workspace_locking_adom
string
ADOM для блокировки при работе в режиме рабочей области FortiManager, значение может быть global и другими, включая root
workspace_locking_timeout
integer
Значение по умолчанию:
300
максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей области

Примечания

Примечание

  • Поддерживается работа в режиме блокировки рабочей области в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно модуль может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия для отказа или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure FortiGuard settings.
     fmgr_fmupdate_fdssetting:
        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, ...]
        fmupdate_fdssetting:
           User-Agent: <value of string>
           fds-clt-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
           fds-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
           fmtr-log: <value in [emergency, alert, critical, ...]>
           linkd-log: <value in [emergency, alert, critical, ...]>
           max-av-ips-version: <value of integer>
           max-work: <value of integer>
           push-override:
              ip: <value of string>
              port: <value of integer>
              status: <value in [disable, enable]>
           push-override-to-client:
              announce-ip:
                -
                    id: <value of integer>
                    ip: <value of string>
                    port: <value of integer>
              status: <value in [disable, enable]>
           send_report: <value in [disable, enable]>
           send_setup: <value in [disable, enable]>
           server-override:
              servlist:
                -
                    id: <value of integer>
                    ip: <value of string>
                    ip6: <value of string>
                    port: <value of integer>
                    service-type:
                      - fds
                      - fct
              status: <value in [disable, enable]>
           system-support-fct:
             - 4.x
             - 5.0
             - 5.2
             - 5.4
             - 5.6
             - 6.0
           system-support-fgt:
             - 5.4
             - 5.6
             - 6.0
             - 6.2
           system-support-fml:
             - 4.x
             - 5.x
             - 6.x
           system-support-fsa:
             - 1.x
             - 2.x
             - 3.x
           system-support-fsw:
             - 5.4
             - 5.6
             - 6.0
             - 6.2
           umsvc-log: <value in [emergency, alert, critical, ...]>
           unreg-dev-option: <value in [ignore, svc-only, add-service]>
           update-schedule:
              day: <value in [Sunday, Monday, Tuesday, ...]>
              frequency: <value in [every, daily, weekly]>
              status: <value in [disable, enable]>
              time: <value of string>
           wanip-query-mode: <value in [disable, ipify]>

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

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

Ключ Возвращаемое значение Описание
request_url
string
всегда
Полный запрашиваемый URL

Пример:
/sys/login/user
response_code
integer
всегда
Статус запроса API

response_message
string
всегда
Дескриптивное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_fmupdate_fdssetting_module.html

Spec-Zone.ru

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