Reference
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": "" } } } |
Create action reference
ICC –action Create reference Name Creates a new instance:
|
1 |
ICC --action Create |
The –help parameter can show more information about the command:
|
1 |
ICC --action Create --help |
Synopsis
|
1 |
ICC [-a|--action] Create [-f|--configuration-file] "<FILE_PATH>" |
|
1 |
ICC [-a|--action] Create [-h|--help] |
Options -f|–configuration-file "<FILE_PATH>" – Specifies the path of the configuration file used to create a new […]
Configuration template JSON
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
{ "info": { "title": "Safewhere Identify CLI - Instance JSON Configuration", "version": "5.7" }, "definitions": { "configuratorInformation": { "databaseServerName": "", "databaseLoginUserName": "", "databaseLoginUserPassword": "" }, "tenantConfiguration": { "clientName": "", "defaultLanguage": "", "tenantId": "", "safewhereAdminIdleTimeout": 20, "passwordAdmin": "" }, "tenantDatabaseConfiguration": { "isMultiSubnetFailover": false, "databaseConfiguration": { "server": "", "schema": "", "loginUserName": "", "loginPassword": "", "dbAuthenticationType": "SQLServerAuthentication" }, "auditConfiguration": { "port": 1433, "connectionTimeout": 60 }, "sessionStateConfiguration": { "sessionStateMode": "InProc", "timeOut": 60 } }, "tenantIISConfiguration": { "generateDefaultValues": true, "serverIpAddress": "127.0.0.1", "port": 443, "domainName": "", "siteName": "", "sitePool": "", "adminPool": "", "runtimePool": "", "servicePool": "", "bindCertificate": true, "requireServerNameIndication": false, "UseHttpSecurityHeaders": true }, "tenantCertificateConfiguration": { "sslCertificateConfiguration": { "certificateSetupType": "UseDefaultCertificate", "sslDomainName": "safewhere.local", "filePath": "", "password": "", "certificateThumbprintInStore": "" }, "signingCertificateConfiguration": { "certificateSetupType": "UseDefaultCertificate", "filePath": "", "password": "", "certificateThumbprintInStore": "" }, "pathToTrustedRootCertificateToImport": "" } } } |
Configuration template
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
{ "info": { "title": "Safewhere Identify CLI - Instance JSON Configuration", "version": "5.7" }, "definitions": { "configuratorInformation": { "databaseServerName": "", "databaseLoginUserName": "", "databaseLoginUserPassword": "" }, "tenantConfiguration": { "clientName": "", "defaultLanguage": "", "tenantId": "", "safewhereAdminIdleTimeout": 20, "passwordAdmin": "" }, "tenantDatabaseConfiguration": { "isMultiSubnetFailover": false, "databaseConfiguration": { "server": "", "schema": "", "loginUserName": "", "loginPassword": "", "dbAuthenticationType": "SQLServerAuthentication" }, "auditConfiguration": { "port": 1433, "connectionTimeout": 60 }, "sessionStateConfiguration": { "sessionStateMode": "InProc", "timeOut": 60 } }, "tenantIISConfiguration": { "generateDefaultValues": true, "serverIpAddress": "127.0.0.1", "port": 443, "domainName": "", "siteName": "", "sitePool": "", "adminPool": "", "runtimePool": "", "servicePool": "", "bindCertificate": true, "requireServerNameIndication": false, "UseHttpSecurityHeaders": true }, "tenantCertificateConfiguration": { "sslCertificateConfiguration": { "certificateSetupType": "UseDefaultCertificate", "sslDomainName": "safewhere.local", "filePath": "", "password": "", "certificateThumbprintInStore": "" }, "signingCertificateConfiguration": { "certificateSetupType": "UseDefaultCertificate", "filePath": "", "password": "", "certificateThumbprintInStore": "" }, "pathToTrustedRootCertificateToImport": "" } } } |