Command line arguments - SmartPlant Foundation - Administration

SmartPlant Foundation Server Manager Help

PPMProductFamily
Asset Information Management
PPMProduct
SmartPlant Foundation
PPMCategory
Administration
SPFVersion_custom
2019 (10.0)
Version_MTR
(none)

The arguments that can be used with SPFServerManager.exe are listed below.

For arguments that take a value, use quote marks around the value if there are spaces in the string. For example: /log:"c:\log files\create site"

/log: - creates a log file at the filename and path specified; used in combination with the other arguments.

/create - creates a new site.

/sn: - names the new site; "server" is appended to the name automatically (required).

/db: - identifies the database type, either Oracle or SQL Server, not case-sensitive (required).

/dsn: - identifies the data source or TNS name (required).

/u: - identifies the database user name (required).

/p: - identifies the database password (required).

/se: - sets a secure HTTPS connection when /se is set to True (optional).

/lsp: [True/False] - If set to True, loads the stored procedures (optional).

/su: - identifies the system user having system administrator privileges (required for Oracle when /lsp is set to True).

/sp: - identifies the system password (required for Oracle when /lsp is set to True).

/ts: - identifies the tablespace to load the stored procedures for Oracle (optional).

/its: - identifies the index tablespace to load the stored procedures for Oracle (optional).

/ic: - identifies the initial catalog value (required for SQL Server).

/ls: - identifies the license server URL (optional).

/rp: - sets the root path location (optional; use only if path not already set on the server).

/PropertyName: [PropertyValue] - Sets property values for the site. The complete property name is required. (Optional)

/update: - updates an existing site.

/sn: - names the site to be updated (required).

/lsp: [True/False] - If set to True, loads the stored procedures (optional).

/su: - identifies the system user with system admin privileges (required for Oracle when /lsp is set to True).

/sp: - identifies the system password (required for Oracle when /lsp is set to True).

/ts: - identifies the tablespace to load the stored procedures for Oracle (optional).

/its: - identifies the index tablespace to load the stored procedures for Oracle (optional).

/updatesitesettings /sn: - updates site settings for server properties,the file service, the remote service, or FTR settings.

/import - imports the configuration saved in the specified file.

/export - exports the configuration to the specified file name.

/listsites - lists all sites on the server.

/deletesite /sn: - deletes the specified site.

/showsitesettings /sn: - shows the settings for a specified site.

/upgrade /sn: - upgrades the site named by the required argument /sn.

/from: - identifies the SmartPlant Foundation version of your SmartPlant Foundation site database. For example, if you are upgrading from version 6.0, enter 06.00.00.21 to upgrade to the latest version. The format should be xx.xx.xx.xx.

The available /from values are listed in the UpgradeControls.xml file located at: [drive]:\Program Files (x86)\SmartPlant\Foundation\SPFServerManager. For example, if you are upgrading from:

  • SPF 2016 - the /from value would be 06.00.00.21.

  • SPF 2018 - the /from value would be 07.00.00.17.

  • SPF 2018 R1 - the /from value would be 07.01.00.15.

/upgradedataindb: - indicates if the data in the database should be upgraded. The default setting is True.

/backupdb: - backs up the database before the upgrade. The default setting is False.

/dbpath: - identifies the path of the database back up file to which the data is exported. If the path is not defined, by default, it is exported to the backup folder located in the default server files folder. For example, [drive]:\SmartPlant Foundation Server Files\Backups. The default server files location is read from the Settings.xml file located at: [drive]::\ProgramData\SPFServerManager.

/upgradecmf: - upgrades the configuration managed file (CMF). The default setting is False.

/cmfpath: - identifies the customized CMF file.

/lmcreate - creates a new license manager site.

/sn: - names the new site (required).

/lst: - sets the license server type; only valid value is SPLM (SmartPlant License Manager) (required).

/db: - sets the database type; valid values are Oracle or SQLServer.

/dsn: - identifies the data source or TNS name.

/u: - identifies the database user name.

/p: - identifies the database password.

/lmupdate /sn: - updates the license manager site named by the required argument /sn.

/lmdelete /sn: - deletes the license manager site named by the required argument /sn.

/createsdasite - creates a new SmartPlant Foundation Web Client site.

/sn: - names the new site (required).

/spfserverurl: - sets the fully-qualified URL of the SmartPlant Foundation server (required).

/spfconfigserviceurl: - sets the fully-qualified URL of the SmartPlant Foundation configuration service (required).

/updatesdasite /sn: - updates the SmartPlant Foundation Web Client site named by the required argument /sn.

/deletesdasite /sn: - deletes the SmartPlant Foundation Web Client site named by the required argument /sn.

/uninstallcleanup - deletes all sites on the server, including all support sites (such as FileService and RemoteServices); also removes permissions set in the Access Control List for these virtual directories and related folders.

/recycle - recycles application pools of a site.

/sn: - Name of the site to recycle its related application pools.

/all: [True/False] - If set to True, recycles all application pools of a site. If set to False, recycles only a server application pool. The default value is False.