opentelekomcloud.cloud.cbr_restore_point (0.14.2) — module

Manage CBR Restore Point

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

Authors: Gubina Polina (@Polina-Gubina)

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

Manage cbr restore point from the OTC.


Requirements

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

name:
    description:
    - Backup name.
    type: str

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

vault:
    description:
    - Vault name or id.
    required: true
    type: str

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

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

resources:
    description:
    - UUID list of resources to be backed up.
    elements: str
    type: list

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

description:
    description:
    - Backup description.
    type: str

incremental:
    description:
    - Whether the backup is an incremental backup.
    type: bool

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

auto_trigger:
    default: false
    description:
    - Whether automatic triggering is enabled
    type: bool

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

resource_details:
    description:
    - Resource details.
    elements: dict
    suboptions:
      id:
        description: Cloud type, which is public.
        required: true
        type: str
      name:
        description:
        - Name of the resource to be backed up.          The value consists of 0 to 255
          characters..
        type: str
      type:
        choices:
        - OS::Nova::Server
        - OS::Cinder::Volume
        description: Cloud type, which is public.
        required: true
        type: str
    type: list

Outputs

checkpoint:
  contains:
    created_at:
      description: Creation time.
      type: str
    extra_info:
      contains:
        description:
          description: Backup description.
          type: str
        name:
          description: Backup name.
          type: str
        retention_duration:
          description: Number of days that backups can be retained.
          type: int
      description: Vault name.
      type: dict
    id:
      description: Restore point ID.
      type: str
    project_id:
      description: Project id.
      type: str
    status:
      description: Status.
      type: str
    vault:
      contains:
        id:
          description: Vault ID.
          type: str
        name:
          description: Vault name.
          type: str
        resources:
          contains:
            backup_count:
              description: Number of backups.
              type: str
            backup_size:
              description: Backup size.
              type: str
            extra_info:
              description: Extra information of the resource.
              type: str
            id:
              description: ID of the resource to be backed up.
              type: str
            name:
              description: Name of the resource to be backed up.
              type: str
            protect_status:
              description: Protected status.
              type: str
            resource_size:
              description: Allocated capacity for the associated resource,                 in
                GB.
              type: str
            type:
              description: Type of the resource to be backed up.
              type: str
          description: Backup name.
          type: dict
        skipped_resources:
          contains:
            code:
              description: Error code.
              type: str
            id:
              description: Resource ID.
              type: str
            name:
              description: Resource name.
              type: str
            reason:
              description: Reason for the skipping. For example,                 the
                resource is being backed up.
              type: str
            type:
              description: Resource type.
              type: str
          description: Backup name.
          type: str
      description: Project ID.
      type: complex
  description: Restore point object.
  returned: On Success.
  type: complex