Skip to content

Command Index

All commands in the latest release of MilestonePSTools can be found in the table below, each with a link to their documentation page. If you have the module installed already, you may see a list of available commands from PowerShell using Get-Command -Module MilestonePSTools.

To get to the online help for any command in the module from a PowerShell terminal with an internet connection, you may use Get-Help with the "-Online" switch. For example, Get-Help -Name Get-VmsCameraReport -Online.

📇 Index

Command From version Date Published Aliases
Add-Bookmark 1.0.12 2019-04-23
Add-EvidenceLock 1.0.12 2019-04-23
Add-GenericEvent 1.0.30 2019-05-13
Add-RegisteredService 1.0.12 2019-04-23
Add-Stream 1.0.7 2019-04-16
Add-UserDefinedEvent 1.0.10 2019-04-18
Add-VmsArchiveStorage 1.1.1 2021-05-14
Add-VmsDeviceGroupMember 22.3.0 2022-11-30 Add-DeviceGroupMember
Add-VmsFailoverRecorder 23.2.1 2023-08-17
Add-VmsHardware 21.2.0 2021-10-27
Add-VmsLoginProviderClaim 23.1.1 2023-03-28
Add-VmsRoleClaim 23.1.1 2023-03-28
Add-VmsRoleMember 22.3.0 2022-11-30 Add-User
Add-VmsStorage 1.1.1 2021-05-14
Assert-VmsLicensedFeature 23.2.1 2023-08-17
Assert-VmsRequirementsMet 23.2.1 2023-08-17
Clear-VmsCache 21.2.6 2022-02-09
Clear-VmsSiteInfo 22.1.0 2022-04-19
Clear-VmsView 21.2.7 2022-02-23
Connect-ManagementServer 1.0.6 2019-04-15
Connect-Vms 23.2.2 2023-09-28
ConvertFrom-ConfigurationApiProperties 21.2.0 2021-10-27
ConvertFrom-ConfigurationItem 21.1.453308 2021-09-17
ConvertFrom-GisPoint 21.1.451385 2021-06-29
ConvertFrom-Snapshot 21.1.451385 2021-06-29
ConvertTo-GisPoint 21.2.0 2021-10-27
Copy-EvidenceLock 1.0.36 2019-06-05
Copy-VmsClientProfile 23.1.2 2023-04-07
Copy-VmsRole 23.1.2 2023-04-07
Copy-VmsView 21.2.7 2022-02-23
Copy-VmsViewGroup 21.2.7 2022-02-23
Disconnect-ManagementServer 1.0.6 2019-04-15
Disconnect-Vms 23.2.2 2023-09-28
Export-VmsClientProfile 23.1.2 2023-04-07
Export-VmsHardware 21.2.0 2021-10-27
Export-VmsLicenseRequest 21.2.0 2021-10-27
Export-VmsRole 23.1.2 2023-04-07
Export-VmsRule 23.1.3 2023-04-21
Export-VmsViewGroup 21.2.7 2022-02-23
Find-ConfigurationItem 21.1.453308 2021-09-17
Find-VmsVideoOSItem 23.2.1 2023-08-17
Find-XProtectDevice 21.1.453308 2021-09-17
Get-AlarmDefinition 1.0.10 2019-04-18
Get-AlarmLine 1.0.81 2020-09-18
Get-AlarmStatistics 1.0.81 2020-09-18
Get-BankTable 1.0.70 2020-01-11
Get-Bookmark 1.0.12 2019-04-23
Get-CameraRecordingStats 21.1.451385 2021-06-29
Get-CameraSetting 1.0.7 2019-04-16
Get-ConfigurationItem 1.0.31 2019-05-16
Get-ConfigurationItemProperty 1.0.80 2020-09-16
Get-CurrentDeviceStatus 21.1.451385 2021-06-29
Get-DeviceAcl 1.0.6 2019-04-15
Get-EventLine 1.0.81 2020-09-18
Get-EvidenceLock 1.0.12 2019-04-23
Get-GenericEvent 1.0.30 2019-05-13
Get-GenericEventDataSource 1.0.30 2019-05-13
Get-HardwareSetting 1.0.7 2019-04-16
Get-IAlarmClient 1.0.81 2020-09-18
Get-IConfigurationService 1.0.31 2019-05-16
Get-Input 1.0.10 2019-04-18
Get-InputSetting 1.0.10 2019-04-18
Get-IServerCommandService 1.0.31 2019-05-16
Get-ItemState 1.0.45 2019-07-19
Get-Kind 1.0.47 2019-07-20
Get-LicenseDetails 1.0.66 2019-12-09
Get-LicensedProducts 1.1.4 2021-05-29
Get-LicenseOverview 1.1.4 2021-05-29
Get-LoginSettings 1.0.41 2019-06-18
Get-Metadata 1.0.10 2019-04-18
Get-MetadataSetting 1.0.10 2019-04-18
Get-MethodInfo 1.0.31 2019-05-16
Get-Microphone 1.0.10 2019-04-18
Get-MicrophoneSetting 1.0.10 2019-04-18
Get-MipMessageIdList 1.0.76 2020-04-07
Get-MipSdkEula 1.0.64 2019-11-01
Get-MobileServerInfo 1.0.56 2019-09-27
Get-Output 1.0.10 2019-04-18
Get-OutputSetting 1.0.10 2019-04-18
Get-OverallSecurity 1.0.56 2019-09-27
Get-PlatformItem 1.0.46 2019-07-19
Get-PlaybackInfo 1.0.51 2019-07-28
Get-RecorderStatusService2 1.0.67 2019-12-09
Get-RegisteredService 1.0.12 2019-04-23
Get-SequenceData 1.0.40 2019-06-11
Get-Snapshot 1.0.15 2019-04-26
Get-Speaker 1.0.10 2019-04-18
Get-SpeakerSetting 1.0.10 2019-04-18
Get-Stream 1.0.7 2019-04-16
Get-StreamProperties 21.1.451385 2021-06-29
Get-Translations 1.0.31 2019-05-16
Get-UserDefinedEvent 1.0.10 2019-04-18
Get-ValueDisplayName 21.1.451385 2021-06-29
Get-VideoDeviceStatistics 21.1.451385 2021-06-29
Get-VideoSource 1.0.53 2019-08-13
Get-VmsArchiveStorage 1.1.1 2021-05-14
Get-VmsBasicUser 23.1.1 2023-03-28
Get-VmsBasicUserClaim 23.1.1 2023-03-28
Get-VmsCamera 21.2.3 2022-01-21 Get-Camera
Get-VmsCameraGeneralSetting 21.2.3 2022-01-21
Get-VmsCameraReport 21.2.0 2021-10-27
Get-VmsCameraStream 21.2.3 2022-01-21
Get-VmsClientProfile 23.1.2 2023-04-07
Get-VmsClientProfileAttributes 23.1.2 2023-04-07
Get-VmsConnectionProfile 23.2.2 2023-09-28 Get-Vms
Get-VmsConnectionString 22.3.0 2022-11-30 Get-ConnectionString
Get-VmsDeviceEvent 23.2.3 2023-10-11
Get-VmsDeviceGroup 22.3.0 2022-11-30 Get-DeviceGroup
Get-VmsDeviceGroupMember 22.3.0 2022-11-30
Get-VmsDeviceStatus 21.2.5 2022-01-28
Get-VmsFailoverGroup 21.2.2 2021-11-04
Get-VmsFailoverRecorder 23.2.1 2023-08-17
Get-VmsHardware 22.3.0 2022-11-30 Get-Hardware
Get-VmsHardwareDriver 22.3.1 2023-02-09 Get-HardwareDriver
Get-VmsHardwarePassword 23.1.1 2023-03-28 Get-HardwarePassword
Get-VmsLog 21.2.6 2022-02-09 Get-Log
Get-VmsLoginProvider 23.1.1 2023-03-28
Get-VmsLoginProviderClaim 23.1.1 2023-03-28
Get-VmsManagementServer 21.2.6 2022-02-09 Get-ManagementServer
Get-VmsRecordingServer 22.3.0 2022-11-30 Get-RecordingServer
Get-VmsRole 22.3.0 2022-11-30 Get-Role
Get-VmsRoleClaim 23.1.1 2023-03-28
Get-VmsRoleMember 22.3.0 2022-11-30 Get-User
Get-VmsRoleOverallSecurity 22.3.0 2022-11-30
Get-VmsRule 23.1.3 2023-04-21
Get-VmsSite 23.2.1 2023-08-17 Get-Site
Get-VmsSiteInfo 22.1.0 2022-04-19
Get-VmsStorage 1.1.1 2021-05-14
Get-VmsStorageRetention 21.2.0 2021-10-27
Get-VmsSystemLicense 23.2.1 2023-08-17
Get-VmsToken 22.3.0 2022-11-30 Get-Token
Get-VmsVideoOSItem 23.2.1 2023-08-17
Get-VmsView 21.2.7 2022-02-23
Get-VmsViewGroup 21.2.7 2022-02-23
Get-VmsViewGroupAcl 21.2.7 2022-02-23
Get-VmsWebhook 23.2.2 2023-09-28
Get-WhoIsOnline 1.0.74 2020-04-07
Import-VmsClientProfile 23.1.2 2023-04-07
Import-VmsHardware 21.2.0 2021-10-27
Import-VmsLicense 21.2.0 2021-10-27
Import-VmsRole 23.1.2 2023-04-07
Import-VmsRule 23.1.3 2023-04-21
Import-VmsViewGroup 21.2.7 2022-02-23
Install-StableFPS 1.0.70 2020-01-11
Invoke-LicenseActivation 1.1.4 2021-05-29
Invoke-Method 1.0.31 2019-05-16
Invoke-MipSdkEula 1.0.64 2019-11-01
Invoke-ServerConfigurator 1.0.86 2020-11-24
Invoke-VmsLicenseActivation 21.2.0 2021-10-27
Join-VmsDeviceGroupPath 22.3.0 2022-11-30
Move-VmsHardware 23.2.3 2023-10-11
New-Alarm 1.0.81 2020-09-18
New-AlarmCondition 1.0.81 2020-09-18
New-AlarmOrder 1.0.81 2020-09-18
New-VmsBasicUser 23.1.1 2023-03-28
New-VmsClientProfile 23.1.2 2023-04-07
New-VmsDeviceGroup 22.3.0 2022-11-30 Add-DeviceGroup
New-VmsFailoverGroup 23.2.1 2023-08-17
New-VmsLoginProvider 23.1.1 2023-03-28
New-VmsRole 22.3.0 2022-11-30 Add-Role
New-VmsRule 23.1.3 2023-04-21
New-VmsView 21.2.7 2022-02-23
New-VmsViewGroup 21.2.7 2022-02-23
New-VmsWebhook 23.2.2 2023-09-28
Remove-Bookmark 1.0.12 2019-04-23
Remove-EvidenceLock 1.0.12 2019-04-23
Remove-GenericEvent 1.0.31 2019-05-16
Remove-RegisteredService 1.0.12 2019-04-23
Remove-Stream 1.0.7 2019-04-16
Remove-UserDefinedEvent 1.0.10 2019-04-18
Remove-VmsArchiveStorage 1.1.1 2021-05-14
Remove-VmsBasicUser 23.1.1 2023-03-28
Remove-VmsClientProfile 23.1.2 2023-04-07
Remove-VmsConnectionProfile 23.2.2 2023-09-28
Remove-VmsDeviceGroup 22.3.0 2022-11-30 Remove-DeviceGroup
Remove-VmsDeviceGroupMember 22.3.0 2022-11-30
Remove-VmsFailoverGroup 21.2.2 2021-11-04
Remove-VmsFailoverRecorder 23.2.1 2023-08-17
Remove-VmsHardware 23.2.2 2023-09-28 Remove-Hardware
Remove-VmsLoginProvider 23.1.1 2023-03-28
Remove-VmsLoginProviderClaim 23.1.1 2023-03-28
Remove-VmsRole 22.3.0 2022-11-30 Remove-Role
Remove-VmsRoleClaim 23.1.1 2023-03-28
Remove-VmsRoleMember 22.3.0 2022-11-30 Remove-User
Remove-VmsRule 23.1.3 2023-04-21
Remove-VmsStorage 1.1.1 2021-05-14
Remove-VmsView 21.2.7 2022-02-23
Remove-VmsViewGroup 21.2.7 2022-02-23
Remove-VmsWebhook 23.2.2 2023-09-28
Resize-Image 21.1.451385 2021-06-29
Resolve-VmsDeviceGroupPath 21.2.0 2021-10-27
Save-VmsConnectionProfile 23.2.2 2023-09-28
Select-Camera 1.0.77 2020-05-08
Select-VideoOSItem 1.0.77 2020-05-08
Select-VmsSite 23.2.1 2023-08-17 Select-Site
Send-Alarm 1.0.81 2020-09-18
Send-GenericEvent 1.0.49 2019-07-27
Send-MipMessage 1.0.76 2020-04-07
Send-UserDefinedEvent 1.0.10 2019-04-18
Set-CameraSetting 1.0.7 2019-04-16
Set-ConfigurationItem 1.0.31 2019-05-16
Set-ConfigurationItemProperty 1.0.80 2020-09-16
Set-DeviceAcl 1.0.6 2019-04-15
Set-HardwareSetting 1.0.7 2019-04-16
Set-InputSetting 1.0.10 2019-04-18
Set-MetadataSetting 1.0.10 2019-04-18
Set-MicrophoneSetting 1.0.10 2019-04-18
Set-OutputSetting 1.0.10 2019-04-18
Set-OverallSecurity 1.0.56 2019-09-27
Set-SpeakerSetting 1.0.10 2019-04-18
Set-Stream 1.0.7 2019-04-16
Set-VmsBasicUser 23.1.1 2023-03-28
Set-VmsCamera 21.2.3 2022-01-21
Set-VmsCameraGeneralSetting 21.2.3 2022-01-21
Set-VmsCameraStream 21.2.3 2022-01-21
Set-VmsClientProfile 23.1.2 2023-04-07
Set-VmsClientProfileAttributes 23.1.2 2023-04-07
Set-VmsConnectionString 22.3.0 2022-11-30
Set-VmsDeviceEvent 23.2.3 2023-10-11
Set-VmsDeviceGroup 22.3.0 2022-11-30
Set-VmsFailoverGroup 23.2.1 2023-08-17
Set-VmsFailoverRecorder 23.2.1 2023-08-17
Set-VmsHardware 23.1.1 2023-03-28 Set-HardwarePassword
Set-VmsHardwareDriver 22.3.1 2023-02-09
Set-VmsLicense 21.2.0 2021-10-27
Set-VmsLoginProvider 23.1.1 2023-03-28
Set-VmsLoginProviderClaim 23.1.1 2023-03-28
Set-VmsRecordingServer 22.3.0 2022-11-30
Set-VmsRole 22.3.0 2022-11-30
Set-VmsRoleOverallSecurity 22.3.0 2022-11-30
Set-VmsRule 23.1.3 2023-04-21
Set-VmsSiteInfo 22.1.0 2022-04-19
Set-VmsView 21.2.7 2022-02-23
Set-VmsViewGroup 21.2.7 2022-02-23
Set-VmsViewGroupAcl 21.2.7 2022-02-23
Set-VmsWebhook 23.2.2 2023-09-28
Set-XProtectCertificate 21.1.453308 2021-09-17
Split-VmsConfigItemPath 23.2.3 2023-10-11
Split-VmsDeviceGroupPath 22.3.0 2022-11-30
Start-Export 1.0.13 2019-04-25
Start-VmsHardwareScan 21.2.0 2021-10-27
Test-Playback 1.0.15 2019-04-26
Test-VmsConnection 23.2.2 2023-09-28
Test-VmsLicensedFeature 23.2.1 2023-08-17
Trace-Events 1.0.23 2019-05-03
Update-AlarmLine 1.0.81 2020-09-18
Update-Bookmark 1.0.12 2019-04-23
Update-EvidenceLock 1.0.12 2019-04-23
Update-RegisteredService 1.0.12 2019-04-23
Wait-VmsTask 21.2.0 2021-10-27