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

Примечание

Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).

Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.

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

Новое в версии 1.0.0: of sensu.sensu_go

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

Обзор

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

Требования

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

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
annotations словарь			Пользовательские метаданные с меньшими ограничениями, как пары "ключ-значение". Эти данные сохраняются Sensu, но не доступны как токены или идентификаторы и предназначены в основном для использования с внешними инструментами.
auth словарь			Параметры аутентификации. Можно определить каждый из них с помощью переменной окружения.
	api_key строка добавлен в 1.3.0 sensu.sensu_go		Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверена переменная среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
	ca_path путь добавлен в 1.5.0 sensu.sensu_go		Путь к пакету сертификатов CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать пакет CA, используемый Python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH.
	password строка	Значение по умолчанию: "P@ssw0rd!"	Пароль пользователя Sensu. Если он не задан, будет проверена переменная среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key.
	url строка	Значение по умолчанию: "http://localhost:8080"	Расположение API бэкенда Sensu. Если он не задан, будет проверена переменная среды SENSU_URL.
	user строка	Значение по умолчанию: "admin"	Имя пользователя для подключения к API Sensu. Если он не задан, будет проверена переменная среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key.
	verify логическое добавлен в 1.5.0 sensu.sensu_go	Варианты: no да ←	Флаг, который управляет проверкой сертификатов. Если вы используете самозаверяющие сертификаты, можно установить этот параметр в значение `false`. ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самозаверяющие сертификаты в производственной среде, см. параметр auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY.
deregister логическое		Варианты: no yes	Если сущность должна быть удалена, когда она перестанет отправлять сообщения keepalive.
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 строка		Значение по умолчанию: "default"	Пространство имен RBAC для работы. Если этот параметр не задан, будет использоваться значение переменной среды SENSU_NAMESPACE.
redact список / элементы=строка			Список элементов, которые нужно скрыть из сообщений журналов. Если значение указано, оно переопределяет список элементов, которые нужно скрыть по умолчанию.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
subscriptions список / элементы=строка			Список подписок для сущности.
system словарь			Системная информация о сущности, например, операционная система и платформа. Дополнительную информацию см. по адресу https://docs.sensu.io/sensu-go/5.13/reference/entities/#system-attributes.
user строка			Имя пользователя Sensu RBAC, используемое сущностью. Сущности агентов требуют разрешений на получение, перечисление, создание, обновление и удаление событий во всех пространствах имен.

См. также

sensu.sensu_go.entity_info: Официальная документация по модулю sensu.sensu_go.entity_info.

Примеры

- 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 словарь	успех	Объект, представляющий сущность Sensu. Пример: {'deregister': False, 'deregistration': {}, 'entity_class': 'agent', 'last_seen': 1542667231, 'metadata': {'annotations': None, 'labels': None, 'name': 'webserver01', 'namespace': 'default'}, 'redact': ['password', 'private_key', 'secret'], 'sensu_agent_version': '1.0.0', 'subscriptions': ['entity:webserver01'], 'system': {'arch': 'amd64', 'cloud_provider': None, '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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/entity_module.html