community.network.avi_errorpageprofile 模块 – 用于设置 ErrorPageProfile Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

版本 6.0.0

原因：

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

替代方案：

未知。

摘要

别名：network.avi.avi_errorpageprofile

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

app_name

字符串

生成错误页面的虚拟服务的名称。

在 18.1.1 中弃用的字段。

在 17.2.4 中引入的字段。

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

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

company_name

字符串

要在错误页面中显示的公司名称。

在 18.1.1 中弃用的字段。

在 17.2.4 中引入的字段。

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

controller

字符串

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

error_pages

字符串

为 http 状态码定义的错误页面。

在 17.2.4 中引入的字段。

host_name

字符串

为其生成错误页面的完全限定域名。

在 18.1.1 中弃用的字段。

在 17.2.4 中引入的字段。

未在API或模块中指定时，Avi Controller将默认值解释为主机标头。

名称

字符串 / 必填

在 17.2.4 中引入的字段。

password

字符串

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

状态

字符串

应应用于实体的状态。

选项

  • "不存在"

  • "存在" ← (默认)

tenant

字符串

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

默认值： "admin"

租户引用

字符串

它是对类型为租户的对象的引用。

在 17.2.4 中引入的字段。

tenant_uuid

字符串

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

默认值： ""

URL

字符串

对象的Avi控制器URL。

username

字符串

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

UUID

字符串

在 17.2.4 中引入的字段。

注释

注意

示例

- name: Example to create ErrorPageProfile object
  community.network.avi_errorpageprofile:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_errorpageprofile

返回值

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

键

描述

obj

字典

ErrorPageProfile (api/errorpageprofile) 对象

已返回：成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)