fortinet.fortios.fortios_icap_server_group 模块 – 配置一个由多个转发服务器组成的 ICAP 服务器组。支持 Fortinet FortiOS 和 FortiGate 中的故障转移和负载均衡。
注意
此模块是 fortinet.fortios 集合(版本 2.3.8)的一部分。
如果您正在使用 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortios
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:fortinet.fortios.fortios_icap_server_group
。
在 fortinet.fortios 2.0.0 中新增
概要
此模块能够通过允许用户设置和修改 icap 功能和 server_group 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值,需要在使用前调整到数据源。已使用 FOS v6.0.0 进行测试
要求
在执行此模块的主机上需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选择
|
|
配置一个由多个转发服务器组成的 ICAP 服务器组。支持故障转移和负载均衡。 |
|
负载均衡方法。 选择
|
|
配置一个由一个或多个转发服务器组成的 ICAP 服务器组。支持故障转移和负载均衡。 |
|
将 ICAP 服务器添加到列表以形成服务器组。可以选择为每个服务器分配权重。 |
|
ICAP 服务器名称。源 icap.server.name。 |
|
可以选择为转发服务器分配权重,用于加权负载均衡 (1 - 100)。 |
|
要操作的成员属性路径。 如果存在多个属性,则用斜杠字符分隔。 标记为 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时,将忽略 state 选项。 选择
|
|
指示是创建还是删除对象。 选择
|
|
虚拟域,在先前定义的域中。vdom 是 FortiGate 的虚拟实例,可以配置并用作不同的单元。 默认值: |
注释
注意
旧版 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式
示例
- name: Configure an ICAP server group consisting of multiple forward servers. Supports failover and load balancing.
fortinet.fortios.fortios_icap_server_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
icap_server_group:
ldb_method: "weighted"
name: "default_name_4"
server_list:
-
name: "default_name_6 (source icap.server.name)"
weight: "10"
返回值
常见的返回值记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
Fortigate 镜像的构建号 返回值: 始终 示例: |
|
用于将内容配置到 FortiGate 中的最后一种方法 返回值: 始终 示例: |
|
FortiGate 在上次应用操作时给出的最后结果 返回值: 始终 示例: |
|
上次调用 FortiGate 时使用的主键 (id) 返回值: 成功 示例: |
|
用于满足请求的表名称 返回值: 始终 示例: |
|
用于满足请求的表路径 返回值: 始终 示例: |
|
内部修订号 返回值: 始终 示例: |
|
设备的序列号 返回值: 始终 示例: |
|
操作结果的指示 返回值: 始终 示例: |
|
使用的虚拟域 返回值: 始终 示例: |
|
FortiGate 的版本 返回值: 始终 示例: |