RegPlugIn parameters
- Last UpdatedDec 19, 2024
- 2 minute read
- PI System
- PI Server 2024 R2
- PI Server
The following table lists available parameters for the RegPlugin utility.
|
Parameter |
Short form |
Description |
|---|---|---|
|
/PISystem:string |
/P |
Specifies the PI AF server to process. If not specified, the default PI AF server is used. |
|
/OutputFile:string |
/O |
Specifies an output file. If specified, a SQL script is generated to create Plug-Ins. Use the AppendFile parameter to append to an existing file. |
|
/AppendFile[-] |
/A |
Used in conjunction with the OutputFile parameter, specifies whether to append to an existing output file. |
|
/List |
/L |
Lists registered assemblies in the specified PI AF server. |
|
/Recursive[-] |
/R |
Automatically processes support assemblies in subdirectories based upon assembly and directory names. Use the RootDirectory parameter to specify a root directory that is different than the current working directory. |
|
/Force[-] |
/F |
Forces registration of assemblies that are older than currently registered assemblies or forces the deregistration of assemblies that do not appear to be registered. |
|
/Silent[-] |
/S |
Silent mode. Prevents messages from being displayed. |
|
/Unregister |
/U |
Removes assembly and plug-ins from the specified PI AF server. |
|
/RegFile:string |
/RF |
Creates a registration XML file for the specified assembly that can be used to register a plug-in assembly and all its related support assemblies. Any additional files specified are treated as support assemblies. |
|
/Version |
/V |
Displays version information. All other parameters are ignored. |
|
/User:string |
/user |
Specifies a different Windows user account to connect to the PI AF server. |
|
/Password:string |
/PW |
Used in conjunction with the User parameter, specifies the password of a different Windows user account to connect to the PI AF server. |
|
/Owner:string |
/Own |
Provides the owner file name of all specified support assemblies. Normally used with the Directory parameter when registering support assemblies. By default, the directory name will be determined relative to the RootDirectory parameter or current working directory if the root directory is not specified. |
|
/Directory:string |
/Dir |
Provides the directory name for all specified support assemblies. Normally used with the Owner parameter when registering support assemblies. By default, the directory name is determined relative to the RootDirectory parameter or current working directory if the root directory is not specified. |
|
/RootDirectory:string |
/RootDir |
Registers all assemblies relative to the specified root directory name. Normally used with the Recursive parameter when registering assemblies instead of using the Directoryparameter. By default this parameter is set to the current working directory. |
|
/Exclude:string |
/E |
Specifies input files or directories to exclude when searching a directory for files. You can specify this parameter more than once, but values must be unique. |
|
files |
Specifies the input assembly files, registration files, or directories to process. You can use the following wildcard specifiers to filter files processed in directories:
|
|
|
@file |
Provides additional input parameters to the specified file. The file should contain one parameter per line. Comment lines start with the '' character. |
|
|
/?, /help |
Displays these option descriptions. |