Модуль fortinet.fortimanager.fmgr_apcfgprofile — Настройка профилей локальной конфигурации точек доступа.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
apcfgprofile dictionary	Набор параметров верхнего уровня.
ac_ip псевдонимы: ac-ip string	IP-адрес контроллера проверки, к которому точка доступа должна иметь возможность подключиться после применения локальной конфигурации.
ac_port псевдонимы: ac-port integer	Порт контроллера проверки, к которому точка доступа должна иметь возможность подключиться после применения локальной конфигурации
ac_timer псевдонимы: ac-timer integer	Максимальное время ожидания подключения точки доступа к контроллеру проверки после применения локальной конфигурации
ac_type псевдонимы: ac-type string	Тип контроллера проверки Варианты: `"default"` `"specify"` `"apcfg"`
ap_family псевдонимы: ap-family string	Тип семейства FortiAP Варианты: `"fap"` `"fap-u"` `"fap-c"`
command_list псевдонимы: command-list list / элементы=dictionary	Список команд.
id integer	Идентификатор команды.
name string	Имя команды локальной конфигурации точки доступа.
passwd_value псевдонимы: passwd-value any	(список) Значение пароля команды локальной конфигурации точки доступа.
type string	Тип команды Варианты: `"non-password"` `"password"`
value string	Значение команды локальной конфигурации точки доступа.
comment string	Комментарий.
name string / обязательный	Имя профиля локальной конфигурации точки доступа.
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	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure AP local configuration profiles.
      fortinet.fortimanager.fmgr_apcfgprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        apcfgprofile:
          name: "your value" # Required variable, string
          # ac_ip: <string>
          # ac_port: <integer>
          # ac_timer: <integer>
          # ac_type: <value in [default, specify, apcfg]>
          # command_list:
          #   - id: <integer>
          #     name: <string>
          #     passwd_value: <list or string>
          #     type: <value in [non-password, password]>
          #     value: <string>
          # comment: <string>
          # ap_family: <value in [fap, fap-u, fap-c]>

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

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

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