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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required	Параметр (adom) в запрошенном URL.
apcfgprofile dictionary	Набор параметров верхнего уровня.
ac-ip string	Устарело, переименуйте в ac_ip. IP-адрес контроллера проверки подлинности, к которому AP должен иметь возможность присоединиться после применения…
ac-port integer	Устарело, переименуйте в ac_port. Порт контроллера проверки подлинности, к которому AP должен иметь возможность присоединиться после применения AP …
ac-timer integer	Устарело, переименуйте в ac_timer. Максимальное время ожидания для подключения AP к контроллеру проверки подлинности после применения…
ac-type string	Устарело, переименуйте в ac_type. Тип контроллера проверки подлинности Варианты: `"default"` `"specify"` `"apcfg"`
ap-family string	Устарело, переименуйте в ap_family. Тип семейства FortiAP Варианты: `"fap"` `"fap-u"` `"fap-c"`
command-list list / elements=dictionary	Устарело, переименуйте в command_list. Список команд.
id integer	Идентификатор команды.
name string	Имя команды локальной конфигурации AP.
passwd-value any	(list) Устарело, переименуйте в passwd_value. Значение пароля команды локальной конфигурации AP.
type string	Тип команды Варианты: `"non-password"` `"password"`
value string	Значение команды локальной конфигурации AP.
comment string	Комментарий.
name string / required	Имя профиля локальной конфигурации AP.
bypass_validation boolean	Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия успеха.

state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	Область ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют именование с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name” на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения о deprecation. Вы можете проигнорировать это предупреждение, установив 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: Configure AP local configuration profiles.
      fortinet.fortimanager.fmgr_apcfgprofile:
        # 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>
        state: present # <value in [present, absent]>
        apcfgprofile:
          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>
          name: <string>
          ap_family: <value in [fap, fap-u, fap-c]>

Значения возврата

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

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