Модуль fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress — параметры DHCP-сервера для назначения IP-настроек определённым MAC-адресам.

Примечание

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

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

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

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

Добавлено в 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 / элементы типа integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / элементы типа integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
server string / обязательный	Параметр (server) в запрошенном URL.
state string / обязательный	Директива для создания, обновления или удаления объекта. Возможные значения: `"present"` `"absent"`
system_dhcp_server_reservedaddress dictionary	Набор параметров верхнего уровня.
action string	Параметры, определяющие, как DHCP-сервер настроит клиента с зарезервированным MAC-адресом. Возможные значения: `"assign"` `"block"` `"reserved"`
circuit_id псевдонимы: circuit-id string	Идентификатор канала (circuit-ID) параметра 82 для клиента, которому будет назначен зарезервированный IP-адрес.
circuit_id_type псевдонимы: circuit-id-type string	Тип параметра DHCP. Возможные значения: `"hex"` `"string"`
description string	Описание.
id integer / обязательный	Идентификатор.
ip string	IP-адрес, резервируемый для MAC-адреса.
mac string	MAC-адрес клиента, которому будет назначен зарезервированный IP-адрес.
remote_id псевдонимы: remote-id string	Удалённый идентификатор (remote-ID) параметра 82 для клиента, которому будет назначен зарезервированный IP-адрес.
remote_id_type псевдонимы: remote-id-type string	Тип параметра DHCP. Возможные значения: `"hex"` `"string"`
type string	Тип зарезервированного адреса DHCP. Возможные значения: `"mac"` `"option82"`
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.
Для создания или обновления объекта используйте директиву 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: Options for the DHCP server to assign IP settings to specific MAC addresses.
      fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress:
        bypass_validation: false
        adom: ansible
        server: 1 # id
        state: present
        system_dhcp_server_reservedaddress:
          action: assign # <value in [assign, block, reserved]>
          description: ansible-description
          id: 1
          ip: 222.222.222.1

- 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 reserved addresses of DHCP server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_dhcp_server_reservedaddress"
          params:
            adom: "ansible"
            server: "1" # id
            reserved_address: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы типа string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы типа 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_system_dhcp_server_reservedaddress_module.html