Модуль fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress — Опции для DHCP-сервера по назначению IP-настроек для конкретных MAC-адресов.

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress.

Новая функция в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Выбираемые значения: `false` ← (по умолчанию) `true`
dynamic_mapping строка / обязательно	Параметр (dynamic_mapping) в запрошенном URL.
enable_log логическое значение	Включить/отключить ведение журнала для задачи. Выбираемые значения: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Проверка подлинности Ansible-клиента с помощью токена доступа к forticloud API.
fsp_vlan_dynamicmapping_dhcpserver_reservedaddress словарь	Настройка параметров верхнего уровня.
action строка	Действие. Выбираемые значения: `"assign"` `"block"` `"reserved"`
circuit_id строка	Устарело, пожалуйста, переименуйте на circuit_id. Идентификатор канала.
circuit_id_type строка	Устарело, пожалуйста, переименуйте на circuit_id_type. Тип идентификатора канала. Выбираемые значения: `"hex"` `"string"`
description строка	Описание.
id целое число / обязательно	Идентификатор.
ip строка	IP-адрес.
mac строка	MAC-адрес.
remote_id строка	Устарело, пожалуйста, переименуйте на remote_id. Удаленный идентификатор.
remote_id_type строка	Устарело, пожалуйста, переименуйте на remote_id_type. Тип удаленного идентификатора. Выбираемые значения: `"hex"` `"string"`
type строка	Тип. Выбираемые значения: `"mac"` `"option82"`
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Выбираемые значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми условия ошибки будут переопределены.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми условия успеха будут переопределены.

END_OF_DOCUMENT_MARKER

state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
vlan строка / обязательно	Параметр (vlan) в запрошенном URL.
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `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 (generated based on argument schema)
  hosts: fortimanagers
  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_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress:
        # 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>
        vlan: <your own value>
        dynamic_mapping: <your own value>
        state: present # <value in [present, absent]>
        fsp_vlan_dynamicmapping_dhcpserver_reservedaddress:
          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]>

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

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

Ключ	Описание
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_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress_module.html