community.network.avi_serverautoscalepolicy 模块 – 用于设置 ServerAutoScalePolicy Avi RESTful 对象的模块

注意

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

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

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

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

注意

community.network 集合已被弃用，并将从 Ansible 12 中移除。有关更多信息，请参阅 讨论主题。

已弃用

在以下版本中移除：

版本 6.0.0

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_serverautoscalepolicy

需求

以下需求是在执行此模块的主机上所需的。

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

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 控制器登录详细信息。

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

controller

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于与 session id 重用现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API session id，用于与 csrftoken 重用现有会话

默认值： ""

tenant

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

timeout

字符串

Avi 控制器请求超时

默认值： 300

token

字符串

Avi 控制器 API 令牌

默认值： ""

username

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

它禁用将 avi 会话信息缓存在事实中。

选项

  • false ← (默认)

  • true

controller

字符串

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

description

字符串

用户为对象定义的描述。

intelligent_autoscale

布尔值

使用 Avi 智能自动缩放算法，其中自动缩放是通过将池上的负载与所有服务器的估计容量进行比较来执行的。

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

选项

  • false

  • true

intelligent_scalein_margin

字符串

智能方案使用的负载的额外容量最大百分比。

当可用容量超过此裕度时，将触发缩容。

允许的值为 1-99。

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

intelligent_scaleout_margin

字符串

智能方案使用的负载的额外容量最小百分比。

当可用容量小于此裕度时，将触发扩容。

允许的值为 1-99。

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

max_scalein_adjustment_step

字符串

同时缩容的服务器最大数量。

选择的实际缩容服务器数量使得目标服务器数量始终大于或等于 min_size。

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

max_scaleout_adjustment_step

字符串

同时扩容的服务器最大数量。

选择的实际扩容服务器数量使得目标服务器数量始终小于或等于 max_size。

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

max_size

字符串

扩容后服务器的最大数量。

允许的值为 0-400。

min_size

字符串

一旦运行正常的服务器数量达到 min_servers，则不会发生缩容。

允许的值为 0-400。

name

字符串 / 必需

对象的名称。

password

字符串

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

scalein_alertconfig_refs

字符串

当由于任何这些告警配置而触发告警时，触发缩容。

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

scalein_cooldown

字符串

冷却期，在此期间不会触发新的缩容，以允许之前的缩容成功完成。

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

scaleout_alertconfig_refs

字符串

当由于任何这些告警配置而触发告警时，触发扩容。

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

scaleout_cooldown

字符串

冷却期，在此期间不会触发新的扩容，以允许之前的扩容成功完成。

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

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

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

tenant_uuid

字符串

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

默认值： ""

url

字符串

对象的 Avi 控制器 URL。

use_predicted_load

布尔值

使用预测负载而不是当前负载。

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

选项

  • false

  • true

username

字符串

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

uuid

字符串

对象的唯一对象标识符。

注释

注意

示例

- name: Example to create ServerAutoScalePolicy object
  community.network.avi_serverautoscalepolicy:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_serverautoscalepolicy

返回值

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

键

描述

obj

字典

ServerAutoScalePolicy (api/serverautoscalepolicy) 对象

返回：成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)