Модуль openstack.cloud.object_containers_info – получение сведений о контейнерах из службы OpenStack Swift.
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.object_containers_info.
Краткое описание
- Получение сведений о контейнерах из службы OpenStack Swift.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Время ожидания на уровне сокета перед истечением срока ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми для выбранной стратегии плагина аутентификации облака. Для используемого по умолчанию плагина password здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если в облаке используется не парольная аутентификация, укажите здесь имя плагина и соответствующим образом измените содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов API по SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при обмене данными по SSL. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при обмене данными по SSL. |
cloud any | Именованное облако или конфигурация облака, с которыми нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
name псевдонимы: container string | Имя контейнера |
prefix string | Фильтрация контейнеров по префиксу |
region_name string | Имя региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся. |
timeout integer | Время ожидания запрошенного ресурса в Ansible. По умолчанию: |
validate_certs псевдонимы: verify boolean | Нужно ли проверять запросы API по SSL. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ожидать завершения операции над запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Сведения для аутентификации обрабатываются openstacksdk. Это означает, что значения могут быть взяты из файла конфигурации yaml /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно указанных параметров плейбука. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: List all containers existing on the project
openstack.cloud.object_containers_info:
- name: Retrive a single container by name
openstack.cloud.object_containers_info:
name: test-container
- name: Retrieve and filter containers by prefix
openstack.cloud.object_containers_info:
prefix: test-
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже приведены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
containers list / элементы=dictionary | Список словарей с описаниями соответствующих контейнеров. Возвращается: всегда |
|
bytes integer |
Общее количество байтов, хранящихся в Object Storage для контейнера. Возвращается: при успехе Пример: |
|
bytes_used integer |
Общее количество использованных байтов. Возвращается: при успехе Пример: |
|
content_type string |
MIME-тип списка имён. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
count integer |
Количество объектов в контейнере. Возвращается: при успехе Пример: |
|
history_location string |
Включает управление версиями контейнера. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
id string |
Идентификатор контейнера. Совпадает с name. Возвращается: при успехе Пример: |
|
if_none_match string |
В сочетании с Возвращается: при успехе |
|
is_content_type_detected boolean |
Если задано значение Возвращается: при успехе |
|
is_newest boolean |
Если задано значение True, Object Storage опрашивает все реплики, чтобы вернуть самую последнюю. Если этот заголовок не указан, Object Storage отвечает быстрее, найдя первую действительную реплику. Поскольку установка этого заголовка в True увеличивает нагрузку на серверную часть, используйте его только при крайней необходимости. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
meta_temp_url_key string |
Значение секретного ключа для временных URL. Если значение не задано, эта операция не возвращает данный заголовок. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
meta_temp_url_key_2 string |
Значение второго секретного ключа для временных URL. Если значение не задано, эта операция не возвращает данный заголовок. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
name string |
Имя контейнера. Возвращается: при успехе Пример: |
|
object_count integer |
Количество объектов. Возвращается: при успехе Пример: |
|
read_ACL string |
Список контроля доступа (ACL), предоставляющий доступ на чтение. Если значение не задано, эта операция не возвращает данный заголовок. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
storage_policy string |
Политика хранения, используемая контейнером. Изменить политику существующего контейнера нельзя. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
sync_key string |
Секретный ключ для синхронизации контейнера. Если значение не задано, эта операция не возвращает данный заголовок. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
sync_to string |
Место назначения для синхронизации контейнера. Если значение не задано, эта операция не возвращает данный заголовок. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
timestamp string |
Метка времени транзакции. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
versions_location string |
Включает управление версиями этого контейнера. Значение — имя другого контейнера. Перед добавлением имени в заголовок его необходимо закодировать в UTF-8, а затем URL-кодировать. Чтобы отключить управление версиями, задайте для заголовка пустую строку. Получается только при поиске контейнера по имени. Возвращается: при успехе |
|
write_ACL string |
Список контроля доступа (ACL), предоставляющий доступ на запись. Если значение не задано, эта операция не возвращает данный заголовок. Получается только при поиске контейнера по имени. Возвращается: при успехе |
Ссылки на коллекцию
© 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/openstack/cloud/object_containers_info_module.html