Модуль fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver – Настройка DHCP-серверов.

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver.

Новый в 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.
fsp_vlan_dhcpserver словарь	Установленные параметры верхнего уровня.
auto_configuration строка	Устарело, переименуйте на auto_configuration. Автоконфигурация. Варианты: `"disable"` `"enable"`
auto_managed_status строка	Устарело, переименуйте на auto_managed_status. Автоуправляемый статус. Варианты: `"disable"` `"enable"`
conflicted_ip_timeout целое число	Устарело, переименуйте на conflicted_ip_timeout. Таймаут конфликтующего IP.
ddns_auth строка	Устарело, переименуйте на ddns_auth. Авторизация DDNS. Варианты: `"disable"` `"tsig"`
ddns_key любой	(список или строка) Устарело, переименуйте на ddns_key. Ключ DDNS.
ddns_keyname строка	Устарело, переименуйте на ddns_keyname. Имя ключа DDNS.
ddns_server_ip строка	Устарело, переименуйте на ddns_server_ip. IP-адрес сервера DDNS.
ddns_ttl целое число	Устарело, переименуйте на ddns_ttl. DDNS TTL.
ddns_update строка	Устарело, переименуйте на ddns_update. Обновление DDNS. Варианты: `"disable"` `"enable"`
ddns_update_override строка	Устарело, переименуйте на ddns_update_override. Переопределение обновления DDNS. Варианты: `"disable"` `"enable"`
ddns_zone строка	Устарело, переименуйте на ddns_zone. Зона DDNS.
default_gateway строка	Устарело, переименуйте на default_gateway. Шлюз по умолчанию.
dhcp_settings_from_fortiipam строка	Устарело, переименуйте на dhcp_settings_from_fortiipam. Настройки DHCP из fortiipam. Варианты: `"disable"` `"enable"`
dns_server1 строка	Устарело, переименуйте на dns_server1. DNS-сервер 1.
dns_server2 строка	Устарело, переименуйте на dns_server2. DNS-сервер 2.

END_OF_DOCUMENT_MARKER

dns-server3 string	Устарело, переименуйте в dns_server3. Dns server3.
dns-server4 string	Устарело, переименуйте в dns_server4. Dns server4.
dns-service string	Устарело, переименуйте в dns_service. Dns service. Choices: `"default"` `"specify"` `"local"`
domain string	Домен.
enable string	Включить. Choices: `"disable"` `"enable"`
exclude-range list / elements=dictionary	Устарело, переименуйте в exclude_range. Исключить диапазон.
end-ip string	Устарело, переименуйте в end_ip. Конечный IP.
id integer	Id.
lease-time integer	Устарело, переименуйте в lease_time. Время аренды в секундах, 0 означает время аренды по умолчанию.
start-ip string	Устарело, переименуйте в start_ip. Начальный IP.
uci-match string	Устарело, переименуйте в uci_match. Включить/отключить идентификатор класса пользователя Choices: `"disable"` `"enable"`
uci-string any	(list) Устарело, переименуйте в uci_string. Одна или несколько строк UCI в кавычках, разделенные пробелами.
vci-match string	Устарело, переименуйте в vci_match. Включить/отключить идентификатор класса поставщика Choices: `"disable"` `"enable"`
vci-string any	(list) Устарело, переименуйте в vci_string. Одна или несколько строк VCI в кавычках, разделенные пробелами.
filename string	Имя файла.
forticlient-on-net-status string	Устарело, переименуйте в forticlient_on_net_status. Статус Forticlient в сети. Choices: `"disable"` `"enable"`
id integer	Id.
interface string	Интерфейс.
ip-mode string	Устарело, переименуйте в ip_mode. Режим IP. Choices: `"range"` `"usrgrp"`
ip-range list / elements=dictionary	Устарело, переименуйте в ip_range. Диапазон IP.
end-ip string	Устарело, переименуйте в end_ip. Конечный IP.
id integer	Id.
lease-time integer	Устарело, переименуйте в lease_time. Время аренды в секундах, 0 означает время аренды по умолчанию.

