Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_system_dhcp_server_iprange – Настройка диапазона DHCP-адресов.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательный
параметр (adom) в запрошенном URL
bypass_validation
логический тип
    Варианты:
  • нет ←
  • да
устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров.
rc_failed
список / элементы=строка
список кодов rc, при которых условия для завершения выполнения модуля будут переопределены.
rc_succeeded
список / элементы=строка
список кодов rc, при которых условия для успешного завершения выполнения модуля будут переопределены.
server
строка / обязательный
параметр (server) в запрошенном URL
state
строка / обязательный
    Варианты:
  • present
  • absent
направление для создания, обновления или удаления объекта
system_dhcp_server_iprange
словарь
установленные параметры верхнего уровня
end-ip
строка
Конец диапазона IP-адресов.
id
целое число
Идентификатор.
start-ip
строка
Начало диапазона IP-адресов.
workspace_locking_adom
строка
adom для блокировки при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным или другим, включая корневой.
workspace_locking_timeout
целое число
Значение по умолчанию:
300
максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем

Примечания

Примечание

  • Поддерживается работа в режиме блокировки рабочего пространства в данном модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте значение state present.
  • Для удаления объекта используйте значение state absent.
  • Обычно, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия завершения с ошибкой или успехом, используя параметры rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: DHCP IP range configuration.
     fmgr_system_dhcp_server_iprange:
        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>
        server: <your own value>
        state: <value in [present, absent]>
        system_dhcp_server_iprange:
           end-ip: <value of string>
           id: <value of integer>
           start-ip: <value of string>

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

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

Ключ Возвращаемое значение Описание
request_url
строка
всегда
Полный запрашиваемый URL

Пример:
/sys/login/user
response_code
целое число
всегда
Статус запроса API

response_message
строка
всегда
Дескриптивное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_dhcp_server_iprange_module.html

Spec-Zone.ru

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