opentelekomcloud.cloud.object_info (0.14.2) — module

Get Swift info.

| "added in version" 0.8.0 of opentelekomcloud.cloud"

Authors: Anton Sidelnikov (@anton-sidelnikov)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Get Swift containers, container object, object metadata info from the OTC.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get swift containers/objects/object content.
- opentelekomcloud.cloud.object_info:
  register: sw
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- opentelekomcloud.cloud.object_info:
    container: my_container
  register: sw
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- opentelekomcloud.cloud.object_info:
    container: my_container
    object_name: my_object
  register: sw

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

container:
    description: Name of container in Swift.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

object_name:
    description: Name of object in Swift.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

Outputs

swift:
  contains:
    containers:
      description: Specifies the list of available containers. Shows when no params
        passed.
      sample:
      - bytes: 5449
        bytes_used: 5449
        content_type: null
        count: 1
        id: otc
        if_none_match: null
        is_content_type_detected: null
        is_newest: null
        meta_temp_url_key: null
        meta_temp_url_key_2: null
        name: otc
        object_count: 1
        read_ACL: null
        sync_key: null
        sync_to: null
        timestamp: null
        versions_location: null
        write_ACL: null
      type: list
    metadata:
      description: Specifies the object metadata. Shows when container and object_name
        params is not Null
      sample:
        _bytes: null
        _content_type: null
        _hash: null
        _last_modified: null
        accept_ranges: bytes
        container: test
        content_disposition: null
        content_encoding: null
        content_length: 5
        content_type: text/plain
        copy_from: null
        delete_after: null
        delete_at: null
        etag: e1cbb0c3879af8347246f12c559a86b5
        expires_at: null
        id: my2.txt
        if_match: null
        if_modified_since: null
        if_none_match: null
        if_unmodified_since: null
        is_content_type_detected: null
        is_newest: null
        is_static_large_object: null
        last_modified_at: Thu, 18 Feb 2021 13:40:09 GMT
        multipart_manifest: null
        name: null
        object_manifest: null
        range: null
        signature: null
        timestamp: '1613655609.64076'
        transfer_encoding: null
      type: dict
    objects:
      description: Specifies the list of objects in container. Shows when container
        param is not Null
      sample:
      - _bytes: 273
        _content_type: text/plain
        _hash: 58c6362a0e013dae97594abe7b06d801
        _last_modified: '2021-02-18T14:23:55.259610'
        accept_ranges: null
        content_disposition: null
        content_encoding: null
        content_length: 273
        content_type: text/plain
        copy_from: null
        delete_after: null
        delete_at: null
        etag: 58c6362a0e013dae97594abe7b06d801
        expires_at: null
        id: my.txt
        last_modified_at: '2021-02-18T14:23:55.259610'
        multipart_manifest: null
        name: my.txt
        object_manifest: null
        range: null
        signature: null
        timestamp: null
        transfer_encoding: null
      type: list
  description: List of dictionaries describing containers, objects and object metadata
    in container.
  returned: On Success.
  type: complex