start-ip string	Устаревшее, пожалуйста, переименуйте на start_ip. Начальный IP-адрес.
uci-match string	Устаревшее, пожалуйста, переименуйте на uci_match. Включение/выключение идентификатора класса пользователя Варианты: `"disable"` `"enable"`
uci-string any	(список) Устаревшее, пожалуйста, переименуйте на uci_string. Один или несколько строк UCI в кавычках, разделенных пробелами.
vci-match string	Устаревшее, пожалуйста, переименуйте на vci_match. Включение/выключение идентификатора класса поставщика Варианты: `"disable"` `"enable"`
vci-string any	(список) Устаревшее, пожалуйста, переименуйте на vci_string. Один или несколько строк VCI в кавычках, разделенных пробелами.
ipsec-lease-hold integer	Устаревшее, пожалуйста, переименуйте на ipsec_lease_hold. Длительность аренды IPsec.
lease-time integer	Устаревшее, пожалуйста, переименуйте на lease_time. Длительность аренды.
mac-acl-default-action string	Устаревшее, пожалуйста, переименуйте на mac_acl_default_action. Действие по умолчанию для MAC ACL. Варианты: `"assign"` `"block"`
netmask string	Маска сети.
next-server string	Устаревшее, пожалуйста, переименуйте на next_server. Следующий сервер.
ntp-server1 string	Устаревшее, пожалуйста, переименуйте на ntp_server1. NTP-сервер 1.
ntp-server2 string	Устаревшее, пожалуйста, переименуйте на ntp_server2. NTP-сервер 2.
ntp-server3 string	Устаревшее, пожалуйста, переименуйте на ntp_server3. NTP-сервер 3.
ntp-service string	Устаревшее, пожалуйста, переименуйте на ntp_service. NTP-сервис. Варианты: `"default"` `"specify"` `"local"`
option1 any	(список) Параметр 1.
option2 any	(список) Параметр 2.
option3 any	(список) Параметр 3.
option4 string	Параметр 4.
option5 string	Параметр 5.
option6 string	Параметр 6.
options list / elements=dictionary	Параметры.
code integer	Код.
id integer	Идентификатор.
ip any	(список) IP-адрес.

type string	Тип. Варианты: `"hex"` `"string"` `"ip"` `"fqdn"`
uci-match string	Устарело, переименуйте в uci_match. Включить/выключить идентификатор класса пользователя Варианты: `"disable"` `"enable"`
uci-string any	(список) Устарело, переименуйте в uci_string. Одна или более строк UCI в кавычках, разделенных пробелами.
value string	Значение.
vci-match string	Устарело, переименуйте в vci_match. Включить/выключить идентификатор класса поставщика Варианты: `"disable"` `"enable"`
vci-string any	(список) Устарело, переименуйте в vci_string. Одна или более строк VCI в кавычках, разделенных пробелами.
relay-agent string	Устарело, переименуйте в relay_agent. IP-адрес агента ретрансляции.
reserved-address list / elements=dictionary	Устарело, переименуйте в reserved_address. Зарезервированный адрес.
action string	Действие. Варианты: `"assign"` `"block"` `"reserved"`
circuit-id string	Устарело, переименуйте в circuit_id. Идентификатор цепи.
circuit-id-type string	Устарело, переименуйте в circuit_id_type. Тип идентификатора цепи. Варианты: `"hex"` `"string"`
description string	Описание.
id integer	Идентификатор.
ip string	IP-адрес.
mac string	MAC-адрес.
remote-id string	Устарело, переименуйте в remote_id. Удаленный идентификатор.
remote-id-type string	Устарело, переименуйте в remote_id_type. Тип удаленного идентификатора. Варианты: `"hex"` `"string"`
type string	Тип. Варианты: `"mac"` `"option82"`
server-type string	Устарело, переименуйте в server_type. Тип сервера. Варианты: `"regular"` `"ipsec"`
shared-subnet string	Устарело, переименуйте в shared_subnet. Включить/выключить общую подсеть. Варианты: `"disable"` `"enable"`
status string	Статус. Варианты: `"disable"` `"enable"`

