fortinet.fortimanager.fmgr_sys_cloud_orchest 模块 – 系统云编排
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_sys_cloud_orchest。
fortinet.fortimanager 2.2.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整到数据源的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 FortiCloud API 访问令牌验证 Ansible 客户端。 |
|
将被覆盖的失败条件的 RC 代码列表。 |
|
将被覆盖的成功条件的 RC 代码列表。 |
|
设置的顶级参数。 |
|
操作。 选项
|
|
虚拟域。 |
|
虚拟域 OID。 |
|
名称。 |
|
在工作区模式下运行 FortiManager 时要锁定的虚拟域，值可以是全局的和其他包括 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: Sys cloud orchest
fortinet.fortimanager.fmgr_sys_cloud_orchest:
# 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, ...]
sys_cloud_orchest:
action: <value in [deploy, undeploy, status]>
adom: <string>
adom_oid: <integer>
name: <string>
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回值： 始终 |
|
请求的完整 URL。 返回值： 始终 示例： |
|
API 请求的状态。 返回值： 始终 示例： |
|
API 响应。 返回值： 始终 |
|
API 响应的描述性消息。 返回值： 始终 示例： |
|
目标系统的信息。 返回值： 始终 |
|
请求的状态。 返回值： 始终 示例： |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回值： 复杂类型 |