community.network.avi_serviceenginegroup 模块 – 用于设置 ServiceEngineGroup Avi RESTful 对象的模块

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

如果您使用的是 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。您需要其他需求才能使用此模块，请参阅 需求 以了解详细信息。

要在 playbook 中使用它，请指定：community.network.avi_serviceenginegroup。

注意

community.network 集合已弃用，并将从 Ansible 12 中删除。请参阅 讨论主题 以了解更多信息。

已弃用

在以下版本中移除：

版本 6.0.0

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

别名：network.avi.avi_serviceenginegroup

需求

执行此模块的主机需要以下需求。

  • avisdk

参数

参数

注释

accelerated_networking

布尔值

为 Azure SE 启用加速网络选项。

加速网络将单根 I/O 虚拟化 (SR-IOV) 启用到 SE VM。

这提高了网络性能。

在 17.2.14、18.1.5、18.2.1 中引入的字段。

选项

  • false

  • true

active_standby

布尔值

用于 HA 故障转移的活动/备用模式下的服务引擎。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

additional_config_memory

字符串

指示用于配置更新的配置内存百分比。

允许的值为 0-90。

在 18.1.2 中弃用的字段。

在 18.1.1 中引入的字段。

advertise_backend_networks

布尔值

通过 BGP 为默认网关功能通过 ADC 公告后端服务器网络的可达性。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

aggressive_failure_detection

布尔值

为 HA 启用积极的故障转移配置。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

algo

字符串

在紧凑型部署中，虚拟服务将放置在现有 SE 上，直到达到 max_vs_per_se 限制。

枚举选项 - PLACEMENT_ALGO_PACKED、PLACEMENT_ALGO_DISTRIBUTED。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 PLACEMENT_ALGO_PACKED。

allow_burst

布尔值

允许使用突发许可证创建 SE。

在 17.2.5 中引入的字段。

选项

  • false

  • true

api_context

字典

包含当前会话 ID 和 CSRF 令牌的 Avi API 上下文。

这允许用户执行单一登录并重复使用会话。

api_version

字符串

要用于 Avi API 和对象的 Avi API 版本。

默认值： "16.4.4"

app_cache_percent

字符串

为应用程序缓存保留的总 SE 内存的百分比值。

这是一个 SE 启动属性，需要 SE 重启。

允许的值为 0-100。

特殊值为 0 - '禁用'。

在 18.2.3 中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

app_learning_memory_percent

字符串

为应用程序学习保留的总 SE 内存的百分比值。

这是一个 SE 启动属性，需要 SE 重启。

允许的值为 0-10。

在 18.2.3 中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

archive_shm_limit

字符串

以 GB 为单位的 SE 内存量，直到该内存量为止，共享内存才会收集到核心存档中。

在 17.1.3 中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 8。

async_ssl

布尔值

SSL 握手将由专用 SSL 线程处理。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

async_ssl_threads

字符串

每个 se_dp 的异步 SSL 线程数。

允许的值为 1-16。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

auto_rebalance

布尔值

如果设置，则当 SE 上的负载低于最小值或高于最大值阈值时，虚拟服务将自动迁移。

仅当未设置 auto_rebalance 时才会生成警报。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

auto_rebalance_capacity_per_se

字符串

每个条件下用于自动重新平衡的 SE 容量。

在 17.2.4 版本中引入。

auto_rebalance_criteria

字符串

SE 自动重新平衡的条件集。

枚举选项 - SE_AUTO_REBALANCE_CPU、SE_AUTO_REBALANCE_PPS、SE_AUTO_REBALANCE_MBPS、SE_AUTO_REBALANCE_OPEN_CONNS、SE_AUTO_REBALANCE_CPS。

在 17.2.3 版本中引入。

auto_rebalance_interval

字符串

如果启用了“自动重新平衡”，则重新平衡的频率。

如果未在 API 或模块中指定，Avi Controller 将其解释为 300。

auto_redistribute_active_standby_load

布尔值

