ICC --action Upgrade reference

Name

Upgrade an existing instance:

ICC --action Upgrade

The --help parameter can show more information about the command:

ICC --action Upgrade --help

Synopsis

ICC [-a|--action] Upgrade [-n|--name] "<INSTANCE_NAME...>" [-f|--configuration-file] "<FILE_PATH>" [-b|--backup-database] [-t|--safewhere-admin-idle-timeout] [--configure-security-settings] [--identify-security-settings-xml-configuration] "<BASE64_ENCODED_XML_CONFIGURATION>" [--safewhere-admin-security-settings-xml-configuration] "<BASE64_ENCODED_XML_CONFIGURATION>"

ICC [-a|--action] Upgrade [-h|--help]

Options

  • -n|--name "<INSTANCE_NAME...>" - Specifies the name of an existing instance that you want to upgrade (you can enter multiple items separating by white space).
  • -f|--configuration-file "<FILE_PATH>" - Specifies the path of the configuration file used for database connection. For more information about the configuration file, see Database connection configuration JSON schema.
  • -b|--backup-database - Does database backup before upgrading to the new version.
  • -t|--safewhere-admin-idle-timeout - Specifies the number of minutes that an Safewhere Admin instance can remain idle before it shuts down (this setting is used when deploying the Safewhere Admin).
  • --configure-security-settings - allows you to customize security settings for Identify and the new Admin. This parameter is used in conjunction with --identify-security-settings-xml-configuration and --safewhere-admin-security-settings-xml-configuration.
    • The value of the --identify-security-settings-xml-configuration parameter is a <system.webServer> XML block in Base64-encoded format. If you leave it empty, the default value will be used.
    • The value of the --safewhere-admin-security-settings-xml-configuration parameter is a <system.webServer> XML block in Base64-encoded format. If you leave it empty, the default value will be used.
  • --skip-backup-source - Skip sources backup before upgrading to expedite the upgrading process.
  • -h|--help - Prints out a short help for the command.

Note: the parameter -b|--backup-database is not yet supported for the MariaDB database provider.

Examples

Upgrade an existing instance:

ICC --action Upgrade --name "instance1" --configuration-file "C:\identify-configuration\database_connection.json" --backup-database

Upgrade an existing instance with custom security settings:

ICC --action Upgrade --name "instance1" --configuration-file "C:\identify-configuration\database_connection.json" --backup-database --configure-security-settings --identify-security-settings-xml-configuration "<BASE64_ENCODED_XML_CONFIGURATION>" --safewhere-admin-security-settings-xml-configuration "<BASE64_ENCODED_XML_CONFIGURATION>"
  • For the --identify-security-settings-xml-configuration parameter, you can use the default value, Base64-encode it and replace <BASE64_ENCODED_XML_CONFIGURATION> with the encoded value.
  • For the --safewhere-admin-security-settings-xml-configuration parameter, you can use the default value, Base64-encode it and replace <BASE64_ENCODED_XML_CONFIGURATION> with the encoded value.
  • You can use the tool at https://rcfed.com/Utilities/EncodeHash to do Base64 encoding.

Upgrade multiple existing instances:

ICC --action Upgrade --name "instance1 instance2 instance3" --configuration-file "C:\identify-configuration\database_connection.json" --backup-database --safewhere-admin-idle-timeout 30

Upgrade multiple existing instances without backing up sources:

ICC --action Upgrade --name "instance1 instance2 instance3" --configuration-file "C:\identify-configuration\database_connection.json" --skip-backup-source