Syntax
Start -SEERegion parameter parameter . .
Starts a region, either on the local machine or on a specified server.
Start-SEERegion encapsulates the
seestart command line utility.
The region startup processing is performed by the event monitor process
seemonitor.exe. By default, the event monitor that performs region startup is on the machine invoking the
seestart command.
- Use the
-server parameter to specify that an event monitor on a remote server, rather the local machine, performs the region startup.
- With the
-server parameter, you can use the
-regionfile parameter's
(local) or
(server) switch to specify whether the region startup file (and associated resource definition file) is located on the local or server machine.
If no server or local region startup path is specified, the command searches for region startup and resource definition files in the following locations in order, and uses the first version it finds:
Parameters
Note: All parameters have these properties:
- Required: false
- Position: named
- Default value: none
- Accept pipeline input: false
- Accept wildcard characters: false
- -coldstart/-warmstart
- -cs / -ws
- Cold-starts or warm-starts the region.
With
-coldstart, the region is re-created from the startup file if it exists.
-coldstart is the default value.
For the
-warmstart parameter to work, the region must have been stopped normally. You cannot warmstart a region that has been force-stopped or immediate-stopped. You must cold-start regions stopped in this manner.
- -nobanner
- Do not display utility welcome and copyright messages.
- -properties <properties file name> / -noproperties
-
You can define properties to be used by region startup processing to replace pseudo-variables that you have specified in a region startup file's
<location> sections. Pseudo-variables are replaced by the value associated with a property of the same name. If the property does not exist, the value of an environment variable of the same name replaces the pseudo-variable.
If neither
-noproperties nor
-properties is specified, each variable/value in the current environment space passes as a property to the region startup processing.
- -region "<region-name>:
-
Name of the region to be started. If
-regionfile is omitted, the command uses the first region startup file with the name
Region_<region-name>.config that it finds in the search paths.
Note: If both
-region and
-regionfile are omitted, the command opens the ESDEMO region using
-region:ESDEMO.
- -regionfile "<(local)/(server)>"<region-definition-file>"
- The region startup file to be used. The
(local)/(server) switch identifies the region startup file location. This is either the local machine or the server identified by the
-server parameter. The default is
(local).
- If
-region is omitted, the value of the file's
region element's
name property is used as the name of the region to be started.
The command uses the first region startup file with the specified name that it finds in the search paths.
Note: If both
-region and
-regionfile are omitted, the command opens the ESDEMO region using
-region:ESDEMO.
- The following show how the
-regionfile and
-server parameters work in conjunction.
This command starts the region on the local machine and uses the local region startup file.
-regionfile "c:\mydir\region_myregion.config"
This command starts the region on the server and uses the local region startup file.
-regionfile "c:\mydir\region_myregion.config -server:myserver"
This command starts the region on the local machine and uses the local region startup file.
-regionfile "(local)c:\mydir\region_myregion.config"
This command starts the region on the server and uses the local region startup file.
-regionfile "(local)c:\mydir\region_myregion.config" -server "myserver"
This command starts the region on the server and uses the server region startup file.
-regionfile "(server)c:\mydir\region_myregion.config" -server "myserver"
- -sit:<SIT-name>
- Name of the SIT to start the region with. This overrides the SIT that is specified in the region startup file.
- -server:<machine-name>[:<port>]
- The name of the machine performing the start region operation. Specify
<port> if the event monitor on the target machine is not listening on the default
9186 port.
- The default is
localhost:9186
- For example:
- -was
- Use a WAS-hosted SEP instead of spawning a
seesep process to perform PLT processing.
- -usedb:<database-server-instance>
- Name of the database server instance that hosts the region database. For example:
Default database server on the local machine:
|
-usedb
|
Default database server on the local machine, identical to
-usedb:
|
-usedb "(local)"
|
Specific database server on the local machine:
|
-usedb "(local)\SQLEXPRESS"
|
Default database server instance on a specific machine (SC1 used in example)
|
-usedb "SC1"
|
Specific database server instance on a specific machine (SC1, SQLEXPRESS used in example for machine name, database server name)
|
-usedb "SC1\SQLEXPRESS"
|
Note: Parameter values are not case sensitive.
- -verbose
- The command output displays all of the messages that the command generates.
Examples
This command uses the
Region_ESDEMO.config file to start the ESDEMO region.
Start-SEERegion
This command uses the
Region_TESTDB.config file to start the TESTDB region.
Start-SEERegion -region "TESTDB"
This command uses the
Region_Common.config file to start the DEMO region.
Start-SEERegion -region "DEMO" -regionfile "Region_Common.config"
This command uses the
Region_ESDEMO.config file to start the ESDEMO region, using
TESTSIT instead of the SIT defined in
Region_ESDEMO.config.
Start-SEERegion -sit "TESTSIT"
This command uses the
Region_ESDEMO.config file to start the ESDEMO region using the
(local)\SQLEXPRESS database instance instead of the database instance defined in
Region_ESDEMO.config.
Start-SEERegion -usedb "(local)\SQLEXPRESS"