Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.12.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.

managed-switch

string

Устарел, используйте «managed_switch»

managed_switch

string

Параметр (managed-switch) в запрашиваемом URL.

proposed_method

string

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

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

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

rc_failed

list / элементы=integer

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

rc_succeeded

list / элементы=integer

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

revision_note

string

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

state

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

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

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

  • "present"
  • "absent"

switchcontroller_managedswitch_systemdhcpserver

dictionary

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

default_gateway

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

string

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

dns_server1

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

string

DNS-сервер 1.

dns_server2

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

string

DNS-сервер 2.

dns_server3

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

string

DNS-сервер 3.

dns_service

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

string

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

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

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

id

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

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

interface

list / элементы=string

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

ip_range

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

list / элементы=dictionary

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

end_ip

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

string

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

id

integer

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

start_ip

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

string

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

lease_time

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

integer

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

netmask

string

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

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

Настройки назначения серверов Network Time Protocol

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

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

options

list / элементы=dictionary

Параметры.

code

integer

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

id

integer

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

ip

string

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

type

string

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

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

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

value

string

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

status

string

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

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

  • "disable"
  • "enable"

switch_id

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

list / элементы=string

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

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другое значение, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку workspace.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы вида «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, однако при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, задав deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия ошибки или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Чтобы создать или обновить объект, используйте директиву state present.
  • Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure DHCP servers.
      fortinet.fortimanager.fmgr_switchcontroller_managedswitch_systemdhcpserver:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        managed_switch: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_managedswitch_systemdhcpserver:
          id: 0 # Required variable, integer
          # default_gateway: <string>
          # dns_server1: <string>
          # dns_server2: <string>
          # dns_server3: <string>
          # dns_service: <value in [default, specify, local]>
          # interface: <list or string>
          # ip_range:
          #   - end_ip: <string>
          #     id: <integer>
          #     start_ip: <string>
          # lease_time: <integer>
          # netmask: <string>
          # ntp_server1: <string>
          # ntp_server2: <string>
          # ntp_server3: <string>
          # ntp_service: <value in [default, specify, local]>
          # options:
          #   - code: <integer>
          #     id: <integer>
          #     ip: <string>
          #     type: <value in [hex, string, ip, ...]>
          #     value: <string>
          # status: <value in [disable, enable]>
          # switch_id: <list or string>

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

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

Ключ

Описание

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_switchcontroller_managedswitch_systemdhcpserver_module.html

Spec-Zone.ru

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