Spec-Zone.ru › Ansible

Модуль sensu.sensu_go.entity – Управление сущностями Sensu

Примечание

Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).

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

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

Для использования в плейбуке укажите: sensu.sensu_go.entity.

Добавлена в sensu.sensu_go 1.0.0

  • Описание
  • Требования
  • Параметры
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Создание, обновление или удаление сущности Sensu.
  • Дополнительную информацию можно найти в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/entities/.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.7

Параметры

Параметр

Комментарии

annotations

словарь

Пользовательские метаданные поля с меньшими ограничениями, в виде пар ключ/значение.

Они сохраняются Sensu, но недоступны в качестве токенов или идентификаторов и предназначены в основном для использования с внешними инструментами.

По умолчанию: {}

auth

словарь

Параметры аутентификации. Можно определить каждый из них также с помощью переменной окружения.

api_key

строка

добавлен в sensu.sensu_go 1.3.0

Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверена переменная окружения SENSU_API_KEY.

Заменяет параметры auth.user и auth.password.

Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

ca_path

путь

добавлен в sensu.sensu_go 1.5.0

Путь к файлу с корневыми сертификатами, который следует использовать для проверки сертификата бэкенда.

Если этот параметр не задан, модуль будет использовать файл сертификатов, используемый python.

Также можно задать этот параметр через переменную окружения SENSU_CA_PATH.

password

строка

Пароль пользователя Sensu. Если он не задан, будет проверена переменная окружения SENSU_PASSWORD.

Этот параметр игнорируется, если задан параметр auth.api_key.

По умолчанию: "P@ssw0rd!"

url

строка

Расположение API бэкенда Sensu. Если он не задан, будет проверена переменная окружения SENSU_URL.

По умолчанию: "http://localhost:8080"

user

строка

Имя пользователя для подключения к API Sensu. Если он не задан, будет проверена переменная окружения SENSU_USER.

Этот параметр игнорируется, если задан параметр auth.api_key.

По умолчанию: "admin"

verify

логическое

добавлен в sensu.sensu_go 1.5.0

Флаг, который управляет проверкой сертификатов.

Если вы используете самоподписанные сертификаты, вы можете установить этот параметр в false.

ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самоподписанные сертификаты в производстве, см. параметр auth.ca_path.

Также можно установить этот параметр через переменную среды SENSU_VERIFY.

Варианты:

  • false
  • true ← (по умолчанию)

deregister

логическое

Если сущность должна быть удалена, когда она перестает отправлять сообщения keepalive.

Варианты:

  • false
  • true

deregistration_handler

строка

Имя обработчика, который будет вызван при снятии с регистрации сущности.

entity_class

строка

Класс сущности. Стандартные классы — proxy и agent, но вы можете использовать любой.

Требуется, если state — present.

labels

словарь

Пользовательские поля метаданных, к которым можно получить доступ в Sensu, в виде пар ключ/значение.

По умолчанию: {}

last_seen

целое число

Отметка времени последнего наблюдения за сущностью в секундах с начала эпохи Unix.

name

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

Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где это применимо) однозначно идентифицирует ресурс, с которым работает Ansible.

Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его в соответствии со спецификацией в задаче.

См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.

namespace

строка

Пространство имен RBAC, в котором необходимо работать. Если он не задан, будет использовано значение переменной окружения SENSU_NAMESPACE.

По умолчанию: "default"

redact

список / элементы=строка

Список элементов, которые нужно скрыть из сообщений журнала. Если значение указано, оно перезаписывает список элементов, которые должны быть скрыты по умолчанию.

state

строка

Целевое состояние объекта Sensu.

Варианты:

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

subscriptions

список / элементы=строка

Список подписок для сущности.
END_OF_DOCUMENT_MARKER

system

dictionary

Система информации об объекте, например, операционной системе и платформе. Более подробную информацию можно найти по адресу https://docs.sensu.io/sensu-go/5.13/reference/entities/#system-attributes.

user

string

Имя пользователя Sensu RBAC, используемое объектом. Объекты агентов требуют разрешений get, list, create, update и delete для событий во всех пространствах имен.

См. также

См. также

sensu.sensu_go.entity_info

Список объектов Sensu.

Примеры

- name: Create an entity
  sensu.sensu_go.entity:
    auth:
      url: http://localhost:8080
    name: entity
    entity_class: proxy
    subscriptions:
      - web
      - prod
    system:
      hostname: playbook-entity
      os: linux
      platform: ubutntu
      network:
        interfaces:
          - name: lo
            addresses:
              - 127.0.0.1/8
              - ::1/128
          - name: eth0
            mac: 52:54:00:20:1b:3c
            addresses:
              - 93.184.216.34/24
    last_seen: 1522798317
    deregister: yes
    deregistration_handler: email-handler
    redact:
      - password
      - pass
      - api_key
    user: agent

- name: Delete an entity
  sensu.sensu_go.entity:
    name: entity
    state: absent

Возвращаемые значения

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

object

dictionary

Объект, представляющий сущность Sensu.

Возвращено: успех

Пример: {"deregister": false, "deregistration": {}, "entity_class": "agent", "last_seen": 1542667231, "metadata": {"annotations": null, "labels": null, "name": "webserver01", "namespace": "default"}, "redact": ["password", "private_key", "secret"], "sensu_agent_version": "1.0.0", "subscriptions": ["entity:webserver01"], "system": {"arch": "amd64", "cloud_provider": null, "libc_type": "glibc", "network": {"interfaces": [{"addresses": ["127.0.0.1/8", "::1/128"], "name": "lo"}, {"addresses": ["172.28.128.3/24", "fe80::a00:27ff:febc:be60/64"], "mac": "08:00:27:bc:be:60", "name": "enp0s8"}]}, "os": "linux", "platform": "centos", "platform_family": "rhel", "platform_version": "7.4.1708", "vm_role": "host", "vm_system": "kvm"}, "user": "agent"}

Авторы

  • Paul Arthur (@flowerysong)
  • Aljaz Kosir (@aljazkosir)
  • Miha Plesko (@miha-plesko)
  • Tadej Borovsak (@tadeboro)

Ссылки на сборку

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/entity_module.html

Spec-Zone.ru

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