config_target_groups - Data Stream Architecture

Teradata Data Stream Architecture (DSA) User Guide

Product
Data Stream Architecture
Release Number
16.10
Published
August 2017
Language
English (United States)
Last Update
2018-04-17
dita:mapPath
mbk1487616377418.ditamap
dita:ditavalPath
3150_DSA_UG_1610.ditaval.ditaval
dita:id
B035-3150
lifecycle
previous
Product Category
Software
Teradata Tools and Utilities

Purpose

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

Syntax

config_target_groups -t|-type Target Type -f|-file File -B|-repository_backup -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

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, and TARGET_AZURE.
target_nbu
f|file filename
The full path and name of the file containing the necessary configuration parameters.
TargetGroupParameters.xml
B|repository_backup Repository Backup
[Optional] Marks a target group for repository backup. Only valid for the TARGET_NBU, REMOTE_FILE_SYSTEM, or TARGET_DDBOOST types.
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.

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 saveset.
  • 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 32 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 32 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>
</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 32 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>

<media_storage_units>
<!--media_storage_units' - Required (at least one) -->

<!-- 'bar_media_server' - Required, max 32 characters -->
<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>

<targets>
<!-- 'target_entity' - Required, max 32 characters -->
<target_entity>dddomain2</target_entity>

<media_storage_units>
<!--media_storage_units' - Required (at least one) -->

<!-- 'bar_media_server' - Required, max 32 characters -->
<bar_media_server>barvm13</bar_media_server>

<!-- storage_units' - Required (at least one) -->
<storage_units>

<!-- 'storage_unit_name' - Required, max characters 50, alphanumeric and "-","_" -->
<storage_unit_name>storage_unit2</storage_unit_name>

<!-- 'max_files' - Required, Integer, min value is 1-->
<files>45</files>

</storage_units>
</media_storage_units>
</targets>

</dscConfigTargetGroupsDDBoost>

XML File Example - AWS 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>

   <!-- 'Storage account' - Required, max length 24, lower case -->
  <storage_account>azure_storage_account</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>
           <prefix_list>
          <prefix_name>prefix2</prefix_name>
		 <storage_devices>50</storage_devices>
          </prefix_list>
      </blobs>
  </targetMediaBlob>  
   <targetMediaBlob>
          <bar_media_server>mediaserver2</bar_media_server>
          <blobs>
             <blob_container>blob2</blob_container>
              <prefix_list>
                  <prefix_name>prefix3</prefix_name>
                  <storage_devices>60</storage_devices>
              </prefix_list>                 
          </blobs>
  </targetMediaBlob>
</dscConfigTargetGroupsAzureBlobStorage>