community.network.avi_backup 模块 – 用于设置备份 Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在以下版本中删除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

别名：network.avi.avi_backup

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认： "16.4.4"

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为 patch 时，要使用的 Patch 操作。

选择

  • "添加"

  • "替换"

  • "删除"

avi_api_update_method

字符串

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

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

选择

  • "put" ←（默认）

  • "patch"

avi_credentials

字典

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

api_version

字符串

Avi 控制器版本

默认： "16.4.4"

控制器

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于使用会话 ID 重用现有会话

默认： ""

密码

字符串

Avi 控制器密码

端口

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API 会话 ID，用于使用 csrftoken 重用现有会话

默认： ""

租户

字符串

Avi 控制器租户

默认： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认： ""

超时

字符串

Avi 控制器请求超时

默认： 300

令牌

字符串

Avi 控制器 API 令牌

默认： ""

用户名

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

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

选择

  • false ←（默认）

  • true

backup_config_ref

字符串

备份配置信息。

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

控制器

字符串

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

file_name

字符串 / 必需

备份的文件名。

local_file_url

字符串

用于下载备份文件的 URL。

密码

字符串

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

remote_file_url

字符串

用于下载备份文件的 URL。

scheduler_ref

字符串

计划程序信息。

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

state

字符串

应该应用于实体的状态。

选择

  • "不存在"

  • "存在" ←（默认）

租户

字符串

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

默认： "admin"

tenant_ref

字符串

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

tenant_uuid

字符串

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

默认： ""

timestamp

字符串

创建备份文件时的 Unix 时间戳。

url

字符串

对象的 Avi 控制器 URL。

用户名

字符串

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

uuid

字符串

对象的唯一对象标识符。

注释

注意

示例

- name: Example to create Backup object
  community.network.avi_backup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_backup

返回值

通用返回值记录在 此处，以下是此模块特有的字段

键

描述

obj

字典

备份 (api/backup) 对象

返回: 成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)