openstack.cloud.object модуль — Создание или удаление объектов Swift в облаках OpenStack
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.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. Если это пропущено, ничего не будет передано в библиотеку запросов. |
auth dictionary | Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать любые параметры, требуемые этим плагином аутентификации. Этот параметр не требуется, если предоставлено именованное облако или присутствуют переменные окружения OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом. |
ca_cert aliases: cacert string | Путь к пакету сертификатов CA, который может использоваться как часть проверки запросов API SSL. |
client_cert aliases: cert string | Путь к клиентскому сертификату, который будет использоваться как часть транзакции SSL. |
client_key aliases: key string | Путь к клиентскому ключу, который будет использоваться как часть транзакции SSL. |
cloud any | Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или если присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
container string / required | Имя (и ID) контейнера, в котором нужно создать объект. Этот контейнер не будет создан, если он ещё не существует. |
data string | Содержимое для загрузки в объект. Взаимоисключающий с filename. Этот атрибут не может быть обновлен. |
filename string | Путь к локальному файлу, содержимое которого будет загружено. Взаимоисключающий с data. |
interface aliases: endpoint_type string | Тип URL конечной точки для извлечения из каталога служб. Варианты:
|
name string / required | Имя (и ID) объекта. |
region_name string | Имя региона. |
sdk_log_level string | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
state string | Должен ли объект быть Варианты:
|
timeout integer | Как долго ansible должен ждать запрашиваемого ресурса. По умолчанию: |
validate_certs aliases: 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: 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 словарь | Словарь, описывающий объект. Возвращается: при успехе, когда state равен |
|
accept_ranges строка |
Тип диапазонов, которые принимает объект. Возвращается: успех |
|
access_control_allow_origin строка |
CORS для RAX (отклонение от стандарта) Возвращается: успех |
|
content_disposition строка |
Если установлено, указывает поведение переопределения для браузера. Например, этот заголовок может указать браузеру использовать программу для загрузки файла вместо отображения файла, что является стандартным по умолчанию. Если не установлено, этот заголовок не возвращается в результате этой операции. Возвращается: успех |
|
content_encoding строка |
Если установлено, значение метаданных Content-Encoding. Если не установлено, этот заголовок не возвращается в результате этой операции. Возвращается: успех |
|
content_length строка |
Операции HEAD не возвращают содержимое. Однако в этой операции значение в заголовке Content-Length не является размером тела ответа. Вместо этого оно содержит размер объекта в байтах. Возвращается: успех |
|
content_type целое число |
MIME-тип объекта. Возвращается: успех |
|
copy_from строка |
Если установлено, это имя объекта, используемого для создания нового объекта путем копирования объекта X-Copy-From. Значение имеет вид {контейнер}/{объект}. Вам необходимо UTF-8-кодировать и затем URL-кодировать имена контейнера и объекта перед включением их в заголовок. Использование PUT с X-Copy-From имеет тот же эффект, что и использование операции COPY для копирования объекта. Возвращается: успех |
|
delete_after целое число |
Указывает количество секунд, по истечении которых объект удаляется. Внутренне система Object Storage сохраняет это значение в элементе метаданных X-Delete-At. Возвращается: успех |
|
delete_at строка |
Если установлено, время, когда объект будет удален системой в формате временной метки эпохи UNIX. Если не установлено, этот заголовок не возвращается в результате этой операции. Возвращается: успех |
|
etag строка |
Для объектов размером менее 5 ГБ это значение — контрольная сумма MD5 содержимого объекта. Значение не заключено в кавычки. Для объектов-манифестов это значение — контрольная сумма MD5 конкатенированной строки контрольных сумм MD5 и ETag для каждого из сегментов в манифесте, а не контрольная сумма MD5 загруженного содержимого. Также значение заключено в двойные кавычки. Сильно рекомендуется вычислить контрольную сумму MD5 тела ответа по мере его получения и сравнить это значение с значением в заголовке ETag. Если они отличаются, содержимое повреждено, поэтому повторите операцию. Возвращается: успех |
|
expires_at строка |
Используется с временными URL-адресами для указания времени истечения срока действия подписи. Дополнительную информацию о временных URL-адресах см. в справке API хранилища объектов OpenStack v1. Возвращается: успех |
|
id строка |
Идентификатор объекта. Равен Возвращается: успех |
|
if_match список / элементы=строка |
См. http://www.ietf.org/rfc/rfc2616.txt. Возвращается: успех |
|
if_modified_since строка |
См. http://www.ietf.org/rfc/rfc2616.txt. Возвращается: успех |
|
if_none_match список / элементы=строка |
В сочетании с Возвращается: успех |
|
if_unmodified_since строка |
См. http://www.ietf.org/rfc/rfc2616.txt. Возвращается: успех |
|
is_content_type_detected логическое значение |
Если установлено в значение true, хранилище объектов определяет тип содержимого на основе расширения файла и игнорирует значение, переданное в заголовке Content-Type, если он присутствует. Возвращается: успех |
|
is_newest boolean |
Если установлено в True, Object Storage обращается ко всем репликам, чтобы вернуть последнюю. Если вы опустите этот заголовок, Object Storage ответит быстрее, как только найдёт одну действительную реплику. Поскольку установка этого заголовка в True более ресурсоёмка для бэкенда, используйте его только в случае крайней необходимости. Возвращаемое значение: успех |
|
is_static_large_object boolean |
Установлено в True, если этот объект является объектом манифеста статического большого объекта. Возвращаемое значение: успех |
|
last_modified_at string |
Дата и время создания объекта или последнего изменения метаданных. Возвращаемое значение: успех |
|
manifest string |
Если присутствует, это объект манифеста динамического большого объекта. Значение — префикс имени контейнера и объекта фрагментированных объектов в формате контейнер/префикс. Возвращаемое значение: успех |
|
multipart_manifest string |
Если вы включите параметр запроса multipart-manifest=get и объект является большим объектом, содержимое объекта не возвращается. Вместо этого манифест возвращается в заголовке ответа X-Object-Manifest для динамических больших объектов или в теле ответа для статических больших объектов. Возвращаемое значение: успех |
|
name string |
Имя объекта. Возвращаемое значение: успех |
|
object_manifest string |
Если установлено, это объект манифеста динамического большого объекта. Значение — префикс имени контейнера и объекта фрагментированных объектов в формате контейнер/префикс. Возвращаемое значение: успех |
|
range dictionary |
TODO. Возвращаемое значение: успех |
|
signature string |
Используется с временными URL-адресами для подписания запроса. Дополнительную информацию о временных URL-адресах см. в справочнике по API OpenStack Object Storage v1. Возвращаемое значение: успех |
|
symlink_target string |
Если присутствует, это объект символической ссылки. Значение — относительный путь целевого объекта в формате <контейнер>/<объект>. Возвращаемое значение: успех |
|
symlink_target_account string |
Если присутствует и X-Symlink-Target, это символическая ссылка на объект в указанном в значении аккаунте. Возвращаемое значение: успех |
|
timestamp string |
Маркер времени транзакции. Возвращаемое значение: успех |
|
transfer_encoding string |
Установлено в chunked для включения фрагментации передачи. Если используется, не устанавливайте заголовок Content-Length в значение, отличное от нуля. Возвращаемое значение: успех |
Ссылки на коллекцию
© 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_module.html
