config_target_groups | Teradata DSA Commands - 17.20 - config_target_groups - BAR - Data Stream Architecture

Teradata® DSA User Guide

Product
BAR
Data Stream Architecture
Release Number
17.20
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-3150-101K
Language
English (United States)

Purpose

The config_target_groups command configures the target groups based on the target type and the information from the parameters file.

  • New disable_gen_zero flag for NetBackup and DDBoost. When true, backup jobs are rejected if any media server is offline.
  • New repository_replication flag. When true, backup data is replicated from the system landing zone to third party storage.

Syntax

config_target_groups -t|-type Target Type -r|repository_replication -f|-file File -B|backup_repository -S|-skip_prompt

Example

dsc config_target_groups -t target_nbu -f TargetGroupParameters.xml -B -S

dsc config_target_groups -t remote_file_system -f test.xml

dsc config_target_groups -t TARGET_S3 -r -f replication_tg_S3.xml

Parameters

t|type Type
The type of the BAR component to add to the target group. Target group types are DUMMY, TARGET_NBU, REMOTE_FILE_SYSTEM, TARGET_DDBOOST, TARGET_S3, TARGET_AZURE, and TARGET_GCP.
Example: target_nbu
f|file filename
The full path and name of the file containing the necessary configuration parameters.
Example: TargetGroupParameters.xml
r|repository_replication
[Optional] Marks a target group for replication. Valid for target group types TARGET_NBU, REMOTE_FILE_SYSTEM, TARGET_DDBOOST, TARGET_S3, TARGET_AZURE, and TARGET_GCP.
S|skip_prompt SkipPrompt
[Optional] Skips displaying a confirmation message before performing the command action.
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

When adding or removing a policy, storage unit, or file path from an existing target group, the following is true:
  • You cannot remove a policy, storage unit, or file path from an existing target group if it has been used to generate a valid save set.
  • When you remove a policy, storage unit, or file path from an existing target group, the DSC automatically disables the target group mapping if that policy, storage unit, or file path is used in either the source or target of target group mapping.
  • When you add a new policy, storage unit, or file path to an existing target group, the DSC disables the target group mapping if the target group is defined as the source target group in the target group mapping.
When using a REMOTE_FILE_SYSTEM target group type, the following is true:
  • If the path defined in <mounted_file_system> is the same among multiple media servers, the path implies that the media server is a NFS mount that all the media servers can access the data written under the same <mounted_file_system>.
  • If one of the media servers is offline during a restore, analyze_read or query_backupids command, DSA will automatically replace the media server with a media server that can access the same mounted file system.
When using a TARGET_DDBOOST target group type, the following is true:
  • If the values in <target_entity> and <storage_units> are the same among multiple media servers, the values imply that these media servers can access the data written on the same <target_entity> and <storage_units>.
  • If one of the media servers is offline during a restore, analyze or query_backupids command, DSA will automatically replace the media server with a media server that can access the same target entity and storage units.

Before configuring a different type of target group, the media server must have the corresponding AXM module installed. Use list_access_module to verify which AXM modules are installed.

The component name can only use the following characters: 'A-Z', 'a-z', '0-9' and '_'.

XML File Example - Remote Media Target Group (NetBackup)

A sample XML file to configure a remote media target group (TARGET_NBU) is shown below.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

                 <!--****The command below must be on one line.****-->
<dscConfigTargetGroupsRemoteMedia dscVersion="dscVersion1" xmlns="http://schemas.teradata.com/v2012/DSC">

<!-- 'target_group_name' - Required,  max 32 characters, first character must be alphanumeric only. -->
<target_group_name>SampleTargetGroup</target_group_name>
	
<!-- 'is_enabled' Optional, accepted values: true/false. Default : false -->
<is_enabled>true</is_enabled>
	
<!-- 'target_entity' - Required, max 30 characters -->
<target_entity>nbu52</target_entity>
	
<!-- 'targets' - Required (at least one) -->
<targets>
	
   <!-- 'bar_media_server' - Required, max 32 characters -->
   <bar_media_server>SampleMediaServer1</bar_media_server>
		
   <!-- 'policy_class' - Required (at least one) -->
   <policy_class>
		
     <!-- 'policy_class_name' - Required, max 128 characters. Policy must exist on 
     target_entity. -->
     <policy_class_name>policy75</policy_class_name>
			
     <!-- 'devices' - Required -->
     <devices>1</devices>
			
   </policy_class>
   <policy_class>
     <policy_class_name>policy76</policy_class_name>
     <devices>1</devices>
     </policy_class>
</targets>
<targets>
   <bar_media_server>SampleMediaServer2</bar_media_server>
   <policy_class>
     <policy_class_name>policy75</policy_class_name>
     <devices>1</devices>
   </policy_class>
   <policy_class>
     <policy_class_name>policy76</policy_class_name>
     <devices>1</devices>
   </policy_class>
