Difference between revisions of "Administration API - Function Reference"

[unchecked revision]

[quality revision]

Revision as of 13:56, 2 April 2015

AttachStore

Attach existing archive store.

Arguments

Name	Type	Description
`name`	string	Meaningful name of archive store.
`type`	string (optional)
`databaseName`	string (optional)	Name of database on Microsoft SQL Server or PostgreSQL server.
`databasePath`	string (optional)	Path to directory in which database folder information and email meta data are stored.
`contentPath`	string (optional)	Path to directory in which email headers and contents are stored.
`indexPath`	string (optional)	Path to directory in which full text search indexes are stored.
`serverName`	string (optional)	Name of Microsoft SQL Server or PostgreSQL server.
`userName`	string (optional)	User name for accessing Microsoft SQL Server or PostgreSQL server.
`password`	string (optional)	Password for accessing Microsoft SQL Server or PostgreSQL server.
`requestedState`	string (optional)	State of archive store after attaching.

Argument Values

type

Name	Description
`FileSystemStandard`	Standard archive store.
`FileSystemAdvanced`	Advanced file system-based archive store.
`SQLServer`	Microsoft SQL Server-based arechive store.
`PostgreSQL`	PostgreSQL server-based archive store.

requestedState

Name	Description
`current`	Same as Normal but new messages will be archived in the archive store that is set to Current.
`normal`	The content of archives store is available to users and can be modified if the user has the appropriate permission.
`writeProtected`	The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
`disabled`	Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.

ClearUserPrivilegesOnFolders

Removes all privileges of a user on all archive folders.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.

CompactMasterDatabase

Compact master database.

CompactStore

Compact archive store.

Arguments

Name	Type	Description
`id`	number	Unique ID of archive store

CreateProfile

Create a new archiving or exporting profile.

Arguments

Name	Type	Description
`properties`	json	Profile properties.
`raw`	bool	Currently only 'true' is supported.

Argument Values

properties

To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.

CreateStore

Create and attach a new archive store.

Arguments

Name	Type	Description
`name`	string	Meaningful name of archive store.
`type`	string (optional)
`databaseName`	string (optional)	Name of database on Microsoft SQL Server or PostgreSQL server.
`databasePath`	string (optional)	Path to directory in which database folder information and email meta data are stored.
`contentPath`	string (optional)	Path to directory in which email headers and contents are stored.
`indexPath`	string (optional)	Path to directory in which full text search indexes are stored.
`serverName`	string (optional)	Name of Microsoft SQL Server or PostgreSQL server.
`userName`	string (optional)	User name for accessing Microsoft SQL Server or PostgreSQL server.
`password`	string (optional)	Password for accessing Microsoft SQL Server or PostgreSQL server.
`requestedState`	string (optional)	State of archive store after attaching.

Argument Values

type

Name	Description
`FileSystemStandard`	Standard archive store.
`FileSystemAdvanced`	Advanced file system-based archive store.
`SQLServer`	Microsoft SQL Server-based arechive store.
`PostgreSQL`	PostgreSQL server-based archive store.

requestedState

Name	Description
`current`	Same as Normal but new messages will be archived in the archive store that is set to Current.
`normal`	The content of archives store is available to users and can be modified if the user has the appropriate permission.
`writeProtected`	The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
`disabled`	Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.

CreateUser

Create new MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of new MailStore user.
`privileges`	string	Comma separated list of privileges.
`fullName`	string (optional)	Full name of user.
`distinguishedName`	string (optional)	LDAP DN string.
`authentication`	string (optional)	Authentication setting for user: 'integrated or 'directoryServices'.
`password`	string (optional)	Password of new user.

DeleteEmptyFolders

Remove folders from folder tree that do not contain emails.

Arguments

Name	Type	Description
`folder`	string (optional)	Entry point in folder tree.

DeleteMessage

Delete a single message

Arguments

Name	Type	Description
`id`	string (optional)	Unique ID of message. Format: <store_id>:<message_num>

DeleteProfile

Delete an archiving or exporting profile.

Arguments

Name	Type	Description
`id`	number	Unique ID of profile.

DeleteUser

Delete a MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.

DetachStore

Detach archive store

Arguments

Name	Type	Description
`id`	number	Unique ID of archive store.

GetActiveSessions

Get list of current user sessions.

GetChildFolders

Get child folders.

Arguments

