dsslocationconfig - DSS 6 | Data Source Solutions Documentation

Documentation: dsslocationconfig - DSS 6 | Data Source Solutions Documentation

dsslocationconfig

Usage

  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <em>hub</em> List all locations in a hub.
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <em>hub loc</em> List the location properties of the specified location.
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <em>hub loc </em>[<em>properties</em>]... Print the specified property(ies).
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <em>hub loc</em> [<em>property</em>=[<em>value</em>]]... Set or unset the specified location properties.
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <b>-a</b> <em>hub</em> <em>loc</em> [<em>property</em>=<em>value</em>]... Replace all the existing location properties with a new set of specified properties.
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <b>-c</b> <em>hub loc</em> [<em>property</em>=[<em>value</em>]]... Create a location with the specified location properties.
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <b>-d</b> <em>hub loc</em> Delete a location.
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <b>-E</b><em>x </em><em>hub loc property=@file</em> Set encoding for a location property when setting the property from a file.
  • <b>dsslocationconfig</b> [<b>-R</b><em>url</em>] <b>-E</b><em>x </em><em>hub loc property&gt;@file</em> Set encoding for a location property when fetching the property into a file.

Description

Command dsslocationconfig allows you to create, configure, delete a location, as well as manage location properties including location connection parameters, location/database type, database version, method of capture, etc. For a complete list of location properties, see section Location Properties.

Options

This section describes the options available for command dsslocationconfig.

Parameter Description
-a Replace (delete) all the existing location properties with a new set of properties. The new set of properties may be supplied directly in the command line ([property=[value]]...). For specific examples, see Example 6.

-c

Create a location. For specific examples, see Create location.

In the User interface, this option corresponds to the Create New Location page.

-d

Delete a location. For specific examples, see Delete location.

In the User interface, this option corresponds to the Delete Location option.
-Ex

Override automatic encoding/decoding of string properties when reading a property from file using property=@file_name or when writing a property to file using property>@file_name. This option may be required only while setting the property whose argument is base64.

When this option is not used, the default encoding is base64.

Valid values of x are:

  • none: no encoding/decoding will be applied.
  • base64: encode a property in the base64 format.
-Rurl

Remote hub server. Access the hub server running on a remote machine, via the REST interface.

This option is required for remote CLI access. When using this option, command dsslogin should be run first, for authentication.

-Vaccessmeth

Handle classified data.

  • redact: Redact classified data.

  • storage default: Save classified data as they are stored in the hub system.

  • @outputfile: Apply transport encryption, save key to file outputfile.

  • @print: Apply transport encryption using the transport encryption key and display the key in command terminal.

  • @inputfile: Read transport encryption key stored in a inputfile. This can also be a path (relative or absolute) to this file.

  • @prompt: Prompt a user to enter the transport key via keyboard.

Examples

This section provides examples of using the dsslocationconfig command.

Example 1. Create location

The following command creates location myloc with the specified properties.

dsslocationconfig -c myhub myloc Class=oracle
Example 2. Delete location

The following command deletes location myloc.

dsslocationconfig -d myhub myloc
Example 3: Get location properties
  • The following command displays the properties of location myloc.

    dsslocationconfig myhub myloc
    
  • The following command prints the value of property Database_User of location myloc.

    dsslocationconfig myhub myloc Database_User
    
Example 4: Set location properties
  • The following command sets location property Database_User to value myuser. The command will override the current value of the Database_User property (if set) with value myuser.

    dsslocationconfig myhub myloc Database_User=myuser
    
  • The following command sets location property Stream_Client_Public_Certificate from file mycertificate.pub_cert and encodes it into the base64 format.

    dsslocationconfig -E base64 myhub myloc Stream_Client_Public_Certificate=@mycertificate.pub_cert
    
  • The following command sets location property Database_Password from the user input prompted on the command line.

    dsslocationconfig myhub myloc Database_Password=@prompt
    

For safety reasons, this is the recommended method for supplying password on the command line.

Example 5. Unset location properties

The following command unsets property Staging_Directory.

dsslocationconfig myhub myloc Staging_Directory=
Example 6. Replace location properties

The following command replaces the current properties of location myloc with the properties supplied on the command line.

dsslocationconfig -a myhub myloc Oracle_Home=/oracle/1900 Oracle_SID=ora1900
Example 7: Fetch location properties to file

The following command fetches location property Database_User into file loc.props without encoding it into base64 format.

{% tabs %}

{% tab label="Linux" %}

dsslocationconfig -E none myhub myloc 'Database_User>@loc.props'

{% /tab %}

{% tab label="Windows" %}

dsslocationconfig -E none myhub myloc "Database_User>@loc.props"

{% /tab %}

{% /tabs %}