将虚拟服务从接管的 SE 重新分配到替换的 SE 可能会导致短暂的流量丢失。

如果 auto-redistribute load 选项保持其默认关闭状态，则任何所需的重新平衡都需要调用 REST API。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

avi_api_patch_op

字符串

当使用 avi_api_update_method 为 patch 时使用的补丁操作。

选项

  • “add”

  • “replace”

  • “delete”

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选项

  • "put" ← (默认)

  • “patch”

avi_credentials

字典

Avi 凭据字典，可用于代替枚举 Avi Controller 登录详细信息。

api_version

字符串

Avi Controller 版本

默认值： "16.4.4"

controller

字符串

Avi Controller IP 或 SQDN

csrftoken

字符串

Avi Controller API csrftoken，用于与 session id 重新使用现有会话。

默认值： ""

password

字符串

Avi Controller 密码

port

字符串

Avi Controller 端口

session_id

字符串

Avi Controller API session id，用于与 csrftoken 重新使用现有会话。

默认值： ""

tenant

字符串

Avi Controller 租户

默认值： "admin"

tenant_uuid

字符串

Avi Controller 租户 UUID

默认值： ""

timeout

字符串

Avi Controller 请求超时

默认值： 300

token

字符串

Avi Controller API 令牌

默认值： ""

username

字符串

Avi Controller 用户名

avi_disable_session_cache_as_fact

布尔值

禁用将 Avi 会话信息作为事实缓存。

选项

  • false ← (默认)

  • true

bgp_state_update_interval

字符串

BGP 对等体状态更新间隔。

允许的值为 5-100。

在 17.2.14、18.1.5、18.2.1 中引入的字段。

如果未在 API 或模块中指定，Avi Controller 将其解释为 10。

buffer_se

字符串

为 HA 故障转移预配的额外服务引擎容量。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

cloud_ref

字符串

它是对 cloud 类型对象的引用。

config_debugs_on_all_cores

布尔值

启用 SE 所有核心上的配置调试。

在 17.2.13、18.1.5、18.2.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

connection_memory_percentage

字符串

连接状态的内存百分比。

这将以牺牲用于 HTTP 内存缓存的内存为代价。

允许的值为 10-90。

如果未在 API 或模块中指定，Avi Controller 将其解释为 50。

controller

字符串

Controller 的 IP 地址或主机名。默认值为环境变量 AVI_CONTROLLER。

cpu_reserve

布尔值

用于设置 cpu_reserve 的布尔标志。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

cpu_socket_affinity

布尔值

将服务引擎虚拟机的所有 CPU 内核分配到同一个 CPU 插槽上。

仅适用于 vCenter Cloud。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

custom_securitygroups_data

字符串

与 OpenStack 和 AWS 云中 SE 实例的数据 vNIC 关联的自定义安全组。

在 17.1.3 中引入的字段。

custom_securitygroups_mgmt

字符串

与 OpenStack 和 AWS 云中 SE 实例的管理 vNIC 关联的自定义安全组。

在 17.1.3 中引入的字段。

custom_tag

字符串

自定义标签将用于为 AWS 中的 SE 实例创建标签。

请注意，这与 SE 名称的前缀不同。

data_network_id

字符串

用于启动服务引擎数据 NIC 的子网，仅用于 Azure 云。

覆盖服务引擎子网的云级别设置。

在 18.2.3 中引入的字段。

datascript_timeout

字符串

数据脚本超时之前的指令数。

允许的值为 0-100000000。

在 18.2.3 中引入的字段。

如果未在 API 或模块中指定，Avi Controller 将其解释为 1000000。

dedicated_dispatcher_core

布尔值

将处理来自网络的数据包接收/传输的核心专门用于调度功能。

不要将其用于 TCP/IP 和 SSL 功能。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

description

字符串

对象的自定义描述。

disable_avi_securitygroups

布尔值

默认情况下，Avi 会创建和管理安全组以及用户提供的自定义安全组。

将其设置为 true 以禁止 Avi 创建和管理新的安全组。

