New in version 1.5.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
api_key
|
|
Rackspace API key, overrides credentials.
aliases: password |
|
auth_endpoint
(added in 1.5) |
Default:
https://identity.api.rackspacecloud.com/v2.0/
|
The URI of the authentication service.
|
|
clear_meta
|
|
Optionally clear existing metadata when applying metadata to existing objects. Selecting this option is only appropriate when setting type=meta
|
|
container
required |
|
The container to use for file object operations.
|
|
credentials
|
|
File to find the Rackspace credentials in. Ignored if api_key and username are provided.
aliases: creds_file |
|
dest
|
|
The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder". Used to specify the destination of an operation on a remote object; i.e. a file name, "file1", or a comma-separated list of remote objects, "file1,file2,file17"
|
|
env
(added in 1.5) |
|
Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
|
|
expires
|
|
Used to set an expiration on a file or folder uploaded to Cloud Files. Requires an integer, specifying expiration in seconds
|
|
identity_type
(added in 1.5) |
Default:
rackspace
|
Authentication mechanism to use, such as rackspace or keystone.
|
|
meta
|
|
A hash of items to set as metadata values on an uploaded file or folder
|
|
method
|
|
The method of operation to be performed. For example, put to upload files to Cloud Files, get to download files from Cloud Files or delete to delete remote objects in Cloud Files
|
|
region
|
Default:
DFW
|
Region to create an instance in.
|
|
src
|
|
Source from which to upload files. Used to specify a remote object as a source for an operation, i.e. a file name, "file1", or a comma-separated list of remote objects, "file1,file2,file17". src and dest are mutually exclusive on remote-only object operations
|
|
state
|
|
Indicate desired state of the resource
|
|
structure
|
|
Used to specify whether to maintain nested directory structure when downloading objects from Cloud Files. Setting to false downloads the contents of a container to a single, flat directory
|
|
tenant_id
(added in 1.5) |
|
The tenant ID used for authentication.
|
|
tenant_name
(added in 1.5) |
|
The tenant name used for authentication.
|
|
type
|
|
Type of object to do work on
Metadata object or a file object
|
|
username
|
|
Rackspace username, overrides credentials.
|
|
verify_ssl
(added in 1.5) |
|
Whether or not to require SSL validation of API endpoints.
|
Note
- name: "Test Cloud Files Objects"
hosts: local
gather_facts: False
tasks:
- name: "Get objects from test container"
rax_files_objects:
container: testcont
dest: ~/Downloads/testcont
- name: "Get single object from test container"
rax_files_objects:
container: testcont
src: file1
dest: ~/Downloads/testcont
- name: "Get several objects from test container"
rax_files_objects:
container: testcont
src: file1,file2,file3
dest: ~/Downloads/testcont
- name: "Delete one object in test container"
rax_files_objects:
container: testcont
method: delete
dest: file1
- name: "Delete several objects in test container"
rax_files_objects:
container: testcont
method: delete
dest: file2,file3,file4
- name: "Delete all objects in test container"
rax_files_objects:
container: testcont
method: delete
- name: "Upload all files to test container"
rax_files_objects:
container: testcont
method: put
src: ~/Downloads/onehundred
- name: "Upload one file to test container"
rax_files_objects:
container: testcont
method: put
src: ~/Downloads/testcont/file1
- name: "Upload one file to test container with metadata"
rax_files_objects:
container: testcont
src: ~/Downloads/testcont/file2
method: put
meta:
testkey: testdata
who_uploaded_this: someuser@example.com
- name: "Upload one file to test container with TTL of 60 seconds"
rax_files_objects:
container: testcont
method: put
src: ~/Downloads/testcont/file3
expires: 60
- name: "Attempt to get remote object that does not exist"
rax_files_objects:
container: testcont
method: get
src: FileThatDoesNotExist.jpg
dest: ~/Downloads/testcont
ignore_errors: yes
- name: "Attempt to delete remote object that does not exist"
rax_files_objects:
container: testcont
method: delete
dest: FileThatDoesNotExist.jpg
ignore_errors: yes
- name: "Test Cloud Files Objects Metadata"
hosts: local
gather_facts: false
tasks:
- name: "Get metadata on one object"
rax_files_objects:
container: testcont
type: meta
dest: file2
- name: "Get metadata on several objects"
rax_files_objects:
container: testcont
type: meta
src: file2,file1
- name: "Set metadata on an object"
rax_files_objects:
container: testcont
type: meta
dest: file17
method: put
meta:
key1: value1
key2: value2
clear_meta: true
- name: "Verify metadata is set"
rax_files_objects:
container: testcont
type: meta
src: file17
- name: "Delete metadata"
rax_files_objects:
container: testcont
type: meta
dest: file17
method: delete
meta:
key1: ''
key2: ''
- name: "Get metadata on all objects"
rax_files_objects:
container: testcont
type: meta
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.