Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
  • Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_token

строка

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

adom

строка / обязательно

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

bypass_validation

логическое

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

Варианты:

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

enable_log

логическое

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

Варианты:

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

forticloud_access_token

строка

Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.

proposed_method

строка

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

Варианты:

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

rc_failed

список / элементы=целое число

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

rc_succeeded

список / элементы=целое число

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

state

строка / обязательно

Направление для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

system_dhcp_server

словарь

Параметры верхнего уровня.

auto-configuration

строка

Устаревшее, пожалуйста, переименуйте на auto_configuration. Включить/выключить автоматическую настройку.

Варианты:

  • "disable"
  • "enable"

auto-managed-status

строка

Устаревшее, пожалуйста, переименуйте на auto_managed_status. Включить/выключить использование этого DHCP-сервера после того, как этот интерфейс …

Варианты:

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

ddns-update

строка

Устаревшее, пожалуйста, переименуйте на ddns_update. Включить/выключить обновление DDNS для DHCP.

Варианты:

  • "disable"
  • "enable"

ddns-update-override

строка

Устаревшее, пожалуйста, переименуйте на ddns_update_override. Включить/выключить переопределение обновления DDNS для DHCP.

Варианты:

  • "disable"
  • "enable"

ddns-zone

string

Устарело, переименуйте в ddns_zone. Зона вашего доменного имени

default-gateway

string

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

dhcp-settings-from-fortiipam

string

Устарело, переименуйте в dhcp_settings_from_fortiipam. Включить/отключить заполнение настроек DHCP-сервера из Forti…

Choices:

  • "disable"
  • "enable"

dns-server1

string

Устарело, переименуйте в dns_server1. DNS-сервер 1.

dns-server2

string

Устарело, переименуйте в dns_server2. DNS-сервер 2.

dns-server3

string

Устарело, переименуйте в dns_server3. DNS-сервер 3.

dns-server4

string

Устарело, переименуйте в dns_server4. DNS-сервер 4.

dns-service

string

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

Choices:

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

domain

string

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

exclude-range

list / elements=dictionary

Устарело, переименуйте в exclude_range. Исключаемый диапазон.

end-ip

string

Устарело, переименуйте в end_ip. Конец диапазона IP-адресов.

id

integer

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

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

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

forticlient-on-net-status

string

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

Choices:

  • "disable"
  • "enable"

id

integer / required

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

interface

string

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

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

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

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 в кавычках, разделенные пробелами.

ipsec-lease-hold

integer

Устарело, переименуйте в ipsec_lease_hold. Аренды DHCP через IPsec истекают через столько секунд после отключения туннеля

lease-time

integer

Устарело, переименуйте в lease_time. Время аренды в секундах, 0 означает неограниченное время.

mac-acl-default-action

string

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

Choices:

  • "assign"
  • "block"

netmask

string

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

next-server

string

Устарело, переименуйте в next_server. IP-адрес сервера

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. Параметры для назначения протокола сетевого времени

Choices:

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

options

list / elements=dictionary

Параметры.

code

integer

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

id

integer

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

ip

any

(list) IP-адреса параметров DHCP.

type

string

Тип опции DHCP.

Варианты:

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

uci-match

string

Устарело, переименуйте в uci_match. Включить/выключить идентификатор класса пользователя

Варианты:

  • "disable"
  • "enable"

uci-string

any

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

value

string

Значение опции DHCP.

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

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

Варианты:

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

circuit-id

string

Устарело, переименуйте в circuit_id. Опция 82 circuit-ID клиента, который получит зарезервированный IP-адрес.

circuit-id-type

string

Устарело, переименуйте в circuit_id_type. Тип опции DHCP.

Варианты:

  • "hex"
  • "string"

description

string

Описание.

id

integer

ИД.

ip

string

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

mac

string

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

remote-id

string

Устарело, переименуйте в remote_id. Опция 82 remote-ID клиента, который получит зарезервированный IP-адрес.

remote-id-type

string

Устарело, переименуйте в remote_id_type. Тип опции DHCP.

Варианты:

  • "hex"
  • "string"

type

string

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

Варианты:

  • "mac"
  • "option82"

server-type

string

Устарело, переименуйте в server_type. DHCP-сервер может быть обычным DHCP-сервером или DHCP-сервером IPsec.

Варианты:

  • "regular"
  • "ipsec"

shared-subnet

string

Устарело, переименуйте в shared_subnet. Включить/выключить общую подсеть.

Варианты:

  • "disable"
  • "enable"

status

string

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

Варианты:

  • "disable"
  • "enable"

tftp-server

any

(list) Устарело, переименуйте в tftp_server. Одно или несколько имён хостов или IP-адресов TFTP-серверов в кавычках se…

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

string

Устарело, переименуйте в timezone_option. Параметры для сервера DHCP для установки часового пояса клиентов.

Варианты:

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

vci-match

string

Устарело, переименуйте в vci_match. Включить/отключить идентификатор класса поставщика

Варианты:

  • "disable"
  • "enable"

vci-string

any

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

wifi-ac-service

string

Устарело, переименуйте в wifi_ac_service. Параметры для назначения контроллеров беспроводного доступа WiFi клиентам DHCP

Варианты:

  • "specify"
  • "local"

wifi-ac1

string

Устарело, переименуйте в wifi_ac1. IP-адрес контроллера беспроводного доступа WiFi 1

wifi-ac2

string

Устарело, переименуйте в wifi_ac2. IP-адрес контроллера беспроводного доступа WiFi 2

wifi-ac3

string

Устарело, переименуйте в wifi_ac3. IP-адрес контроллера беспроводного доступа WiFi 3

wins-server1

string

Устарело, переименуйте в wins_server1. WINS-сервер 1.

wins-server2

string

Устарело, переименуйте в wins_server2. 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 помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код rc. Вы также можете переопределить условия для завершения успехом или ошибкой с помощью параметров rc_failed и rc_succeeded

Примеры

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

Spec-Zone.ru

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