Avi 仅使用用户提供的自定义安全组。

此选项仅支持 AWS 云类型。

在 17.2.13、18.1.4、18.2.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

disable_csum_offloads

布尔值

停止使用 NIC 的 TCP/UDP 和 IP 校验和卸载功能。

在 17.1.14、17.2.5、18.1.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

disable_gro

布尔值

在 DPDK 轮询模式驱动程序数据包接收路径中禁用通用接收卸载 (GRO)。

GRO 默认情况下在不支持 LRO（大型接收卸载）或从 LRO 中获得性能提升的 NIC 上启用。

在 17.2.5、18.1.1 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

disable_se_memory_check

布尔值

如果设置，则禁用在服务引擎中进行的配置内存检查。

在 18.1.2 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

disable_tso

布尔值

在 DPDK 轮询模式驱动程序数据包传输路径中禁用 TCP 分段卸载 (TSO)。

TSO 默认情况下在支持它的 NIC 上启用。

在 17.2.5、18.1.1 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

disk_per_se

字符串

每个服务引擎虚拟机的磁盘空间量。

如果未在 API 或模块中指定，Avi Controller 将其解释为 10。

distribute_load_active_standby

布尔值

在传统的主动-备用 HA 模式下，同时使用主动和备用服务引擎进行虚拟服务放置。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

distribute_queues

布尔值

在核心之间分配队列所有权，以便多个核心处理调度程序职责。

在 17.2.8 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

enable_hsm_priming

布尔值

(这是一个测试版功能)。

启用 HSM 密钥预加载。

如果启用，则在处理客户端连接之前，HSM 上的密钥句柄将同步到 SE。

在 17.2.7、18.1.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

enable_multi_lb

布尔值

仅适用于带有基本 SKU LB 的 Azure 云。

如果设置，如果现有 LB 中的资源耗尽，将自动创建其他 Azure LB。

在 17.2.10、18.1.2 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

enable_routing

布尔值

为此 serviceenginegroup 启用路由。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

enable_vip_on_all_interfaces

布尔值

在 SE 的所有接口上启用 VIP。

在 17.1.1 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

enable_vmac

布尔值

对放置浮动接口 IP 的接口使用虚拟 MAC 地址。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

ephemeral_portrange_end

字符串

出站连接的结束本地临时端口号。

在 17.2.13、18.1.5、18.2.1 版本中引入。

ephemeral_portrange_start

字符串

出站连接的起始本地临时端口号。

在 17.2.13、18.1.5、18.2.1 版本中引入。

extra_config_multiplier

字符串

用于额外配置的乘数，以支持大型 VS/池配置。

如果未在 API 或模块中指定，Avi Controller 将其解释为 0.0。

extra_shared_config_memory

字符串

支持大型地理数据库配置的额外配置内存。

在 17.1.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

floating_intf_ip

字符串

如果 serviceenginegroup 配置为传统的 1+1 主动-备用 HA 模式，则浮动 IP 仅由对中的活动 SE 通告。

此组中的虚拟服务必须被禁用/启用才能使对浮动 IP 的任何更改生效。

只有托管带有主动-备用 SE 1 标签的 VS 的活动 SE 在启用手动负载分配时才会通告此浮动 IP。

floating_intf_ip_se_2

字符串

如果 serviceenginegroup 配置为传统的 1+1 主动-备用 HA 模式，则浮动 IP 仅由对中的活动 SE 通告。

此组中的虚拟服务必须被禁用/启用才能使对浮动 IP 的任何更改生效。

只有托管带有主动-备用 SE 2 标签的 VS 的活动 SE 在启用手动负载分配时才会通告此浮动 IP。

flow_table_new_syn_max_entries

字符串

尚未完成 TCP 三次握手的数据包流表条目的最大数量。

在 17.2.5 中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

free_list_size

字符串

空闲列表中的条目数。

在 17.2.10、18.1.2 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 1024。

ha_mode

字符串

使用此服务引擎组的所有虚拟服务的高可用性模式。

