rax_files – Manipulate Rackspace Cloud Files Containers

From Get docs
Ansible/docs/2.7/modules/rax files module


rax_files – Manipulate Rackspace Cloud Files Containers

New in version 1.5.


Synopsis

  • Manipulate Rackspace Cloud Files Containers

Requirements

The below requirements are needed on the host that executes this module.

  • pyrax
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments

api_key

-

Rackspace API key, overrides credentials.


aliases: password

auth_endpoint

-

added in 1.5

Default:

The URI of the authentication service.

clear_meta

boolean

  • no

  • yes

Optionally clear existing metadata when applying metadata to existing containers. Selecting this option is only appropriate when setting type=meta

container

- / required

The container to use for container or metadata operations.

credentials

-

File to find the Rackspace credentials in. Ignored if api_key and username are provided.


aliases: creds_file

env

-

added in 1.5

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 a container

private

-

Used to set a container as private, removing it from the CDN. Warning! Private containers, if previously made public, can have live objects available until the TTL on cached objects expires

public

-

Used to set a container as public, available via the Cloud Files CDN

region

-

Default:

"DFW"

Region to create an instance in

state

-

  • present

  • absent

Indicate desired state of the resource

tenant_id

-

added in 1.5

The tenant ID used for authentication.

tenant_name

-

added in 1.5

The tenant name used for authentication.

ttl

-

In seconds, set a container-wide TTL for all objects cached on CDN edge nodes. Setting a TTL is only appropriate for containers that are public

type

-

  • file

  • meta

Type of object to do work on, i.e. metadata object or a container object

username

-

Rackspace username, overrides credentials.

verify_ssl

-

added in 1.5

Whether or not to require SSL validation of API endpoints.

web_error

-

Sets an object to be presented as the HTTP error page when accessed by the CDN URL

web_index

-

Sets an object to be presented as the HTTP index page when accessed by the CDN URL



Notes

Note

  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.
  • RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file
  • RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)
  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.
  • RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file
  • RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)


Examples

- name: "Test Cloud Files Containers"
  hosts: local
  gather_facts: no
  tasks:
    - name: "List all containers"
      rax_files:
        state: list

    - name: "Create container called 'mycontainer'"
      rax_files:
        container: mycontainer

    - name: "Create container 'mycontainer2' with metadata"
      rax_files:
        container: mycontainer2
        meta:
          key: value
          file_for: [email protected]

    - name: "Set a container's web index page"
      rax_files:
        container: mycontainer
        web_index: index.html

    - name: "Set a container's web error page"
      rax_files:
        container: mycontainer
        web_error: error.html

    - name: "Make container public"
      rax_files:
        container: mycontainer
        public: yes

    - name: "Make container public with a 24 hour TTL"
      rax_files:
        container: mycontainer
        public: yes
        ttl: 86400

    - name: "Make container private"
      rax_files:
        container: mycontainer
        private: yes

- name: "Test Cloud Files Containers Metadata Storage"
  hosts: local
  gather_facts: no
  tasks:
    - name: "Get mycontainer2 metadata"
      rax_files:
        container: mycontainer2
        type: meta

    - name: "Set mycontainer2 metadata"
      rax_files:
        container: mycontainer2
        type: meta
        meta:
          uploaded_by: [email protected]

    - name: "Remove mycontainer2 metadata"
      rax_files:
        container: "mycontainer2"
        type: meta
        state: absent
        meta:
          key: ""
          file_for: ""

Status

Authors

  • Paul Durivage (@angstwad)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/rax_files_module.html