otcextensions.sdk.cbr.v3.vault¶
The CBR Vault Class¶
The Vault class inherits from
Resource.
-
class
otcextensions.sdk.cbr.v3.vault.Vault(_synchronized=False, connection=None, **attrs)¶ CBR Vault Resource
The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
-
auto_bind¶ Properties
-
auto_expand¶ Whether to automatically expand the vault capacity
-
backup_policy_id¶ Backup Policy ID
-
billing¶ Billing spec
-
bind_rules¶ Rules for automatic association
-
created_at¶ Creation time
-
description¶ Description
-
name¶ Vault name
-
project_id¶ Project ID
-
provider_id¶ Vault type
-
resources¶ Associated Resources
Tag list up to 10 key value pairs
-
user_id¶ User ID
-
bind_policy(session, policy_id)¶ Method to associate a CBR policy to a CBR vault
- Parameters
session (
Adapter) – The session to use for making this request.policy_id (str) – The ID of the policy being attached to the CBR vault.
-
unbind_policy(session, policy_id)¶ Method to dissociate a CBR policy from a CBR vault
- Parameters
session (
Adapter) – The session to use for making this request.policy_id (str) – The ID of the policy being attached to the CBR vault.
-
associate_resources(session, resources)¶ Method to bind one or more ECS or Volume to a CBR vault
- Parameters
session (
Adapter) – The session to use for making this request.resources – array of resources in the format: name, type
-
dissociate_resources(session, resources)¶ Method to release one or more ECS or Volume to a CBR vault
- Parameters
session (
Adapter) – The session to use for making this request.resources – list of ressource ids to be released from vault
-
class
otcextensions.sdk.cbr.v3.vault.BillingSpec(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
-
allocated¶ Properties Allocated capacity in MB
-
charging_mode¶ Biling mode values: post_paid, pre_paid default: post_paid
-
cloud_type¶ Cloud type values: public, hybrid
-
consistent_level¶ Backup specifications default: crash_consistent
-
console_url¶ Redirection URL
-
extra_info¶ Billing extra info spec
-
frozen_scene¶ Scenario when an account is frozen
-
is_auto_pay¶ Whether the fee is automatically deducted from the customers account default: false
-
is_auto_renew¶ Whether to automatically renew the subscirption after expiration default: false
-
object_type¶ Object type
-
order_id¶ Order ID
-
period_num¶ Required duration for the package mandatory if charging_mode is set to pre_paid
-
period_type¶ Package type mandatory if charging_mode is pre_paid values: year, month
-
product_id¶ Product ID
-
protect_type¶ Operation type
-
size¶ Capicity in GB min: 1, max: 10485760
-
spec_code¶ Specification code
-
status¶ Status values: available, lock, frozen, deleting, error
-
storage_unit¶ Name of the bucket of the vault
-
used¶ Used capacity in MB
-
class
otcextensions.sdk.cbr.v3.vault.BillingExtraInfoSpec(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
-
combined_order_ecs_num¶ Properties Number of items in the aplication for creating vaults in the combination mode
-
combined_order_id¶ ID of the application for creating vaults in combination
-
class
otcextensions.sdk.cbr.v3.vault.ResourceSpec(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
-
backup_count¶ Properties Number of backups
-
backup_size¶ Backup size
-
extra_info¶ Extra info of the resource
-
id¶ ID of the resource to be backed up
-
name¶ Resource name
-
protect_status¶ Protection status values: available, error, protecting, restoring, removing
-
size¶ Allocated capacity for the associated resource, in GB
-
type¶ type of the resource to be backed up. values: OS::Nova::Server, OS::Cinder::Volume
-
class
otcextensions.sdk.cbr.v3.vault.ResourceExtraInfoSpec(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
-
exclude_volumes¶ Properties ID of the disk that is excluded from the backup
-
include_volumes¶ Disk to be backed up
-
class
otcextensions.sdk.cbr.v3.vault.VolumeSpec(_synchronized=False, connection=None, **attrs)¶ The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()andexisting().connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connectionin Resource code should protect itself with a check for None.
-
id¶ Properties Volume id
-
os_version¶ OS type