枚举选项 - HA_MODE_SHARED_PAIR、HA_MODE_SHARED、HA_MODE_LEGACY_ACTIVE_STANDBY。

如果未在 API 或模块中指定，Avi Controller 将其解释为 HA_MODE_SHARED。

hardwaresecuritymodulegroup_ref

字符串

它是对 hardwaresecuritymodulegroup 类型对象的引用。

heap_minimum_config_memory

字符串

应用任何配置所需的最小堆内存。

允许的值为 0-100。

在 18.1.2 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 8。

hm_on_standby

布尔值

为所有已放置的虚拟服务启用来自备用 SE 的活动运行状况监控。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

host_attribute_key

字符串

标识一组节点（通常在容器云中）的标签的 (键，值) 对的键。

需要与 host_attribute_value 一起指定。

可以对 SE 进行不同的配置，包括跨不同 SE 组的 HA 模式。

也可用于不同类别的虚拟服务之间的隔离。

虚拟服务的 SE 组可以通过注释/标签指定。

OpenShift/Kubernetes 命名空间可以使用与 SE 组标签匹配的注释，例如 openshift.io/node-selector apptype=prod。

当在具有指定主机属性的云中使用多个 SE 组时，只有一个 SE 组可以作为没有 host_attribute_key 的匹配所有 SE 组存在。

host_attribute_value

字符串

标识一组节点（通常在容器云中）的标签的 (键，值) 对的值。

需要与 host_attribute_key 一起指定。

host_gateway_monitor

布尔值

当服务引擎作为 Docker 容器部署时，启用主机网关监控。

默认情况下禁用。

在 17.2.4 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

hypervisor

字符串

覆盖默认虚拟机管理程序。

枚举选项 - DEFAULT、VMWARE_ESX、KVM、VMWARE_VSAN、XEN。

ignore_rtt_threshold

字符串

如果 RTT 样本高于阈值，则忽略。

在 17.1.6、17.2.2 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 5000。

ingress_access_data

字符串

为 SE 安全组入口规则编程，以允许来自远程 CIDR 类型的 VIP 数据访问。

枚举选项 - SG_INGRESS_ACCESS_NONE、SG_INGRESS_ACCESS_ALL、SG_INGRESS_ACCESS_VPC。

在 17.1.5 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 SG_INGRESS_ACCESS_ALL。

ingress_access_mgmt

字符串

为 SE 安全组入口规则编程，以允许来自远程 CIDR 类型的 SSH/ICMP 管理访问。

枚举选项 - SG_INGRESS_ACCESS_NONE、SG_INGRESS_ACCESS_ALL、SG_INGRESS_ACCESS_VPC。

在 17.1.5 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 SG_INGRESS_ACCESS_ALL。

instance_flavor

字符串

SE 实例的实例/类型名称。

iptables

字符串

iptables 规则。

least_load_core_selection

布尔值

为新数据流选择负载最小的核心。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

license_tier

字符串

指定将使用的许可证层级。

此字段默认继承自云。

枚举选项 - ENTERPRISE_16、ENTERPRISE_18。

在 17.2.5 中引入的字段。

license_type

字符串

如果没有指定许可证类型，则选择云类型的默认许可证执行。

枚举选项 - LIC_BACKEND_SERVERS、LIC_SOCKETS、LIC_CORES、LIC_HOSTS、LIC_SE_BANDWIDTH、LIC_METERED_SE_BANDWIDTH。

在 17.2.5 中引入的字段。

log_disksz

字符串

分配给 SE 的最大磁盘容量（以 MB 为单位）。

这专门用于调试和日志数据。

如果未在 API 或模块中指定，Avi Controller 将其解释为 10000。

max_cpu_usage

字符串

当 SE 上的 CPU 使用率超过此阈值时，托管在此 SE 上的虚拟服务可能会重新平衡到其他 SE 以减少负载。

在此过程中可能会创建一个新的 SE。

允许的值为 40-90。

如果未在 API 或模块中指定，Avi Controller 将其解释为 80。

