Help Commands for AVEVA Gateway Data Publisher

aveva.gdp.service

Commands:

service

token

shutdown

Options:

--version

-?, -h, --help

aveva.gdp.service [command] [options]

Main command to invoke the AVEVA™ Gateway Data Publisher

aveva.gdp.service service

Enables you to work with the AVEVA™ Gateway Data Publisher service

aveva.gdp.service token

Enables you to perform actions on authentication tokens

aveva.gdp.service shutdown

Enables you to perform shutdown actions

aveva.gdp.service --version

Shows version information

aveva.gdp.service -?

aveva.gdp.service -h

aveva.gdp.service --help

Displays the help information

aveva.gdp.service service

Commands:

run

Options:

-?, -h, --help

aveva.gdp.service service [command] [options]

Enables you to work with the AVEVA™ Gateway Data Publisher service

aveva.gdp.service service run

Enables you to run the AVEVA™ Gateway Data Publisher service

aveva.gdp.service service -?

aveva.gdp.service service -h

aveva.gdp.service service --help

Displays the help information

aveva.gdp.service service run

Options:

--config-file-path

--app-data-directory

--logs-location-path

-?, -h, --help

aveva.gdp.service service run [options]

Enables you to run the AVEVA™ Gateway Data Publisher service

aveva.gdp.service service run --config-file-path <config-file-path> (REQUIRED)

Enables you to specify the path to the GDP Manager configuration. Note that the associated sub-configuration files must be located in the same directory

aveva.gdp.service service run --app-data-directory <app-data-directory>

Enables you to specify the directory of the GDP service app data [default: C:\Users\<username>\AppData\Local\Gdp]

aveva.gdp.service service run --logs-location-path <logs-location-path>

Enables you to specify the directory of the GDP service logs [default: C:\Users\<username>\AppData\Local\Gdp\Logs]

aveva.gdp.service service run -?

aveva.gdp.service service run -h

aveva.gdp.service service run --help

Displays help information

aveva.gdp.service token

Commands:

add

delete

list

Options:

-?, -h, --help

aveva.gdp.service token [command] [options]

Enables you to work with access tokens

aveva.gdp.service token add

Enables you to add an access token

aveva.gdp.service token delete

Enables you to delete an access token

aveva.gdp.service token list

Enables you to list access tokens

aveva.gdp.service token -?

aveva.gdp.service token -h

aveva.gdp.service token --help

Displays help information

aveva.gdp.service token add

Options:

--value

--name

--app-data-directory

-?, -h, --help

aveva.gdp.service token add [options]

Enables you to add an access token

aveva.gdp.service token add --value <value> (REQUIRED)

Enables you to specify th value of the token to be added

aveva.gdp.service token add --name <name>

Enables you to specify a name for the token [default: default]

aveva.gdp.service token add --app-data-directory <app-data-directory>

Enables you to specify the directory of the GDP service app data [default: C:\Users\<username>\AppData\Local\Gdp]

aveva.gdp.service token add -?

aveva.gdp.service token add -h

aveva.gdp.service token add --help

Displays help information

aveva.gdp.service token delete

Options:

--name

--app-data-directory

-?, -h, --help

aveva.gdp.service token delete [options]

Enables you to delete an access token

aveva.gdp.service token delete --name <name> (REQUIRED)

Enables you to specify the name of the token to delete

aveva.gdp.service token delete --app-data-directory <app-data-directory>

Enables you to specify the directory of the GDP service app data [default: C:\Users\<username>\AppData\Local\Gdp]

aveva.gdp.service token delete -?

aveva.gdp.service token delete -h

aveva.gdp.service token delete --help

Displays the help information

aveva.gdp.service token list

Options:

--output-json-file-path

--app-data-directory

-?, -h, --help

aveva.gdp.service token list [options]

Returns the registered access tokens as JSON array

aveva.gdp.service token list --output-json-file-path <output-json-file-path>

Enables you to specify the location for the output JSON file

aveva.gdp.service token list --app-data-directory <app-data-directory>

Enables you to specify the directory of the GDP service app data [default: C:\Users\<username>\AppData\Local\Gdp]

aveva.gdp.service token shutdown

Command:

all

Options:

-?, -h, --help

aveva.gdp.service token shutdown [command] [options]

Enables you to stop the AVEVA™ Gateway Data Publisher service

aveva.gdp.service token shutdown all

Enables you to stop the AVEVA™ Gateway Data Publisher service and all its instances

aveva.gdp.service token shutdown -?

aveva.gdp.service token shutdown -h

aveva.gdp.service token shutdown --help

Displays the help information