Spec-Zone.ru › Ansible

Модуль openstack.cloud.object — создание и удаление объектов Swift в облаках OpenStack

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.object.

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

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

  • Создание и удаление объектов Swift в облаках OpenStack

Требования

Следующие требования необходимы на хосте, на котором выполняется этот модуль.

  • 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.

container

string / обязательный

Имя (и ID) контейнера, в котором нужно создать объект.

Если контейнер ещё не существует, он не будет создан.

data

string

Содержимое для загрузки в объект.

Взаимоисключающий параметр с filename.

Этот атрибут нельзя обновить.

filename

string

Путь к локальному файлу, содержимое которого будет загружено.

Взаимоисключающий параметр с data.

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

string / обязательный

Имя (и ID) объекта.

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 ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Create a object named 'fstab' in the 'config' container
  openstack.cloud.object:
    cloud: mordred
    container: config
    filename: /etc/fstab
    name: fstab
    state: present

- name: Delete a container called config and all of its contents
  openstack.cloud.object:
    cloud: rax-iad
    container: config
    state: absent

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

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

Ключ

Описание

object

dictionary

Словарь с описанием объекта.

Возвращается: при успешном выполнении, когда state имеет значение present.

accept_ranges

string

Тип диапазонов, которые принимает объект.

Возвращается: при успешном выполнении

access_control_allow_origin

string

CORS для RAX (отличается от стандарта)

Возвращается: при успешном выполнении

content_disposition

string

Если задано, определяет поведение браузера, переопределяющее стандартное. Например, этот заголовок может указывать браузеру использовать программу загрузки для сохранения файла, а не отображать его, как это происходит по умолчанию. Если значение не задано, эта операция не возвращает данный заголовок.

Возвращается: при успешном выполнении

content_encoding

string

Если задано, содержит значение метаданных Content-Encoding. Если значение не задано, эта операция не возвращает данный заголовок.

Возвращается: при успешном выполнении

content_length

string

Операции HEAD не возвращают содержимое. Однако в этой операции значение заголовка Content-Length не равно размеру тела ответа. Вместо этого оно содержит размер объекта в байтах.

Возвращается: при успешном выполнении

content_type

integer

Тип MIME объекта.

Возвращается: при успешном выполнении

copy_from

string

Если задано, это имя объекта, используемого для создания нового объекта путём копирования объекта X-Copy-From. Значение имеет вид {container}/{object}. Перед включением имён контейнера и объекта в заголовок необходимо закодировать их в UTF-8, а затем выполнить URL-кодирование. Использование PUT с X-Copy-From даёт тот же результат, что и операция COPY для копирования объекта.

Возвращается: при успешном выполнении

delete_after

integer

Указывает количество секунд, по истечении которых объект будет удалён. Внутренне система Object Storage сохраняет это значение в элементе метаданных X-Delete-At.

Возвращается: при успешном выполнении

delete_at

string

Если задано, указывает время удаления объекта системой в формате временной метки UNIX Epoch. Если значение не задано, эта операция не возвращает данный заголовок.

Возвращается: при успешном выполнении

etag

string

Для объектов размером менее 5 ГБ это значение представляет собой контрольную сумму MD5 содержимого объекта. Значение не заключено в кавычки. Для объектов-манифестов это значение представляет собой контрольную сумму MD5 конкатенированной строки из контрольных сумм MD5 и ETag каждого сегмента манифеста, а не контрольную сумму MD5 загруженного содержимого. Кроме того, значение заключено в двойные кавычки. Настоятельно рекомендуется вычислить контрольную сумму MD5 тела ответа по мере его получения и сравнить её со значением в заголовке ETag. Если значения различаются, содержимое повреждено — повторите операцию.

Возвращается: при успешном выполнении

expires_at

string

Используется с временными URL-адресами для указания срока действия подписи. Дополнительные сведения о временных URL-адресах см. в справочнике OpenStack Object Storage API v1 Reference.

Возвращается: при успешном выполнении

id

string

Идентификатор объекта. Равен name.

Возвращается: при успешном выполнении

if_match

list / elements=string

См. http://www.ietf.org/rfc/rfc2616.txt.

Возвращается: при успешном выполнении

if_modified_since

string

См. http://www.ietf.org/rfc/rfc2616.txt.

Возвращается: при успешном выполнении

if_none_match

list / elements=string

В сочетании с Expect: 100-Continue укажите заголовок If-None-Match: *, чтобы проверить, есть ли у сервера копия объекта, прежде чем отправлять какие-либо данные.

Возвращается: при успешном выполнении

if_unmodified_since

string

См. http://www.ietf.org/rfc/rfc2616.txt.

Возвращается: при успешном выполнении

is_content_type_detected

boolean

Если установлено значение true, Object Storage определяет тип содержимого по расширению файла и игнорирует значение, переданное в заголовке Content-Type, если он присутствует.

Возвращается: при успешном выполнении

is_newest

boolean

Если установлено значение True, Object Storage запрашивает все реплики, чтобы вернуть самую актуальную. Если этот заголовок не указан, Object Storage отвечает быстрее, как только найдёт одну действующую реплику. Поскольку установка значения True для этого заголовка увеличивает нагрузку на серверную часть, используйте его только при крайней необходимости.

Возвращается: при успешном выполнении

is_static_large_object

boolean

Установите значение True, если этот объект является объектом-манифестом статического большого объекта.

Возвращается: при успешном выполнении

last_modified_at

string

Дата и время создания объекта или последнего изменения метаданных.

Возвращается: при успешном выполнении

manifest

string

Если присутствует, это объект-манифест динамического большого объекта. Значение представляет собой имя контейнера и префикс имени объекта для сегментов в формате container/prefix.

Возвращается: при успешном выполнении

multipart_manifest

string

Если включить параметр запроса multipart-manifest=get и объект является большим объектом, содержимое объекта не возвращается. Вместо этого манифест возвращается в заголовке ответа X-Object-Manifest для динамических больших объектов или в теле ответа для статических больших объектов.

Возвращается: при успешном выполнении

name

string

Имя объекта.

Возвращается: при успешном выполнении

object_manifest

string

Если задано, это объект-манифест динамического большого объекта. Значение представляет собой имя контейнера и префикс имени объекта для сегментов в формате container/prefix.

Возвращается: при успешном выполнении

range

dictionary

Требуется уточнение.

Возвращается: при успешном выполнении

signature

string

Используется с временными URL-адресами для подписания запроса. Дополнительные сведения о временных URL-адресах см. в справочнике OpenStack Object Storage API v1 Reference.

Возвращается: при успешном выполнении

symlink_target

string

Если присутствует, объект является символической ссылкой. Значение представляет собой относительный путь к целевому объекту в формате <container>/<object>.

Возвращается: при успешном выполнении

symlink_target_account

string

Если значение присутствует и указан X-Symlink-Target, это символическая ссылка между учётными записями на объект в учётной записи, заданной этим значением.

Возвращается: при успешном выполнении

timestamp

string

Временная метка транзакции.

Возвращается: при успешном выполнении

transfer_encoding

string

Установите значение chunked, чтобы включить передачу с кодированием фрагментами. Если этот параметр используется, не задавайте ненулевое значение заголовка Content-Length.

Возвращается: при успешном выполнении

Авторы

  • 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API