Spec-Zone.ru › Ansible

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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_dhcp_server.

Добавлено в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределяемый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых переопределяются условия неудачного выполнения.

rc_succeeded

list / elements=integer

Список кодов rc, для которых переопределяются условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание создать, обновить или удалить объект.

Варианты:

  • "present"
  • "absent"

system_dhcp_server

dictionary

Набор параметров верхнего уровня.

auto_configuration

псевдонимы: auto-configuration

string

Включить/отключить автоматическую настройку.

Варианты:

  • "disable"
  • "enable"

auto_managed_status

псевдонимы: auto-managed-status

string

Включить/отключить использование этого DHCP-сервера после назначения IP-адреса этому интерфейсу службой FortiIPAM.

Варианты:

  • "disable"
  • "enable"

conflicted_ip_timeout

псевдонимы: conflicted-ip-timeout

integer

Время в секундах, в течение которого следует ожидать после удаления конфликтующего IP-адреса из диапазона DHCP, прежде чем его можно будет использовать повторно.

ddns_auth

псевдонимы: ddns-auth

string

Режим аутентификации DDNS.

Варианты:

  • "disable"
  • "tsig"

ddns_key

псевдонимы: ddns-key

any

(список или строка) Ключ обновления DDNS

ddns_keyname

псевдонимы: ddns-keyname

string

Имя ключа обновления DDNS.

ddns_server_ip

псевдонимы: ddns-server-ip

string

IP-адрес сервера DDNS.

ddns_ttl

псевдонимы: ddns-ttl

integer

TTL.

ddns_update

псевдонимы: ddns-update

string

Включить/отключить обновление DDNS для DHCP.

Варианты:

  • "disable"
  • "enable"

ddns_update_override

псевдонимы: ddns-update-override

string

Включить/отключить переопределение обновления DDNS для DHCP.

Варианты:

  • "disable"
  • "enable"

ddns_zone

псевдонимы: ddns-zone

string

Зона доменного имени

default_gateway

псевдонимы: default-gateway

string

IP-адрес шлюза по умолчанию, назначаемый DHCP-сервером.

dhcp_settings_from_fortiipam

псевдонимы: dhcp-settings-from-fortiipam

string

Включить/отключить заполнение настроек DHCP-сервера данными из FortiIPAM.

Варианты:

  • "disable"
  • "enable"

dns_server1

псевдонимы: dns-server1

string

DNS-сервер 1.

dns_server2

псевдонимы: dns-server2

string

DNS-сервер 2.

dns_server3

псевдонимы: dns-server3

string

DNS-сервер 3.

dns_server4

псевдонимы: dns-server4

string

DNS-сервер 4.

dns_service

псевдонимы: dns-service

string

Параметры назначения DNS-серверов DHCP-клиентам.

Варианты:

  • "default"
  • "specify"
  • "local"

domain

string

Суффикс доменного имени для IP-адресов, которые DHCP-сервер назначает клиентам.

exclude_range

псевдонимы: exclude-range

list / elements=dictionary

Исключаемый диапазон.

end_ip

псевдонимы: end-ip

string

Конец диапазона IP-адресов.

id

integer

Идентификатор.

lease_time

псевдонимы: lease-time

integer

Время аренды в секундах; значение 0 означает время аренды по умолчанию.

start_ip

псевдонимы: start-ip

string

Начало диапазона IP-адресов.

uci_match

псевдонимы: uci-match

string

Включить/отключить идентификатор класса пользователя

Варианты:

  • "disable"
  • "enable"

uci_string

псевдонимы: uci-string

any

(список) Одна или несколько строк UCI в кавычках, разделённых пробелами.

vci_match

псевдонимы: vci-match

string

Включить/отключить идентификатор класса производителя

Варианты:

  • "disable"
  • "enable"

vci_string

псевдонимы: vci-string

any

(список) Одна или несколько строк VCI в кавычках, разделённых пробелами.

filename

string

Имя загрузочного файла на TFTP-сервере.

forticlient_on_net_status

псевдонимы: forticlient-on-net-status

string

Включить/отключить службу FortiClient-On-Net для этого DHCP-сервера.

Варианты:

  • "disable"
  • "enable"

id

integer / обязательный

Идентификатор.

interface

string

DHCP-сервер может назначать IP-конфигурации клиентам, подключённым к этому интерфейсу.

ip_mode

псевдонимы: ip-mode

string

Метод назначения IP-адреса клиенту.

Варианты:

  • "range"
  • "usrgrp"

ip_range

псевдонимы: ip-range

list / elements=dictionary

Диапазон IP-адресов.

end_ip

псевдонимы: end-ip

string

Конец диапазона IP-адресов.

id

integer

Идентификатор.

lease_time

псевдонимы: lease-time

integer

Время аренды в секундах; значение 0 означает время аренды по умолчанию.

start_ip

псевдонимы: start-ip

string

Начало диапазона IP-адресов.

uci_match

псевдонимы: uci-match

string

Включить/отключить идентификатор класса пользователя

Варианты:

  • "disable"
  • "enable"

uci_string

псевдонимы: uci-string

any

(список) Одна или несколько строк UCI в кавычках, разделённых пробелами.

vci_match

псевдонимы: vci-match

string

Включить/отключить идентификатор класса производителя

Варианты:

  • "disable"
  • "enable"

vci_string

псевдонимы: vci-string

any

(список) Одна или несколько строк VCI в кавычках, разделённых пробелами.

ipsec_lease_hold

aliases: ipsec-lease-hold

integer

Срок аренды DHCP через IPsec истекает через указанное количество секунд после разрыва туннеля

lease_time

aliases: lease-time

