fortinet.fortimanager.fmgr_dvmdb_workflow_save 模块 – 设备管理器数据库工作流保存
注意
此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_dvmdb_workflow_save
。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值,在使用前需要根据数据源进行调整。
参数
参数 |
注释 |
---|---|
用于访问 FortiManager 而无需使用用户名和密码的令牌。 |
|
请求的 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True,模块将继续执行而不验证参数。 选择
|
|
启用/禁用任务日志记录。 选择
|
|
使用 FortiCloud API 访问令牌验证 Ansible 客户端。 |
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
请求的 URL 中的参数 (session_id)。 |
|
为以工作区模式运行的 FortiManager 锁定 adom,该值可以是 global 和其他包括 root。 |
|
等待其他用户释放工作区锁定的最长时间(以秒为单位)。 默认值: |
说明
注意
从 2.4.0 版本开始,所有输入参数都使用下划线命名约定 (snake_case) 进行命名。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用,但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行,顶层参数 workspace_locking_adom 和 workspace_locking_timeout 帮助完成这项工作。
通常,当返回非零 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: Device manager database workflow save
fortinet.fortimanager.fmgr_dvmdb_workflow_save:
# 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>
session_id: <your own value>
返回值
通用返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则会发出警告。 返回: 复杂 |