max_memory_per_mempool

字符串

可以在单个内存池中分配的最大字节数。

在 18.1.5 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 64。

max_public_ips_per_lb

字符串

仅适用于 Azure 平台。

每个 Azure LB 的最大公共 IP 数。

该字段在 17.2.12、18.1.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 30。

max_rules_per_lb

字符串

仅适用于 Azure 平台。

每个 Azure 负载均衡器的最大规则数。

该字段在 17.2.12、18.1.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 150。

max_scaleout_per_vs

字符串

虚拟服务的最大活动服务引擎数。

允许的值为 1-64。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 4。

max_se

字符串

此组中的最大服务引擎数。

允许的值为 0-1000。

如果未在 API 或模块中指定，Avi Controller 将其解释为 10。

max_vs_per_se

字符串

单个服务引擎上可以部署的最大虚拟服务数。

东西向虚拟服务不受此限制。

允许的值为 1-1000。

如果未在 API 或模块中指定，Avi Controller 将其解释为 10。

mem_reserve

布尔值

用于设置 mem_reserve 的布尔标志。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

memory_for_config_update

字符串

指示为配置更新保留的内存百分比。

允许的值为 0-100。

在 18.1.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 15。

memory_per_se

字符串

每个服务引擎虚拟机的内存量。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 2048。

mgmt_network_ref

字符串

Avi 服务引擎使用的管理网络。

它是对类型为 network 的对象的引用。

mgmt_subnet

字符串

Avi 服务引擎使用的管理子网。

min_cpu_usage

字符串

当 SE 上的 CPU 使用率低于最小阈值时，托管在该 SE 上的虚拟服务可能会合并到其他未充分利用的 SE 上。

合并后，未使用的服务引擎可能有资格被删除。

允许的值为 20-60。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 30。

min_scaleout_per_vs

字符串

虚拟服务的最小活动服务引擎数。

允许的值为 1-64。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

min_se

字符串

此组中的最小服务引擎数（仅与 SE 自动再平衡相关）。

允许的值为 0-1000。

该字段在 17.2.13、18.1.3、18.2.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

minimum_connection_memory

字符串

指示为连接保留的内存百分比。

允许的值为 0-100。

在 18.1.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 20。

minimum_required_config_memory

字符串

应用任何配置所需的可用配置内存。

允许的值为 0-90。

在 18.1.2 中弃用的字段。

在 18.1.1 中引入的字段。

n_log_streaming_threads

字符串

用于日志流的线程数。

允许的值为 1-100。

该字段在 17.2.12、18.1.2 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

name

字符串 / 必填

对象的名称。

non_significant_log_throttle

字符串

此设置限制此 SE 上每秒每个核心生成的非重要日志的数量。

默认为每秒 100 条日志。

将其设置为零 (0) 可禁用节流。

在 17.1.3 中引入的字段。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 100。

num_dispatcher_cores

字符串

调度程序内核数 (0, 1, 2, 4, 8 或 16)。

如果设置为 0，则会自动推断调度程序内核数。

允许的值为 0, 1, 2, 4, 8, 16。

该字段在 17.2.12、18.1.3、18.2.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

num_flow_cores_sum_changes_to_ignore

字符串

要忽略的 num flow cores sum 更改次数。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 8。

openstack_availability_zone

字符串

在 17.1.1 版本中已弃用。

openstack_availability_zones

字符串

在 17.1.1 版本中引入。

openstack_mgmt_network_name

字符串

Avi 管理网络名称。

openstack_mgmt_network_uuid

字符串

管理网络 UUID。

os_reserved_memory

字符串

为服务引擎上的操作系统保留的额外内存量。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

password

字符串

Avi 控制器中 Avi 用户的密码。默认值为环境变量 AVI_PASSWORD。

per_app

布尔值

每应用 SE 模式旨在为每个应用 (VS) 部署专用的负载均衡器。

在此模式下，每个 SE 限制为最多 2 个 VS。

每应用 SE 中的 VCPU 以 25% 的比率计入许可使用情况。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

