fortinet.fortimanager.fmgr_dvmdb_adom 模块 – ADOM 表,大多数属性为只读,只能在内部更改。

注意

此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。

如果您正在使用 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

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时设置为 True,模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

dvmdb_adom

字典

设置的顶级参数。

create_time

整数

创建时间。

desc

字符串

描述。

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"

lock_override

整数

锁定覆盖。

log_db_retention_hours

整数

日志数据库保留小时数。

log_disk_quota

整数

日志磁盘配额。

log_disk_quota_alert_thres

整数

日志磁盘配额警报阈值。

log_disk_quota_split_ratio

整数

日志磁盘配额拆分比率。

log_file_retention_hours

整数

日志文件保留小时数。

meta_fields

别名:meta fields

字典

默认元字段

mig_mr

整数

Mig mr。

mig_os_ver

字符串

Mig os ver。

选项

  • "unknown"

  • "0.0"

  • "1.0"

  • "2.0"

  • "3.0"

  • "4.0"

  • "5.0"

  • "6.0"

  • "7.0"

  • "8.0"

  • "9.0"

mode

字符串

ems -

provider - 全局数据库。

选项

  • "ems"

  • "gms"

  • "provider"

mr

整数

Mr。

name

字符串 / 必需

名称。

os_ver

字符串

Os ver。

选项

  • "unknown"

  • "0.0"

  • "1.0"

  • "2.0"

  • "3.0"

  • "4.0"

  • "5.0"

  • "6.0"

  • "7.0"

  • "8.0"

  • "9.0"

primary_dns_ip4

字符串

主 dns ip4。

primary_dns_ip6_1

整数

主 dns ip6 1。

primary_dns_ip6_2

整数

主 dns ip6 2。

primary_dns_ip6_3

整数

主 dns ip6 3。

primary_dns_ip6_4

整数

主 dns ip6 4。

restricted_prds

任何

(列表或字符串)受限 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

字符串

辅助 dns ip4。

secondary_dns_ip6_1

整数

辅助 dns ip6 1。

secondary_dns_ip6_2

整数

辅助 dns ip6 2。

secondary_dns_ip6_3

整数

辅助 dns ip6 3。

secondary_dns_ip6_4

整数

辅助 dns ip6 4。

state

整数

状态。

tz

整数

时区。

uuid

字符串

Uuid。

workspace_mode

整数

工作区模式。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

用于底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 adom,该值可以是 global 和其他值,包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间(以秒为单位)。

默认值: 300

说明

注意

  • 从版本 2.4.0 开始,所有输入参数都使用下划线命名约定 (snake_case) 命名。请将参数(如“var-name”)更改为“var_name”。旧的参数名称仍然可用,但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 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>

返回值

此处记录了常用返回值 here,以下是此模块独有的字段

描述

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)