community.general.hwc_smn_topic 模块 – 在华为云中创建 SMNTopic 资源

注意

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

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

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

要在 playbook 中使用它,请指定:community.general.hwc_smn_topic

概要

  • 表示 SMN 通知主题资源。

需求

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

  • requests >= 2.18.4

  • keystoneauth1 >= 3.6.0

参数

参数

注释

display_name

字符串

主题显示名称,在电子邮件中显示为发件人名称。主题显示名称最多包含 192 个字节。

domain

字符串 / 必填

要限定作用域的域的名称 (Identity v3)。

目前仅支持域名,不支持域 ID。

id

字符串

要管理的资源的 ID。

identity_endpoint

字符串 / 必填

身份验证 URL。

name

字符串 / 必填

要创建的主题的名称。主题名称是 1 到 256 个字符的字符串。它必须包含大写或小写字母、数字、连字符 (-) 和下划线 (_),并且必须以字母或数字开头。

password

字符串 / 必填

登录密码。

project

字符串 / 必填

租户 (Identity v2) 或项目 (Identity v3) 的名称。

目前仅支持项目名称,不支持项目 ID。

region

字符串

项目所属的区域。

state

字符串

给定对象是否应该存在于华为云中。

选项

  • "present" ← (默认)

  • "absent"

user

字符串 / 必填

登录用户名。

目前仅支持用户名,不支持用户 ID。

属性

属性

支持

描述

check_mode

支持: 完全支持

可以在 check_mode 中运行,并在不修改目标的情况下返回更改状态预测。

diff_mode

支持: 不支持

在差异模式下,将返回有关已更改内容(或可能需要在 check_mode 中更改的内容)的详细信息。

注释

注意

  • 对于身份验证,您可以使用 ANSIBLE_HWC_IDENTITY_ENDPOINT 环境变量设置 identity_endpoint。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_USER 环境变量设置 user。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_PASSWORD 环境变量设置 password。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_DOMAIN 环境变量设置 domain。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_PROJECT 环境变量设置 project。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_REGION 环境变量设置 region。

  • 只有在未设置 playbook 值时,才会使用环境变量值。

示例

- name: Create a smn topic
  community.general.hwc_smn_topic:
      identity_endpoint: "{{ identity_endpoint }}"
      user_name: "{{ user_name }}"
      password: "{{ password }}"
      domain_name: "{{ domain_name }}"
      project_name: "{{ project_name }}"
      region: "{{ region }}"
      name: "ansible_smn_topic_test"
      state: present

返回值

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

描述

create_time

字符串

创建主题的时间。

返回:成功

display_name

字符串

主题显示名称,在电子邮件中显示为发件人名称。主题显示名称最多包含 192 个字节。

返回:成功

name

字符串

要创建的主题的名称。主题名称是 1 到 256 个字符的字符串。它必须包含大写或小写字母、数字、连字符 (-) 和下划线 (_),并且必须以字母或数字开头。

返回:成功

push_policy

整数

消息推送策略。0 表示消息发送失败,消息缓存在队列中;1 表示丢弃失败的消息。

返回:成功

topic_urn

字符串

主题的资源标识符,它是唯一的。

返回:成功

update_time

字符串

更新主题的时间。

返回:成功

作者

  • 华为公司 (@huaweicloud)