Spec-Zone.ru › Ansible

Модуль community.general.hwc_smn_topic — создание ресурса SMNTopic в Huawei Cloud

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: community.general.hwc_smn_topic.

  • Краткое описание
  • Требования
  • Параметры
  • Атрибуты
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Представляет ресурс темы уведомлений SMN.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • requests >= 2.18.4
  • keystoneauth1 >= 3.6.0

Параметры

Параметр

Комментарии

display_name

строка

Отображаемое имя темы, которое указывается в качестве имени отправителя электронного письма. Длина отображаемого имени темы не должна превышать 192 байта.

domain

строка / обязательный

Имя домена, в область действия которого входит ресурс (Identity v3).

В настоящее время поддерживаются только имена доменов, но не их идентификаторы.

id

строка

Идентификатор управляемого ресурса.

identity_endpoint

строка / обязательный

URL-адрес аутентификации Identity.

name

строка / обязательный

Имя создаваемой темы. Имя темы представляет собой строку длиной от 1 до 256 символов. Оно должно содержать буквы верхнего или нижнего регистра, цифры, дефисы (-) и символы подчёркивания (_), а также начинаться с буквы или цифры.

password

строка / обязательный

Пароль для входа.

project

строка / обязательный

Имя арендатора (Identity v2) или проекта (Identity v3).

В настоящее время поддерживаются только имена проектов, но не их идентификаторы.

region

строка

Регион, к которому относится проект.

state

строка

Определяет, должен ли указанный объект существовать в Huawei Cloud.

Возможные значения:

  • "present" ← (по умолчанию)
  • "absent"

user

строка / обязательный

Имя пользователя для входа.

В настоящее время поддерживаются только имена пользователей, но не их идентификаторы.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может выполняться в режиме check_mode и возвращать прогноз состояния изменений, не изменяя целевой объект.

diff_mode

Поддержка: отсутствует

В режиме сравнения возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в check_mode).

Примечания

Примечание

  • Для аутентификации параметр identity_endpoint можно задать с помощью переменной среды ANSIBLE_HWC_IDENTITY_ENDPOINT.
  • Для аутентификации параметр user можно задать с помощью переменной среды ANSIBLE_HWC_USER.
  • Для аутентификации параметр password можно задать с помощью переменной среды ANSIBLE_HWC_PASSWORD.
  • Для аутентификации параметр domain можно задать с помощью переменной среды ANSIBLE_HWC_DOMAIN.
  • Для аутентификации параметр project можно задать с помощью переменной среды ANSIBLE_HWC_PROJECT.
  • Для аутентификации параметр region можно задать с помощью переменной среды ANSIBLE_HWC_REGION.
  • Значения переменных среды используются только в том случае, если значения параметров не заданы в сценарии.

Примеры

- 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

строка

Время обновления темы.

Возвращается: при успешном выполнении

Авторы

  • Huawei Inc. (@huaweicloud)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Задать вопрос
  • Сообщить об ошибке
  • Предложить новую функцию
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/hwc_smn_topic_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API