dsshubconfig - DSS 6 | Data Source Solutions Documentation

Documentation: dsshubconfig - DSS 6 | Data Source Solutions Documentation

dsshubconfig

Usage

dsshubconfig [-Rurl] List all the hubs on the hub server.
dsshubconfig [-Rurl] hub List the hub properties of the hub.
dsshubconfig [-Rurl] [-ojsonfile] hub [properties]... Print the specified hub properties (property...), or all if none are specified.
dsshubconfig [-Rurl] [-ijsonfile] hub [property=[value]]... Set or unset the specific hub properties supplied in the jsonfile and/or directly on the command line.
dsshubconfig [-Rurl] -a [-ijsonfile] hub [property=value]... Replace all the existing properties of the hub with a new set of properties supplied in the jsonfile and/or directly set on the command line (property=value...).
dsshubconfig [-Rurl] -c [-ijsonfile] hub [property=[value]]... Create a hub with the specified properties in the jsonfile and/or the properties specified in the command line (property=[value]...).
dsshubconfig [-Rurl] -d hub Drop the hub.
dsshubconfig [-Rurl] -f hub Freeze the hub.
dsshubconfig [-Rurl] -u hub Unfreeze the hub.
dsshubconfig [-Rurl] -Atype[:name]=[access]... hub Add or delete Access_List property to the hub (Deprecated in v6.1.5/2).

Description

Command dsshubconfig allows you to create and drop a hub, as well as configure hub properties. If this command is executed without supplying any of the options, it will list all the hubs available on a hub server.

Argument properties or property specifies the properties that define the hub configuration. For more information, see section Hub Properties.

Options

This section describes the options available for command dsshubconfig.

Parameter	Description
`-Atype[:name]=[access]`	`Deprecated in v6.1.5/2`. Use User_Access and/or All_User_Access hub properties instead. Add or delete Access_List property entry. Value `type` can be all or user. If value `type` is all, then `name` is omitted. Value `access` can be HubOwner, ReadWrite, ReadExecRefresh, ReadExec, ReadOnly. Omitting access causes all matching access elements to be removed/unset. The following command will add or update the permissions for user dssuser to be HubOwner on hub myhub: `dsshubconfig -A user:dssuser=HubOwner myhub` The following command will remove all permissions explicitly set for user dssuser on the hub level: `dsshubconfig -A user:dssuser= myhub`
`-a`	Replace (delete) all the existing hub 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 file jsonfile using parameter `-i`. The following syntaxes are applicable: Replace the properties of the current hub with the properties supplied in jsonfile. `dsshubconfig -a -i jsonfile hub` Replace the current hub properties with the properties supplied on the command line. `dsshubconfig -a hub property1=value1 property2=value2 property3=value3...` Replace the current hub properties with the properties supplied in jsonfile and on the command line. `dsshubconfig -a -i jsonfile hub 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 properties.
`-c`	Create a hub. Before creating a hub, you must stop the hub server using command dsshubserver `-k`. For example, the following command will create hub myhub: `dsshubconfig -c myhub` You can also create a new hub myhub using a JSON file hub_props.json: `dsshubconfig -i hub_props.json -c myhub`
`-d`	Delete a hub. Deleting a hub will delete everything associated with that hub. That includes all definition objects, jobs, events, statistics data, files on the disk ($DSS_CONFIG/hubs/hub/ is removed). The hub will be frozen automatically before it is deleted. Deactivating a channel(s) is not required. Exporting hub definition is a good optional step for backup. For example, the following command will drop hub myhub: `dsshubconfig -d myhub`
`-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.
`-f`	Freeze a hub. When you freeze a hub, the hub's scheduler and all running jobs are stopped. In a frozen hub, you cannot run any jobs such as compare, refresh, activate, deactivate. You can freeze a hub when you no longer need it. The main benefit of freezing a hub is to stop resource consumption on the hub server while saving the state, history and configuration of the hub.
`-ijsonfile`	Read property values from JSON file `jsonfile`. For example, the following command will replace all the existing properties of hub myhub with the new properties supplied in the hub_props.json file: `dsshubconfig -a -i hub_props.json myhub`
`-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 the hub_props.json file with the current hub properties: `dsshubconfig -o hub_props.json myhub`
`-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 create hub myhub on a remote hub server: `dsshubconfig -R http://node:port -c myhub`
`-u`	Unfreeze a hub. When you unfreeze a hub, the jobs will return to the state they were at the moment of freezing. It is important to note that if the hub is frozen for an extended period of time, a capture job(s) may not be able to resume from the moment the hub is frozen since the log files were most likely cleared up a while ago.

Examples

This section provides an example of using the dsshubconfig command.

Example 1. Get hub properties

The following command prints the value of property Hub_Server_URL of hub myhub.

dsshubconfig myhub Hub_Server_URL

Example 2. Set hub properties

The following command sets property Hub_State to value FROZEN for hub myhub.

dsshubconfig myhub Hub_State=FROZEN

Example 3. Unset hub properties

The following command unsets property Description of hub myhub.

dsshubconfig myhub Description=

Example 4. Replace hub properties

The following command replaces the current properties of hub myhub with the properties supplied in the hub_props.json file.
```
dsshubconfig -a -i hub_props.json myhub
```
The following command replaces the current properties of hub myhub with the properties supplied in the hub_props.json file and property Description.
```
dsshubconfig -a -i hub_props.json myhub Description=My_old_hub
```

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