Reference
Schema-cli
Configuration JSON schema The Create command receives a full configuration JSON template template as an input parameter. All the other commands may work with just the configuratorInformation section. For all the upcoming sections, settings that are used by an action […]
Upgrade action reference
ICC –action Upgrade reference Name Upgrade an existing instance:
|
1 |
ICC --action Upgrade |
The –help parameter can show more information about the command:
|
1 |
ICC --action Upgrade --help |
Synopsis
|
1 |
ICC [-a|--action] Upgrade [-n|--name] "<INSTANCE_NAME...>" [-f|--configuration-file] "<FILE_PATH>" [-b|--backup-database] [-u|--use-default-http-security-headers] [-t|--safewhere-admin-idle-timeout] |
|
1 |
ICC [-a|--action] Upgrade [-h|--help] |
Options -n|–name "<INSTANCE_NAME…>" – Specifies the name of an existing instance that you want to upgrade […]
Replicate action reference
ICC –action Replicate reference Name Replicate an existing instance to another server:
|
1 |
ICC --action Replicate |
The –help parameter can show more information about the command:
|
1 |
ICC --action Replicate --help |
Synopsis
|
1 |
ICC [-a|--action] Replicate [-n|--name] "<INSTANCE_NAME>" [-f|--configuration-file] "<FILE_PATH>" |
|
1 |
ICC [-a|--action] Replicate [-h|--help] |
Options -n|–name "<INSTANCE_NAME>" – Specifies the name of an existing instance that you […]
Reconfigure action reference
ICC –action Reconfigure reference Name Reconfigure an existing instance:
|
1 |
ICC --action Reconfigure |
The –help parameter can show more information about the command:
|
1 |
ICC --action Reconfigure --help |
Synopsis Print out a short help for the command:
|
1 |
ICC [-a|--action] Reconfigure [-h|--help] |
Change user’s password:
|
1 |
ICC [-a|--action] Reconfigure [-n|--name] "<INSTANCE_NAME>" [-c|--change-user-password] [-u|--username] "<USER_NAME>" [-p|--password] "<PASSWORD>" [-f|--configuration-file] "<FILE_PATH>" |
Change the instance’s signing certificate: […]
Configuring logging
Logging Configuring logging To configure logging, you can look at the <appSettings> element of the Identify CLI’s App.config file:
|
1 2 3 4 5 6 |
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="serilog:minimum-level" value="Verbose" /> <add key="LoggingFolder" value="C:\\IdentifyLogs" /> <!-- More settings here --> |
The serilog:minimum-level setting specifies the log level. Valid values are those defined in the Serilog’s Minimum level enumeration: Verbose, Debug, […]
ImportData action reference
ICC –action ImportData reference Name Import data to an existing instance:
|
1 |
ICC --action ImportData |
The –help parameter can show more information about the command:
|
1 |
ICC --action ImportData --help |
Synopsis
|
1 |
ICC [-a|--action] ImportData --name "<INSTANCE_NAME>" [-f|--configuration-file] "<FILE_PATH>" [-r|--resources] <RESOURCE_TYPE...> [-s|--source-folder] "<DIRECTORY_PATH>" |
|
1 |
ICC [-a|--action] ImportData [-h|--help] |
Options -n|–name "<INSTANCE_NAME>" – Specifies the name of an existing instance to which you […]
Help action reference
ICC –help reference Name The –help parameter can show more information about the supported commands:
|
1 |
ICC --help |
You can specify an action name to see its help content:
|
1 |
ICC --action <COMMAND_NAME> --help |
Synopsis
|
1 |
ICC [-h|--help] |
|
1 |
ICC [-a|--action] <COMMAND_NAME> [-h|--help] |
Options -a|–action <COMMAND_NAME> – Specifies the action to see […]
ExportData action reference
ICC –action ExportData reference Name Export data of an existing instance:
|
1 |
ICC --action ExportData |
The –help parameter can show more information about the command:
|
1 |
ICC --action ExportData --help |
Synopsis
|
1 |
ICC [-a|--action] ExportData --name "<INSTANCE_NAME>" [-f|--configuration-file] "<FILE_PATH>" [-r|--resources] <RESOURCE_TYPE...> [-o|--output-folder] "<DIRECTORY_PATH>" |
|
1 |
ICC [-a|--action] ExportData [-h|--help] |
Options -n|–name "<INSTANCE_NAME>" – Specifies the name of an existing instance from which you […]
Delete action reference
ICC –action Delete reference Name Delete an existing instance:
|
1 |
ICC --action Delete |
The –help parameter can show more information about the command:
|
1 |
ICC --action Delete --help |
Synopsis
|
1 |
ICC [-a|--action] Delete [-n|--name] "<INSTANCE_NAME...>" [-f|--configuration-file] "<FILE_PATH>" [-o|--force] |
|
1 |
ICC [-a|--action] Delete [-h|--help] |
Options -n|–name "<INSTANCE_NAME…>" – Specifies the name of an existing instance that you want to delete […]
Database configuration template JSON
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
{ "info": { "title": "Safewhere Identify CLI - Database Connection JSON Configuration", "version": "5.7" }, "definitions": { "configuratorInformation": { "databaseServerName": "", "databaseLoginUserName": "", "databaseLoginUserPassword": "" } } } |