tftp-server any	(list) Устарело, переименуйте в tftp_server. Tftp-сервер.
timezone string	Часовой пояс. Варианты: `"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"`
timezone-option string	Устарело, переименуйте в timezone_option. Параметр часового пояса. Варианты: `"disable"` `"default"` `"specify"`
vci-match string	Устарело, переименуйте в vci_match. Сопоставление VCI. Варианты: `"disable"` `"enable"`
vci-string any	(list) Устарело, переименуйте в vci_string. Строка VCI.
wifi-ac-service string	Устарело, переименуйте в wifi_ac_service. Служба Wifi AC. Варианты: `"specify"` `"local"`
wifi-ac1 string	Устарело, переименуйте в wifi_ac1. Wifi AC1.
wifi-ac2 string	Устарело, переименуйте в wifi_ac2. Wifi AC2.
wifi-ac3 string	Устарело, переименуйте в wifi_ac3. Wifi AC3.
wins-server1 string	Устарело, переименуйте в wins_server1. WINS-сервер 1.
wins-server2 string	Устарело, переименуйте в wins_server2. WINS-сервер 2.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми будут переопределены условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, с которыми будут переопределены условия успешного завершения.
vlan string / required	Параметр (vlan) в запрошенном URL.
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

Примеры

- 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: Configure DHCP servers.
      fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver:
        # 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>
        vlan: <your own value>
        fsp_vlan_dhcpserver:
          auto_configuration: <value in [disable, enable]>
          conflicted_ip_timeout: <integer>
          ddns_auth: <value in [disable, tsig]>
          ddns_key: <list or string>
          ddns_keyname: <string>
          ddns_server_ip: <string>
          ddns_ttl: <integer>
          ddns_update: <value in [disable, enable]>
          ddns_update_override: <value in [disable, enable]>
          ddns_zone: <string>
          default_gateway: <string>
          dns_server1: <string>
          dns_server2: <string>
          dns_server3: <string>
          dns_service: <value in [default, specify, local]>
          domain: <string>
          enable: <value in [disable, enable]>
          exclude_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
              vci_match: <value in [disable, enable]>
              vci_string: <list or string>
              lease_time: <integer>
              uci_match: <value in [disable, enable]>
              uci_string: <list or string>
          filename: <string>
          forticlient_on_net_status: <value in [disable, enable]>
          id: <integer>
          interface: <string>
          ip_mode: <value in [range, usrgrp]>
          ip_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
              vci_match: <value in [disable, enable]>
              vci_string: <list or string>
              lease_time: <integer>
              uci_match: <value in [disable, enable]>
              uci_string: <list or string>
          ipsec_lease_hold: <integer>
          lease_time: <integer>
          mac_acl_default_action: <value in [assign, block]>
          netmask: <string>
          next_server: <string>
          ntp_server1: <string>
          ntp_server2: <string>
          ntp_server3: <string>
          ntp_service: <value in [default, specify, local]>
          option1: <list or string>
          option2: <list or string>
          option3: <list or string>
          option4: <string>
          option5: <string>
          option6: <string>
          options:
            -
              code: <integer>
              id: <integer>
              ip: <list or string>
              type: <value in [hex, string, ip, ...]>
              value: <string>
              vci_match: <value in [disable, enable]>
              vci_string: <list or string>
              uci_match: <value in [disable, enable]>
              uci_string: <list or string>
          reserved_address:
            -
              action: <value in [assign, block, reserved]>
              circuit_id: <string>
              circuit_id_type: <value in [hex, string]>
              description: <string>
              id: <integer>
              ip: <string>
              mac: <string>
              remote_id: <string>
              remote_id_type: <value in [hex, string]>
              type: <value in [mac, option82]>
          server_type: <value in [regular, ipsec]>
          status: <value in [disable, enable]>
          tftp_server: <list or string>
          timezone: <value in [00, 01, 02, ...]>
          timezone_option: <value in [disable, default, specify]>
          vci_match: <value in [disable, enable]>
          vci_string: <list or string>
          wifi_ac1: <string>
          wifi_ac2: <string>
          wifi_ac3: <string>
          wins_server1: <string>
          wins_server2: <string>
          dns_server4: <string>
          wifi_ac_service: <value in [specify, local]>
          auto_managed_status: <value in [disable, enable]>
          dhcp_settings_from_fortiipam: <value in [disable, enable]>
          relay_agent: <string>
          shared_subnet: <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_fsp_vlan_dhcpserver_module.html