models.vault module

class models.vault.Vault(ca_trusted_certificate=None, client_certificate=None, client_private_key=None, compression_policy=None, config=None, customer_managing_encryption_keys=None, dedup_enabled=None, delete_vault_error=None, description=None, desired_wal_location=None, encryption_key_file_downloaded=None, encryption_policy=None, external_target_type=None, full_archive_interval_days=None, id=None, incremental_archives_enabled=None, is_password_encrypted=None, key_file_download_time_usecs=None, key_file_download_user=None, name=None, removal_state=None, mtype=None, usage_type=None, vault_bandwidth_limits=None)

Bases: object

Implementation of the ‘Vault’ model.

Specifies an external storage location and is equivalent to an External Target in the Cohesity Dashboard. A Vault can provide an additional Cloud Tier where cold data of the Cohesity Cluster can be stored in the Cloud. A Vault can also provide archive storage for backup data. This archive data is stored on Tapes and in Cloud Vaults.

Attributes:

ca_trusted_certificate (string): Specifies the CA (certificate

authority) trusted certificate.

client_certificate (string): Specifies the client CA certificate.

This certificate is in pem format.

client_private_key (string): Specifies the client private key. This

certificate is in pem format.

compression_policy (CompressionPolicyVaultEnum): Specifies whether to

send data to the Vault in a compressed format. ‘kCompressionNone’ indicates that data is not compressed. ‘kCompressionLow’ indicates that data is compressed using LZ4 or Snappy. ‘kCompressionHigh’ indicates that data is compressed in Gzip.

config (VaultConfig): Specifies the settings required to connect to a

specific Vault type. For some Vaults, you must also specify a storage location (bucketName).

customer_managing_encryption_keys (bool): Specifies whether to manage

the encryption key manually or let the Cohesity Cluster manage it. If true, you must get the encryption key store it outside the Cluster, before disaster strikes such as the source local Cohesity Cluster being down. You can get the encryption key by downloading it using the Cohesity Dashboard or by calling the GET /public/vaults/encryptionKey/{id} operation.

dedup_enabled (bool): Specifies whether to deduplicate data before

sending it to the Vault.

delete_vault_error (string): Specifies the error message when deleting

a vault.

description (string): Specifies a description about the Vault. desired_wal_location (DesiredWalLocationEnum): Desired location for

write ahead logs(wal). ‘kHomePartition’ indicates desired wal location to be the home partition. ‘kDisk’ indicates desired wal location to be the same disk as chunk repo. ‘kScribe’ indicates desired wal location to be scribe. ‘kScribeTable’ indicates chunk repository state is kept as key-value pairs in scribe.

encryption_key_file_downloaded (bool): Specifies if the encryption key

file has been downloaded using the Cohesity Dashboard (Cohesity UI). If true, the encryption key has been downloaded using the Cohesity Dashboard. An encryption key can only be downloaded once using the Cohesity Dashboard.

encryption_policy (EncryptionPolicyVaultEnum): Specifies whether to

send and store data in an encrypted format. ‘kEncryptionNone’ indicates the data is not encrypted. ‘kEncryptionStrong’ indicates the data is encrypted.

external_target_type (ExternalTargetTypeEnum): Specifies the type of

Vault. ‘kNearline’ indicates a Google Nearline Vault. ‘kGlacier’ indicates an AWS Glacier Vault. ‘kS3’ indicates an AWS S3 Vault. ‘kAzureStandard’ indicates a Microsoft Azure Standard Vault. ‘kS3Compatible’ indicates an S3 Compatible Vault. (See the online help for supported types.) ‘kQStarTape’ indicates a QStar Tape Vault. ‘kGoogleStandard’ indicates a Google Standard Vault. ‘kGoogleDRA’ indicates a Google DRA Vault. ‘kAmazonS3StandardIA’ indicates an Amazon S3 Standard-IA Vault. ‘kAWSGovCloud’ indicates an AWS Gov Cloud Vault. ‘kNAS’ indicates a NAS Vault. ‘kColdline’ indicates a Google Coldline Vault. ‘kAzureGovCloud’ indicates a Microsoft Azure Gov Cloud Vault. ‘kAzureArchive’ indicates an Azure Archive Vault. ‘kAzure’ indicates an Azure Vault. ‘kGoogle’ indicates a Google Vault. ‘kAmazon’ indicates an Amazon Vault. ‘kOracle’ indicates an Oracle Vault. ‘kOracleTierStandard’ indicates an Oracle Tier Standard Vault. ‘kOracleTierArchive’ indicates an Oracle Tier Archive Vault. ‘kAmazonC2S’ indicates an Amazon Commercial Cloud Services Vault.

