Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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

строка

Токен доступа к 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"

user_tacacs

словарь

Установленные параметры верхнего уровня.

authen-type

строка

Устарело, пожалуйста, переименуйте его в authen_type. Разрешенные протоколы/методы аутентификации.

Варианты:

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

authorization

строка

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

Варианты:

  • "disable"
  • "enable"

dynamic_mapping

список / элементы=словарь

Динамическое отображение.

_scope

список / элементы=словарь

Область.

name

строка

Имя.

vdom

строка

Vdom.

authen-type

строка

Устарело, пожалуйста, переименуйте его в authen_type. Тип аутентификации.

Варианты:

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

authorization

строка

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

Варианты:

  • "disable"
  • "enable"

interface

строка

Интерфейс.

interface_select_method

строка

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

Варианты:

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

key

любой

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

port

integer

Порт.

secondary-key

any

(list) Устарело, переименуйте в secondary_key. Вторичный ключ.

secondary-server

string

Устарело, переименуйте в secondary_server. Вторичный сервер.

server

string

Сервер.

source-ip

string

Устарело, переименуйте в source_ip. Исходный IP.

status-ttl

integer

Устарело, переименуйте в status_ttl. Время, в течение которого кэшируется доступность сервера, так что когда сервер…

tertiary-key

any

(list) Устарело, переименуйте в tertiary_key. Третичный ключ.

tertiary-server

string

Устарело, переименуйте в tertiary_server. Третичный сервер.

interface

string

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

interface-select-method

string

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

Варианты:

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

key

any

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

name

string / required

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

port

integer

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

secondary-key

any

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

secondary-server

string

Устарело, переименуйте в secondary_server. Вторичный сервер TACACS+ доменное имя CN или IP-адрес.

server

string

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

source-ip

string

Устарело, переименуйте в source_ip. Исходный IP для связи с сервером TACACS+.

status-ttl

integer

Устарело, переименуйте в status_ttl. Время, в течение которого кэшируется доступность сервера, так что когда сервер недоступен…

tertiary-key

any

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

tertiary-server

string

Устарело, переименуйте в tertiary_server. Третичный сервер TACACS+ доменное имя CN или IP-адрес.

workspace_locking_adom

string

ADOM для блокировки FortiManager, работающего в режиме рабочих пространств; значение может быть global и другие, включая 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.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код возврата. Вы также можете переопределить условия сбоя или успеха с помощью параметров 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:
        # 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]>
        user_tacacs:
          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>
          key: <list or string>
          name: <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_module.html

Spec-Zone.ru

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