openstack.cloud.object_container модуль — Управление контейнером Swift.

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

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

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

Для использования в плейбуке укажите: openstack.cloud.object_container.

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

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

Создание, обновление и удаление контейнера Swift.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени должна ждать транспортная сокетная часть, прежде чем истечёт таймаут для API-запросов. Если это опущено, ничего не будет передано в библиотеку запросов.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов, этот параметр должен содержать любые параметры, требуемые данным плагином авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом.
ca_cert псевдонимы: cacert строка	Путь к пакету CA-сертификата, который может использоваться для проверки SSL-API-запросов.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках SSL-транзакции.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках SSL-транзакции.
cloud любой	Именованное облако или конфигурация облака для работы с ним. Если cloud — это строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные окружения OpenStack OS_. Если cloud* — это словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
delete_metadata_keys псевдонимы: keys список / элементы=строка	Ключи из metadata, которые должны быть удалены. metadata имеет приоритет над delete_metadata_keys: Если какой-либо ключ присутствует в обоих параметрах, он будет создан или обновлён, а не удалён. Ключи метаданных нечувствительны к регистру.
delete_with_all_objects булево	Следует ли удалять контейнер рекурсивно, включая все его объекты. Если delete_with_all_objects установлено в `false`, попытка удалить контейнер, содержащий объекты, завершится ошибкой. Варианты: `false` ← (по умолчанию) `true`
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для получения из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
metadata словарь	Ключевые пары значений, которые будут установлены в качестве метаданных для контейнера. Можно задать как пользовательские, так и системные метаданные. Пользовательские метаданные — это ключи и значения, определённые пользователем. metadata аналогично установке свойств в openstackclient с `openstack container set --property ...`. Ключи метаданных нечувствительны к регистру.
name псевдонимы: container строка / обязательно	Имя (и ID) контейнера Swift.
read_ACL строка	ACL, предоставляющий доступ для чтения. Например, используйте `.r:*,.rlistings` для публичного доступа и `''` для частного доступа.
region_name строка	Название региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается.
state строка	Следует ли `present` или `absent` объект. Варианты: `"present"` ← (по умолчанию) `"absent"`

timeout integer	Сколько времени Ansible должно ждать запрошенного ресурса. По умолчанию: `180`
validate_certs aliases: verify boolean	Нужно ли проверять SSL-запросы API. До Ansible 2.3 это значение по умолчанию было `true`. Возможные значения: `false` `true`
wait boolean	Должен ли Ansible ждать завершения запрошенного ресурса. Возможные значения: `false` `true` ← (по умолчанию)
write_ACL string	ACL, предоставляющий доступ для записи.

Примечания

Примечание

Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явного указания значений.
Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут браться из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в задачах. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Create empty container with public access
  openstack.cloud.object_container:
    name: "new-container"
    state: present
    read_ACL: ".r:*,.rlistings"

- name: Set metadata for container
  openstack.cloud.object_container:
    name: "new-container"
    metadata:
      'Cache-Control': 'no-cache'
      'foo': 'bar'

- name: Delete metadata keys of a container
  openstack.cloud.object_container:
    name: "new-container"
    delete_metadata_keys:
      - foo

- name: Delete container
  openstack.cloud.object_container:
    name: "new-container"
    state: absent

- name: Delete container and all its objects
  openstack.cloud.object_container:
    name: "new-container"
    delete_with_all_objects: true
    state: absent

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

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

Ключ	Описание
контейнер словарь	Словарь, описывающий контейнер Swift. Возвращается: при успехе, когда состояние равно `present`.
байты целое число	Общее количество байтов, хранящихся в хранилище объектов для контейнера. Возвращается: успешно Пример: `5449`
использованные_байты целое число	Общее количество используемых байтов. Возвращается: успешно Пример: `5449`
тип_контента строка	Тип MIME списка имён. Возвращается: успешно
количество целое число	Количество объектов в контейнере. Возвращается: успешно Пример: `1`
местоположение_истории строка	Включает версионирование в контейнере. Возвращается: успешно
идентификатор строка	Идентификатор контейнера. Равен имени. Возвращается: успешно Пример: `"otc"`
если_не_совпадает строка	В сочетании с `Expect: 100-Continue`, укажите заголовок `If-None-Match: `, чтобы запросить, есть ли у сервера копия объекта до отправки любых данных. Возвращается:* успешно
тип_контента_обнаружен булево	Если установлено значение `true`, хранилище объектов угадывает тип контента на основе расширения файла и игнорирует значение, отправленное в заголовке Content-Type, если оно присутствует. Возвращается: успешно
самый_новый булево	Если установлено значение True, хранилище объектов обращается ко всем репликам, чтобы вернуть самую последнюю. Если вы опустите этот заголовок, хранилище объектов ответит быстрее после того, как найдёт одну действительную реплику. Поскольку установка этого заголовка в значение True более затратна для бэкэнда, используйте его только в крайнем случае. Возвращается: успешно
ключ_временно_url строка	Значение секретного ключа для временных URL-адресов. Если не задано, этот заголовок не возвращается этим действием. Возвращается: успешно
ключ_временно_url_2 строка	Второе значение секретного ключа для временных URL-адресов. Если не задано, этот заголовок не возвращается этим действием. Возвращается: успешно
имя строка	Имя контейнера. Возвращается: успешно Пример: `"otc"`
количество_объектов целое число	Количество объектов. Возвращается: успешно Пример: `1`
считывание_acl строка	ACL, предоставляющий доступ для чтения. Если не задано, этот заголовок не возвращается этим действием. Возвращается: успешно
политика_хранения строка	Политика хранения, используемая контейнером. Изменить политику существующего контейнера нельзя. Возвращается: успешно
ключ_синхронизации строка	Секретный ключ для синхронизации контейнера. Если не задан, этот заголовок не возвращается этим действием. Возвращается: успешно
синхронизировать_с строка	Место назначения для синхронизации контейнера. Если не задано, этот заголовок не возвращается этим действием. Возвращается: успешно
отметка_времени строка	Отметка времени транзакции. Возвращается: успешно

versions_location

string

Включает версионирование в этом контейнере. Значение — имя другого контейнера. Вы должны закодировать имя в UTF-8, а затем закодировать его в URL, прежде чем включать в заголовок. Для отключения версионирования установите заголовок в пустую строку.

Возвращается: success

write_ACL

string

ACL, предоставляющий права на запись. Если не задано, этот заголовок не возвращается в результате этой операции.

Возвращается: success

Авторы

OpenStack Ansible SIG

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

© 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/openstack/cloud/object_container_module.html