get_cloud_staging | Commands | Teradata Data Mover - get_cloud_staging - Teradata Data Mover

Teradata® Data Mover User Guide - 20.01

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Mover
Release Number
20.01
Published
November 2023
Language
English (United States)
Last Update
2023-12-05
dita:mapPath
hlv1700545853003.ditamap
dita:ditavalPath
mpm1591127278842.ditaval
dita:id
don1467241476387
Product Category
Analytical Ecosystem

Purpose

The get_cloud_staging allows you to retrieve the details of a cloud staging area.

Parameters

See Parameter Order.

name
Name of the cloud staging area to get details for.
Example: my_staging_area
filename
[Optional] Name of the file where the details of the cloud staging area remains. If you do not provided the output file name, the command creates a file named with the cloud staging area name and .xml extension to store the details.
Example: my_staging_area.xml
dm.rest.endpoint
[Optional] Enter a Data Mover REST server URL to overwrite the default value specified in the commandline.properties file in order to connect to a different REST server (and therefore a different daemon) at runtime.
https://dm-server1:1443/datamover
response_timeout
[Optional] Amount of time, in seconds, to wait for response from the Data Mover daemon.
Example: 60
security_password
[Optional] Password for the super user or authorized Viewpoint user.
Example: 53cUr17y
Required if security management is enabled on the Data Mover daemon. Not a valid parameter if -security_password_encrypted is also specified.
security_password_encrypted
[Optional] Encrypted password for the super user.
Example: 052c7aabd14c7770141ac3c0137ab98ae0d3f0f7cddf588981206b010c0c1b2f
Required if security management is enabled on the Data Mover daemon. Not a valid parameter if -security_password is also specified.
security_username
[Optional] User ID of the super user or authorized Viewpoint user. The user ID of the super user is dmcl_admin and cannot be changed.
Required if security management is enabled on the Data Mover daemon.

Usage Notes

You can use get_cloud_staging command with the command line parameter or an XML file. Type datamove get_cloud_staging -name my_staging_area -filename output.xml to get the details of a cloud staging area using the command line parameter. Type datamove get_cloud_staging -f getcloudstaging.xml to to get the details of a cloud staging area using an XML file.

XML File Example

<?xml version='1.0' encoding='UTF-8'?>
<dmGetCloudStagingArea  xmlns="http://schemas.teradata.com/dataMover/v2009" xsi:schemaLocation="http://schemas.teradata.com/unity/DataMover.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <name>my_staging_area</name>
    <filename>my_output_file.xml</filename>
</dmGetCloudStagingArea>