dsshubserverconfig - DSS 6 | Data Source Solutions Documentation

Documentation: dsshubserverconfig - DSS 6 | Data Source Solutions Documentation

dsshubserverconfig

Usage

  • <b>dsshubserverconfig</b> [<b>-R</b><em>url</em>] List all the properties of the hub server.
  • <b>dsshubserverconfig</b> [<b>-R</b><em>url</em>] [<b>-o</b><em>jsonfile</em>] [<em>property...</em>] Print the specified hub server properties (property...), or all if none are specified.
  • <b>dsshubserverconfig</b> [<b>-R</b><em>url</em>] [<b>-i</b><em>jsonfile</em>] [<em>property</em>=[<em>value</em>]]... Set or unset the specific hub server properties supplied in the jsonfile and/or directly on the command line.
  • <b>dsshubserverconfig</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 properties of the hub server with a new set of properties supplied in the jsonfile and/or directly set on the command line (property=value...).

Description

Command dsshubserverconfig allows you to configure hub server properties, such as HTTP(S) port, repository class, and enable or disable setup mode. If this command is executed without supplying any of the options, it will list all the properties of a hub server.

Argument <em>properties</em> or <em>property</em> specifies the properties that define the hub server configuration. For more information, see section Hub Server Properties.

Options

This section describes the options available for command dsshubserverconfig.

Parameter Description
-a

Replace (delete) all the existing properties with a new set of properties. The new set of properties may be supplied directly in the command line ([Property=[value]]...) and/or from a JSON file jsonfile using parameter -i. Property HTTP_Port must be supplied with this option or available in the JSON file.

The following syntaxes are applicable:

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

    dsshubserverconfig -a -i jsonfile
  • The following command replaces the current hub server properties with the properties supplied on the command line.

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

    dsshubserverconfig -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 hub server properties.
-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 property values from JSON file jsonfile.
-ojsonfile Write properties to JSON file jsonfile. If no properties are specified on the command line, then all properties are fetched from the repository.
-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.

-t Check if changes to the DSS Hub Server configuration were successful.
-v Show the list of discovered location properties.

Examples

This section provides an example of using the dsshubserverconfig command.

Example 1. Get hub server properties

The following command prints the value of hub server property Oracle_SID.

dsshubserverconfig Oracle_SID
Example 2. Set hub server properties
  • The following command sets the hub server property Oracle_SID to value ora18c.

    dsshubserverconfig Oracle_SID=ora18c
    
  • The following command sets the repository database password in the property Database_Password.

    dsshubserverconfig Database_Password=@prompt
    

    Supply password when prompted.

  • The same command can be used to change/replace the repository database password configured in Hub Server Properties.

    • For better security, we recommend using @prompt while supplying password in the command line.
Example 3. Unset hub server properties

The following command unsets hub server property Oracle_SID.

dsshubserverconfig Oracle_SID=
Example 4. Replace hub server properties
  • The following command replaces the current hub server properties with the properties specified in the hubserver_props.json file.

    dsshubserverconfig -a -i hubserver_props.json
    
  • The following command replaces the current hub server properties with the properties supplied on the command line.

    dsshubserverconfig -a Database_User=dssuser HTTP_Port=4340 Oracle_Home=/oracle/18c Oracle_SID=ora18c Repository_Class=oracle
    
  • The following command replaces the current hub server properties with the properties supplied in the hubserver_props.json file and properties Oracle_Home and Oracle_SID**.**

    dsshubserverconfig -a -i hubserver_props.json Oracle_Home=/oracle/18c Oracle_SID=ora18c
    

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

For better security, we recommend using @prompt while supplying password in the command line.