sensu.sensu_go.namespace – Управление пространствами имён Sensu
Примечание
Этот плагин является частью коллекции sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в playbook укажите: sensu.sensu_go.namespace.
Добавлен в версии 1.0.0: sensu.sensu_go
Описание
- Создание, обновление или удаление пространства имён Sensu.
- Дополнительную информацию можно найти в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/rbac/#namespaces.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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 |
| Флаг, контролирующий проверку сертификата. Если вы используете самоподписанные сертификаты, вы можете установить этот параметр на false.Используйте этот параметр ТОЛЬКО в тестовых сценариях! В случае использования самоподписанных сертификатов в рабочей среде, обратитесь к параметру auth.ca_path. Этот параметр также можно задать через переменную среды SENSU_VERIFY. | |
| name строка / обязательно | Имя ресурса Sensu. Это имя (в сочетании с пространством имён, если применимо) однозначно идентифицирует ресурс, на котором Ansible выполняет операции. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии с заданием в задаче. Обратитесь к спецификации атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях. | ||
| state строка |
| Целевое состояние объекта Sensu. | |
См. также
См. также
- sensu.sensu_go.namespace_info
-
Официальная документация по модулю sensu.sensu_go.namespace_info.
Примеры
- name: Create a new namespace
sensu.sensu_go.namespace:
name: production
state: present
- name: Delete a namespace
sensu.sensu_go.namespace:
name: staging
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| object словарь | success | Объект, представляющий пространство имён Sensu. Пример: {'name': 'default'} |
Авторы
- 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/namespace_module.html