</targets>
	
<!-- 'disable_gen_zero' Optional, accepted values: true/false. Default: false -->
<disable_gen_zero>true</disable_gen_zero>

</dscConfigTargetGroupsRemoteMedia>

XML File Example - Remote File System Target Group

A sample XML file to configure a remote file system target group (REMOTE_FILE_SYSTEM) is shown below.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<dscConfigTargetGroupsRemoteFile xmlns="http://schemas.teradata.com/v2012/DSC">
  <target_group_name>t_remote_fs</target_group_name> 
  <is_enabled>true</is_enabled> 
  <mounted_file_system_remote>
  <bar_media_server>barms2</bar_media_server>  
  <file_system>
  <mounted_file_system>/tmp/jing_test</mounted_file_system> 
  <files>3</files> 
  </file_system>
  </mounted_file_system_remote>
  </dscConfigTargetGroupsRemoteFile>

XML File Example - DDBoost Target Group

A sample XML file to configure a DDBoost target group (TARGET_DDBOOST) is shown below.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<dscConfigTargetGroupsDDBoost dscVersion="dscVersion1" xmlns="http://schemas.teradata.com/v2012/DSC">

<!-- 'target_group_name' - Required,  max 30 characters, first character must be alphanumeric only. -->
<target_group_name>dd_boost_tg1</target_group_name>
	
<!-- 'is_enabled' Optional, accepted values: true/false. Default : false -->
<is_enabled>true</is_enabled>
	
<!-- 'targets' - Required (at least one) -->
<targets>
   <!-- 'target_entity' - Required, max 32 characters -->
   <target_entity>dddomain1</target_entity>
	    
   <!-- 'bar_media_server' - Required, max 32 characters -->
   <media_storage_units>
     <!--media_storage_units' - Required (at least one) -->
     <bar_media_server>barvm12</bar_media_server>
		
     <!-- storage_units' - Required (at least one) -->
     <storage_units>
		
       <!-- 'storage_unit_name' - Required, max characters 50, alphanumeric and 
       "-","_"   --> 
       <storage_unit_name>storage_unit1</storage_unit_name>

       <!-- 'max_files' - Required, Integer, min value is 1--> 
       <files>40</files>
			
     </storage_units>
   </media_storage_units>
</targets>
	
<!-- 'disable_gen_zero' Optional, accepted values: true/false. Default : false -->
<disable_gen_zero>true</disable_gen_zero>
	
</dscConfigTargetGroupsDDBoost>

XML File Example - Amazon S3 Target Group

A sample XML file to configure an S3 target group (TARGET_S3) is shown below.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<dscConfigTargetGroupsAmzS3 dscVersion="dscVersion1" xmlns="http://schemas.teradata.com/v2012/DSC">

 <!-- 'target_group_name' - Required,  max 32 characters, first character must 
 be alphanumeric only. -->
 <target_group_name>SampleTargetGroup</target_group_name>
	
 <!-- 'is_enabled' Optional, accepted values: true/false. Default : false -->
 <is_enabled>true</is_enabled>
	
 <!-- 'aws_account_name'- Required, max 32 characters -->
 <account_name>accountName</account_name>
	
 <!-- 'region' - Required, max 30 characters -->
 <region>us-east-1</region>
	
 <!-- 'targets' - Required (at least one) -->
 <targetMediaBuckets>
	<!-- 'bar_media_server' - Required, max 32 characters -->
	<bar_media_server>SampleMediaServer1</bar_media_server>
		
	<!-- 'buckets' - Required (at least one) -->
	<buckets
		<!-- 'bucket_name' - Required, max 512 characters. Bucket must exist 
           on the region -->
		<bucket_name>bucket1</bucket_name>
			
		<!-- 'prefix_list' - Required (at least one) -->
		<prefix_list>
			<!-- 'prefix_name' - Required, max 256 characters -->
			<prefix_name>prefix1/prefix2/</prefix_name>

			<!-- 'storage_devices' - Required -->
			<storage_devices>1</storage_devices>
		</prefix_list>
	</buckets>
</targetMediaBuckets>
<targetMediaBuckets>
		<!-- 'bar_media_server' - Required, max 32 characters -->
		<bar_media_server>SampleMediaServer2</bar_media_server>
		
		<!-- 'buckets' - Required (at least one) -->
		<buckets>
		<!-- 'bucket_name' - Required, max 512 characters. Bucket must exist 
           on the region -->
		<bucket_name>bucket2</bucket_name>
			
		<!-- 'prefix_list' - Required (at least one) -->
		<prefix_list>
			<!-- 'prefix_name' - Required, max 256 characters -->
			<prefix_name>prefix1/prefix2/</prefix_name>
			<!-- 'storage_devices' - Required -->
			<storage_devices>1</storage_devices>
		</prefix_list>				
	</buckets>
