fortinet.fortimanager.fmgr_dvmdb_adom 模块 – ADOM 表，大多数属性是只读的，只能内部修改。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_dvmdb_adom。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括在使用前需要调整到数据源的所有参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
设置的顶级参数。 |
|
创建时间。 |
|
描述。 |
|
标志。 选项
|
|
锁定覆盖。 |
|
日志数据库保留小时数。 |
|
日志磁盘配额。 |
|
日志磁盘配额警报阈值。 |
|
日志磁盘配额分割比例。 |
|
日志文件保留小时数。 |
|
默认元字段 |
|
迁移版本。 |
|
迁移操作系统版本。 选项
|
|
ems - provider - 全局数据库。 选项
|
|
版本。 |
|
名称。 |
|
操作系统版本。 选项
|
|
主DNS IPv4地址。 |
|
主DNS IPv6地址 1。 |
|
主DNS IPv6地址 2。 |
|
主DNS IPv6地址 3。 |
|
主DNS IPv6地址 4。 |
|
(列表或字符串) 受限产品。 选项
|
|
辅助DNS IPv4地址。 |
|
辅助DNS IPv6地址 1。 |
|
辅助DNS IPv6地址 2。 |
|
辅助DNS IPv6地址 3。 |
|
辅助DNS IPv6地址 4。 |
|
状态。 |
|
时区。 |
|
UUID。 |
|
工作区模式。 |
|
启用/禁用任务日志记录。 选项
|
|
使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将被覆盖的失败条件的 RC 代码列表。 |
|
将被覆盖的成功条件的 RC 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行 FortiManager 时要锁定的 ADOM，该值可以是全局的和其他值，包括 root。 |
|
等待其他用户释放工作区锁定的最大时间（秒）。 默认值： |
备注
注意
从 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>
返回值
常用返回值已在此处记录，以下是此模块独有的字段：
键 |
描述 |
|---|---|
请求的结果。 返回值：始终返回 |
|
请求的完整 URL。 返回值：始终返回 示例： |
|
API 请求的状态。 返回值：始终返回 示例： |
|
API 响应。 返回值：始终返回 |
|
API 响应的描述性消息。 返回值：始终返回 示例： |
|
目标系统的信息。 返回值：始终返回 |
|
请求的状态。 返回值：始终返回 示例： |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回值：复杂类型 |