Name	Type	Description
`folder`	string (optional)	Parent folder.
`maxLevels`	number (optional)	Depth of child folders.

GetComplianceConfiguration

Get current compliance configuration settings.

GetDirectoryServicesConfiguration

Get current Directory Services configuration settings.

GetFolderStatistics

Get folder statistics.

GetMessages

Get list of messages from a folder.

Arguments

Name	Type	Description
`folder`	string (optional)	Folder whose content to list.

GetProfiles

Get list of archiving and exporting profiles.

Arguments

Name	Type	Description
`raw`	bool	Currently only 'true' is supported.

GetServerInfo

Get MailStore Server version and machine name.

GetStoreIndexes

Get list of attachment file types to index.

Arguments

Name	Type	Description
`id`	number (optional)	Unique ID of archive store.

GetStores

Get list of archive stores.

GetTimeZones

Get list of available time zones.

GetUserInfo

Get detailed information about user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user

GetUsers

Get list of users.

GetWorkerResults

Get results of profile executions.

Arguments

Name	Type	Description
`fromIncluding`	string	Beginning of time range to fetch.
`toExcluding`	string	End of time range to fetch.
`timeZoneID`	string	Time zone in which timestamp should be returned.
`profileID`	number (optional)	Filter results by given profile ID.
`userName`	string (optional)	Filter results by given user name.

MaintainFileSystemDatabases

Run database maintainance on all datbases of file system based archive stores.

MergeStore

Merge two archive stores.

Arguments

Name	Type	Description
`id`	number	Unique ID of destination archive store.
`sourceId`	number	Unique ID of source archive store.

MoveFolder

Move folder.

Arguments

Name	Type	Description
`fromFolder`	string	Old folder name.
`toFolder`	string	New folder name.

RebuildStoreIndex

Rebuild search index for given archive folder.

Arguments

Name	Type	Description
`id`	number	Unique ID of archive store.
`folder`	string	Name of folder name.

RefreshAllStoreStatistics

Refresh statistics of all archive stores.

RenameStore

Rename archvive store

Arguments

Name	Type	Description
`id`	number	Unique ID of archive store.
`name`	string	New name of archive store.

RenameUser

Rename a MailStore user.

Arguments

Name	Type	Description
`oldUserName`	string	Old user name.
`newUserName`	string	New user name.

RetryOpenStores

Retry opening stores that failed previously

RunProfile

Run an existing archiving or exporting profile.

Arguments

Name	Type	Description
`id`	number	Unique profile ID.

RunTemporaryProfile

Run a temporary/non-existent profile.

Arguments

Name	Type	Description
`properties`	json	Profile properties.
`raw`	bool	Currently only 'true' is supported.

Argument Values

properties

To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.

SetComplianceConfiguration

Set compliance configuration settings.

Arguments

Name	Type	Description
`config`	json	Compliance configuration.

Argument Values

config

Use GetComplianceConfiguration to receive supported value.

SetDirectoryServicesConfiguration

Set directory services configuration settings.

Arguments

Name	Type	Description
`config`	json	Directory services configuration.

Argument Values

config

Use GetDirectoryServicesConfiguration to receive supported value.

SetStoreProperties

Set properties of archive store.

Arguments

Name	Type	Description
`id`	number	Set properties of archive store.
`type`	string (optional)
`databaseName`	string (optional)	Name of database on Microsoft SQL Server or PostgreSQL server.
`databasePath`	string (optional)	Path to directory in which database folder information and email meta data are stored.
`contentPath`	string (optional)	Path to directory in which email headers and contents are stored.
`indexPath`	string (optional)	Path to directory in which full text search indexes are stored.
`serverName`	string (optional)	Name of Microsoft SQL Server or PostgreSQL server.
`userName`	string (optional)	User name for accessing Microsoft SQL Server or PostgreSQL server.
`password`	string (optional)	Password for accessing Microsoft SQL Server or PostgreSQL server.

Argument Values

type

Name	Description
`FileSystemStandard`	Standard archive store.
`FileSystemAdvanced`	Advanced file system-based archive store.
`SQLServer`	Microsoft SQL Server-based arechive store.
`PostgreSQL`	PostgreSQL server-based archive store.

SetStoreRequestedState

Set state of archive store.

Arguments

Name	Type	Description
`id`	number	Unique ID of archvie store.
`requestedState`	string (optional)	State of archive store after attaching.