placement_mode

字符串

如果放置模式为“auto”，则虚拟服务将自动放置在服务引擎上。

枚举选项 - PLACEMENT_MODE_AUTO。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 PLACEMENT_MODE_AUTO。

realtime_se_metrics

字符串

启用或禁用实时 SE 指标。

reboot_on_stop

布尔值

如果停止 SE，则重新启动系统。

该字段在 17.2.16、18.2.3 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

se_bandwidth_type

字符串

为带宽许可证选择 SE 带宽。

枚举选项 - SE_BANDWIDTH_UNLIMITED, SE_BANDWIDTH_25M, SE_BANDWIDTH_200M, SE_BANDWIDTH_1000M, SE_BANDWIDTH_10000M。

在 17.2.5 中引入的字段。

se_deprovision_delay

字符串

在删除未使用的服务引擎虚拟机之前保留它们的时间。

如果对虚拟服务的流量突然激增，此 SE 仍然可用再次使用，而不是创建新的 SE。

如果此值设置为 0，控制器将永远不会删除任何 SE，管理员必须手动清理未使用的 SE。

允许的值为 0-525600。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 120。

se_dos_profile

字符串

服务引擎组的 Dosthresholdprofile 设置。

se_dpdk_pmd

字符串

确定是否应使用 dpdk 池模式驱动程序：0 自动根据虚拟机管理程序/网卡类型确定；1 无条件使用 dpdk 轮询模式驱动程序；2 不使用 dpdk 轮询模式驱动程序。

轮询模式驱动程序 2 不使用 dpdk 轮询模式驱动程序。

允许的值为 0-2。

该字段在 18.1.3 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

se_flow_probe_retries

字符串

如果没有收到回复，则进行流探测重试次数。

允许的值为 0-5。

该字段在 18.1.4、18.2.1 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 2。

se_flow_probe_timer

字符串

流探测条目的超时时间（毫秒）。

允许的值为 10-200。

该字段在 18.1.4、18.2.1 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 100。

se_ipc_udp_port

字符串

在 Docker 桥接模式下用于 se_dp ipc 的 UDP 端口。

该字段在 17.1.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 1500。

se_name_prefix

字符串

用于服务引擎虚拟机名称的前缀。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 Avi。

se_pcap_lookahead

布尔值

启用 pcap 模式下的数据包接收的超前模式。

引入是为了解决 hv_netvsc 驱动程序的问题。

超前模式尝试确保应用程序和内核对接收环的视图一致。

在 18.2.3 中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

se_pcap_reinit_frequency

字符串

定期触发 pcap 重新初始化检查的频率（秒）。

可以与配置 pcap_reinit_threshold 结合使用。

（有效范围：15 分钟 - 12 小时，0 - 禁用）。

允许的值为 900-43200。

特殊值为 0 - '禁用'。

该字段在 17.2.13、18.1.3、18.2.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

se_pcap_reinit_threshold

字符串

pcap 模式下输入数据包接收错误超过此阈值时将触发 pcap 重新初始化。

如果未设置，则执行无条件重新初始化。

每隔 pcap_reinit_frequency 间隔检查此值。

该字段在 17.2.13、18.1.3、18.2.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

se_probe_port

字符串

SE 上将运行 echo 服务的 TCP 端口。

该字段在 17.2.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 7。

se_remote_punt_udp_port

字符串

在 Docker 桥接模式下用于已丢弃数据包的 UDP 端口。

该字段在 17.1.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 1501。

se_routing

布尔值

启用通过服务引擎数据路径进行路由。

禁用时，路由由 Linux 内核完成。

需要在服务引擎组中启用 IP 路由才能使 SE 路由生效。

在 18.2.3 中引入的字段。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

se_sb_dedicated_core

布尔值

旁路流量将由专用核心处理。

该字段在 16.5.2、17.1.9、17.2.3 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

se_sb_threads

字符串

每个 SE 的旁路线程数。

允许的值为 1-128。

该字段在 16.5.2、17.1.9、17.2.3 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

