fortinet.fortimanager.fmgr_user_tacacs_dynamicmapping модуль — Настройка записей сервера TACACS+.

Примечание

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

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

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

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

Впервые появился в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Выбори: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Выбори: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Выбори: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc-кодов, при которых условия будут переопределены для неудачи.
rc_succeeded список / элементы=целое	Список rc-кодов, при которых условия будут переопределены для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Выбори: `"present"` `"absent"`
tacacs+ строка	Устаревшее, используйте «tacacs_»
tacacs_ строка	Параметр (tacacs+) в запрошенном URL.
user_tacacs_dynamicmapping словарь	Настройка параметров верхнего уровня.
_scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
authen_type строка	Устаревшее, переименуйте на authen_type. Тип аутентификации. Выбори: `"auto"` `"ascii"` `"pap"` `"chap"` `"mschap"`
authorization строка	Авторизация. Выбори: `"disable"` `"enable"`
interface строка	Интерфейс.
interface_select_method строка	Устаревшее, переименуйте на interface_select_method. Метод выбора интерфейса. Выбори: `"auto"` `"sdwan"` `"specify"`
key любой	(список) Ключ.
port целое	Порт.
secondary_key любой	(список) Устаревшее, переименуйте на secondary_key. Вспомогательный ключ.

secondary-server string	Устаревшее, переименуйте на secondary_server. Вторичный сервер.
server string	Сервер.
source-ip string	Устаревшее, переименуйте на source_ip. Источник IP.
status-ttl integer	Устаревшее, переименуйте на status_ttl. Время, в течение которого кешируется доступность сервера, чтобы при недоступности сервера...
tertiary-key any	(список) Устаревшее, переименуйте на tertiary_key. Третичный ключ.
tertiary-server string	Устаревшее, переименуйте на tertiary_server. Третичный сервер.
workspace_locking_adom string	ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая корневой.
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 выполняют необходимые действия.
Для создания или обновления объекта используйте директиву 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 TACACS+ server entries.
      fortinet.fortimanager.fmgr_user_tacacs_dynamicmapping:
        # 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>
        tacacs_: <your own value>
        state: present # <value in [present, absent]>
        user_tacacs_dynamicmapping:
          _scope:
            -
              name: <string>
              vdom: <string>
          authen_type: <value in [auto, ascii, pap, ...]>
          authorization: <value in [disable, enable]>
          key: <list or string>
          port: <integer>
          secondary_key: <list or string>
          secondary_server: <string>
          server: <string>
          source_ip: <string>
          tertiary_key: <list or string>
          tertiary_server: <string>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          status_ttl: <integer>

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

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

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