Argument Values

requestedState

Name	Description
`current`	Same as Normal but new messages will be archived in the archive store that is set to Current.
`normal`	The content of archives store is available to users and can be modified if the user has the appropriate permission.
`writeProtected`	The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
`disabled`	Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.

SetUserAuthentication

Set authentication settings of a MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`authentication`	string	Authentication method. Either 'inegrated' or 'directoryServices'.

SetUserDistinguishedName

Set the LDAP distinguished name of a MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`distinguishedName`	string (optional)	LDAP DN string.

SetUserEmailAddresses

Set email addresses of MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`emailAddresses`	string (optional)	List of email addresses.

SetUserFullName

Set full name of MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`fullName`	string (optional)	Full name of MailStore user.

SetUserPassword

Set password of MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`password`	string	Password of MailStore user.

SetUserPop3UserNames

Set POP3 user name of MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`pop3UserNames`	string (optional)	Comma seperated list of POP3 user names.

SetUserPrivileges

Set privileges of MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`privileges`	string	Comma separated list of privileges.

SetUserPrivilegesOnFolder

Set privileges on folder for MailStore user.

Arguments

Name	Type	Description
`userName`	string	User name of MailStore user.
`folder`	string	Folder name.
`privileges`	string	Comma separated list of folder privileges.

SyncUsersWithDirectoryServices

Sync users of MailStore instance with directory services.

Arguments

Name	Type	Description
`dryRun`	bool (optional)	Simulate sync only.

UpgradeStore

Upgrade archive store from MailStore Server 5 or older to current format.

Arguments

Name	Type	Description
`id`	number	Unique ID of archive store.

VerifyStore

Verify archive stores consistency.

Arguments

Name	Type	Description
`id`	number	Unique ID of archive store.

@@ Line 11: / Line 11: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>name</tt>
@@ Line 20: / Line 16: @@
 | Meaningful name of archive store.
 |-
-| <tt>path</tt>
+| <tt>type</tt>
-| string
+| string (optional)
-| Path of directory containing archive store data.
+|
 |-
-| <tt>requestedState</tt>
+| <tt>databaseName</tt>
 | string (optional)
-| State of archive store after attaching.
+| Name of database on Microsoft SQL Server or PostgreSQL server.
-|}
-=== Argument Values ===
-==== requestedState ====
-{| class="wikitable"
-! width=270px | Name
-! Description
 |-
-| <tt>current</tt>
+| <tt>databasePath</tt>
-| Same as Normal but new messages will be archived in the archive store that is set to Current.
+| string (optional)
+| Path to directory in which database folder information and email meta data are stored.
 |-
-| <tt>normal</tt>
+| <tt>contentPath</tt>
-| The content of archives store is available to users and can be modified if the user has the appropriate permission.
+| string (optional)
-|-
+| Path to directory in which email headers and contents are stored.
-| <tt>writeProtected</tt>
-| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
-|-
-| <tt>disabled</tt>
-| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
-|}
-== CompactStore ==
-Compact archive store.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store
-|}
-== CreateClientAccessServer ==
-Register new client access server.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>config</tt>
-| json
-| Configuration of new Client Access Server.
-|}
-=== Argument Values ===
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "serverName" : string,
-  "port" : number,
-  "serverCertificate" : {
-    "thumbprint" : string
-  }
-}
-</source>
-== CreateClientOneTimeUrlForArchiveAdmin ==
-Create URL including OTP for $archiveadmin access.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>instanceUrl</tt>
+| <tt>indexPath</tt>
 | string (optional)
-| Base URL for accessing instance.
+| Path to directory in which full text search indexes are stored.
-|}
-== CreateDirectoryOnInstanceHost ==
-Create a directory on an Instance Host
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
 | <tt>serverName</tt>
-| string
+| string (optional)
-| Name of Instance Host.
+| Name of Microsoft SQL Server or PostgreSQL server.
 |-
