community.network.avi_controllerproperties 模块 – 用于设置 ControllerProperties Avi RESTful 对象的模块

注意

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

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

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

要在剧本中使用它，请指定：community.network.avi_controllerproperties。

注意

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

已弃用

在以下版本中删除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_controllerproperties

要求

以下要求需要在执行此模块的主机上满足。

  • avisdk

参数

参数

注释

allow_ip_forwarding

布尔值

在 17.1.1 中引入的字段。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 False。

选项

  • false

  • true

allow_unauthenticated_apis

布尔值

允许对特殊 API 进行未经身份验证的访问。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 False。

选项

  • false

  • true

allow_unauthenticated_nodes

布尔值

设置 allow_unauthenticated_nodes 的布尔标志。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 False。

选项

  • false

  • true

api_context

字典

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

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

api_idle_timeout

字符串

允许的值为 0-1440。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 15。

api_perf_logging_threshold

字符串

用于在 portal_performance.log 和 server-timing 响应标头中记录请求时间的阈值。

任何阶段花费的时间超过阈值的 1% 都将包含在 server-timing 标头中。

在 18.1.4、18.2.1 中引入的字段。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 10000。

api_version

字符串

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

默认值： "16.4.4"

appviewx_compat_mode

布尔值

以 appviewx 兼容模式导出配置。

在 17.1.1 中引入的字段。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 False。

选项

  • false

  • true

attach_ip_retry_interval

字符串

attach_ip_retry_interval 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 360。

attach_ip_retry_limit

字符串

attach_ip_retry_limit 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 4。

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为 patch 时，要使用的 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，用于重用与会话 id 的现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API 会话 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

bm_use_ansible

布尔值

在裸机中使用 ansible 进行 se 创建。

在 17.2.2 中引入的字段。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 True。

选项

  • false

  • true

cleanup_expired_authtoken_timeout_period

字符串

用于身份验证令牌清理作业的周期。

在 18.1.1 中引入的字段。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

cleanup_sessions_timeout_period

字符串

用于会话清理作业的周期。

在 18.1.1 中引入的字段。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

cloud_reconcile

布尔值

启用/禁用所有云的定期协调。

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

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 True。

选项

  • false

  • true

cluster_ip_gratuitous_arp_period

字符串

用于集群 ip 免费 arp 作业的周期。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

consistency_check_timeout_period

字符串

用于一致性检查作业的周期。

在 18.1.1 中引入的字段。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

controller

字符串

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

crashed_se_reboot

字符串

crashed_se_reboot 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 900。

dead_se_detection_timer

字符串

dead_se_detection_timer 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 360。

dns_refresh_period

字符串

用于刷新池和 gslb dns 作业的周期。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

dummy

字符串

dummy 的数量。

enable_api_sharding

布尔值

此设置使控制器领导者能够将 api 请求分片到跟随者（如果有）。

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

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 True。

选项

  • false

  • true

enable_memory_balancer

布尔值

启用/禁用内存平衡器。

该字段在 17.2.8 版本中引入。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 True。

选项

  • false

  • true

fatal_error_lease_time

字符串

fatal_error_lease_time 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 120。

max_dead_se_in_grp

字符串

max_dead_se_in_grp 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 1。

max_pcap_per_tenant

字符串

每个租户存储的最大 pcap 文件数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 4。

max_seq_attach_ip_failures

字符串

导致 VS 放置停止的最大连续 IP 附加失败次数。

在 17.2.2 中引入的字段。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 3。

max_seq_vnic_failures

字符串

max_seq_vnic_failures 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 3。

password

字符串

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

persistence_key_rotate_period

字符串

应用程序持久性密钥轮换作业的周期。

允许的值为 1-1051200。

特殊值为 0 - ‘禁用’。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 0。

portal_token

字符串

用于将技术支持上传到门户的令牌。

该字段在 16.4.6、17.1.2 版本中引入。

process_locked_useraccounts_timeout_period

字符串

处理锁定的用户帐户作业的周期。

在 18.1.1 中引入的字段。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 1。

process_pki_profile_timeout_period

