Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Варианты:

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

dynamic_mapping

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

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

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

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

fsp_vlan_dynamicmapping_dhcpserver

dictionary

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

auto_configuration

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

string

Автоматическая настройка.

Варианты:

  • "disable"
  • "enable"

auto_managed_status

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

string

Статус автоматического управления.

Варианты:

  • "disable"
  • "enable"

conflicted_ip_timeout

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

integer

Тайм-аут конфликтующего IP-адреса.

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.

ddns_update

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

string

Обновление DDNS.

Варианты:

  • "disable"
  • "enable"

ddns_update_override

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

string

Переопределение обновления DDNS.

Варианты:

  • "disable"
  • "enable"

ddns_zone

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

string

Зона DDNS.

default_gateway

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

string

Шлюз по умолчанию.

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.

Варианты:

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

domain

string

Домен.

enable

string

Включить.

Варианты:

  • "disable"
  • "enable"

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

Имя файла.

forticlient_on_net_status

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

string

Состояние FortiClient в сети.

Варианты:

  • "disable"
  • "enable"

id

integer

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

interface

string

Интерфейс.

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

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

integer

Удержание аренды IPsec.

lease_time

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

integer

Время аренды.

mac_acl_default_action

псевдонимы: mac-acl-default-action

string

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

Варианты:

  • "assign"
  • "block"

netmask

string

Маска подсети.

next_server

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

string

Следующий сервер.

ntp_server1

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

string

Сервер NTP 1.

ntp_server2

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

string

Сервер NTP 2.

ntp_server3

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

string

Сервер NTP 3.

ntp_service

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

string

Служба 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

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

string

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

Варианты:

  • "disable"
  • "enable"

uci_string

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

any

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

value

string

Значение.

vci_match

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

string

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

Варианты:

  • "disable"
  • "enable"

vci_string

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

any

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

relay_agent

псевдонимы: relay-agent

string

IP-адрес DHCP-ретранслятора.

reserved_address

псевдонимы: reserved-address

list / elements=dictionary

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

action

string

Действие.

Варианты:

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

circuit_id

псевдонимы: circuit-id

string

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

circuit_id_type

псевдонимы: circuit-id-type

string

Тип идентификатора канала.

Варианты:

  • "hex"
  • "string"

description

string

Описание.

id

integer

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

ip

string

IP-адрес.

mac

string

MAC-адрес.

remote_id

псевдонимы: remote-id

string

Удалённый идентификатор.

remote_id_type

псевдонимы: remote-id-type

string

Тип удалённого идентификатора.

Варианты:

  • "hex"
  • "string"

type

string

Тип.

Варианты:

  • "mac"
  • "option82"

server_type

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

string

Тип сервера.

Варианты:

  • "regular"
  • "ipsec"

shared_subnet

псевдонимы: shared-subnet

string

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

Варианты:

  • "disable"
  • "enable"

status

string

Состояние.

Варианты:

  • "disable"
  • "enable"

tftp_server

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

any

(список) Сервер 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

псевдонимы: timezone-option

string

Параметр часового пояса.

Варианты:

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

vci_match

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

string

Сопоставление VCI.

Варианты:

  • "disable"
  • "enable"

vci_string

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

any

(список) Строка VCI.

wifi_ac1

псевдонимы: wifi-ac1

string

Контроллер Wi-Fi 1.

wifi_ac2

псевдонимы: wifi-ac2

string

Контроллер Wi-Fi 2.

wifi_ac3

псевдонимы: wifi-ac3

string

Контроллер Wi-Fi 3.

wifi_ac_service

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

string

Служба контроллера Wi-Fi.

Варианты:

  • "specify"
  • "local"

wins_server1

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

string

Сервер WINS 1.

wins_server2

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

string

Сервер WINS 2.

proposed_method

string

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

Варианты:

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

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / elements=integer

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

revision_note

string

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

vlan

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

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

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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
  gather_facts: false
  tasks:
    - name: Configure DHCP servers.
      fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        vlan: <your own value>
        dynamic_mapping: <your own value>
        fsp_vlan_dynamicmapping_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

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_fsp_vlan_dynamicmapping_dhcpserver_module.html

Spec-Zone.ru

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