Purpose
The backup_application_gcp command configures GCP Storage based on a parameter file.
Syntax
backup_application_gcp -f|-file filename
Example
backup_application_gcp -f file1.xml
Parameters
- f|file filename
- The full path and name of the file containing the necessary configuration parameters.
- u|user_authentication User
-
Required when security management is enabled. Supplies the command with the Viewpoint user, and triggers a password prompt for authentication.
Permissions required: Administrator role
Usage Notes
You need the following information for the XML file.
- account: Name of the GCP Service Account
- account_key: Private Key from the GCP Service Account See https://cloud.google.com/iam/docs/creating-managing-service-account-keys
XML File Example
A representative XML file is shown below. Note the following:
- See https://cloud.google.com/storage/docs/creating-buckets for GCP Storage bucket information.
- The prefix_name should be followed by "/" to be used as a folder.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dscBackupApplicationGcp xmlns="http://schemas.teradata.com/v2012/DSC">
<config_gcp_storage_list>
<account>sa-name@project-id.iam.gserviceaccount.com</account>
<!-- 'account_key' - Required, max length 4,096 -->
<account_key>long_account_key</account_key>
<encryption_key>customer_managed_key</encryption_key>
<buckets>
<!--
'Bucket name' - Required,
- only lowercase letters, numbers, dashes (-), underscores (_),
and dots (.). Spaces are not allowed
- start and end with a number or letter
- contain 3-63 characters. Names containing dots can contain up
to 222 characters, but each dot-separated component can be no
longer than 63 characters
- cannot be represented as an IP address in dotted-decimal
notation (for example, 192.168.5.4)
- cannot begin with the "google" prefix
- cannot contain "google" or close misspellings, such as "g00gle"
-->
<bucket_name>bucket1</bucket_name>
<!-- 'Location enumeration ' - Required, valid values: us, eu, asia -->
<location>us</location>
<!-- 'Storage class enumeration ' - Required, valid values: standard,
nearline, coldline, archive -->
<storage_class>standard</storage_class>
<prefix_list>
<!--
'Folder name' - Required
- may contain letters, digits, spaces, hyphens and underscores
- start and end with a letter or digit
- 30 characters or less
- distinct from all other folders that share its parent
-->
<prefix_name>folder1/</prefix_name>
<storage_devices>2</storage_devices>
</prefix_list>
</buckets>
<buckets>
<bucket_name>bucket2</bucket_name>
<location>us</location>
<storage_class>standard</storage_class>
<prefix_list>
<prefix_name>folder2/</prefix_name>
<storage_devices>10</storage_devices>
</prefix_list>
</buckets>
</config_gcp_storage_list>
</dscBackupApplicationGcp>