Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_system_dhcp_server – Настройка DHCP-серверов.

Примечание

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

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

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

В версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательно
параметр (adom) в запрошенном URL
bypass_validation
логическое
    Варианты:
  • нет ←
  • да
устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
rc_failed
список / элементы=строка
список кодов rc, с которыми будут переопределены условия для отказа
rc_succeeded
список / элементы=строка
список кодов rc, с которыми будут переопределены условия для успеха
state
строка / обязательно
    Варианты:
  • present
  • absent
директива для создания, обновления или удаления объекта
system_dhcp_server
словарь
параметры верхнего уровня
auto-configuration
строка
    Варианты:
  • disable
  • enable
Включить/выключить автоматическую настройку.
conflicted-ip-timeout
целое число
Время в секундах, которое нужно подождать после удаления конфликтного IP-адреса из диапазона DHCP, прежде чем его можно будет повторно использовать.
ddns-auth
строка
    Варианты:
  • disable
  • tsig
Режим аутентификации DDNS.
ddns-key
строка
Ключ обновления DDNS (кодировка base 64).
ddns-keyname
строка
Имя ключа обновления DDNS.
ddns-server-ip
строка
IP-адрес сервера DDNS.
ddns-ttl
целое число
TTL.
ddns-update
строка
    Варианты:
  • disable
  • enable
Включить/выключить обновление DDNS для DHCP.
ddns-update-override
строка
    Варианты:
  • disable
  • enable
Включить/выключить переопределение обновления DDNS для DHCP.
ddns-zone
строка
Зона вашего доменного имени (например, DDNS.com).
default-gateway
строка
IP-адрес шлюза по умолчанию, назначенный сервером DHCP.
dns-server1
строка
DNS-сервер 1.
dns-server2
строка
DNS-сервер 2.
dns-server3
строка
DNS-сервер 3.
dns-service
строка
    Варианты:
  • default
  • specify
  • local
Параметры для назначения DNS-серверов клиентам DHCP.
domain
строка
Суффикс доменного имени для IP-адресов, которые сервер DHCP назначает клиентам.
exclude-range
список / элементы=строка
нет описания
end-ip
строка
Конец диапазона IP-адресов.
id
целое число
Идентификатор.
start-ip
строка
Начало диапазона IP-адресов.
filename
строка
Имя файла загрузки на сервере TFTP.
forticlient-on-net-status
строка
    Варианты:
  • disable
  • enable
Включить/выключить службу FortiClient-On-Net для этого сервера DHCP.
id
целое число
Идентификатор.
interface
строка
Сервер DHCP может назначать IP-конфигурации клиентам, подключенным к этому интерфейсу.
ip-mode
строка
    Варианты:
  • range
  • usrgrp
Метод, используемый для назначения IP-адреса клиенту.
ip-range
список / элементы=строка
нет описания
end-ip
строка
Конец диапазона IP-адресов.
id
целое число
Идентификатор.
start-ip
строка
Начало диапазона IP-адресов.
ipsec-lease-hold
целое число
Срок действия аренды DHCP по IPsec истекает через указанное количество секунд после отключения туннеля (0 для отключения принудительного истечения срока действия).
lease-time
целое число
Срок аренды в секундах, 0 означает неограниченный.
mac-acl-default-action
строка
    Варианты:
  • assign
  • block
Действие по умолчанию для управления доступом по MAC (разрешить или заблокировать назначение IP-настроек).
netmask
строка
Маска сети, назначенная сервером DHCP.
next-server
строка
IP-адрес сервера (например, сервера TFTP), с которого клиенты DHCP могут загружать файл загрузки.
ntp-server1
строка
NTP-сервер 1.
ntp-server2
строка
NTP-сервер 2.
ntp-server3
строка
NTP-сервер 3.
ntp-service
строка
    Варианты:
  • default
  • specify
  • local
Параметры для назначения серверов Network Time Protocol (NTP) клиентам DHCP.
options
список / элементы=строка
нет описания
code
целое число
Код DHCP-опции.
id
целое число
Идентификатор.
ip
строка
нет описания
type
строка
    Варианты:
  • hex
  • string
  • ip
  • fqdn
Тип DHCP-опции.
value
строка
Значение DHCP-опции.
reserved-address
список / элементы=строка
нет описания
action
строка
    Варианты:
  • assign
  • block
  • reserved