full_archive_interval_days (long|int): Specifies the number days

between full archives to the Vault. The current default is 90 days. This is only meaningful when incrementalArchivesEnabled is true and the Vault usage type is kArchival.

id (long|int): Specifies an id that identifies the Vault. incremental_archives_enabled (bool): Specifies whether to perform

incremental archival when sending data to the Vault. If false, only full backups are performed. If true, incremental backups are performed between the full backups.

is_password_encrypted (bool): Specifies if given password is not

encrypted or not in the cluster

key_file_download_time_usecs (long|int): Specifies the time (in

microseconds) when the encryption key file was downloaded from the Cohesity Dashboard (Cohesity UI). An encryption key can only be downloaded once using the Cohesity Dashboard.

key_file_download_user (string): Specifies the user who downloaded the

encryption key from the Cohesity Dashboard (Cohesity UI). This field is only populated if encryption is enabled for the Vault and customerManagingEncryptionKeys is true.

name (string): Specifies the name of the Vault. removal_state (RemovalStateVaultEnum): Specifies the state of the

vault to be removed. ‘kDontRemove’ means the state of object is functional and it is not being removed. ‘kMarkedForRemoval’ means the object is being removed. ‘kOkToRemove’ means the object has been removed on the Cohesity Cluster and if the object is physical, it can be removed from the Cohesity Cluster.

mtype (TypeVaultEnum): Specifies the type of Vault. This field is

deprecated. This field is split into ExternalTargetType in and TierType in respective credentials. Initialize those fields instead. deprecated: true ‘kNearline’ indicates a Google Nearline Vault. ‘kGlacier’ indicates an AWS Glacier Vault. ‘kS3’ indicates an AWS S3 Vault. ‘kAzureStandard’ indicates a Microsoft Azure Standard Vault. ‘kS3Compatible’ indicates an S3 Compatible Vault. (See the online help for supported types.) ‘kQStarTape’ indicates a QStar Tape Vault. ‘kGoogleStandard’ indicates a Google Standard Vault. ‘kGoogleDRA’ indicates a Google DRA Vault. ‘kAmazonS3StandardIA’ indicates an Amazon S3 Standard-IA Vault. ‘kAWSGovCloud’ indicates an AWS Gov Cloud Vault. ‘kNAS’ indicates a NAS Vault. ‘kColdline’ indicates a Google Coldline Vault. ‘kAzureGovCloud’ indicates a Microsoft Azure Gov Cloud Vault. ‘kAzureArchive’ indicates an Azure Archive Vault. ‘kAzure’ indicates an Azure Vault. ‘kGoogle’ indicates a Google Vault. ‘kAmazon’ indicates an Amazon Vault. ‘kOracle’ indicates an Oracle Vault. ‘kOracleTierStandard’ indicates an Oracle Tier Standard Vault. ‘kOracleTierArchive’ indicates an Oracle Tier Archive Vault. ‘kAmazonC2S’ indicates an Amazon Commercial Cloud Services Vault.

usage_type (UsageTypeEnum): Specifies the usage type of the Vault.

‘kArchival’ indicates the Vault provides archive storage for backup data. ‘kCloudSpill’ indicates the Vault provides additional storage for cold data.

vault_bandwidth_limits (VaultBandwidthLimits): VaultBandwidthLimits

represents the network bandwidth limits while uploading/downloading data to/from the external media.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.