integer

Срок аренды в секундах; значение 0 означает отсутствие ограничения.

mac_acl_default_action

aliases: mac-acl-default-action

string

Действие по умолчанию для списка управления доступом MAC

Допустимые значения:

  • "assign"
  • "block"

netmask

string

Маска подсети, назначаемая DHCP-сервером.

next_server

aliases: next-server

string

IP-адрес сервера

ntp_server1

aliases: ntp-server1

string

Сервер NTP 1.

ntp_server2

aliases: ntp-server2

string

Сервер NTP 2.

ntp_server3

aliases: ntp-server3

string

Сервер NTP 3.

ntp_service

aliases: ntp-service

string

Параметры назначения сервера сетевого времени (NTP)

Допустимые значения:

  • "default"
  • "specify"
  • "local"

options

list / elements=dictionary

Параметры.

code

integer

Код параметра DHCP.

id

integer

Идентификатор.

ip

any

(список) IP-адреса параметра DHCP.

type

string

Тип параметра DHCP.

Допустимые значения:

  • "hex"
  • "string"
  • "ip"
  • "fqdn"

uci_match

aliases: uci-match

string

Включить/отключить идентификатор класса пользователя

Допустимые значения:

  • "disable"
  • "enable"

uci_string

aliases: uci-string

any

(список) Одна или несколько строк UCI в кавычках, разделённых пробелами.

value

string

Значение параметра DHCP.

vci_match

aliases: vci-match

string

Включить/отключить идентификатор класса производителя

Допустимые значения:

  • "disable"
  • "enable"

vci_string

aliases: vci-string

any

(список) Одна или несколько строк VCI в кавычках, разделённых пробелами.

relay_agent

aliases: relay-agent

string

IP-адрес агента ретрансляции.

reserved_address

aliases: reserved-address

list / elements=dictionary

Зарезервированный адрес.

action

string

Параметры настройки DHCP-сервером клиента с зарезервированным MAC-адресом.

Допустимые значения:

  • "assign"
  • "block"
  • "reserved"

circuit_id

aliases: circuit-id

string

Идентификатор канала circuit-ID параметра 82 для клиента, которому будет назначен зарезервированный IP-адрес.

circuit_id_type

aliases: circuit-id-type

string

Тип параметра DHCP.

Допустимые значения:

  • "hex"
  • "string"

description

string

Описание.

id

integer

Идентификатор.

ip

string

IP-адрес, резервируемый для MAC-адреса.

mac

string

MAC-адрес клиента, которому будет назначен зарезервированный IP-адрес.

remote_id

aliases: remote-id

string

Идентификатор удалённого узла remote-ID параметра 82 для клиента, которому будет назначен зарезервированный IP-адрес.

remote_id_type

aliases: remote-id-type

string

Тип параметра DHCP.

Допустимые значения:

  • "hex"
  • "string"

type

string

Тип зарезервированного адреса DHCP.

Допустимые значения:

  • "mac"
  • "option82"

server_type

aliases: server-type

string

DHCP-сервер может быть обычным сервером DHCP или DHCP-сервером IPsec.

Допустимые значения:

  • "regular"
  • "ipsec"

shared_subnet

aliases: shared-subnet

string

Включить/отключить общую подсеть.

Допустимые значения:

  • "disable"
  • "enable"

status

string

Включить/отключить эту конфигурацию DHCP.

Допустимые значения:

  • "disable"
  • "enable"

tftp_server

aliases: tftp-server

any

(список) Одно или несколько имён узлов или IP-адресов серверов TFTP в кавычках, разделённых пробелами.

timezone

string

Выберите часовой пояс, который будет назначен DHCP-клиентам.

Допустимые значения:

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

aliases: timezone-option

string

Параметры, позволяющие DHCP-серверу задавать часовой пояс клиентов.

Допустимые значения:

  • "disable"
  • "default"
  • "specify"

vci_match

aliases: vci-match

string

Включить/отключить идентификатор класса производителя

Допустимые значения:

  • "disable"
  • "enable"

vci_string

aliases: vci-string

any

(список) Одна или несколько строк VCI в кавычках, разделённых пробелами.

wifi_ac1

aliases: wifi-ac1

string

IP-адрес контроллера доступа Wi-Fi 1

wifi_ac2

aliases: wifi-ac2

string

IP-адрес контроллера доступа Wi-Fi 2

wifi_ac3

aliases: wifi-ac3

string

IP-адрес контроллера доступа Wi-Fi 3

wifi_ac_service

aliases: wifi-ac-service

string

Параметры назначения контроллеров доступа Wi-Fi DHCP-клиентам

Допустимые значения:

  • "specify"
  • "local"

wins_server1

aliases: wins-server1

string

Сервер WINS 1.

wins_server2

aliases: wins-server2

string

Сервер WINS 2.

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.
  • Чтобы создать объект или обновить его, используйте директиву state present.
  • Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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_system_dhcp_server:
        bypass_validation: false
        adom: ansible
        state: present
        system_dhcp_server:
          auto_configuration: enable # <value in [disable, enable]>
          default_gateway: "222.222.222.1"
          filename: ansible-file
          id: 1
          interface: any
          ip_mode: range # <value in [range, usrgrp]>
          ip_range:
            - end_ip: 222.222.222.22
              id: 1
              start_ip: 222.222.222.2
          netmask: 255.255.255.0
          server_type: regular # <value in [regular, ipsec]>
          status: disable # <value in [disable, enable]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the DHCP servers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_dhcp_server"
          params:
            adom: "ansible"
            server: "your_value"

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

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

Ключ

Описание

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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_dhcp_server_module.html

Spec-Zone.ru

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