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

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.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

Параметры

Параметр	Комментарии
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	Путь к пакету сертификатов центра сертификации (CA), который можно использовать для проверки запросов 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.
delete_metadata_keys псевдонимы: keys list / элементы=string	Ключи из metadata, которые нужно удалить. Параметр metadata имеет приоритет над delete_metadata_keys: если один и тот же ключ указан в обоих параметрах, он будет создан или обновлен, а не удален. Регистр символов в ключах метаданных не учитывается.
delete_with_all_objects boolean	Следует ли удалять контейнер рекурсивно, то есть вместе со всеми его объектами. Если для delete_with_all_objects задано значение `false`, попытка удалить контейнер, содержащий объекты, завершится ошибкой. Варианты: `false` ← (по умолчанию) `true`
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
metadata dictionary	Пары «ключ — значение», которые нужно задать в качестве метаданных контейнера. Можно задавать пользовательские и системные метаданные. Пользовательские метаданные — это определенные пользователем ключи и значения. Параметр metadata эквивалентен заданию свойств в openstackclient с помощью `openstack container set --property ...`. Регистр символов в ключах метаданных не учитывается.
name псевдонимы: container string / обязательный	Имя (и идентификатор) контейнера Swift.
read_ACL string	ACL, предоставляющий доступ на чтение. Например, используйте `.r:*,.rlistings` для открытого доступа и `''` для закрытого доступа.
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается.
state string	Должен ли объект быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время, в течение которого Ansible ожидает запрошенный ресурс. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы API SSL. До 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

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

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

Ключ	Описание
container dictionary	Словарь с описанием контейнера Swift. Возвращается: при успешном выполнении, если state имеет значение `present`.
bytes integer	Общее количество байтов, хранящихся в Object Storage для контейнера. Возвращается: при успешном выполнении Пример: `5449`
bytes_used integer	Общее количество использованных байтов. Возвращается: при успешном выполнении Пример: `5449`
content_type string	Тип MIME списка имен. Возвращается: при успешном выполнении
count integer	Количество объектов в контейнере. Возвращается: при успешном выполнении Пример: `1`
history_location string	Включает версионирование контейнера. Возвращается: при успешном выполнении
id string	Идентификатор контейнера. Совпадает со значением name. Возвращается: при успешном выполнении Пример: `"otc"`
if_none_match string	В сочетании с `Expect: 100-Continue` укажите заголовок `If-None-Match: `, чтобы проверить, есть ли на сервере копия объекта, прежде чем отправлять данные. Возвращается:* при успешном выполнении
is_content_type_detected boolean	Если задано значение `true`, Object Storage определяет тип содержимого по расширению файла и игнорирует значение заголовка Content-Type, если он присутствует. Возвращается: при успешном выполнении
is_newest boolean	Если задано значение True, Object Storage запрашивает все реплики, чтобы вернуть самую новую. Если этот заголовок не указан, Object Storage отвечает быстрее, найдя первую действительную реплику. Поскольку установка для этого заголовка значения True увеличивает нагрузку на серверную часть, используйте ее только при крайней необходимости. Возвращается: при успешном выполнении
meta_temp_url_key string	Секретный ключ для временных URL. Если он не задан, эта операция не возвращает данный заголовок. Возвращается: при успешном выполнении
meta_temp_url_key_2 string	Второй секретный ключ для временных URL. Если он не задан, эта операция не возвращает данный заголовок. Возвращается: при успешном выполнении
name string	Имя контейнера. Возвращается: при успешном выполнении Пример: `"otc"`
object_count integer	Количество объектов. Возвращается: при успешном выполнении Пример: `1`
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, предоставляющий доступ на запись. Если он не задан, эта операция не возвращает данный заголовок. Возвращается: при успешном выполнении

Авторы

Специальная группа OpenStack Ansible (SIG)

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

© 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_container_module.html