se_thread_multiplier

字符串

基于 vCPU 的 SE 线程乘数。

允许的值为 1-10。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

se_tracert_port_range

字符串

Traceroute 端口范围。

在 17.2.8 版本中引入。

se_tunnel_mode

字符串

确定来自辅助 SE 的 DSR 是否处于活动状态：0 自动根据虚拟机管理程序类型确定；1 无条件禁用 DSR；2 无条件启用 DSR。

1 无条件禁用 DSR。

2 无条件启用 DSR。

允许的值为 0-2。

在 17.1.1 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

se_tunnel_udp_port

字符串

在 Docker 桥接模式下，用于从辅助 SE 到主 SE 的隧道数据包的 UDP 端口。

在 17.1.3 中引入的字段。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 1550。

se_udp_encap_ipc

字符串

确定 SE-SE ipc 消息是否封装在 UDP 头部中：0 自动根据虚拟机管理程序类型确定；1 无条件使用 UDP 封装。

1 无条件使用 UDP 封装。

允许的值为 0-1。

该字段在 17.1.2 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

se_use_dpdk

字符串

确定是否应使用 dpdk 库：0 自动根据虚拟机管理程序类型确定；1 如果未启用 pcap，则使用 dpdk；2 不使用 dpdk。

不使用 dpdk。

允许的值为 0-2。

该字段在 18.1.3 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

se_vs_hb_max_pkts_in_batch

字符串

批量发送的聚合 VS 心跳数据包的最大数量。

允许的值为 1-256。

在 17.1.1 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 64。

se_vs_hb_max_vs_in_pkt

字符串

在一个数据包中聚合心跳消息的虚拟服务最大数量。

允许的值为 1-1024。

在 17.1.1 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 256。

self_se_election

布尔值

启用 SE 在无法连接到控制器的情况下自行选举主 SE。

在 18.1.2 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

service_ip6_subnets

字符串

分配给 SE 组的 IPv6 子网。

VS 组放置所需。

在 18.1.1 中引入的字段。

service_ip_subnets

字符串

分配给 SE 组的子网。

VS 组放置所需。

在 17.1.1 版本中引入。

shm_minimum_config_memory

字符串

应用任何配置所需的最小共享内存。

允许的值为 0-100。

在 18.1.2 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 4。

significant_log_throttle

字符串

此设置限制此 SE 上每秒每个核心生成的重要日志的数量。

默认为每秒 100 条日志。

将其设置为零 (0) 可禁用节流。

在 17.1.3 中引入的字段。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 100。

ssl_preprocess_sni_hostname

布尔值

（测试版）预处理 SSL 客户端 Hello 的 SNI 主机名扩展。如果设置为 true，这将应用 SNI 子级的 SSL 协议（如果不同），

来自 SNI 父级允许的 SSL 协议。

该字段在 17.2.12、18.1.3 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

用于所有 Avi API 调用和对象上下文的租户名称。

默认值： "admin"

tenant_ref

字符串

它是对类型为 tenant 的对象的引用。

tenant_uuid

字符串

用于所有 Avi API 调用和对象上下文的租户 UUID。

默认值： ""

udf_log_throttle

字符串

此设置限制此 SE 上每秒每个核心生成的 UDF 日志的数量。

由于配置的客户端日志过滤器或启用了日志记录的规则，会生成 UDF 日志。

默认为每秒 100 条日志。

将其设置为零 (0) 可禁用节流。

在 17.1.3 中引入的字段。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 100。

url

字符串

对象的 Avi 控制器 URL。

use_standard_alb

布尔值

使用标准 SKU Azure 负载均衡器。

默认情况下设置云级别标志。

如果未设置，它将继承/使用来自云的 use_standard_alb 标志。

在 18.2.3 中引入的字段。

选项

  • false

  • true

username

字符串

用于访问 Avi 控制器的用户名。默认值为环境变量 AVI_USERNAME。

uuid

字符串

对象的唯一对象标识符。

vcenter_clusters