Параметры для конфигурации сервера DHCP с резервированным MAC-адресом.
description
строка
Описание.
id
целое число
Идентификатор.
ip
строка
IP-адрес, который нужно зарезервировать для MAC-адреса.
mac
строка
MAC-адрес клиента, которому будет назначен зарезервированный IP-адрес.
server-type
строка
    Варианты:
  • regular
  • ipsec
Сервер DHCP может быть обычным сервером DHCP или сервером DHCP с IPsec.
status
строка
    Варианты:
  • disable
  • enable
Включить/выключить эту конфигурацию DHCP.
tftp-server
строка
нет описания
timezone
строка
    Варианты:
  • 00
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • 08
  • 09
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
Выберите часовой пояс, который нужно назначить клиентам DHCP.
timezone-option
строка
    Варианты:
  • disable
  • default
  • specify
Параметры сервера DHCP для установки часового пояса клиентов.
vci-match
строка
    Варианты:
  • disable
  • enable
Включить/выключить соответствие идентификатору класса поставщика (VCI). При включении обслуживаются только запросы DHCP с соответствующим VCI.
vci-string
строка
нет описания
wifi-ac1
строка
IP-адрес WiFi контроллера доступа 1 (DHCP опция 138, RFC 5417).
wifi-ac2
строка
IP-адрес WiFi контроллера доступа 2 (DHCP опция 138, RFC 5417).
wifi-ac3
строка
IP-адрес WiFi контроллера доступа 3 (DHCP опция 138, RFC 5417).
wins-server1
строка
WINS сервер 1.
wins-server2
строка
WINS сервер 2.
workspace_locking_adom
строка
Область домена (adom), которая должна быть заблокирована для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корень.
workspace_locking_timeout
целое число
По умолчанию:
300
Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство.

Примечания

Примечание

  • Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код возврата. Вы также можете переопределить условия завершения ошибкой или успехом с помощью параметров 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 DHCP servers.
     fmgr_system_dhcp_server:
        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: <value in [present, absent]>
        system_dhcp_server:
           auto-configuration: <value in [disable, enable]>
           conflicted-ip-timeout: <value of integer>
           ddns-auth: <value in [disable, tsig]>
           ddns-key: <value of string>
           ddns-keyname: <value of string>
           ddns-server-ip: <value of string>
           ddns-ttl: <value of integer>
           ddns-update: <value in [disable, enable]>
           ddns-update-override: <value in [disable, enable]>
           ddns-zone: <value of string>
           default-gateway: <value of string>
           dns-server1: <value of string>
           dns-server2: <value of string>
           dns-server3: <value of string>
           dns-service: <value in [default, specify, local]>
           domain: <value of string>
           exclude-range:
             -
                 end-ip: <value of string>
                 id: <value of integer>
                 start-ip: <value of string>
           filename: <value of string>
           forticlient-on-net-status: <value in [disable, enable]>
           id: <value of integer>
           interface: <value of string>
           ip-mode: <value in [range, usrgrp]>
           ip-range:
             -
                 end-ip: <value of string>
                 id: <value of integer>
                 start-ip: <value of string>
           ipsec-lease-hold: <value of integer>
           lease-time: <value of integer>
           mac-acl-default-action: <value in [assign, block]>
           netmask: <value of string>
           next-server: <value of string>
           ntp-server1: <value of string>
           ntp-server2: <value of string>
           ntp-server3: <value of string>
           ntp-service: <value in [default, specify, local]>
           options:
             -
                 code: <value of integer>
                 id: <value of integer>
                 ip: <value of string>
                 type: <value in [hex, string, ip, ...]>
                 value: <value of string>
           reserved-address:
             -
                 action: <value in [assign, block, reserved]>
                 description: <value of string>
                 id: <value of integer>
                 ip: <value of string>
                 mac: <value of string>
           server-type: <value in [regular, ipsec]>
           status: <value in [disable, enable]>
           tftp-server: <value of string>
           timezone: <value in [00, 01, 02, ...]>
           timezone-option: <value in [disable, default, specify]>
           vci-match: <value in [disable, enable]>
           vci-string: <value of string>
           wifi-ac1: <value of string>
           wifi-ac2: <value of string>
           wifi-ac3: <value of string>
           wins-server1: <value of string>
           wins-server2: <value of string>

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

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

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

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

response_message
строка
всегда
Описание ответа 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_system_dhcp_server_module.html

Spec-Zone.ru

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