Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_user_tacacs module — настройка записей сервера TACACS+.

Примечание

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

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

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

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

Добавлено в 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

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Команда для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

user_tacacs

dictionary

Набор параметров верхнего уровня.

authen_type

псевдонимы: authen-type

string

Разрешенные протоколы/методы аутентификации.

Варианты:

  • "auto"
  • "ascii"
  • "pap"
  • "chap"
  • "mschap"

authorization

string

Включить/отключить авторизацию TACACS+.

Варианты:

  • "disable"
  • "enable"

dynamic_mapping

list / элементы=dictionary

Динамическое сопоставление.

_scope

list / элементы=dictionary

Область действия.

name

string

Имя.

vdom

string

VDOM.

authen_type

псевдонимы: authen-type

string

Тип аутентификации.

Варианты:

  • "auto"
  • "ascii"
  • "pap"
  • "chap"
  • "mschap"

authorization

string

Авторизация.

Варианты:

  • "disable"
  • "enable"

interface

string

Интерфейс.

interface_select_method

псевдонимы: interface-select-method

string

Метод выбора интерфейса.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

key

any

(список) Ключ.

port

integer

Порт.

secondary_key

псевдонимы: secondary-key

any

(список) Вторичный ключ.

secondary_server

псевдонимы: secondary-server

string

Вторичный сервер.

server

string

Сервер.

source_ip

псевдонимы: source-ip

string

IP-адрес источника.

status_ttl

псевдонимы: status-ttl

integer

Время кэширования доступности сервера: если сервер недоступен, повторные попытки не выполняются в течение как минимум…

tertiary_key

псевдонимы: tertiary-key

any

(список) Третичный ключ.

tertiary_server

псевдонимы: tertiary-server

string

Третичный сервер.

vrf_select

псевдонимы: vrf-select

integer

Идентификатор VRF, используемый для подключения к серверу.

interface

string

Укажите исходящий интерфейс для подключения к серверу.

interface_select_method

псевдонимы: interface-select-method

string

Укажите способ выбора исходящего интерфейса для подключения к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

key

any

(список) Ключ для доступа к основному серверу.

name

string / обязательный

Имя записи сервера TACACS+.

port

integer

Номер порта сервера TACACS+.

secondary_key

псевдонимы: secondary-key

any

(список) Ключ для доступа к вторичному серверу.

secondary_server

псевдонимы: secondary-server

string

Доменное имя CN или IP-адрес вторичного сервера TACACS+.

server

string

Доменное имя CN или IP-адрес основного сервера TACACS+.

source_ip

псевдонимы: source-ip

string

IP-адрес источника для обмена данными с сервером TACACS+.

status_ttl

псевдонимы: status-ttl

integer

Время кэширования доступности сервера: если сервер недоступен, повторные попытки не выполняются как минимум в течение этого…

tertiary_key

псевдонимы: tertiary-key

any

(список) Ключ для доступа к третичному серверу.

tertiary_server

псевдонимы: tertiary-server

string

Доменное имя CN или IP-адрес третичного сервера TACACS+.

vrf_select

псевдонимы: vrf-select

integer

Идентификатор VRF, используемый для подключения к серверу.

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 TACACS+ server entries.
      fortinet.fortimanager.fmgr_user_tacacs:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_tacacs:
          name: "your value" # Required variable, string
          # authen_type: <value in [auto, ascii, pap, ...]>
          # authorization: <value in [disable, enable]>
          # dynamic_mapping:
          #   - _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>
          #     vrf_select: <integer>
          # 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>
          # vrf_select: <integer>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL-адрес запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=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_user_tacacs_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API