字符串

服务引擎组的 Vcenterclusters 设置。

vcenter_datastore_mode

字符串

枚举选项 - vcenter_datastore_any, vcenter_datastore_local, vcenter_datastore_shared。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 VCENTER_DATASTORE_ANY。

vcenter_datastores

字符串

vCenter 数据存储列表。

vcenter_datastores_include

布尔值

设置 vcenter_datastores_include 的布尔标志。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

vcenter_folder

字符串

在 vCenter 中放置所有服务引擎虚拟机的文件夹。

如果 API 或模块中未指定，Avi Controller 将其解释为 AviSeFolder。

vcenter_hosts

字符串

serviceenginegroup 的 Vcenterhosts 设置。

vcpus_per_se

字符串

每个服务引擎虚拟机的 vCPU 数量。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 1。

vip_asg

字符串

当设置 vip_asg 时，VIP 配置将由 Avi 管理。用户可以在创建时单独配置 vip_asg 或 VIP。

该字段在 17.2.12、18.1.2 版本中引入。

vs_host_redundancy

布尔值

确保主服务引擎和辅助服务引擎部署在不同的物理主机上。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

vs_scalein_timeout

字符串

等待缩容的 SE 排空现有流量，然后标记缩容完成的时间。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 30。

vs_scalein_timeout_for_upgrade

字符串

在 SE 升级期间，等待缩容的 SE 排空现有流量，然后标记缩容完成的时间。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 30。

vs_scaleout_timeout

字符串

等待扩容的 SE 准备就绪，然后标记扩容完成的时间。

如果 API 或模块中未指定，Avi Controller 将其解释为 600。

vs_se_scaleout_additional_wait_time

字符串

虚拟服务标记为启动后，发送扩容就绪通知的等待时间。

在某些部署中，可能会有额外的延迟才能接受流量。

例如，对于 BGP，需要一些时间来进行路由公告。

允许的值为 0-20。

在 18.1.5、18.2.1 版本中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

vs_se_scaleout_ready_timeout

字符串

服务引擎发送虚拟服务的扩容就绪通知的超时时间（秒）。

允许的值为 0-60。

在 18.1.5、18.2.1 版本中引入的字段。

如果 API 或模块中未指定，Avi Controller 将其解释为 25。

vs_switchover_timeout

字符串

在传统主动/备用 segroup 中进行 SE 升级期间，等待新的主 SE 接受流量然后标记切换完成的时间。

在 17.2.13、18.1.4、18.2.1 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 300。

vss_placement

字符串

仅将虚拟服务放置在 SE 的一部分内核上的参数。

在 17.2.5 中引入的字段。

vss_placement_enabled

布尔值

如果设置，虚拟服务将仅放置在 SE 的一部分内核上。

在 18.1.1 中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

waf_learning_interval

字符串

SE 发布 WAF 学习的频率。

允许的值为 1-43200。

在 18.2.3 版本中已弃用。

在 18.1.2 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 10。

waf_learning_memory

字符串

在 SE 上为 WAF 学习保留的内存量。

不能超过 SE 内存的 5%。

在 18.2.3 版本中已弃用。

在 18.1.2 版本中引入。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 0。

waf_mempool

布尔值

启用 WAF 的内存池。

在 17.2.3 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 True。

选项

  • false

  • true

waf_mempool_size

字符串

用于 WAF 的内存池大小。

在 17.2.3 版本中引入。

如果未在 API 或模块中指定，Avi Controller 将其解释为 64。

注释

注意

示例

- name: Example to create ServiceEngineGroup object
  community.network.avi_serviceenginegroup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_serviceenginegroup

返回值

常见的返回值已在 此处 记录，以下是此模块独有的字段

键

描述

obj

字典

ServiceEngineGroup (api/serviceenginegroup) 对象

返回：success, changed

状态

  • 此模块将在 6.0.0 版本中移除。[已弃用]

  • 有关更多信息，请参见 已弃用。

作者

  • Gaurav Rastogi (@grastogi23)