Command Line Server Console

You can run the server console as a command line utility to back up, restore, and migrate vaults and Content Center libraries.

Note: AutoCAD Civil 3D does not use Content Center libraries.

You can run the server console as a command line utility to back up and restore vaults.

Run the server console from the command line:

Click Windows Start Run, and then enter cmd in the Run dialog box.
Change directories to the install directory for the server console. By default, this path is C:\Program Files\Autodesk\ADMS <application><year>\ADMS Console, where application is the Autodesk Vault edition, and year is the release year (such as Professional 2014).
At the command line, enter: Connectivity.ADMSConsole.exe followed by the command line options, and then press Enter.

Back Up the Vault

The backup switch requires a vault administrator account.

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Note: If using Autodesk Vault Collaboration or Autodesk Vault Professional the Hot Backup feature allows the backup to run while users are connected to the Vault.

Command	Details
-Obackup	The operation being performed (required).
-Bfolder	The back up directory (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required unless password is blank).
-VAL	Validates the backup. Errors are recorded in the specified log file. See Optional Switches for more information on specifying a log file.
-INCR	Performs an incremental backup.
-DBSC	Excludes the standard content libraries from the back up process. The standard content libraries are detached before backing up the vault, the vault is backed up, and then the standard content libraries are reattached.
-DBUsaUser	The SQL sa account user name (required unless default configuration).
-DBPsapassword	The SQL sa account password (required unless default configuration).
-INRF	Ignore non-replicated files. If this switch is not present in the command line, files will get replicated prior to the backup starting.

Example

Connectivity.ADMSConsole.exe -Obackup -BC:\Backup -VUadministrator -VPadmin -VAL -LC:\Backup\BackupLog.txt

Note: Paths containing spaces must be inside of double quotes (for example, "C:\Vault Backup").

Using Tape Backup Software with a SQL Server Plug In

If you use backup software that supports Microsoft SQL server, such as Veritas Backup Exec, then you can select the vault server during your standard backup.

Note: We recommend using the supplied utility. Using it backs up the SQL data and the file store giving you more predictable results.

Restore the Vault

The restore switch requires a vault administrator account and a database administrator account, unless the default database account is still valid. The restore command does not automatically migrate data. If restoring the vault data to an upgraded vault server, migrate the data immediately after restore.

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Orestore	The operation being performed (required).
-Bfolder	The back up directory (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required unless password is blank).
-DBUusername	Database account user name (required unless default configuration).
-DBPpassword	Database account password (required unless default configuration).
-Tfolder	The target database location (optional). If used with the -TL switch, this will be the target location for the MDF database file.
-TLfolder	The target database log file (LDF) location (optional).
-Ufolder	The target file store location (optional).
-INCR	Performs an incremental restore.

Note: By default, the restore command restores both components to their original locations. If the -T is not used, then the database is restored to the default location defined in the MSDE SQL installation. If the -U is not used, then the file store is restored to its original location.

Example

Connectivity.ADMSConsole.exe -Orestore -BC:\Backup -VUadministrator -VPadmin -DBUdbadmin -DBPdbpword -LC:\Vault.txt

Note: You specify the name and location of the backup from which you want to restore. Paths containing spaces must be inside of double quotes (for example, "C:\Vault Backup").

Migrate Vault Data

