PowerShell Cmdlets

On Windows, ScaleOut StateServer (SOSS) can be managed through a set of PowerShell Cmdlets to configure and administer the in-memory data grid. The SOSS PowerShell module can be used by directly importing the SossAdministration Powershell module within Powershell (for example, Import-Module SossAdministration) or by using the ScaleOut StateServer PowerShell shortcut which will automatically import the SossAdministration PowerShell module. The ScaleOut StateServer PowerShell shortcut is located in the installation directory.

Add-Host: Activate the StateServer service for the selected host. This causes the selected host to join the store and accept a portion of the workload.
Add-AllHosts: Activate the StateServer service for all hosts. This causes the hosts to join the store and accept a portion of the workload.
Remove-Host: De-activate the StateServer service for the selected host. This causes the selected host to leave the store.

Note

It is important to allow a host to fully leave the store prior to shutting down the host or restarting the StateServer service. Otherwise, the host will abruptly leave the store, and other hosts will trigger recovery actions that further delay resumption of full storage throughput. In some cases, the distributed store can be destabilized, especially if multiple hosts are simultaneously stopped in this manner. Be sure to wait for the command to fully complete (indicated by an inactive status) prior to restarting the host. Use the leave_wait command instead of this command whenever possible.
Remove-AllHosts: De-activate the StateServer service for all hosts. This causes all hosts to leave the store. The store will be inactive and unable to service workload.
Add-GroupHost: Adds a group host to the SOSS group host list.
Remove-GroupHost: Removes a group host from the SOSS group host list.
New-HostGroup: Creates a new host group.
Connect-HostGroup: Connects the local host to the SOSS host group.
Disconnect-HostGroup: Disconnects the local host from the SOSS host group.
Clear-Store: Clears the SOSS store of all objects.
Restart-Host: Restart the StateServer service for the selected host. This command first attempts to have the selected host leave the store and then restarts the service through the host’s Windows service control manager.
Restart-AllHosts: Restart the StateServer service for all hosts. This command immediately restarts the service on all hosts through the host’s Windows service control manager.
Set-HostParameters: Set configuration parameters for the selected host.
Get-HostParameters: Show the status and configuration information for the selected host.
Get-HostStatistics: Displays the Create/Read/Update/Delete workload for the selected host or store.
Get-Host: Displays the status of the target SOSS host or the entire SOSS store.
Get-Namespace: Displays the namespaces registered with the SOSS service.
Test-Store: Tests the connectivity between all SOSS hosts.
Add-RemoteStore: Adds a GeoServer connection to a remote SOSS store.
Remove-RemoteStore: Removes a GeoServer connection to a remote SOSS store.
Test-RemoteStoreConnection: Tests the connectivity to a remote GeoServer store.
Start-RemoteStoreReplication: Starts GeoServer replication to the target remote store.
Stop-RemoteStoreReplication: Stops GeoServer replication to the target remote store.
Sync-RemoteStoreReplication: Syncs the local SOSS store with the target remote store.
Start-AllRemoteStoreReplication: Starts GeoServer replication with all configured remote stores.
Stop-AllRemoteStoreReplication: Stops GeoServer replication with all configured remote stores.
Sync-AllRemoteStoreReplication: Syncs the local SOSS store with all configured remote stores.
Get-AllRemoteSTores: Displays all remote GeoServer store parameters.
Backup-AllHosts: Perform a backup operation which will write the contents of the SOSS store or a specified NamedCache to disk.
Restore-AllHosts: Perform a restor operation which will read the contents of a backup file from disk restoring the objects to the distributed store.

Example

The Set-HostParameters and Get-HostParameters Cmdlets can be used to quickly update a host’s configuration. For example, the following commands will configure a recently installed host with IP address 10.0.4.100 to use a new multicast IP address for host auto-discovery:

$val = Get-HostParameters -HostAddress 10.0.4.100
$val.MulticastIP = 224.0.0.19
Set-HostParameters $val

This set of commands will pull the current configuration for the host 10.0.4.100, change the multicast IP address, and then update the host’s configuration.