-| <tt>path</tt>
+| <tt>userName</tt>
-| string
+| string (optional)
-| Path of directory to create.
+| User name for accessing Microsoft SQL Server or PostgreSQL server.
-|}
-== CreateInstance ==
-Create new MailStore instance.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>config</tt>
+| <tt>password</tt>
-| json
+| string (optional)
-| Configuration of new instance.
+| Password for accessing Microsoft SQL Server or PostgreSQL server.
-|}
-=== Argument Values ===
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "instanceID" : string,
-  "alias" : string,
-  "displayName" : string,
-  "instanceHost" : string,
-  "startMode" : string,
-  "baseDirectory" : string,
-  "debugLogEnabled" : bool,
-  "vssWriterEnabled" : bool
-}
-</source>
-== CreateInstanceHost ==
-Create a new Instance Host.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>config</tt>
+| <tt>requestedState</tt>
-| json
+| string (optional)
-| Configuration of new Instance Host.
+| State of archive store after attaching.
 |}
 === Argument Values ===
-==== config ====
+==== type ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "serverName" : string,
-  "port" : number,
-  "serverCertificate" : {
-    "thumbprint" : string
-  }
-}
-</source>
-== CreateLicenseRequest ==
-Create and return data of a license request.
-== CreateStore ==
-Create and attach a new archive store.
-=== Arguments ===
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>FileSystemStandard</tt>
-| string
+| Standard archive store.
-| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>name</tt>
+| <tt>FileSystemAdvanced</tt>
-| string
+| Advanced file system-based archive store.
-| Meaningful name of archive store.
 |-
-| <tt>path</tt>
+| <tt>SQLServer</tt>
-| string
+| Microsoft SQL Server-based arechive store.
-| Path of directory containing archive store data.
 |-
-| <tt>requestedState</tt>
+| <tt>PostgreSQL</tt>
-| string (optional)
+| PostgreSQL server-based archive store.
-| State of archive store after attaching.
 |}
-=== Argument Values ===
 ==== requestedState ====
@@ Line 236: / Line 91: @@
 |}
-== CreateSystemAdministrator ==
+== ClearUserPrivilegesOnFolders ==
-Create a new SPE system administrator.
+Removes all privileges of a user on all archive folders.
 === Arguments ===
@@ Line 245: / Line 100: @@
 ! Description
 |-
-| <tt>config</tt>
+| <tt>userName</tt>
-| json
-| Configuration of new SPE system administrator.
-|-
-| <tt>password</tt>
 | string
-| Password of new SPE system administrator.
+| User name of MailStore user.
 |}
-=== Argument Values ===
+== CompactMasterDatabase ==
+Compact master database.
-==== config ====
+== CompactStore ==
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+Compact archive store.
-{
-  "userName" : string,
-  "fullName" : string
-}
-</source>
-== DeleteClientAccessServer ==
-Delete Client Access Server from management database.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>serverName</tt>
-| string
-| Name of Client Access Server.
-|}
-== DeleteInstanceHost ==
-Delete Instance Host from management database.
 === Arguments ===
@@ Line 286: / Line 116: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>serverName</tt>
-| string
-| Name of Instance Host.
-|}
-== DeleteInstances ==
-Delete one or multiple MailStore Instances
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceFilter</tt>
-| string
-| Instance filter string.
-|}
-=== Argument Values ===
-==== instanceFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
-|-
-| <tt>*</tt>
-| All instances
-|-
-| <tt>instance01 instance02 instance03</tt>
-| instance01, instance02 and instance03
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
-|}
-== DeleteSystemAdministrator ==
-Delete SPE system administrator.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>userName</tt>
-| string
-| User name of SPE system administrator.
-|}
-== DetachStore ==
-Detach archive store
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>id</tt>
 | number
-| Unique ID of archive store.
+| Unique ID of archive store
 |}
-== FreezeInstances ==
+== CreateProfile ==
-Freeze a MailStore Instance
+Create a new archiving or exporting profile.
 === Arguments ===
@@ Line 370: / Line 131: @@
 ! Description
 |-
-| <tt>instanceFilter</tt>
+| <tt>properties</tt>
-| string
+| json
-| Instance filter string.
+| Profile properties.
-|}
-=== Argument Values ===
-==== instanceFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
 |-
-| <tt>*</tt>
+| <tt>raw</tt>
-| All instances
-|-
-| <tt>instance01 instance02 instance03</tt>
-| instance01, instance02 and instance03
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
-|}
-== GetArchiveAdminEnabled ==
-Get currrent state of archive admin access.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== GetClientAccessServers ==
-Get list of Client Access Servers.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>serverNameFilter</tt>
-| string (optional)
-| Server name filter string.
-|-
-| <tt>withServiceStatus</tt>
 | bool
