community.network.avi_systemconfiguration 模块 – 用于设置 SystemConfiguration Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

版本 6.0.0

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_systemconfiguration

需求

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

  • avisdk

参数

参数

注释

admin_auth_configuration

字符串

SystemConfiguration 的 Adminauthconfiguration 设置。

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 Controller 登录详细信息。

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。

default_license_tier

字符串

指定新云将使用的默认许可证层级。

枚举选项 - ENTERPRISE_16, ENTERPRISE_18。

在 17.2.5 中引入的字段。

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

dns_configuration

字符串

SystemConfiguration 的 Dnsconfiguration 设置。

dns_virtualservice_refs

字符串

跨 Avi Vantage 托管 FQDN 记录的应用程序的 DNS 虚拟服务。

如果没有提供虚拟服务，Avi Vantage 将为配置的应用程序提供 DNS 服务。

不允许从 DNS 虚拟服务切换回 Avi Vantage。

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

docker_mode

布尔值

设置 docker_mode 的布尔标志。

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

选项

  • false

  • true

email_configuration

字符串

SystemConfiguration 的 Emailconfiguration 设置。

global_tenant_config

字符串

SystemConfiguration 的 Tenantconfiguration 设置。

linux_configuration

字符串

SystemConfiguration 的 Linuxconfiguration 设置。

mgmt_ip_access_control

字符串

配置控制器的 IP 访问控制以限制开放访问。

ntp_configuration

字符串

SystemConfiguration 的 Ntpconfiguration 设置。

password

字符串

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

portal_configuration

字符串

SystemConfiguration 的 Portalconfiguration 设置。

proxy_configuration

字符串

SystemConfiguration 的 Proxyconfiguration 设置。

secure_channel_configuration

字符串

配置安全通道属性。

在 18.1.4、18.2.1 中引入的字段。

snmp_configuration

字符串

SystemConfiguration 的 Snmpconfiguration 设置。

ssh_ciphers

字符串

控制器和服务引擎管理接口上 SSH 的允许的密码列表。

如果未指定，则允许所有默认密码。

ssh_hmacs

字符串

控制器和服务引擎管理接口上 SSH 的允许的 HMAC 列表。

如果未指定，则允许所有默认 HMAC。

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

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

默认值： "admin"

tenant_uuid

字符串

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

默认值： ""

网址

字符串

对象的 Avi 控制器 URL。

username

字符串

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

uuid

字符串

对象的唯一对象标识符。

welcome_workflow_complete

布尔值

初始控制器设置工作流完成后，将设置此标志。

在 18.2.3 版本中引入的字段。

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

选项

  • false

  • true

备注

注意

示例

- name: Example to create SystemConfiguration object
  community.network.avi_systemconfiguration:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_systemconfiguration

返回值

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

键

描述

obj

字典

SystemConfiguration (api/systemconfiguration) 对象

返回：成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)