Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_dvmdb_adom.

Новое в fortinet.fortimanager 2.0.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

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

bypass_validation

boolean

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

Варианты:

  • false ← (default)
  • true

dvmdb_adom

dictionary

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

create_time

integer

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

desc

string

Описание.

flags

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

dictionary

Устарело, переименуйте в meta_fields. Метаданные по умолчанию.

mig_mr

integer

Mig 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 / required

Имя.

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 IP4.

primary_dns_ip6_1

integer

Основной DNS IP6 1.

primary_dns_ip6_2

integer

Основной DNS IP6 2.

primary_dns_ip6_3

integer

Основной DNS IP6 3.

primary_dns_ip6_4

integer

Основной DNS IP6 4.

restricted_prds

any

(список или строка) Ограниченные 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"

secondary_dns_ip4

string

Вторичный DNS IP4.

secondary_dns_ip6_1

integer

Вторичный DNS IP6 1.

secondary_dns_ip6_2

integer

Вторичный dns ip6 2.

secondary_dns_ip6_3

integer

Вторичный dns ip6 3.

secondary_dns_ip6_4

integer

Вторичный dns ip6 4.

state

integer

Состояние.

tz

integer

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

uuid

string

Uuid.

workspace_mode

integer

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

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

string / required

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

Варианты:

  • "present"
  • "absent"

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: ADOM table, most attributes are read-only and can only be changed internally.
      fortinet.fortimanager.fmgr_dvmdb_adom:
        # 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, ...]
        state: present # <value in [present, absent]>
        dvmdb_adom:
          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>
          name: <string>
          os_ver: <value in [unknown, 0.0, 1.0, ...]>
          restricted_prds: # <list or string>
            - 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
          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 / elements=string

Ответ API.

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

response_message

string

Описательное сообщение ответа API.

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

Пример: "OK."

system_information

dictionary

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

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

rc

integer

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

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

Пример: 0

version_check_warning

list / elements=string

Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_dvmdb_adom_module.html

Spec-Zone.ru

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