Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_dvmdb_adom — таблица ADOM; большинство атрибутов доступны только для чтения и могут изменяться только внутренними средствами.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

dvmdb_adom

dictionary

Параметры верхнего уровня.

create_time

integer

Время создания.

desc

string

Описание.

flags

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

Флаги.

Варианты:

  • "migration"
  • "db_export"
  • "no_vpn_console"
  • "backup"
  • "other_devices"
  • "central_sdwan"
  • "is_autosync"
  • "per_device_wtp"
  • "policy_check_on_install"
  • "install_on_policy_check_fail"
  • "auto_push_cfg"
  • "per_device_fsw"
  • "install_deselect_all"

lock_override

integer

Переопределение блокировки.

log_db_retention_hours

integer

Срок хранения базы данных журналов в часах.

log_disk_quota

integer

Дисковая квота для журналов.

log_disk_quota_alert_thres

integer

Порог предупреждения для дисковой квоты журналов.

log_disk_quota_split_ratio

integer

Коэффициент распределения дисковой квоты журналов.

log_file_retention_hours

integer

Срок хранения файлов журналов в часах.

meta_fields

псевдонимы: meta fields

dictionary

Метаполя по умолчанию

mig_mr

integer

MR миграции.

mig_os_ver

string

Версия ОС для миграции.

Варианты:

  • "unknown"
  • "0.0"
  • "1.0"
  • "2.0"
  • "3.0"
  • "4.0"
  • "5.0"
  • "6.0"
  • "7.0"
  • "8.0"
  • "9.0"

mode

string

ems —

provider — глобальная база данных.

Варианты:

  • "ems"
  • "gms"
  • "provider"

mr

integer

MR.

name

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

Имя.

os_ver

string

Версия ОС.

Варианты:

  • "unknown"
  • "0.0"
  • "1.0"
  • "2.0"
  • "3.0"
  • "4.0"
  • "5.0"
  • "6.0"
  • "7.0"
  • "8.0"
  • "9.0"

primary_dns_ip4

string

Основной DNS-сервер IPv4.

primary_dns_ip6_1

integer

Основной DNS-сервер IPv6 1.

primary_dns_ip6_2

integer

Основной DNS-сервер IPv6 2.

primary_dns_ip6_3

integer

Основной DNS-сервер IPv6 3.

primary_dns_ip6_4

integer

Основной DNS-сервер IPv6 4.

restricted_prds

any

(список или строка) Ограниченные продукты.

Варианты:

  • "fos"
  • "foc"
  • "fml"
  • "fch"
  • "fwb"
  • "log"
  • "fct"
  • "faz"
  • "fsa"
  • "fsw"
  • "fmg"
  • "fdd"
  • "fac"
  • "fpx"
  • "fna"
  • "fdc"
  • "ffw"
  • "fsr"
  • "fad"
  • "fap"
  • "fxt"
  • "fts"
  • "fai"
  • "fwc"
  • "fis"
  • "fed"
  • "fabric"
  • "fpa"
  • "fca"
  • "ftc"
  • "fss"
  • "sim"
  • "fra"

secondary_dns_ip4

string

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

secondary_dns_ip6_1

integer

Вторичный DNS-сервер IPv6 1.

secondary_dns_ip6_2

integer

Вторичный DNS-сервер IPv6 2.

secondary_dns_ip6_3

integer

Вторичный DNS-сервер IPv6 3.

secondary_dns_ip6_4

integer

Вторичный DNS-сервер IPv6 4.

state

integer

Состояние.

tz

integer

Часовой пояс.

uuid

string

UUID.

workspace_mode

integer

Режим рабочей области.

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, переопределяющий условия успешного выполнения.

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: ADOM table, most attributes are read-only and can only be changed internally.
      fortinet.fortimanager.fmgr_dvmdb_adom:
        # workspace_locking_adom: <global or your adom name>
        state: present # <value in [present, absent]>
        dvmdb_adom:
          name: "your value" # Required variable, string
          # desc: <string>
          # flags: ["migration", "db_export", "no_vpn_console", "backup", "other_devices",
          #         "central_sdwan", "is_autosync", "per_device_wtp", "policy_check_on_install",
          #         "install_on_policy_check_fail", "auto_push_cfg", "per_device_fsw",
          #         "install_deselect_all"]
          # log_db_retention_hours: <integer>
          # log_disk_quota: <integer>
          # log_disk_quota_alert_thres: <integer>
          # log_disk_quota_split_ratio: <integer>
          # log_file_retention_hours: <integer>
          # meta_fields: <dict>
          # mig_mr: <integer>
          # mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
          # mode: <value in [ems, gms, provider]>
          # mr: <integer>
          # os_ver: <value in [unknown, 0.0, 1.0, ...]>
          # restricted_prds: ["fos", "foc", "fml", "fch", "fwb", "log", "fct", "faz", "fsa",
          #                   "fsw", "fmg", "fdd", "fac", "fpx", "fna", "fdc", "ffw", "fsr",
          #                   "fad", "fap", "fxt", "fts", "fai", "fwc", "fis", "fed", "fabric",
          #                   "fpa", "fca", "ftc", "fss", "sim", "fra"]
          # state: <integer>
          # uuid: <string>
          # create_time: <integer>
          # workspace_mode: <integer>
          # tz: <integer>
          # lock_override: <integer>
          # primary_dns_ip4: <string>
          # primary_dns_ip6_1: <integer>
          # primary_dns_ip6_2: <integer>
          # primary_dns_ip6_3: <integer>
          # primary_dns_ip6_4: <integer>
          # secondary_dns_ip4: <string>
          # secondary_dns_ip6_1: <integer>
          # secondary_dns_ip6_2: <integer>
          # secondary_dns_ip6_3: <integer>
          # secondary_dns_ip6_4: <integer>

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

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

Ключ

Описание

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_dvmdb_adom_module.html

Spec-Zone.ru

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