Migrating vault data applies whatever changes are necessary to the database schema following an upgrade of the vault server. Always migrate data following an upgrade of the vault server. The migrate switch requires a vault administrator account and a database administrator account, unless the default database account is still valid.

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Omigrate	The operation being performed (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-DBUusername	Database account user name (required unless default configuration).
-DBPpassword	Database account password (required unless default configuration).

Example

Connectivity.ADMSConsole.exe -Omigrate -VUadministrator -VPadmin -DBUdbadmin -DBPdbpword

Migrate Vault Data after Installing a Hot Fix or an Update

Under certain conditions, installing a Hot Fix or an Update on the Vault Server can require a special command. It should only be necessary to run this command when it is stated in the readme of the Hot Fix or Update, or under the guidance of Autodesk support.

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Ob2bmigrate	The operation being performed (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-DBUusername	Database account user name (required unless default configuration).
-DBPpassword	Database account password (required unless default configuration).

Example

Connectivity.ADMSConsole.exe -Ob2bmigrate -VUadministrator -VPadmin -DBUdbadmin -DBPdbpword

Purge File Versions

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Opurge	The operation being performed (required). If this operation is executed without any other switches, the task will run based on revision and lifecycle rules without affecting uncontrolled files.
-Nvault name	The name of the vault to be purged (required).
-Stop	Halts the purge task while it is running.
-Normal	Sets the purge task to a normal system priority.
-KEEPVERSnumberX	Keep the latest X number of versions (optional). The value can range between 1 and 99. The default value is 1.
-MINAGEnumberX	Purge versions older than X number of days (optional). The value can range between 0 and 180. The default value is 0.
-EXCLCMTcomment	Purge versions that do not contain the specified comment (optional). The default value is an empty string, "".
-UNCONTROLLED	Purges versions based on default settings and the revision and lifecycle rules. If used in conjunction with -KEEPVERS, -MINAGE, or -EXCLMT, then the system purges uncontrolled files as well as files based on revision and lifecycle rules.
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).

Example

Connectivity.ADMSConsole.exe -Opurge -NVault -KEEPVERS3 -MINAGE30 -EXCLCMT"Do not purge" -VUadministrator -VPadmin

Disable Purge

Use the following command line process to disable Purge.

Note: You must run the command for each vault that you want to disable.

Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Odisablepurge	Operation being performed (required).
-Ndatabasename	Name of the database (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-WA	Windows Authentication (optional)

Example

Connectivity.ADMSConsole.exe -Odisablepurge -NVault -VUAdministrator -VPadmin -WA

Import Reference Table XML

When repairing references, one of the last steps in the workflow is to import an XML file containing the new reference relationships. This action is performed from the command line.

Note: See Repairing References for more information.

Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Oimportreferencetable	Operation being performed (required).
-Ndatabasename	Name of the database (required).
-FINfile	Full path to the Reference Table that's being imported (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-WA	Windows Authentication (optional)

Example

Connectivity.ADMSConsole.exe -Oimportreferencetable -NVault1 -FIN"c:\My Documents\192.168.92.138_vault_2012-06-26-02-46.xml" -VUAdministrator -VPadmin

Note: Any errors encountered during the import process are written to the Console Log.

Reset Reference Repair

If for any reason you would like to reset the references for a file that you repaired, you can use the reset repaired references command.

The command removes the relationships that have been repaired using the Reference Table and resets them to the state they were in prior to the repair.

Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Oresetrepairedreferences	Operation being performed (required).
-Ndatabasename	Name of the database (required).
-VFILEvaultfilepath	Full Vault path for the file to be processed (required for resetting references for a specific file).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-WA	Windows Authentication (optional)

Example

Connectivity.ADMSConsole.exe -Oresetrepairedreferences -NVault1 -VFILE$/Designs/Assemblies/Padlock.iam -VUAdministrator -VPadmin

Note: The reset command works only for the references that have been repaired by importing the Reference Table. References can be repaired for one parent file at a time. The reset command resets all of the repaired references for the parent file. Any errors encountered during the reset process are written to the Console Log

Re-index File Properties

Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Oreindexfileproperties	The operation being performed (required).
-Ndatabasename	The name of the database to be re-indexed (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-TIP	Re-indexes only leading versions of files (optional). This is the default setting. If -TIP is used (or not specified), only the latest versions, the released versions, and pending released versions are re-indexed. Note: For more information on revision management, see the Autodesk Vault Client help.
-ALL	Re-indexes all versions of files (optional). By default, only the latest versions, the released versions, and pending released versions are indexed (-TIP). If -ALL is used, all versions are re-indexed. Note: For more information on revision management, see the Autodesk Vault Client help.
-EXTextensions	File extensions filter (optional). Enter values separated by ',' or ';' without spaces. With or without '*' or '.'
PROVIDERcontentsourceproviders	Content source providers filter (optional). Enter values separated by ',' or ';' without spaces. Use the following system name for each provider: AutoCAD–AutoCAD_PropertyProvider AutoCAD Electrical–AutoCADElectrical_PropertyProvider Inventor DWG– InventorDwg_PropertyProvider Inventor– Inventor_PropertyProvider Revit– Revit_PropertyProvider Office 97-2003 Documents– Office_PropertyProvider Office Documents– OfficeOpenXml_PropertyProvider All Files– IFilter_PropertyProvider AutoCAD C3D– AutoCADC3D_PropertyProvider Sheet Set Data–SSM_PropertyProvider
-FROMstartdate	Start date filter (optional) Use mm/dd/yyyy format
-TOenddate	End date filter (optional) Use mm/dd/yyyy format
-FORCE	Force all files or latest files to be cracked open and re-indexed (optional).
-STOP	Terminates the re-indexing operation (optional). Once stopped, re-indexing cannot be started from the point at which it left off.
-NORMAL	Bumps the process priority from "Below Normal" to "Normal" (optional). The priority cannot be changed once the re-indexing operation is initiated. If the -NORMAL switch is used, re-indexing will complete sooner; however, server performance will degrade due to the higher priority of the operation.

Examples

Connectivity.ADMSConsole.exe -Oreindexfileproperties -NVault -VUadministrator -VPadmin

Connectivity.ADMSConsole.exe -Oreindexfileproperties -NVault -VUadministrator -VPadmin -STOP

Connectivity.ADMSConsole.exe -Oreindexfileproperties -Nvault -VUadministrator -VPadmin -TIP -FORCE -EXTipt,iam -PROVIDERAutoCADElectrical,OfficeOpenXml -FROM5/10/2011 -TO5/20/2011

Rebuild Search Index Data

Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-ORebuildsearchindexes	The operation being performed (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-DBUusername	Database account user name (required unless default configuration).
-DBPpassword	Database account password (required unless default configuration).

Example

Connectivity.ADMSConsole.exe -ORebuildsearchindexes -NVault -VUadministrator -VPadmin

Defragment a Vault Database

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Odefragmentvault	The operation being performed (required).
-Ndatabasename	The name of the vault database to be defragmented (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).

Example

Connectivity.ADMSConsole.exe -Odefragmentvault -NVault -VUAdministrator -VPadmin -S

Import a Library

The server console command line can be used to import libraries.

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Oimportlibrary	The operation being performed (required).
-NLibraryName	The database name of the library to import (required).
-DFdataFilePath	The path to the data file being imported, including the name of the file (required).
-DLlogFilePath	The path to the log file being imported, including the name of the file (required).
-ZIP	A switch that indicates the data file is a Zip file containing both the .mdf and .ldf files (required regardless if the file specified in the -DF switch ends with a .zip extension).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-DBUusername	Database account user name (required unless default configuration).
-DBPpassword	Database account password (required unless default configuration).

Example

Connectivity.ADMSConsole.exe -Oimportlibrary -N"Inventor Standard Content" -DF"c:\My Library Repository\Inventor Standard Content.mdf" -VUadministrator -VPadmin -DBUsername -DBPassword

Export a Library

The server console command line can be used to export libraries.

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Oexportlibrary	The operation being performed (required).
-NLibraryName	The database name of the library to export (required).
-TtargetDirectory	The path to store the exported library (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).

Example

Connectivity.ADMSConsole.exe -Oexportlibrary -N"Inventor Standard Content" -T"c:\My Library Repository" -VUadministrator -VPadmin

Attach a Library

The server console command line can be used to attach libraries.

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Oattachlibrary	The operation being performed (required).
-NLibraryName	The database name of the library to attach.
-DFdataFilePath	The path to the data file being attached, including the name of the file (required).
-DLlogFilePath	The path to the log file being imported, including the name of the file (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-DBUusername	Database account user name (required unless default configuration).
-DBPpassword	Database account password (required unless default configuration).

Example

Connectivity.ADMSConsole.exe -Oattachlibrary -N"Inventor Standard Content" -DF"c:\My Library Repository\Inventor Standard Content.mdf" -VUadministrator -VPadmin -DBUsername -DBPassword

Detach a Library

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Odetachlibrary	The operation being performed (required).
-NLibraryName	The database name of the library to detach.
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-DBUusername	Database account user name (required unless default configuration).
-DBPpassword	Database account password (required unless default configuration).

Example

Connectivity.ADMSConsole.exe -Odetachlibrary -N"Inventor Standard Content" -VUadministrator -VPadmin -DBUsername -DBPassword

Defragment a Library Database

Make sure no users are connected to the vault.
Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-Odefragmentlibrary	The operation being performed (required).
-NdatabaseName	The name of the library database to defragment (required).
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).

Example

Connectivity.ADMSConsole.exe -Odefragmentlibrary -NLibrary -VUadministrator -VPadmin

Rename a Server

If you rename the computer hosting the Autodesk Vault server, the computer name must also be updated in the Autodesk Vault server. The computer name can be changed in the vault server either before or after the actual computer name is changed. In a multi-site environment, the name of the computer hosting the Autodesk Vault server is the name of the site.

Command	Details
-OSiteRename	The operation being performed (required).
-SNOpreviousname	The current name of the computer to rename (required).
-SNNnewname	The new name for the computer being renamed (required).
-DBUsaUser	The SQL sa account user name (required).
-DBPsapassword	The SQL sa account password (required).

Example

Connectivity.ADMSConsole.exe -OSiteRename -SNOserver -SNNnewserver -VU(Vault Administrator Name) -VP(Vault Administrator Password) -DBUsa -DBPAutodeskVault@26200

Validate File Store

This command runs a validation on the file store and databases. This will validate all of the files recorded in the database against the files in the file store. If any files are missing, a dialog displays a list of missing files. This list will also we written in the console log for the server.

Run Connectivity.ADMSConsole.exe from a command line with the following switches:

Command	Details
-VUusername	Vault administrator account user name (required).
-VPpassword	Vault administrator account password (required).
-Ovalidatefilestore	The operation being performed (required).

Example

Connectivity.ADMSConsole.exe -Ovalidatefilestore -VUadministrator -VPadmin

Synchronize Your Workspace from the Command Line

You can run workspace synchronization from the command line. Using the command line, you can create a script or an event in Windows Task Scheduler to automate workspace synchronization.

Note: By default, the file delete option is suppressed when synchronizing your workspace from the command line. This is to prevent any inadvertent loss of data. To enable file delete via the command line, you must edit the XML file and enable this functionality:

"<StandAloneOnlySettingDeleteFiles>=True

Click Windows Start > Run, and then enter cmd in the Run dialog box.
Change directories to the install directory for Autodesk Vault. By default, this path is C:\Program Files\Autodesk\Autodesk Vault [version]\Explorer.

At the command line, type: Connectivity.WorkspaceSync.exe followed by the command line options, and then press Enter.

Command	Details
-WA	Use Windows authentication to log into the Vault server (optional).
-Nserver\databasename	The name of the server and the database to be synchronized (required).
-VUusername	The user name of the vault account. (This flag is optional if Windows authentication is used. It is required if the Windows authentication flag is not used).
-VPpassword	The vault account password (required unless password is blank).
-S	The full path to a valid synchronization settings file (optional). The synchronization settings file specifies the syncrhonization options. For more information on exporting a settings file, see Specify Workspace Sync Settings.
-F	The full path and file name for a report file (optional). The synchronization summary is written to the report file. If the report file already exists, the summary is appended to the contents of the existing file.

Examples

Connectivity.WorkspaceSync.exe -Ndmserver\Vault -WA -S"C:\Synchronization Settings\Settings.xml" -FC:\temp\SyncReport.csv
Connectivity.WorkspaceSync.exe -Ndmserver\Vault -VUbkeaton -VPg3nEral27-S"C:\Synchronization Settings\Settings.xml" -FC:\temp\SyncReport.csv

Note: Paths containing spaces must be inside of double quotes (for example, "C:\Synchronization Settings\Settings.xml").

Optional Switches

The following switches are optional and can be used with the command line operations.

Switch	Details
-WA	Use Windows Authentication for a command that requires a vault user name and password. Use in place of -VUusername and -VPpassword.
-S	Run the utility in silent mode without any message boxes.
-L	Specify the name and location for a log file. If the log file already exists, the output is appended to the file specified.

Command Line Server Console

Back Up the Vault

Restore the Vault

Migrate Vault Data

Migrate Vault Data after Installing a Hot Fix or an Update

Purge File Versions

Disable Purge

Import Reference Table XML

Reset Reference Repair

Re-index File Properties

Rebuild Search Index Data

Defragment a Vault Database

Import a Library

Export a Library

Attach a Library

Detach a Library

Defragment a Library Database

Rename a Server

Validate File Store

Synchronize Your Workspace from the Command Line

Optional Switches

Related Concepts

Related Information