-| Include service status or not.
+| Currently only 'true' is supported.
 |}
 === Argument Values ===
-==== serverNameFilter ====
+==== properties ====
-{| class="wikitable"
+To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.
-! width=270px | Name
-! Description
-|-
-| <tt>null</tt>
-| All servers
-|-
-| <tt>serverName</tt>
-| Only the given serverName. Must match exactly.
-|}
-== GetDirectoriesOnInstanceHost ==
+== CreateStore ==
-Get file system directory structure from Instance Host.
+Create and attach a new archive store.
 === Arguments ===
@@ Line 453: / Line 154: @@
 ! Description
 |-
-| <tt>serverName</tt>
+| <tt>name</tt>
 | string
-| Name of Instance Host.
+| Meaningful name of archive store.
 |-
-| <tt>path</tt>
+| <tt>type</tt>
 | string (optional)
-| Path of directory to obtain subdirectories from.
+|
-|}
-== GetEnvironmentInfo ==
-Return general information about SPE environment.
-== GetIndexConfiguration ==
-Get list of attachment file types to index.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>databaseName</tt>
-| string
+| string (optional)
-| Unique ID of MailStore instance in which this command is invoked.
+| Name of database on Microsoft SQL Server or PostgreSQL server.
-|}
-== GetInstanceConfiguration ==
-Get configuration of MailStore Instance.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>databasePath</tt>
-| string
+| string (optional)
-| Unique ID of MailStore instance in which this command is invoked.
+| Path to directory in which database folder information and email meta data are stored.
-|}
-== GetInstanceHosts ==
-Get list of Instance Hosts.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>serverNameFilter</tt>
+| <tt>contentPath</tt>
 | string (optional)
-| Server name filter string.
+| Path to directory in which email headers and contents are stored.
-|}
-=== Argument Values ===
-==== serverNameFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
 |-
-| <tt>null</tt>
+| <tt>indexPath</tt>
-| All servers
+| string (optional)
+| Path to directory in which full text search indexes are stored.
 |-
 | <tt>serverName</tt>
-| Only the given serverName. Must match exactly.
+| string (optional)
-|}
+| Name of Microsoft SQL Server or PostgreSQL server.
-== GetInstanceProcessLiveStatistics ==
-Get live statistics from instance process.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>userName</tt>
-| string
+| string (optional)
-| Unique ID of MailStore instance in which this command is invoked.
+| User name for accessing Microsoft SQL Server or PostgreSQL server.
-|}
-== GetInstances ==
-Get list of instances.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceFilter</tt>
+| <tt>password</tt>
-| string
+| string (optional)
-| Instance filter string.
+| Password for accessing Microsoft SQL Server or PostgreSQL server.
-|}
-=== Argument Values ===
-==== instanceFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
 |-
-| <tt>*</tt>
+| <tt>requestedState</tt>
-| All instances
+| string (optional)
-|-
+| State of archive store after attaching.
-| <tt>instance01 instance02 instance03</tt>
-| instance01, instance02 and instance03
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
-|}
-== GetInstanceStatistics ==
-Get archive statistics from instance.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== GetServiceStatus ==
-Get current status of all SPE services.
-== GetStoreAutoCreateConfiguration ==
-Get automatic archive store creation settings.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== GetStores ==
-Get list of archive stores.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== GetSystemAdministrators ==
-Get list of system administrators.
-== MaintainFileSystemDatabases ==
-Execute maintenance task on archive store databases.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== MergeStore ==
-Merge two archive stores.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of destination archive store.
-|-
-| <tt>sourceId</tt>
-| number
-| Unique ID of source archive store.
-|}
-== PairWithManagementServer ==
-Pair server role with Management Server.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>serverType</tt>
-| string
-| Type of server role.
-|-
-| <tt>serverName</tt>
-| string
-| Name of server that hosts 'serverType' role.
-|-
-| <tt>port</tt>
-| number
-| TCP port on which 'serverType' role on 'serverName' accepts connections.
-|-
-| <tt>thumbprint</tt>
-| string
-| Thumbprint of SSL certificate used by serverType' role on 'serverName'
-|}
-=== Argument Values ===
-==== serverType ====
-{| class="wikitable"
-! width=270px | Name
-! Description
-|-
-| <tt>instanceHost</tt>
-| Pairing an Instance Host.
-|-
-| <tt>clientAccessServer</tt>
-| Pairing a Client Access Server.
-|}
-== Ping ==
-Send a keep alive packet.
-== RebuildSelectedStoreIndexes ==
-Rebuild search indexes of selected archive stores.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== RefreshAllStoreStatistics ==
-Refresh archive store statistics.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== RenameStore ==
-Rename archvive store
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store.
-|-
-| <tt>name</tt>
-| string
-| New name of archive store.
-|}
-== RestartInstances ==
-Restart one or multiple instances.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceFilter</tt>
-| string
-| Instance filter string.
 |}
 === Argument Values ===
