dssreposconfig - DSS 6 | Data Source Solutions Documentation

Documentation: dssreposconfig - DSS 6 | Data Source Solutions Documentation

dssreposconfig

Usage

  • <b>dssreposconfig</b> [<b>-R</b><em>url</em>] [<b>-o</b><em>jsonfile</em>] [<em>property</em>]... Print specific repository properties (property...), or all if none are specified.
  • <b>dssreposconfig</b> [<b>-R</b><em>url</em>] [<b>-i</b><em>jsonfile</em>] [<em>property</em>=[<em>value</em>]]... Set or unset the specific repository properties supplied in the jsonfile and/or directly on the command line.
  • <b>dssreposconfig</b> [<b>-R</b><em>url</em>] <b>-a</b> [<b>-i</b><em>jsonfile</em>] [<em>property=</em><em>value</em>]... Replace all the existing repository properties with a new set of properties supplied in the jsonfile and/or directly set on the command line (property=value...).
  • <b>dssreposconfig</b> [<b>-R</b><em>url</em>] <b>-c</b> Create repository tables in the repository database.
  • <b>dssreposconfig</b> [<b>-R</b><em>url</em>] <b>-d</b> Drop all repository tables from the repository database.
  • <b>dssreposconfig</b> [<b>-R</b><em>url</em>] <b>-A</b><em>type</em>[:<em>name</em>]=[<em>access</em>] Add or delete repository-level access permissions to a user(s) (Deprecated in v6.1.5/2).

Description

Command dssreposconfig allows you to create and drop repository tables and a hub database, as well as manage the properties of a repository database. If this command is executed without supplying any of the options, it will list all the repository properties.

Argument properties specifies the properties that define the configuration of a repository database. For more information, see section Repository Properties.

Options

This section describes the options available for command dssreposconfig.

Parameter Description
-Atype[:name]=[access]

Deprecated in v6.1.5/2. Use User_Access and/or All_User_Access repository properties instead.

Add or delete Access_List property entry.

  • Value type can be all, role, or user. If value type is all, then name is omitted.
  • Value access can be SysAdmin or HubCreation.
    Omitting access causes all matching access elements to be removed.
For example, the following command will add or update the permissions for the user dssuser:
dssreposconfig -A user:dssuser=SysAdmin
The following command will remove all permissions set for user dssuser on the repository level:
dssreposconfig -A user:dssuser=
-a

Replace (delete) all the existing repository properties with a new set of properties. The new set of properties may be supplied directly in the command line ([property=[value]]...) or from file jsonfile using parameter -i.

The following syntaxes are applicable:

  • The following command replaces the current repository properties with the properties supplied in jsonfile.

    dssreposconfig -a -i jsonfile
  • The following command will replace all the existing properties with the new properties supplied in the command line.

    dssreposconfig -a property1=value1 property2=value2 property3=value3
  • The following command replaces the current repository properties with the properties supplied in jsonfile and on the command line.

    dssreposconfig -a -i jsonfile property1=value1 property2=value2 property3=value3

    The properties supplied directly on the command line will override the relevant properties in jsonfile.

For specific examples, see Replace repository properties.
-c

Create all repository tables in a repository database.

For example, the following command will create repository tables:
dssreposconfig -c

-d

Drop all repository tables from a repository database. Executing this command removes all locations, channels (including table groups and tables), and all actions defined on the channel or location. It is recommended to backup the tables (using dssdefinitionexport) before executing this command.

For example, the following command will drop all repository tables:
dssreposconfig -d
-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.
-ijsonfile

Read the values of repository properties from JSON file jsonfile.

For example, the following command will replace all the existing repository properties with the new properties supplied in repos_props.json:
dssreposconfig -a -i repos_props.json
-ojsonfile

Write properties to JSON file jsonfile. If no properties are specified on the command line, then all properties are fetched from the repository.

For example, the following command will create JSON file repos_props.json with the existing repository properties:
dssreposconfig -o repos_props.json

-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.

For example, the following command will list the repository properties of the hub server supplied:
dssreposconfig -R https://node:port
-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 dssreposconfig command.

Example 1. Get repository properties

The following command prints the value of property Access_List, which is containing access privileges.

dssreposconfig Access_List

Since 6.1.5/2, the User_Access and All_User_Access should be used.

dssreposconfig User_Access All_User_Access
Example 2. Set repository properties

The following command sets property Access_List, namely, it assigns the SysAdmin access privilege to users dssuser1 and dssuser2.

dssreposconfig Access_List[0].user=dssuser1 Access_List[0].level=SysAdmin Access_List[1].user=dssuser2 Access_List[1].level=SysAdmin

Since 6.1.5/2, the User_Access property should be used.

dssreposconfig User_Access.dssuser1.sysadmin=true User_Access.dssuser2.sysadmin=true

The property Access_List is an array, hence it is required to specify the array position in square brackets [number] while setting this property.

Example 3. Unset repository properties

The following command unsets property Access_List, which is containing access privileges.

dssreposconfig Access_List=

Since 6.1.5/2, the User_Access and All_User_Access should be used.

dssreposconfig User_Access= All_User_Access=
Example 4. Replace repository properties
  • The following command replaces the current repository properties with the properties supplied in the repos_props.json file.

    dssreposconfig -a -i repos_props.json
    
  • The following command replaces the current repository properties with the properties supplied in the repos_props.json file and property Licenses.

    dssreposconfig -a -i repos_props.json Licenses=<em>licenses</em>
    

The properties supplied directly on the command line will override the relevant properties in the repos_props.json file.

Example 5. Create hub bookmarks

The following command creates a hub bookmark.

{% tabs %}

{% tab label="Linux" %}

dssreposconfig Hub_Switch_Bookmarks='[{"url":"https://myserver:4341/#/hubs/myprodhub/","description":"Production Hub"}]'

{% /tab %}

{% tab label="Windows" %}

dssreposconfig Hub_Switch_Bookmarks="[{"url":"https://myserver:4341/#/hubs/myprodhub/","description":"Production Hub"}]"

{% /tab %}

{% /tabs %}