Reconfigure action reference

ICC --action Reconfigure reference

Name

Reconfigure an existing instance:

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

Synopsis

Print out a short help for the command:

Change user's password:

Change the instance's signing certificate using a certificate from the server's Windows Certificate store (Local Machine\Personal):

Change the instance's signing certificate using a certificate from Azure Key Vault:

Deploy Safewhere Admin:

Enable multi subnet failover:

Configure security settings for Identify and Safewhere Admin:

Options

Common options:

  • -n|--name "<INSTANCE_NAME>" - Specifies the name of an existing instance that you want to reconfigure.
  • -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

Change a user's password:

  • -c|--change-user-password - Specifies the change user password action.
  • -u|--username "<USER_NAME>" - Specifies the user name of an existing user who you want to change password.
  • -p|--password "<PASSWORD>" - Specifies the new password.

Change the instance's signing certificate using a certificate from the server's certificate store (Local Machine\Personal):

  • -s|--change-signing-certificate - Specifies the change signing certificate action.
  • -t|--thumbprint "<CERTIFICATE_THUMBPRINT>" - Specifies the thumbprint of a certificate in the server's certificate store (Local Machine\Personal).

Change the instance's signing certificate using a certificate from Azure Key Vault:

  • -s|--change-signing-certificate - Specifies the change signing certificate action.
  • --use-azure-key-vault - Configure the signing certificate using a certificate from Azure Key Vault
  • --key-vault-mode "<KEY_VAULT_MODE>" - Specifies the following key vault modes: Certificate, Key.
  • --azure-tenant-id "<AZURE_TENANT_ID>" - Specifies the Azure Key Vault tenant ID.
  • --application-client-id "<APPLICATION_CLIENT_ID> - Specifies the application client ID.
  • --application-client-secret "<APPLICATION_CLIENT_SECRET> - Specifies the application client secret.
  • --azure-key-vault-url "<AZURE_KEY_VAULT_URL>" - Specifies the Azure Key Vault URL.
  • --certificate-name "<CERTIFICATE_NAME>" - Specifies the certificate name which will be used as the signing certificate. This parameter is required when the value of the Key Vault mode is Certificate.
  • --key-name "<KEY_NAME>" - Specifies the key name which will be used as the signing certificate. This parameter is required when the value of the Key Vault mode is Key.
  • --base64-encoded-certificate "<BASE64_ENCODED_CERTIFICATE>" - Specifies the base64-encoded certificate which will be used as the signing certificate. This parameter is required when the value of the Key Vault mode is Certificate.

Deploy Safewhere Admin:

  • -d|--deploy-safewhere-admin - Specifies the Deploy Safewhere Admin action.

Enable the multi subnet failover option:

  • -m|--enable-multi-subnet-failover - Specifies the enable multi subnet failover action.

Configure security settings for Identify and Safewhere Admin:

  • --configure-security-settings "<TRUE_OR_FALSE>" - The value(case-insensitive) is one of the following: True, False.

    • "True": allow you to customize security settings for XML configuration of Identify and Safewhere Admin. This parameter used in conjunction with --identify-security-settings-xml-configuration and --safewhere-admin-security-settings-xml-configuration.
    • "False": Specifies that you don't want to use security settings for XML configuration of Identify and Safewhere Admin.
  • --identify-security-settings-xml-configuration "<BASE64_ENCODED_XML_CONFIGURATION>" - Specifies the value of <system.webServer> XML block in Base64-encoded format. If you leave it empty, the default value will be used.

  • --safewhere-admin-security-settings-xml-configuration "<BASE64_ENCODED_XML_CONFIGURATION>" - Specifies the value of <system.webServer> XML block in Base64-encoded format. If you leave it empty, the default value will be used.

Examples

Change a user's password:

Change the instance's signing certificate using a certificate from the server's Windows Certificate store (Local Machine\Personal)

Change the instance's signing certificate using a certificate from Azure Key Vault that uses the Certificate mode for the Key vault mode setting:

Change the instance's signing certificate using a certificate from Azure Key Vault that uses the Key mode for the Key vault mode setting:

Deploy a Safewhere Admin site for an existing instance:

Enable multi subnet failover:

Configure security settings for Identify and Safewhere Admin:

  • 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.
  • Use this tool to do BASE64 encode https://rcfed.com/Utilities/EncodeHash