-==== instanceFilter ====
+==== type ====
 {| class="wikitable"
 ! width=270px | Name
 ! Description
 |-
-| <tt>*</tt>
+| <tt>FileSystemStandard</tt>
-| All instances
+| Standard archive store.
 |-
-| <tt>instance01 instance02 instance03</tt>
+| <tt>FileSystemAdvanced</tt>
-| instance01, instance02 and instance03
+| Advanced file system-based archive store.
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
-|}
-== RetryOpenStores ==
-Retry opening stores that failed previously
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>SQLServer</tt>
-| string
+| Microsoft SQL Server-based arechive store.
-| Unique ID of MailStore instance in which this command is invoked.
-|}
-== SelectAllStoreIndexesForRebuild ==
-Select all archive store for rebuild.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>PostgreSQL</tt>
-| string
+| PostgreSQL server-based archive store.
-| Unique ID of MailStore instance in which this command is invoked.
 |}
-== SetArchiveAdminEnabled ==
-Enable or disable archive admin access.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>enabled</tt>
-| bool
-| Enable or disable flag.
-|}
-== SetClientAccessServerConfiguration ==
-Set the configuration of a Client Access Server.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>config</tt>
-| json
-| Client Access Server configuration.
-|}
-=== Argument Values ===
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "serverName" : string,
-  "port" : number,
-  "serverCertificate" : {
-    "thumbprint" : string
-  }
-}
-</source>
-== SetIndexConfiguration ==
-Set full text search index configuration.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>config</tt>
-| json
-| Full text search index configuration.
-|}
-=== Argument Values ===
-==== config ====
-Use GetIndexConfiguration to reveive supported value.
-== SetInstanceConfiguration ==
-Set configuration of MailStore Instance.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>config</tt>
-| json
-| Instance configuration.
-|}
-=== Argument Values ===
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "instanceID" : string,
-  "alias" : string,
-  "displayName" : string,
-  "instanceHost" : string,
-  "startMode" : string,
-  "baseDirectory" : string,
-  "debugLogEnabled" : bool,
-  "vssWriterEnabled" : bool
-}
-</source>
-== SetInstanceHostConfiguration ==
-Set configuration of Instance Host.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>config</tt>
-| json
-| Instance Host configuration.
-|}
-=== Argument Values ===
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "serverName" : string,
-  "port" : number,
-  "serverCertificate" : {
-    "thumbprint" : string
-  },
-  "baseDirectory" : string
-}
-</source>
-== SetStoreAutoCreateConfiguration ==
-Set configuration for automatic archive store creation.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>config</tt>
-| json
-| Archive store automatic creation configuration.
-|}
-=== Argument Values ===
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "enabled" : bool,
-  "interval" : string,
-  "sizeThreshold" : string,
-  "numberOfMessagesThreshold" : number,
-  "baseDirectory" : string
-}
-</source>
-== SetStorePath ==
-Set the path to archive store data.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store.
-|-
-| <tt>path</tt>
-| string
-| Path to archvie store data.
-|}
-== SetStoreRequestedState ==
-Set state of archive store.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store.
-|-
-| <tt>requestedState</tt>
-| string
-| State of archive store.
-|}
-=== Argument Values ===
 ==== requestedState ====
@@ Line 1,034: / Line 232: @@
 | Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
 |}
