Stop-SEERegion: stop a region

Syntax

Stop -SEERegion parameter parameter . . 

Stops or disables a region, either on the local machine or on a specified remote machine.

Parameters

Note: All parameters have these properties:
  • Required: false
  • Position: named
  • Default value: none
  • Accept pipeline input: false
  • Accept wildcard characters: false
-force
Unconditional (or 'forced') region shutdown.
Note: The region must be cold started when using this parameter.
immediate
Stops the region immediately.
Note: The region must be cold started when using this parameter.
-nobanner
Does not display utility welcome and copyright messages.
-region "<region-name>"
The name of the region to be stopped.
-server "<machine-name>"[:<port>]
The name of the machine performing the stop 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
-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 shuts down the ESDEMO region.
Stop -SEERegion
This command uses the Region_TESTDB.config file to stop the TESTDB region.
Stop-SEERegion -region "TESTDB"
This command performs a normal shutdown of the ESDEMO region using the (local)\SQLEXPRESS database instance.
Stop-SEERegion -usedb "(local)\SQLEXPRESS"
This command performs a forced shutdown of the TESTDB region.
Stop-SEERegion -force -region "TESTDB"
This command performs an immediate shutdown of the ESDEMO region.
Stop-SEERegion -immediate -region "ESDEMO"