</targetMediaBuckets>
</dscConfigTargetGroupsAmzS3>

XML File Example - Azure Blob Target Group

A sample XML file to configure an Azure Blob target group (TARGET_AZURE) is shown below.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dscConfigTargetGroupsAzureBlobStorage xmlns="http://schemas.teradata.com/v2012/DSC">
    
  <target_group_name>azure_tg</target_group_name>
  <is_enabled>true</is_enabled>
  <targets>
    
  <!-- 'Storage account' - Required, max length 24, lower case -->
    <storage_account>azure_storage_account1</storage_account>
        
  <!-- 'Storage account enumeration ' - Required, valid values: cool, hot -->
    <storage_type>cool</storage_type>
  <targetMediaBlob>
    <!-- 'bar_media_server' - Required, max 32 characters -->
      <bar_media_server>mediaserver1</bar_media_server>
      
      <blobs>
        <!-- 'Blob container name' - Required, max length 63, lower case, at least 
        one -->
          <blob_container>blob1</blob_container>
          <prefix_list>
          <!-- 'Prefix name' - Required, max length 256, at least one -->
            <prefix_name>prefix1/</prefix_name>
                    
            <!-- 'storage_devices' - Required -->
              <storage_devices>100</storage_devices>
          </prefix_list>
       </blobs>
  </targetMediaBlob>
        
  <targetMediaBlob>
    <!-- 'bar_media_server' - Required, max 32 characters -->
      <bar_media_server>mediaserver2</bar_media_server>
      <blobs>
      <!-- 'Blob container name' - Required, max length 63, lower case, at least 
      one -->
        <blob_container>blob1</blob_container>
        <prefix_list>
        <!-- 'Prefix name' - Required, max length 256, at least one -->
          <prefix_name>prefix1/</prefix_name>
                    
          <!-- 'storage_devices' - Required -->
            <storage_devices>100</storage_devices>
        </prefix_list>
      </blobs>
    </targetMediaBlob>
  </targets>
  <targets>
    <!-- 'Storage account' - Required, max length 24, lower case -->
      <storage_account>azure_storage_account2</storage_account>
      <!-- 'Storage account enumeration' - Required, valid values: cool, hot -->
        <storage_type>cool</storage_type>
        <targetMediaBlob>
          <!-- 'bar_media_server' - Required, max 32 characters -->
            <bar_media_server>mediaserver2</bar_media_server>
     <blobs>
        <blob_container>blob2</blob_container>
          <prefix_list>
            <prefix_name>prefix1/</prefix_name>
              <storage_devices>100</storage_devices>
          </prefix_list>
     </blobs>
   </targetMediaBlob>
 </targets>
</dscConfigTargetGroupsAzureBlobStorage>

XML File Example - GCP Storage Target Group

A sample XML file to configure an GCP Storage target group (TARGET_GCP) is shown below.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dscConfigTargetGroupsGcpStorage xmlns="http://schemas.teradata.com/v2012/DSC">
   <!-- 'target_group_name' - Required, max 43 characters, can only consist of 
   "a-z, A-Z, 0-9, _, -" characters and first character must be alphanumeric
   only. -->
   <target_group_name>gcp_tg</target_group_name>
   <is_enabled>true</is_enabled>
   <targets>
       <!-- 'account_name' - Required, max length 1024, lower case -->
       <account_name>accountName</account_name>
       <targetMediaBuckets>
           <!-- 'bar_media_server' - Required, max 32 characters -->
           <bar_media_server>mediaserver1</bar_media_server>
           <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 "goog" prefix
                 - cannot contain "google" or close misspellings, such as "g00gle"
              -->
              <bucket_name>>bucketName1</bucket_name>
              <prefix_list>
                  <!-- 'prefix_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' - Required -->
                  <storage_devices>100</storage_devices>
              </prefix_list>
           </buckets>
       </targetMediaBuckets>
       <targetMediaBuckets>
           <!-- 'bar_media_server' - Required, max 32 characters -->
           <bar_media_server>mediaserver2</bar_media_server>
           <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 "goog" prefix
                  - cannot contain "google" or close misspellings, such as "g00gle"
               -->
               <bucket_name>>bucketName2</bucket_name>
               <prefix_list>
                   <!-- 'prefix_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>folder2/</prefix_name>
                   <!-- 'storage_devices' - Required -->
                   <storage_devices>100</storage_devices>
               </prefix_list>
           </buckets>
       </targetMediaBuckets>
   </targets>
</dscConfigTargetGroupsGcpStorage>