-== SetSystemAdministratorConfiguration ==
-Set SPE system adminstrator configuration.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>config</tt>
-| json
-| SPE system adminstrator configuration.
-|}
-=== Argument Values ===
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "fullName" : string
-}
-</source>
-== SetSystemAdministratorPassword ==
-Set password for SPE system administrator.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>userName</tt>
-| string
-| User name of SPE system administrator.
-|-
-| <tt>password</tt>
-| string
-| New password for SPE system administrator.
-|}
-== StartInstances ==
-Start one or multiple MailStore Instances.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceFilter</tt>
-| string
-| Instance filter string.
-|}
-=== Argument Values ===
-==== instanceFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
-|-
-| <tt>*</tt>
-| All instances
-|-
-| <tt>instance01 instance02 instance03</tt>
-| instance01, instance02 and instance03
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
-|}
-== StopInstances ==
-Stop one or multiple MailStore Instances.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceFilter</tt>
-| string
-| Instance filter string.
-|}
-=== Argument Values ===
-==== instanceFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
-|-
-| <tt>*</tt>
-| All instances
-|-
-| <tt>instance01 instance02 instance03</tt>
-| instance01, instance02 and instance03
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
-|}
-== ThawInstances ==
-Thaw one or multiple MailStore Instances.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceFilter</tt>
-| string
-| Instance filter string.
-|}
-=== Argument Values ===
-==== instanceFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
-|-
-| <tt>*</tt>
-| All instances
-|-
-| <tt>instance01 instance02 instance03</tt>
-| instance01, instance02 and instance03
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
-|}
-== UpgradeStore ==
-Upgrade archive store from MailStore Server 5 or older to current format.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store.
-|}
-== VerifyStore ==
-Verify archive stores consistency.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store.
-|}
-== ClearUserPrivilegesOnFolders ==
-Removes all privileges of a user on all archive folders.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>userName</tt>
-| string
-| User name of MailStore user.
-|}
-== CreateProfile ==
-Create a new archiving or exporting profile.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>properties</tt>
-| json
-| Profile properties.
-|-
-| <tt>raw</tt>
-| bool
-| Currently only 'true' is supported.
-|}
-=== Argument Values ===
-==== properties ====
-To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.
 == CreateUser ==
@@ Line 1,276: / Line 241: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,299: / Line 260: @@
 | <tt>authentication</tt>
 | string (optional)
-| Authentication setting for user: 'integrated' or 'directoryServices'.
+| Authentication setting for user: 'integrated or 'directoryServices'.
 |-
 | <tt>password</tt>
@@ Line 1,314: / Line 275: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>folder</tt>
@@ Line 1,332: / Line 289: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>id</tt>
@@ Line 1,350: / Line 303: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>id</tt>
@@ Line 1,368: / Line 317: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,377: / Line 322: @@
 | User name of MailStore user.
 |}
+== DetachStore ==
+Detach archive store
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
+|}
+== GetActiveSessions ==
+Get list of current user sessions.
 == GetChildFolders ==
@@ Line 1,386: / Line 348: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>folder</tt>
@@ Line 1,402: / Line 360: @@
 == GetComplianceConfiguration ==
 Get current compliance configuration settings.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
 == GetDirectoryServicesConfiguration ==
 Get current Directory Services configuration settings.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
 == GetFolderStatistics ==
 Get folder statistics.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
 == GetMessages ==
@@ Line 1,450: / Line 375: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>folder</tt>
@@ Line 1,468: / Line 389: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>raw</tt>
@@ Line 1,478: / Line 395: @@
 |}
-== GetTimeZones ==
+== GetServerInfo ==
-Get list of available time zones.
+Get MailStore Server version and machine name.
+== GetStoreIndexes ==
+Get list of attachment file types to index.
 === Arguments ===
@@ Line 1,487: / Line 407: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>id</tt>
-| string
+| number (optional)
-| Unique ID of MailStore instance in which this command is invoked.
+| Unique ID of archive store.
 |}
+== GetStores ==
+Get list of archive stores.
+== GetTimeZones ==
+Get list of available time zones.
 == GetUserInfo ==
@@ Line 1,500: / Line 426: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,512: / Line 434: @@
 == GetUsers ==
 Get list of users.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
 == GetWorkerResults ==
@@ Line 1,532: / Line 443: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>fromIncluding</tt>
@@ Line 1,556: / Line 463: @@
 | string (optional)
 | Filter results by given user name.
+|}
+== MaintainFileSystemDatabases ==
+Run database maintainance on all datbases of file system based archive stores.
+== MergeStore ==
+Merge two archive stores.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Unique ID of destination archive store.
+|-
+| <tt>sourceId</tt>
+| number
+| Unique ID of source archive store.
 |}
