The AutoUpate.exe program supports the automatic software update of a One Identity Manager installation. You can run the program from the command line.
Calling syntax for updating
AutoUpdate.exe
--conn={Connection string}
--Install={Directory}
[--system=MSSQL|APPSERVER]
[--log-level=Off|Fatal|Error|Info|Warn|Debug|Trace]
Calling syntax for generating a Windows PowerShell start script
AutoUpdate.exe
--script {path and file name}
Table 54: Program parameters and options
|
--conn |
--connection|
-c |
Database connection parameter. A user with a minimum access level of Configuration user is required.
For more information about permissions, see the One Identity Manager Installation Guide and the One Identity Manager Authorization and Authentication Guide.
Alternatively, you can enter the name of the connection according to the registry HKEY_CURRENT_USER\Software\One Identity\One Identity Manager\Global\Connections. |
| --install |
--install-dir, -i |
Installation directory to be updated. |
|
--system |
-s |
(Optional) Target system for the connection. Permissible values are MSSQL (default) or APPSERVER. |
|
--script |
|
Creates a Windows PowerShell startup script with the specified file name. The startup script should be located outside the installation directory.
The startup script starts the AutoUpdate.exe program and returns when both AutoUpdate.exe and Update.exe are finished. |
|
--log-level |
-l |
(Optional) Scope of output to be processed. Permitted values are:
-
Off: No logging.
-
Fatal: All critical error messages are logged.
-
Error: All error messages are logged.
-
Info: All information is logged. (default)
-
Warn: All warnings are logged.
-
Debug: Debugger outputs are logged. This setting should only be used for testing.
-
Trace: Highly more information is logged. This setting should only be used for analysis purposes. The log file quickly becomes large and cumbersome. |
|
--help |
-h, -? |
Displays program help. |
Parameter formats
Multiple-character options can be given in the following forms:
--conn="..."
--conn "..."
/conn="..."
/conn "..."
Single-character options can be given in the following forms:
-c="..."
-c "..."
/c="..."
/c "..."
Switches are allowed in the forms:
-R
/R
Example: Updating the installation directory
AutoUpdate.exe
--conn="Data Source=<Database server>;Initial Catalog=<Database name>; User ID=<Database user>; Password=<Password>"
--install="C:\Temp\InstallFolder"
Example: Updating an installation directory from an application server
AutoUpdate.exe
--system=APPSERVER
--conn="URL=https://myappserver/"
--install="C:\Temp\InstallFolder"
Example: Creating and running a Windows PowerShell startup script
Creating the startup script:
AutoUpdate.exe
--script=C:\Temp\Update.ps1
Calling the startup script:
.\Update.ps1 -Connection 'Data Source=<Database server>;Initial Catalog=<Database name>; User ID=<Database user>; Password=<Password>' -InstallDir C:\Temp\InstallFolder
The SoftwareLoaderCMD.exe program allows you to import files and export files to and from the One Identity Manager database. You can run the program from the command line.
Calling syntax
SoftwareLoaderCMD.exe
/Conn="{Connection string}"
/Auth="{Authentication String}"
[/Root="{Path}"]
[-I]
[--Import|--Export]
/Files="{Path\files|Targets}"
[/Targets={List of machine roles}]
[-N [-M] [-E]]
Table 55: Program parameters and options
|
/Conn |
Database connection parameter. A user with a minimum access level of Configuration user is required.
For more information about permissions, see the One Identity Manager Installation Guide and the One Identity Manager Authorization and Authentication Guide.
Alternatively, you can enter the name of the connection according to the registry HKEY_CURRENT_USER\Software\One Identity\One Identity Manager\Global\Connections. |
|
/Auth |
Authentication data. The authentication data depends on the authentication module used.
For more information about authentication modules, see the One Identity Manager Authorization and Authentication Guide. |
|
/Root |
(Optional) Files' installation directory. |
|
- I (--Import) |
(Optional) Only in combination with /Files. If this parameter is not set, only the files that are already known in the QBMFileRevision table are imported. If this parameter is set, unknown files are also imported into the database and an entry is created in the QBMFileRevision table.
Alternatively, the --Import command can be used. |
|
--Export |
(Optional) Export files from the database to a local directory. Only in combination with /Files or /Targets. |
|
/Files |
List of files that are imported into the database or exported from the database.
The files are specified including the directories below /Root. Machine roles are delimited with pipes (|). The entry of wild cards (*) is permitted.
Example:
/Files="Custom.*.dll|Server|Client"
/Files="CCC\Webshop\*|HTMLDevelopment" |
|
/Targets |
(Optional) List of machine roles that are used to determined which files to export. Each machine role is delimited by a space. Dependent machine roles are determined automatically.
Example:
/Targets=Server Client |
|
-N |
(Optional) If the parameter exists, all files known in the QBMFileRevision table and located in the directory specified in the /Root parameter are updated. /Conn, /Auth and /Root are mandatory parameters in this mode. -I and /Files are not taken into account. |
|
-M |
(Optional) If the parameter exists, missing files will be ignored during import. The parameter can be set in connection with parameter -N. |
|
-E |
(Optional) If the parameter exists, all errors are ignored during import. The parameter can be set in connection with parameter -N. |
|
-? |
Display program help. |
Example: Updating files that are declared in the QBMFileRevision table.
SoftwareLoaderCMD.exe
/Conn= "Data Source=<Database server>;Initial Catalog=<Database name>;User ID=<Database user>;Password=<Password>"
/Auth="Module=DialogUser;User=<User name>;Password=<Password>"
/Root="c:\source"
-N
Example: Importing custom files
SoftwareLoaderCMD.exe
/Conn= "Data Source=<Database server>;Initial Catalog=<Database name>;User ID=<Database user>;Password=<Password>"
/Auth="Module=DialogUser;User=<User name>;Password=<Password>"
/Root="c:\customsource"
-I
/Files="Custom.*.dll|Server|Client"
Example: Exporting files belonging to the "Server" and "Client" machine roles
SoftwareLoaderCMD.exe
--Export
/Conn= "Data Source=<Database server>;Initial Catalog=<Database name>;User ID=<Database user>;Password=<Password>"
/Auth="Module=DialogUser;User=<User name>;Password=<Password>"
/Root="C:\MyTemp\Export"
/Targets=Server Client
Related topics
The DBTransporterCMD.exe program allows you to import transport packages into the One Identity Manager database or export them from the database. You can run the program from the command line.
Calling syntax
DBTransporterCMD.exe
[-V]
[-L]
[-I|-P|-S]
[-N]
[-U]
[-A]
[-O]
/File="{Transport file}"
/Conn="{Connection string}"
/Auth="{Authentication String}"
[/MergeAction=Error|Transport|Database]
[/Options]
[/Template]
Table 56: Program parameters and options
|
/Conn |
Database connection parameter. A user with a minimum access level of Configuration user is required.
For more information about permissions, see the One Identity Manager Installation Guide and the One Identity Manager Authorization and Authentication Guide.
Alternatively, you can enter the name of the connection according to the registry HKEY_CURRENT_USER\Software\One Identity\One Identity Manager\Global\Connections. |
|
/Auth |
Authentication data. The authentication data depends on the authentication module used. For more information about One Identity Manager authentication modules, see the One Identity Manager Authorization and Authentication Guide. |
|
/File |
Path to the transport file. |
|
/MergeAction |
(Optional) Definition of conflict handling. Permitted values are:
-
Error: An error occurred.
-
Transport: (Default) Values are transferred from the transport package.
-
Database: Database values are retained. |
|
/Options |
Special options for transport configuration.
Example: When transporting a synchronization project, start up configurations, variables and variable sets remain the same in the target database.
/Options=ObjectFilter=KeepSettings
Example: The transport package description is redefined and the database name removed.
/Options=Description=new description;DBName=; |
|
/Template |
Path to the transport template file in XML format. The transport template contains the export criteria. The transport template is used to create the transport file.
You create transport templates with the Database Transporter. For more information, see Creating and using transport templates. |
|
-L |
If this option is set, a log file is generated of the transport package process. For further logging you can use the NLog functionality. For more information about logging with NLog, see the One Identity Manager Process Monitoring and Troubleshooting Guide. |
|
-I |
If this option is set, errors in insertion and saving are ignored. |
|
-P |
If this option is set, errors in insertion are ignored. |
|
-S |
If this option is set, saves during insertion are ignored. |
|
-N |
If this option is set, the database is not compiled. |
|
-U |
If this option is set, the database is not set to single user mode. |
|
-A |
If this option is set, sensitive data is removed from the transport. For example, this will remove information about the database server, the database, and users. |
|
-O |
For internal use only. |
|
-v |
(Optional) Provides additional information (verbose). |
|
-? | h |
Display program help. |
Example: Importing a transport package
DBTransporterCMD.exe
-L
/File="c:\source\transport.zip"
/Conn= "Data Source=<Database server>;Initial Catalog=<Database name>;User ID=<Database user>;Password=<Password>"
/Auth="Module=DialogUser;User=<User name>;Password=<Password>"
Example: Creating a transport package using a template file
DBTransporterCMD.exe
/Template=c:\data\<Template file>.xml
/File=c:\data\transport.zip
/Conn="Data Source=<Database server>;Initial Catalog=<Database name>;User ID=<Database user>;Password=<Password>"
/Auth="Module=DialogUser;User=<User name>;Password=<Password>"
Related topics
The DataImporterCMD.exe program provides support for importing data from CSV files into a One Identity Manager database. You can run the program from the command line. The program requires the import definition files for import. You create import definition files using the Data Import program.
Calling syntax
DataImporterCMD.exe
/Conn="{Connection string}"
/Auth="{Authentication String}"
[/Prov="{Provider}"]
[/Definition="{Path to import definition file}"]
[/ImportFile="{Path to import file}"]
[/DefinitionPair="{Path to import definition file}|{Path to import file}"]
[/LogLevel=Off|Fatal|Error|Info|Warn|Debug|Trace]
[/Culture="{Language code}"]
[-p]
Table 57: Program parameters and options
|
/Conn |
Database connection parameter. A user with a minimum access level of End user is required.
For more information about permissions, see the One Identity Manager Installation Guide and the One Identity Manager Authorization and Authentication Guide.
Alternatively, you can enter the name of the connection according to the registry HKEY_CURRENT_USER\Software\One Identity\One Identity Manager\Global\Connections. |
|
/Auth |
Authentication data. The authentication data depends on the authentication module used. For more information about One Identity Manager authentication modules, see the One Identity Manager Authorization and Authentication Guide. |
|
/Prov |
(Optional) Database provider. The following values are permitted: VI.DB.ViSqlFactory, VI.DB and QBM.AppServer.Client.ServiceClientFactory, QBM.AppServer.Client. |
| /Definition |
Path to the import definition file.
Example:
C:\Path\To\Definition.xml |
| /ImportFile |
Path to the import file. Multiple instances of this parameter are possible. The import definition file specified in the /Definition parameter is used.
Example:
C:\Path\To\Import.csv |
| /DefinitionPair |
Pair of the import definition file and the import file. The files are separated by a pipe character (|). Multiple instances of this parameter are possible.
Example:
C:\Path\To\Definition.xml|C:\Path\To\Import.csv |
|
/LogLevel |
(Optional) Scope of output to be processed. Permitted values are:
-
Off: No logging.
-
Fatal: All critical error messages are logged.
-
Error: All error messages are logged.
-
Info: All information is logged.
-
Warn: All warnings are logged.
-
Debug: Debugger outputs are logged. This setting should only be used for testing.
-
Trace: Highly detailed information is logged. This setting should only be used for analysis purposes. The log file quickly becomes large and cumbersome. |
|
/Culture |
(Optional) Language used to create the file. The language is required in order to read local character formats correctly, for example, dates.
Example: en-US |
|
-p |
(Optional) If this parameter is used, the processing progress is shown. |
|
-v |
(Optional) Provides additional information (verbose). |
|
-? | h |
Display program help. |
Example: Importing a single file
DataImporterCMD.exe
/Prov=VI.DB.ViSqlFactory, VI.DB
/Conn= "Data Source=<Database server>;Initial Catalog=<Database name>;User ID=<Database user>;Password=<Password>"
/Auth=Module=DialogUserAccountBased
/Defintion=C:\Work\Import\Data\Def_DataImporter_Employee.xml
/ImportFile=C:\Work\Import\Data\1_Employees.csv
Example: Importing multiple files
DataImporterCMD.exe
/Prov=VI.DB.ViSqlFactory, VI.DB
/Conn= "Data Source=<Database server>;Initial Catalog=<Database name>;User ID=<Database user>;Password=<Password>"
/Auth=Module=DialogUserAccountBased
/DefinitionPair=C:\Work\Import\Data\Def_DataImporter_Employee.xml|C:\Work\Import\Data\1_Employees.csv
/DefinitionPair=C:\Work\Import\Data\Def_DataImporter_Department.xml|C:\Work\Import\Data\2_Departments.csv
/DefinitionPair=C:\Work\Import\Data\Def_DataImporter_Locality.xml|C:\Work\Import\Data\3_Localities.csv
/DefinitionPair=C:\Work\Import\Data\Def_DataImporter_CostCenter.xml|C:\Work\Import\Data\4_CostCenters.csv
Related topics