字符串

处理 pki 配置文件作业的周期。

在 18.1.1 中引入的字段。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 1440。

query_host_fail

字符串

query_host_fail 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 180。

safenet_hsm_version

字符串

控制器上安装的 safenet 包的版本。

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

se_create_timeout

字符串

se_create_timeout 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 900。

se_failover_attempt_interval

字符串

尝试故障转移到 SE 的间隔。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 300。

se_from_marketplace

字符串

此设置决定是从云市场部署 SE，还是由控制器创建 SE。

此设置仅在选择 BYOL 许可证时适用。

枚举选项 - MARKETPLACE, IMAGE。

在 18.1.4、18.2.1 中引入的字段。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 IMAGE。

se_offline_del

字符串

se_offline_del 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 172000。

se_vnic_cooldown

字符串

se_vnic_cooldown 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 120。

secure_channel_cleanup_timeout

字符串

安全通道清理作业的周期。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

secure_channel_controller_token_timeout

字符串

secure_channel_controller_token_timeout 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

secure_channel_se_token_timeout

字符串

secure_channel_se_token_timeout 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

seupgrade_fabric_pool_size

字符串

SE 升级期间用于所有 fabric 命令的池大小。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 20。

seupgrade_segroup_min_dead_timeout

字符串

在将 SE 组升级标记为卡住之前等待的时间。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 360。

ssl_certificate_expiry_warning_days

字符串

SSL 证书过期警告的天数。

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

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

默认值： "admin"

tenant_uuid

字符串

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

默认值： ""

unresponsive_se_reboot

字符串

unresponsive_se_reboot 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 300。

upgrade_dns_ttl

字符串

升级期间考虑 DNS TTL 的时间。

这是 SE 组中的 vs_scalein_timeout_for_upgrade 的补充。

在 17.1.1 中引入的字段。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 5。

upgrade_lease_time

字符串

upgrade_lease_time 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 360。

url

字符串

对象的 Avi 控制器 URL。

username

字符串

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

uuid

字符串

对象的唯一对象标识符。

vnic_op_fail_time

字符串

vnic_op_fail_time 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 180。

vs_apic_scaleout_timeout

字符串

在将扩展的 SE 标记为就绪之前，等待其就绪的时间，仅适用于 APIC 配置。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 360。

vs_awaiting_se_timeout

字符串

vs_awaiting_se_timeout 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

vs_key_rotate_period

字符串

轮换 VS 密钥作业的周期。

允许的值为 1-1051200。

特殊值为 0 - ‘禁用’。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 360。

vs_scaleout_ready_check_interval

字符串

当控制器等待来自服务引擎的 scaleoutready RPC 时，检查 scaleout_ready 状态的间隔。

该字段在 18.2.2 版本中引入。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

vs_se_attach_ip_fail

字符串

在将 SE 上的 IP 附加操作标记为失败之前等待的时间。

在 17.2.2 中引入的字段。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 600。

vs_se_bootup_fail

字符串

vs_se_bootup_fail 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 480。

vs_se_create_fail

字符串

vs_se_create_fail 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 1500。

vs_se_ping_fail

字符串

vs_se_ping_fail 的数量。

当 API 或模块中未指定时，默认值由 Avi 控制器解释为 60。

vs_se_vnic_fail

字符串

vs_se_vnic_fail 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 300。

vs_se_vnic_ip_fail

字符串

vs_se_vnic_ip_fail 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 120。

warmstart_se_reconnect_wait_time

字符串

warmstart_se_reconnect_wait_time 的数量。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 480。

warmstart_vs_resync_wait_time

字符串

warmstart VS 重新同步的超时时间。

在 18.1.4、18.2.1 中引入的字段。

当 API 或模块中未指定时，Avi 控制器将默认值解释为 300。

备注

注意

示例

- name: Example to create ControllerProperties object
  community.network.avi_controllerproperties:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_controllerproperties

返回值

通用返回值记录在 这里，以下是此模块独有的字段

键

描述

obj

字典

ControllerProperties (api/controllerproperties) 对象

返回：成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)