@@ Line 1,566: / Line 494: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>fromFolder</tt>
@@ Line 1,578: / Line 502: @@
 | string
 | New folder name.
+|}
+== RebuildStoreIndex ==
+Rebuild search index for given archive folder.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
+|-
+| <tt>folder</tt>
+| string
+| Name of folder name.
+|}
+== RefreshAllStoreStatistics ==
+Refresh statistics of all archive stores.
+== RenameStore ==
+Rename archvive store
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
+|-
+| <tt>name</tt>
+| string
+| New name of archive store.
 |}
@@ Line 1,588: / Line 551: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>oldUserName</tt>
@@ Line 1,601: / Line 560: @@
 | New user name.
 |}
+== RetryOpenStores ==
+Retry opening stores that failed previously
 == RunProfile ==
@@ Line 1,610: / Line 572: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>id</tt>
@@ Line 1,628: / Line 586: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>properties</tt>
@@ Line 1,645: / Line 599: @@
 ==== properties ====
-To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.
+To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value.
 == SetComplianceConfiguration ==
@@ Line 1,655: / Line 609: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>config</tt>
@@ Line 1,678: / Line 628: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>config</tt>
@@ Line 1,692: / Line 638: @@
 ==== config ====
 Use GetDirectoryServicesConfiguration to receive supported value.
+== SetStoreProperties ==
+Set properties of archive store.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Set properties of archive store.
+|-
+| <tt>type</tt>
+| string (optional)
+|
+|-
+| <tt>databaseName</tt>
+| string (optional)
+| Name of database on Microsoft SQL Server or PostgreSQL server.
+|-
+| <tt>databasePath</tt>
+| string (optional)
+| Path to directory in which database folder information and email meta data are stored.
+|-
+| <tt>contentPath</tt>
+| string (optional)
+| Path to directory in which email headers and contents are stored.
+|-
+| <tt>indexPath</tt>
+| string (optional)
+| Path to directory in which full text search indexes are stored.
+|-
+| <tt>serverName</tt>
+| string (optional)
+| Name of Microsoft SQL Server or PostgreSQL server.
+|-
+| <tt>userName</tt>
+| string (optional)
+| User name for accessing Microsoft SQL Server or PostgreSQL server.
+|-
+| <tt>password</tt>
+| string (optional)
+| Password for accessing Microsoft SQL Server or PostgreSQL server.
+|}
+=== Argument Values ===
+==== type ====
+{| class="wikitable"
+! width=270px | Name
+! Description
+|-
+| <tt>FileSystemStandard</tt>
+| Standard archive store.
+|-
+| <tt>FileSystemAdvanced</tt>
+| Advanced file system-based archive store.
+|-
+| <tt>SQLServer</tt>
+| Microsoft SQL Server-based arechive store.
+|-
+| <tt>PostgreSQL</tt>
+| PostgreSQL server-based archive store.
+|}
+== SetStoreRequestedState ==
+Set state of archive store.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archvie store.
+|-
+| <tt>requestedState</tt>
+| string (optional)
+| State of archive store after attaching.
+|}
+=== Argument Values ===
+==== requestedState ====
+{| class="wikitable"
+! width=270px | Name
+! Description
+|-
+| <tt>current</tt>
+| Same as Normal but new messages will be archived in the archive store that is set to Current.
+|-
+| <tt>normal</tt>
+| The content of archives store is available to users and can be modified if the user has the appropriate permission.
+|-
+| <tt>writeProtected</tt>
+| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
+|-
+| <tt>disabled</tt>
+| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
+|}
 == SetUserAuthentication ==
@@ Line 1,701: / Line 751: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,712: / Line 758: @@
 | <tt>authentication</tt>
 | string
-| Authentication method. Either 'integrated' or 'directoryServices'.
+| Authentication method. Either 'inegrated' or 'directoryServices'.
 |}
@@ Line 1,723: / Line 769: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,745: / Line 787: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,767: / Line 805: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,789: / Line 823: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,811: / Line 841: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,833: / Line 859: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,855: / Line 877: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
@@ Line 1,881: / Line 899: @@
 ! width=120px | Type
 ! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>dryRun</tt>
 | bool (optional)
 | Simulate sync only.
+|}
+== UpgradeStore ==
+Upgrade archive store from MailStore Server 5 or older to current format.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
+|}
+== VerifyStore ==
+Verify archive stores consistency.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
 |}