en-US/MilestonePSTools.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-Bookmark</command:name> <command:verb>Add</command:verb> <command:noun>Bookmark</command:noun> <maml:description> <maml:para>Adds a new bookmark to the timeline for a given device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-Bookmark cmdlet adds a new bookmark to the timeline for a given device. The bookmark can later be found by time, name or description, and is represented by a visual marker in the timeline for the given device in playback within XProtect Smart Client and any other integration using the timeline UI component.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-Bookmark</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>GUID based identifier of the device for which the bookmark should be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Timestamp of the event which should be bookmarked. Value can be a string, and it will be parsed into a DateTime object. Default is the current time.</maml:para> <maml:para>Note: The event will be stored with a UTC timestamp on the Management Server. Supplying a DateTime string can be finicky - it is recommended to thoroughly test any scripts to ensure it results in a bookmark at the expected place in the timeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>MarginSeconds</maml:name> <maml:description> <maml:para>Specifies the time in seconds before, and after the value of Timestamp, which should be considered a part of this bookmark event.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Reference</maml:name> <maml:description> <maml:para>Specifies a reference string for the bookmark. The default value will be a string retrieved from the Management Server using the BookmarkGetNewReference() method which returns a string like 'no.016735'. The value does not need to be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Header</maml:name> <maml:description> <maml:para>Specifies the header, or title of the bookmark. It is helpful to supply a header or description to add context to the bookmark. The default value is 'Created <timestamp>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created 2021-08-18 23:10:32.236Z</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the bookmark. It is helpful to supply a header or description to add context to the bookmark. The default value is 'Created by MilestonePSTools'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created by MilestonePSTools</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the bookmark. It is helpful to supply a header or description to add context to the bookmark. The default value is 'Created by MilestonePSTools'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created by MilestonePSTools</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>GUID based identifier of the device for which the bookmark should be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Header</maml:name> <maml:description> <maml:para>Specifies the header, or title of the bookmark. It is helpful to supply a header or description to add context to the bookmark. The default value is 'Created <timestamp>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created 2021-08-18 23:10:32.236Z</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>MarginSeconds</maml:name> <maml:description> <maml:para>Specifies the time in seconds before, and after the value of Timestamp, which should be considered a part of this bookmark event.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Reference</maml:name> <maml:description> <maml:para>Specifies a reference string for the bookmark. The default value will be a string retrieved from the Management Server using the BookmarkGetNewReference() method which returns a string like 'no.016735'. The value does not need to be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Timestamp of the event which should be bookmarked. Value can be a string, and it will be parsed into a DateTime object. Default is the current time.</maml:para> <maml:para>Note: The event will be stored with a UTC timestamp on the Management Server. Supplying a DateTime string can be finicky - it is recommended to thoroughly test any scripts to ensure it results in a bookmark at the expected place in the timeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Add-Bookmark -DeviceId $id -Timestamp '2019-06-04 14:00:00'</dev:code> <dev:remarks> <maml:para>Add a bookmark for device with a GUID ID value stored in the variable $id, using a local timestamp of 2PM on the 4th of June, 2019, based on the culture of the PowerShell session.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Add-Bookmark -DeviceId $id -Timestamp '2019-06-04 14:00:00Z'</dev:code> <dev:remarks> <maml:para>Add a bookmark for device with a GUID ID value stored in the variable $id, using a UTC timestamp of 2PM UTC on the 4th of June, 2019</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-VmsHardware | Get-VmsCamera | Where-Object Name -Like '*Elevator*' | ForEach-Object { Add-Bookmark -DeviceId $_.Id -Timestamp '2019-06-04 14:00:00' -Header 'Vandalism' }</dev:code> <dev:remarks> <maml:para>Find all enabled cameras with the case-insensitive string 'Elevator' in the name, and add a bookmark for those cameras at 2PM on June 4th, or 21:00 UTC if the location where the script is executed has a UTC offset of -7.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Add-Bookmark/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EvidenceLock</command:name> <command:verb>Add</command:verb> <command:noun>EvidenceLock</command:noun> <maml:description> <maml:para>Adds a new evidence lock record.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new evidence lock record. Evidence locks describe sequences of video for one or more cameras and related devices with custom retention settings. This enables you to retain recordings longer than the normal configured video retention for the selected devices.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> <maml:para>- Requires VMS feature "EvidenceLock"</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EvidenceLock</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CameraIds</maml:name> <maml:description> <maml:para>One or more camera IDs to associate with the new evidence lock record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>A detailed description of the evidence lock record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceIds</maml:name> <maml:description> <maml:para>Zero or more additional device IDs to be associated with the evidence lock such as related microphones or speakers</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpireDate</maml:name> <maml:description> <maml:para>The date at which the evidence lock should expire and recordings should be deleted based on normal retention settings for their storage configuration</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageFrom</maml:name> <maml:description> <maml:para>Specifies the earliest start time for the recordings associated with the evidence lock</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageTo</maml:name> <maml:description> <maml:para>Specifies the most recent recordings associated with the evidence lock</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:description> <maml:para>Specifies the title of the evidence lock</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeRelatedDevices</maml:name> <maml:description> <maml:para>Specifies whether related devices are automatically associated with the evidence lock</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RetentionType</maml:name> <maml:description> <maml:para>Specifies the type of retention for the evidence lock</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Indefinite</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UserDefined</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CameraIds</maml:name> <maml:description> <maml:para>One or more camera IDs to associate with the new evidence lock record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>A detailed description of the evidence lock record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceIds</maml:name> <maml:description> <maml:para>Zero or more additional device IDs to be associated with the evidence lock such as related microphones or speakers</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpireDate</maml:name> <maml:description> <maml:para>The date at which the evidence lock should expire and recordings should be deleted based on normal retention settings for their storage configuration</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageFrom</maml:name> <maml:description> <maml:para>Specifies the earliest start time for the recordings associated with the evidence lock</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageTo</maml:name> <maml:description> <maml:para>Specifies the most recent recordings associated with the evidence lock</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Header</maml:name> <maml:description> <maml:para>Specifies the title of the evidence lock</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeRelatedDevices</maml:name> <maml:description> <maml:para>Specifies whether related devices are automatically associated with the evidence lock</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RetentionType</maml:name> <maml:description> <maml:para>Specifies the type of retention for the evidence lock</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedDataResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-EvidenceLock -Header 'Evidence Lock Title' -Description 'Created from PowerShell' -CameraIds (Select-Camera -RemoveDuplicates -AllowFolders -AllowServers).Id -IncludeRelatedDevices -FootageFrom (Get-Date).AddDays(-1) -FootageTo (Get-Date).AddMinutes(-5) -RetentionType UserDefined -ExpireDate (Get-Date).AddDays(300) -Verbose</dev:code> <dev:remarks> <maml:para>Creates a new evidence lock for the last ~24 hours of video from the selected cameras with a 300-day retention.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Add-EvidenceLock/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-GenericEvent</command:name> <command:verb>Add</command:verb> <command:noun>GenericEvent</command:noun> <maml:description> <maml:para>Adds a new Generic Event to the system configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new Generic Event to the system configuration. Generic events can be used to receive generic TCP/UDP messages. If a matching message is detected, then a rule or an alarm can be triggered.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-GenericEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Generic Event. This is the display name used in Management Client and the rules engine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Expression</maml:name> <maml:description> <maml:para>Specifies the expression to attempt to match TCP or UDP messages against. This can be a simple string, or a regular expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ExpressionType</maml:name> <maml:description> <maml:para>Specifies how the expression should be used. Search implies that the expression should occur anywhere in the received message. Match means the message must match the expression exactly. Regex means the expression will be used in a regular expression pattern and the messages must match the regular expression.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Search</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Match</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Regex</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the generic event. Use this when you may have multiple matching generic events and they should be prioritized differently.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>DataSourceId</maml:name> <maml:description> <maml:para>Specifies the Configuration API path of the generic event data source to associate the generic event with. The path is a string like "GenericEventDataSource[8607bccc-2bb5-4b47-a7de-8225d14c4213]" despite the parameter name implying it accepts a simple GUID. If the data source is not enabled in Management Client under Tools > Options > Generic Events, then an error will be thrown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>DataSourceId</maml:name> <maml:description> <maml:para>Specifies the Configuration API path of the generic event data source to associate the generic event with. The path is a string like "GenericEventDataSource[8607bccc-2bb5-4b47-a7de-8225d14c4213]" despite the parameter name implying it accepts a simple GUID. If the data source is not enabled in Management Client under Tools > Options > Generic Events, then an error will be thrown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Expression</maml:name> <maml:description> <maml:para>Specifies the expression to attempt to match TCP or UDP messages against. This can be a simple string, or a regular expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ExpressionType</maml:name> <maml:description> <maml:para>Specifies how the expression should be used. Search implies that the expression should occur anywhere in the received message. Match means the message must match the expression exactly. Regex means the expression will be used in a regular expression pattern and the messages must match the regular expression.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Generic Event. This is the display name used in Management Client and the rules engine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the generic event. Use this when you may have multiple matching generic events and they should be prioritized differently.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-GenericEvent -Name 'Hello world' -Expression '^[hH]ello [wW]orld$' -ExpressionType Regex</dev:code> <dev:remarks> <maml:para>Creates a new Generic Event associated with the first enabled "Generic Event data source". The generic event be triggered if a message is received matching the prrovided regular expression. In this case, "Hello World", "Hello world", "hello World" and "hello world" would all match the given regular expression.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Add-GenericEvent/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-RegisteredService</command:name> <command:verb>Add</command:verb> <command:noun>RegisteredService</command:noun> <maml:description> <maml:para>Adds a new entry to the list of registered services on the connected Milestone XProtect VMS.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-RegisteredService` cmdlet adds a new entry to the list of registered services on the connected Milestone XProtect VMS.</maml:para> <maml:para>The list of registered services are made available to clients so that they may find and connect to additional services. Default registered service entries typically exist for components like the Event Server, Log Server, Report Server, and Mobile Server(s).</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RegisteredService</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new registered service entry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Specifies a URI to use to reach the registered service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ServiceType</maml:name> <maml:description> <maml:para>Specifies an ID representing the type of registered service entry this will be. Built-in Milestone services have their own ServiceType IDs, and each instance of a service will have a unique InstanceId. A custom service entry will have it's own ServiceType ID that should be the same across every installation which makes it easy for you to discover instances of services of that specific type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Data</maml:name> <maml:description> <maml:para>Specifies an optional string to include with the registered service entry. This string could be used to store options for a custom developed integration, or parameters for clients to use when communicating with the service for example.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies an optional descriptive text for the registered service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>Specifies a unique GUID to reference this instance of the registered service with the provided ServiceType .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Data</maml:name> <maml:description> <maml:para>Specifies an optional string to include with the registered service entry. This string could be used to store options for a custom developed integration, or parameters for clients to use when communicating with the service for example.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies an optional descriptive text for the registered service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>Specifies a unique GUID to reference this instance of the registered service with the provided ServiceType .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new registered service entry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ServiceType</maml:name> <maml:description> <maml:para>Specifies an ID representing the type of registered service entry this will be. Built-in Milestone services have their own ServiceType IDs, and each instance of a service will have a unique InstanceId. A custom service entry will have it's own ServiceType ID that should be the same across every installation which makes it easy for you to discover instances of services of that specific type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Specifies a URI to use to reach the registered service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$customServiceType = [guid]'327fb419-a331-4a57-9ae5-f848ecf4adf9' $customServiceInstanceId = [guid]'b8ae97f6-65eb-4b9f-aa76-5b717539c412' $jsonData = '{}' # (1)! $optionalData = [convert]::ToBase64String([text.encoding]::UTF8.GetBytes($jsonData)) Add-RegisteredService -Name 'MyCustomService' -Uri https://MyCustomService/ -ServiceType $customServiceType -Description 'My custom service' -Data $optionalData -InstanceId $customServiceInstanceId</dev:code> <dev:remarks> <maml:para>1. Data can be any string, but a common strategy is to base64 encode a JSON or XML formatted collection of properties to include with the registered service entry.</maml:para> <maml:para>Creates a new registered service entry with a URI pointing to https://MyCustomService/, a unique custom service type ID, and instance ID, and an empty JSON document converted to Base64 format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Add-RegisteredService/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-Stream</command:name> <command:verb>Add</command:verb> <command:noun>Stream</command:noun> <maml:description> <maml:para>Deprecated. Use Get-VmsCameraStream and Set-VmsCameraStream instead.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deprecated. Use Get-VmsCameraStream and Set-VmsCameraStream instead.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-Stream</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object returned by Get-VmsCamera.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object returned by Get-VmsCamera.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$camera | Add-Stream</dev:code> <dev:remarks> <maml:para>Adds a new stream usage for the camera assigned to the $camera variable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Add-Stream/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-UserDefinedEvent</command:name> <command:verb>Add</command:verb> <command:noun>UserDefinedEvent</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-UserDefinedEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Add-UserDefinedEvent/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-VmsCache</command:name> <command:verb>Clear</command:verb> <command:noun>VmsCache</command:noun> <maml:description> <maml:para>Clears any cached VMS configuration in the current PowerShell session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Clear-VmsCache` cmdlet was introduced after MilestonePSTools began keeping a reference to the root ManagementServer Configuration API item, and using this common root configuration item when retrieving other objects like recording servers, cameras, roles, events, and more. This cmdlet will dispose of any cached configuration, including the root ManagementServer object, so that any changes to the configuration can be retrieved.</maml:para> <maml:para>This cmdlet is especially helpful after adding new cameras as it will also invoke `VideoOS.Platform.SDK.Environment.ReloadConfiguration` which makes it possible to retrieve device state, stream statistics, or retrieve live and recorded video from devices that have been added since the call to `Connect-ManagementServer`</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-VmsCache</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Clear-VmsCache</dev:code> <dev:remarks> <maml:para>Clears the cached ManagementServer Configuration API object for the current site, and reloads the configuration.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Clear-VmsCache/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-ManagementServer</command:name> <command:verb>Connect</command:verb> <command:noun>ManagementServer</command:noun> <maml:description> <maml:para>Connects to a Milestone XProtect VMS Management Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command is used to authenticate with, and connect to one or more Milestone XProtect VMS Management Servers. It is required to use `Connect-ManagementServer` before using a great many cmdlets in the MilestonePSTools module.</maml:para> <maml:para>Supported authentication options match those of XProtect Management Client and XProtect Smart Client including the current Windows user, a specified Windows user, or a Milestone basic user.</maml:para> <maml:para>When using MilestonePSTools interactively, you may opt to use a GUI-based login dialog by including the `-ShowDialog` switch parameter.</maml:para> <maml:para>When connecting to a parent management server in a Milestone Federated Architecture hierarchy, you may use the `-IncludeChildSites` switch, and you will automatically authenticate with each child site, recursively, in the hierarchy.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-ManagementServer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:description> <maml:para>Deprecated - please use ServerAddress. Specifies the address of the Milestone XProtect VMS Management Server as an IP, hostname, or FQDN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Localhost</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>WcfProxyTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies, as an integer value, the maximum number of idle seconds before a Windows Communication Foundation (WCF) channel, used to communicate with Milestone XProtect API's, is considered timed out.</maml:para> <maml:para>The Configuration API, used directly by commands like `Get-ConfigurationItem` and `Invoke-Method`, and sometimes indirectly by other commands in the module, uses WCF. There are other API's you can access, such as through the WCF proxy returned by `Get-IServerCommandService`, which also are configured to use the timeout specified here.</maml:para> <maml:para>The default setting is suitable for most common usage patterns for this module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to login to the Milestone XProtect VMS Management Server. This can be a Windows, Active Directory, or Milestone basic user.</maml:para> <maml:para>- When omitted, authentication will proceed with the current Windows user.</maml:para> <maml:para>- When specifying credentials for a basic user, you must also provide the</maml:para> <maml:para> `-BasicUser` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>BasicUser</maml:name> <maml:description> <maml:para>Use Milestone's Basic User authentication instead of Windows or Active Directory.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>SecureOnly</maml:name> <maml:description> <maml:para>Specifies that an HTTPS connection is required for successful authentication. Note: Requires XProtect VMS versions 2021 R1 and newer.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>AcceptEula</maml:name> <maml:description> <maml:para>Acknowledge you have read and accept the end-user license agreement for the redistributable MIP SDK package. This command is required on the first use of `Connect-ManagementServer` for the current Windows user. Note: A 0-byte file is placed at `%appdata%\MilestonePSTools\user-accepted-eula.txt` once the agreement has been accepted.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>IncludeChildSites</maml:name> <maml:description> <maml:para>After successful authentication with the specified Management Server, authentication should be performed on all child sites in a Milestone Federated Architecture hierarchy.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces a `Disconnect-ManagementServer` prior to connecting to the specified Management Server or displaying the login dialog.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="99" aliases="none"> <maml:name>ServerAddress</maml:name> <maml:description> <maml:para>Specifies the HTTP or HTTPS server address of the Milestone XProtect VMS Management Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>http://localhost/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Deprecated - please use ServerAddress. Specifies, as an integer between 1-65535, the HTTP port of the Management Server. Default is 80.</maml:para> <maml:para>*Note: When using basic authentication and a custom HTTP port on the Management Server, leave this value alone. MIP SDK will automatically use HTTPS on port 443.*</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>80</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-ManagementServer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>WcfProxyTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies, as an integer value, the maximum number of idle seconds before a Windows Communication Foundation (WCF) channel, used to communicate with Milestone XProtect API's, is considered timed out.</maml:para> <maml:para>The Configuration API, used directly by commands like `Get-ConfigurationItem` and `Invoke-Method`, and sometimes indirectly by other commands in the module, uses WCF. There are other API's you can access, such as through the WCF proxy returned by `Get-IServerCommandService`, which also are configured to use the timeout specified here.</maml:para> <maml:para>The default setting is suitable for most common usage patterns for this module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>AcceptEula</maml:name> <maml:description> <maml:para>Acknowledge you have read and accept the end-user license agreement for the redistributable MIP SDK package. This command is required on the first use of `Connect-ManagementServer` for the current Windows user. Note: A 0-byte file is placed at `%appdata%\MilestonePSTools\user-accepted-eula.txt` once the agreement has been accepted.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>IncludeChildSites</maml:name> <maml:description> <maml:para>After successful authentication with the specified Management Server, authentication should be performed on all child sites in a Milestone Federated Architecture hierarchy.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces a `Disconnect-ManagementServer` prior to connecting to the specified Management Server or displaying the login dialog.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableAutoLogin</maml:name> <maml:description> <maml:para>Disables and prevents auto-login when showing the login dialog.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowDialog</maml:name> <maml:description> <maml:para>Show a familiar Milestone login dialog. The dialog supports "Remember password" , and "Auto login".</maml:para> <maml:para>! Screenshot of login dialog (../../assets/images/connect-managementserver_logindialog.png)REQUIREMENTS - Requires an interactive PowerShell session.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>AcceptEula</maml:name> <maml:description> <maml:para>Acknowledge you have read and accept the end-user license agreement for the redistributable MIP SDK package. This command is required on the first use of `Connect-ManagementServer` for the current Windows user. Note: A 0-byte file is placed at `%appdata%\MilestonePSTools\user-accepted-eula.txt` once the agreement has been accepted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>BasicUser</maml:name> <maml:description> <maml:para>Use Milestone's Basic User authentication instead of Windows or Active Directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has permission to login to the Milestone XProtect VMS Management Server. This can be a Windows, Active Directory, or Milestone basic user.</maml:para> <maml:para>- When omitted, authentication will proceed with the current Windows user.</maml:para> <maml:para>- When specifying credentials for a basic user, you must also provide the</maml:para> <maml:para> `-BasicUser` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableAutoLogin</maml:name> <maml:description> <maml:para>Disables and prevents auto-login when showing the login dialog.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces a `Disconnect-ManagementServer` prior to connecting to the specified Management Server or displaying the login dialog.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>IncludeChildSites</maml:name> <maml:description> <maml:para>After successful authentication with the specified Management Server, authentication should be performed on all child sites in a Milestone Federated Architecture hierarchy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Deprecated - please use ServerAddress. Specifies, as an integer between 1-65535, the HTTP port of the Management Server. Default is 80.</maml:para> <maml:para>*Note: When using basic authentication and a custom HTTP port on the Management Server, leave this value alone. MIP SDK will automatically use HTTPS on port 443.*</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>80</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>SecureOnly</maml:name> <maml:description> <maml:para>Specifies that an HTTPS connection is required for successful authentication. Note: Requires XProtect VMS versions 2021 R1 and newer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:description> <maml:para>Deprecated - please use ServerAddress. Specifies the address of the Milestone XProtect VMS Management Server as an IP, hostname, or FQDN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Localhost</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="99" aliases="none"> <maml:name>ServerAddress</maml:name> <maml:description> <maml:para>Specifies the HTTP or HTTPS server address of the Milestone XProtect VMS Management Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>http://localhost/</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowDialog</maml:name> <maml:description> <maml:para>Show a familiar Milestone login dialog. The dialog supports "Remember password" , and "Auto login".</maml:para> <maml:para>! Screenshot of login dialog (../../assets/images/connect-managementserver_logindialog.png)REQUIREMENTS - Requires an interactive PowerShell session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>WcfProxyTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies, as an integer value, the maximum number of idle seconds before a Windows Communication Foundation (WCF) channel, used to communicate with Milestone XProtect API's, is considered timed out.</maml:para> <maml:para>The Configuration API, used directly by commands like `Get-ConfigurationItem` and `Invoke-Method`, and sometimes indirectly by other commands in the module, uses WCF. There are other API's you can access, such as through the WCF proxy returned by `Get-IServerCommandService`, which also are configured to use the timeout specified here.</maml:para> <maml:para>The default setting is suitable for most common usage patterns for this module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>`Connect-ManagementServer` does not accept pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>Unless an error occurs, `Connect-ManagementServer` does not generate output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When using `-ShowDialog`, the MIP SDK stores the login history in `C:\Users\jh\AppData\Roaming\MIPSDK\LoginHistory.xml`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Connect-ManagementServer -ShowDialog -ErrorAction Stop Get-VmsHardware Disconnect-ManagementServer</dev:code> <dev:remarks> <maml:para>Prompts the user with a familiar Milestone login dialog to login to the Management Server. With `-ErrorAction Stop`, a failure to authenticate will prevent the next command from running.</maml:para> <maml:para>Then `Get-VmsHardware` returns information for all hardware devices on all recording servers in the current site.</maml:para> <maml:para>Finally, `Disconnect-ManagementServer` logs out gracefully.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Connect-ManagementServer -ShowDialog -DisableAutoLogin</dev:code> <dev:remarks> <maml:para>Prompts the user with a familiar Milestone login dialog to login to the Management Server and prevents automatic login in case that was used previously and isn't wanted now.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Connect-ManagementServer -Server mgtsrv1</dev:code> <dev:remarks> <maml:para>This command authenticates with a server named mgtsrv1 where the server is listening on HTTP port 80, and it uses the current PowerShell user context.</maml:para> <maml:para>If you have opened PowerShell normally, as your current Windows user, then the credentials used will be that of your current Windows user.</maml:para> <maml:para>If you have opened PowerShell as a different user (shift-right-click, run as a different user), OR you are executing your script as a scheduled task, the user context will be that of whichever user account was used to start the PowerShell session.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Connect-ManagementServer -Server mgtsrv1 -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>This command will prompt the user for a username and password, then authenticates with a server named mgtsrv1 where the server is listening on HTTP port 80 using Windows authentication.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Connect-ManagementServer -Server mgtsrv1 -Credential (Get-Credential) -BasicUser</dev:code> <dev:remarks> <maml:para>This command authenticates with a server named mgtsrv1 where the server is listening on HTTPS port 443, and it authenticates a basic user using the credentials supplied in the Get-Credential pop-up</maml:para> <maml:para>Note: As a "Basic User", the user will not have access to child sites in a Milestone Federated Architecture and thus the -IncludeChildSites switch will not have any effect.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Connect-ManagementServer/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Copy-EvidenceLock</command:name> <command:verb>Copy</command:verb> <command:noun>EvidenceLock</command:noun> <maml:description> <maml:para>Copies an existing Evidence Lock by creating a new Evidence Lock record with the same parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>At the time of making this cmdlet, 2019-06-05, an evidence lock record on the Management Server doesn't necessarily mean that same evidence lock is known by the Recording Server. There are various situations in which this data might be out of sync and a user might believe data is evidence locked but in fact the Recording Server disagrees.</maml:para> <maml:para>The purpose of this cmdlet is to create a copy of an existing Evidence Lock record so that we know it exists on the Recording Server, assuming no error is thrown when creating the copy.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> <maml:para>- Requires VMS feature "EvidenceLock"</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-EvidenceLock</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies a MarkedData record returned by a call to `Get-EvidenceLock`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData</command:parameterValue> <dev:type> <maml:name>MarkedData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies a MarkedData record returned by a call to `Get-EvidenceLock`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData</command:parameterValue> <dev:type> <maml:name>MarkedData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedDataResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$records = Get-EvidenceLock; $records[0] | Copy-EvidenceLock</dev:code> <dev:remarks> <maml:para>Retrieves all evidence locks into $records, and creates a copy of the first record in that list. You could do Get-EvidenceLock | Copy-EvidenceLock but I suspect this may result in a unending loop. Best to get all locks into a single array that you can then enumerate.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Copy-EvidenceLock/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-ManagementServer</command:name> <command:verb>Disconnect</command:verb> <command:noun>ManagementServer</command:noun> <maml:description> <maml:para>Disconnects from all Milestone XProtect Management Servers currently logged into.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-ManagementServer cmdlet should be called after you finish working with your VMS. Gracefully closing the connection will help ensure resources are released both locally and remotely.</maml:para> <maml:para>Note: You cannot selectively disconnect from one out of many Management Servers.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-ManagementServer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Disconnect-ManagementServer</dev:code> <dev:remarks> <maml:para>Disconnect from the current Management Server and all child sites if applicable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Disconnect-ManagementServer/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AlarmDefinition</command:name> <command:verb>Get</command:verb> <command:noun>AlarmDefinition</command:noun> <maml:description> <maml:para>Gets Alarm Definitions from the Event Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of Alarm Definitions from the Management Server / Event Server. Effectively this is a simplified way to access (Get-VmsManagementServer).AlarmDefinitionFolder.AlarmDefinitions.</maml:para> <maml:para>Note: Manipulation of Alarm Definitions is not fully supported in this module. You can, however, manipulate alarm definitions retrieved from this cmdlet by making supported changes to the object, then calling the Save() method.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AlarmDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the Alarm Definition Name using a case-insensitive string with support for wildcards characters.</maml:para> <maml:para>If Name is provided, does not contain wildcard characters, and no matching Alarm Definition is found, an error will be raised.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the Alarm Definition Name using a case-insensitive string with support for wildcards characters.</maml:para> <maml:para>If Name is provided, does not contain wildcard characters, and no matching Alarm Definition is found, an error will be raised.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.AlarmDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-AlarmDefinition</dev:code> <dev:remarks> <maml:para>Gets all Alarm Definitions defined on the Event Server. This should be the same list you would see in the Management Client.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-AlarmDefinition -Name *Overflow*</dev:code> <dev:remarks> <maml:para>Gets all Alarm Definitions defined on the Event Server where the Name of the alarm contains "Overflow".</maml:para> <maml:para>Alarms named "Feed Overflow Started" or "Overflows Detected" would be returned with this command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$alarm = Get-AlarmDefinition -Name "Motion Detected"; $alarm.TriggerEventlist = 'UserDefinedEvent[a90f978f-9c28-4202-b7cc-4c232e8b17b4]'; $alarm.Save()</dev:code> <dev:remarks> <maml:para>Gets an alarm named "Motion Detected", and changes the alarm settings such that a previously defined User-defined Event will be triggered when the alarm is triggered, then saves the changes using the Save() method.</maml:para> <maml:para>You might trigger a user-defined event with an alarm in order to connect the alarm into the rules system to perform some other desired action. Occasionally the source of an alarm is not available as a trigger in the rule system, so you can map an alarm into a rule in this way.</maml:para> <maml:para>Note: If an Alarm Definition named 'Motion Detected' does not exist, an error will be thrown with exception ItemNotFoundException.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-AlarmDefinition/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AlarmLine</command:name> <command:verb>Get</command:verb> <command:noun>AlarmLine</command:noun> <maml:description> <maml:para>Gets Alarms from the Event Server</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of Alarms Event Server using the AlarmCommandClient / IAlarmCommand interface.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AlarmLine</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Conditions</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Condition[]</command:parameterValue> <dev:type> <maml:name>Condition[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Each call to IAlarmCommand.GetAlarmLines returns a maximum number of results.</maml:para> <maml:para>By default this module implements a page size of 100, but you may increase or decrease the page size to optimize for speed or memory consumption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SinglePage</maml:name> <maml:description> <maml:para>By default all alarms matching the given conditions will be returned.</maml:para> <maml:para>Use this switch and the StartAt and PageSize parameters if you need control over pagination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortOrders</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OrderBy[]</command:parameterValue> <dev:type> <maml:name>OrderBy[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Results are requested and returned in pages defined by a starting number and a PageSize</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AlarmLine</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Conditions</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Condition[]</command:parameterValue> <dev:type> <maml:name>Condition[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Each call to IAlarmCommand.GetAlarmLines returns a maximum number of results.</maml:para> <maml:para>By default this module implements a page size of 100, but you may increase or decrease the page size to optimize for speed or memory consumption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SinglePage</maml:name> <maml:description> <maml:para>By default all alarms matching the given conditions will be returned.</maml:para> <maml:para>Use this switch and the StartAt and PageSize parameters if you need control over pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortOrders</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OrderBy[]</command:parameterValue> <dev:type> <maml:name>OrderBy[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Results are requested and returned in pages defined by a starting number and a PageSize</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be retrieved.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.AlarmLine</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$c1 = New-AlarmCondition -Operator GreaterThan -Target Timestamp -Value (Get-Date).Date.AddDays(-1).ToUniversalTime() $c2 = New-AlarmCondition -Operator LessThan -Target Timestamp -Value (Get-Date).Date.ToUniversalTime() $order = New-AlarmOrder -Order Descending -Target Timestamp Get-AlarmLine -Conditions $c1,$c2 -SortOrders $order | Select-Object LocalId, Timestamp, Message, SourceName, State</dev:code> <dev:remarks> <maml:para>Create Conditions to filter the AlarmLines to only those alarms with a timestamp occurring 'Yesterday', and order the results in descending order by time.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-AlarmLine/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AlarmStatistics</command:name> <command:verb>Get</command:verb> <command:noun>AlarmStatistics</command:noun> <maml:description> <maml:para>Gets alarm statistics from the Event Server which provides the number of alarms in each state.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the number of alarms in each state. The values are estimates as the statistics are not updated on demand.</maml:para> <maml:para>The built-in alarm state values are New=1, In progress=4, On hold=9 and Closed=11. Administrators may add additional states in Management Client.</maml:para> <maml:para>In the resulting Statistic[] object, the Statistic.Number property represents the State and the Statistic.Value property represents the number of alarms in that state.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AlarmStatistics</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Statistic[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-AlarmStatistics/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Bookmark</command:name> <command:verb>Get</command:verb> <command:noun>Bookmark</command:noun> <maml:description> <maml:para>Gets one or more bookmarks based on the supplied parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all bookmarks matching the supplied parameters. If there is any overlap between the timespan represented by the StartTime and EndTime parameters, and the timespan represented by the TimeBegin and TimeEnd properties of the Bookmarks themselves, the Bookmarks will be included in the results. Since a Bookmark usually has a "Time Triggered" as well as a short timespan before and after the trigger time, this means your Bookmark search may return Bookmarks which have a "TimeTrigged" value which falls outside the bounds of the StartTime and EndTime parameters, but their TimeBegin or TimeEnd timestamps do fall within the specified time period.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Bookmark</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Optional device ID to filter the results on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>UTC time representing the start of the bookmark search period. Default is 24 hours ago.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>UTC time representing the end of the bookmark search period. Default is "now".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>A larger page size may result in a longer wait for the first set of results, but overall shorter processing time. Default is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Search the header or description for the bookmarks in the defined time period for a keyword or phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>List of users to filter the search on. Users are typically searched using the format domain\username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Optional device ID to filter the results on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>UTC time representing the end of the bookmark search period. Default is "now".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>A larger page size may result in a longer wait for the first set of results, but overall shorter processing time. Default is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Search the header or description for the bookmarks in the defined time period for a keyword or phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>UTC time representing the start of the bookmark search period. Default is 24 hours ago.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>List of users to filter the search on. Users are typically searched using the format domain\username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Bookmark -DeviceId $id -StartTime (Get-Date).Date.ToUniversalTime()</dev:code> <dev:remarks> <maml:para>Get all bookmarks for device with ID $id occurring any time during the current day.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Bookmark -StartTime ([DateTime]::UtcNow).AddHours(-2)</dev:code> <dev:remarks> <maml:para>Get all bookmarks for any device where the bookmark time is in the last two hours.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Bookmark -StartTime (Get-Date).Date.ToUniversalTime().AddDays(-1) -EndTime (Get-Date).Date.ToUniversalTime()</dev:code> <dev:remarks> <maml:para>Get all bookmarks for the previous day.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-Bookmark -StartTime ([DateTime]::MinValue) -SearchText "Auto"</dev:code> <dev:remarks> <maml:para>Get all bookmarks with the word "Auto" occuring in the Header or Description properties.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-Bookmark/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CameraSetting</command:name> <command:verb>Get</command:verb> <command:noun>CameraSetting</command:noun> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CameraSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueTypeInfo</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-CameraSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueTypeInfo</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueTypeInfo</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Deprecated</dev:code> <dev:remarks> <maml:para>Deprecated. Use `Get-VmsCameraGeneralSetting` and `Get-VmsCameraStream` instead.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-CameraSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ConfigurationItem</command:name> <command:verb>Get</command:verb> <command:noun>ConfigurationItem</command:noun> <maml:description> <maml:para>Gets a ConfigurationItem object</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses the Configuration API to access configuration items. Useful for navigating the configuration of the VMS without the need to understand the individual object types like cameras, servers, and users.</maml:para> <maml:para>Each ConfigurationItem may have child items, methods that could be invoked, or properties that can be read and/or modified. Use Set-ConfigurationItem to save changes made to a ConfigurationItem object.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ConfigurationItem</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the Configuration API path string for a given item if already known.</maml:para> <maml:para>These are typically in the form of Camera[GUID] but you can always start crawling the configuration from the top starting at "/" which specifies the Management Server itself.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChildItems</maml:name> <maml:description> <maml:para>Get all child items for the given ConfigurationItem, Path, or ItemType and ID pair</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specifies a source ConfigurationItem for retrieving a Child or Parent ConfigurationItem</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a Guid identifier to use for constructing a path in the form of ItemType[Id]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>Specifies an item type such as Camera, Hardware, RecordingServer, to use for constructing a path in the form of ItemType[Id]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Get the immediate parent of a given ConfigurationItem, Path, or ItemType and ID pair</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentItem</maml:name> <maml:description> <maml:para>Get the first parent of a given ConfigurationItem, Path, or ItemType and ID pair where the ItemCategory is "Item"</maml:para> <maml:para>This is mostly used when navigating up from a Camera device to the parent Hardware device, or Hardware to Recording Server</maml:para> <maml:para>The -Parent switch will provide the immediate parent which might be a Folder rather than an actual recognizable device</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Return the desired ConfigurationItem and all child items recursively.</maml:para> <maml:para>Note: This can take a very long time to return a result depending on the provided Path and size of the VMS.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Sort</maml:name> <maml:description> <maml:para>Specifies that device child items should be sorted by channel number after receiving the randomly-ordered list of devices from the Milestone Configuration API.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ChildItems</maml:name> <maml:description> <maml:para>Get all child items for the given ConfigurationItem, Path, or ItemType and ID pair</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specifies a source ConfigurationItem for retrieving a Child or Parent ConfigurationItem</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies a Guid identifier to use for constructing a path in the form of ItemType[Id]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>Specifies an item type such as Camera, Hardware, RecordingServer, to use for constructing a path in the form of ItemType[Id]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Parent</maml:name> <maml:description> <maml:para>Get the immediate parent of a given ConfigurationItem, Path, or ItemType and ID pair</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentItem</maml:name> <maml:description> <maml:para>Get the first parent of a given ConfigurationItem, Path, or ItemType and ID pair where the ItemCategory is "Item"</maml:para> <maml:para>This is mostly used when navigating up from a Camera device to the parent Hardware device, or Hardware to Recording Server</maml:para> <maml:para>The -Parent switch will provide the immediate parent which might be a Folder rather than an actual recognizable device</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the Configuration API path string for a given item if already known.</maml:para> <maml:para>These are typically in the form of Camera[GUID] but you can always start crawling the configuration from the top starting at "/" which specifies the Management Server itself.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Return the desired ConfigurationItem and all child items recursively.</maml:para> <maml:para>Note: This can take a very long time to return a result depending on the provided Path and size of the VMS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Sort</maml:name> <maml:description> <maml:para>Specifies that device child items should be sorted by channel number after receiving the randomly-ordered list of devices from the Milestone Configuration API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para>Specifies a source ConfigurationItem for retrieving a Child or Parent ConfigurationItem</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Specifies an item type such as Camera, Hardware, RecordingServer, to use for constructing a path in the form of ItemType[Id]</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>Specifies a Guid identifier to use for constructing a path in the form of ItemType[Id]</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Specifies the Configuration API path string for a given item if already known.</maml:para> <maml:para>These are typically in the form of Camera[GUID] but you can always start crawling the configuration from the top starting at "/" which specifies the Management Server itself.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$ms = Get-ConfigurationItem -Path "/" $nameProperty = $ms.Properties | Where-Object Key -eq "Name" $nameProperty.Value = "New Name" $ms | Set-ConfigurationItem</dev:code> <dev:remarks> <maml:para>Changes the Name property of the Management Server</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-ConfigurationItem/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Docs - Configuration API</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=gettingstarted/intro_configurationapi.html&tree=tree_4.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DeviceAcl</command:name> <command:verb>Get</command:verb> <command:noun>DeviceAcl</command:noun> <maml:description> <maml:para>Gets the device permissions associated with the specified role.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-DeviceAcl` cmdlet applies gets the device permissions associated with the specified role. These permissions can be changed on the SecurityAttributes property and updated on the VMS using `Set-DeviceAcl`.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Grants "read" permission for a camera to a role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies a hardware object such as the objects returned from `Get-VmsHardware`. A collection of permissions from all child devices will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware</command:parameterValue> <dev:type> <maml:name>Hardware</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>Specifies an input device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies a metadata device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>Specifies a microphone device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>Specifies an output device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>Specifies a speaker device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Grants "read" permission for a camera to a role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies a hardware object such as the objects returned from `Get-VmsHardware`. A collection of permissions from all child devices will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware</command:parameterValue> <dev:type> <maml:name>Hardware</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>Specifies an input device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies a metadata device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>Specifies a microphone device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>Specifies an output device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object such as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleId</maml:name> <maml:description> <maml:para>Specifies the ID of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of an existing role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>Specifies a speaker device channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.IConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MilestoneLib.DeviceAcl</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $role = Get-VmsRole -RoleType UserDefined | Select-Object -First 1 $acl = Get-DeviceAcl -Camera $camera -Role $role $acl.SecurityAttributes.GENERIC_READ = 'True' $acl | Set-DeviceAcl</dev:code> <dev:remarks> <maml:para>Grants "read" permission for a camera to a role.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-DeviceAcl/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EventLine</command:name> <command:verb>Get</command:verb> <command:noun>EventLine</command:noun> <maml:description> <maml:para>Gets Events from the Event Server</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of Events from the Event Server using the AlarmCommandClient / IAlarmCommand interface.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EventLine</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Conditions</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Condition[]</command:parameterValue> <dev:type> <maml:name>Condition[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Each call to IAlarmCommand.GetAlarmLines returns a maximum number of results.</maml:para> <maml:para>By default this module implements a page size of 100, but you may increase or decrease the page size to optimize for speed or memory consumption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SinglePage</maml:name> <maml:description> <maml:para>By default all alarms matching the given conditions will be returned.</maml:para> <maml:para>Use this switch and the StartAt and PageSize parameters if you need control over pagination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortOrders</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OrderBy[]</command:parameterValue> <dev:type> <maml:name>OrderBy[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Results are requested and returned in pages defined by a starting number and a PageSize</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EventLine</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Conditions</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Condition[]</command:parameterValue> <dev:type> <maml:name>Condition[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Each call to IAlarmCommand.GetAlarmLines returns a maximum number of results.</maml:para> <maml:para>By default this module implements a page size of 100, but you may increase or decrease the page size to optimize for speed or memory consumption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SinglePage</maml:name> <maml:description> <maml:para>By default all alarms matching the given conditions will be returned.</maml:para> <maml:para>Use this switch and the StartAt and PageSize parameters if you need control over pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortOrders</maml:name> <maml:description> <maml:para>Specifies the AlarmFilter used to filter alarms to those having only the desired attributes. This is also used to specify how the output should be sorted.</maml:para> <maml:para>By default the results will be unfiltered with no guaranteed order.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OrderBy[]</command:parameterValue> <dev:type> <maml:name>OrderBy[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Results are requested and returned in pages defined by a starting number and a PageSize</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be retrieved.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.EventLine</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$c = New-AlarmCondition -Target Timestamp -Operator GreaterThan -Value (Get-Date).Date.ToUniversalTime() $order = New-AlarmOrder -Order Descending -Target Timestamp Get-EventLine -Conditions $c -SortOrders $order</dev:code> <dev:remarks> <maml:para>Create Conditions to filter the EventLines to only those events with a timestamp occurring on or after midnight of the current day, and order the results in descending order by time.</maml:para> <maml:para>Note that the New-AlarmCondition and New-AlarmOrder cmdlets work for both Alarms and Events.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-EventLine/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EvidenceLock</command:name> <command:verb>Get</command:verb> <command:noun>EvidenceLock</command:noun> <maml:description> <maml:para>Gets evidence lock records matching the specified parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EvidenceLock` cmdlet gets evidence lock records matching the specified parameters.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> <maml:para>- Requires VMS feature "EvidenceLock"</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EvidenceLock</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CreatedFrom</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with a "Created" timestamp on or after the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CreatedTo</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with a "Created" timestamp on or earlier than the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceIds</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with one or more devices matching the provided Guid's should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpireFrom</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with an "Expiration" timestamp on or after the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpireTo</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with an "Expiration" timestamp on or earlier than the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageFrom</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records referencing recordings on or after the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageTo</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records referencing recordings on or earlier than the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Specifies the maximum number of evidence lock search results per page. The underlying API is paginated, and a larger page size may allow all records to be returned faster overall, but the first group of records returned may take longer with a larger page size. The default value is 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Specifies that only evidence locks where the provided SearchText matches part of the header or description should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>Specifies the order of the returned results. Results are sorted by CreateTime by default.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CreateTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Description</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EndTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Header</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RetentionExpireTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Size</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StartTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TagTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UserName</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CreateTime</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortDecending</maml:name> <maml:description> <maml:para>Specifies that the results should be returned in descending order instead of ascending order.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records created by one of the provided users should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CreatedFrom</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with a "Created" timestamp on or after the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CreatedTo</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with a "Created" timestamp on or earlier than the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceIds</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with one or more devices matching the provided Guid's should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpireFrom</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with an "Expiration" timestamp on or after the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExpireTo</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records with an "Expiration" timestamp on or earlier than the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageFrom</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records referencing recordings on or after the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FootageTo</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records referencing recordings on or earlier than the provided DateTime should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Specifies the maximum number of evidence lock search results per page. The underlying API is paginated, and a larger page size may allow all records to be returned faster overall, but the first group of records returned may take longer with a larger page size. The default value is 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Specifies that only evidence locks where the provided SearchText matches part of the header or description should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>Specifies the order of the returned results. Results are sorted by CreateTime by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CreateTime</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SortDecending</maml:name> <maml:description> <maml:para>Specifies that the results should be returned in descending order instead of ascending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>Specifies that only evidence lock records created by one of the provided users should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EvidenceLock</dev:code> <dev:remarks> <maml:para>Returns all evidence lock records visible to the logged in VMS user account.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-EvidenceLock/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-GenericEvent</command:name> <command:verb>Get</command:verb> <command:noun>GenericEvent</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GenericEvent</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-GenericEvent/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-GenericEventDataSource</command:name> <command:verb>Get</command:verb> <command:noun>GenericEventDataSource</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GenericEventDataSource</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEventDataSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-GenericEventDataSource/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HardwareSetting</command:name> <command:verb>Get</command:verb> <command:noun>HardwareSetting</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HardwareSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>{{ Fill Hardware Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware</command:parameterValue> <dev:type> <maml:name>Hardware</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeReadWriteOnly</maml:name> <maml:description> <maml:para>{{ Fill IncludeReadWriteOnly Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueTypeInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueTypeInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>{{ Fill Hardware Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware</command:parameterValue> <dev:type> <maml:name>Hardware</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeReadWriteOnly</maml:name> <maml:description> <maml:para>{{ Fill IncludeReadWriteOnly Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueTypeInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueTypeInfo Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-HardwareSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-IAlarmClient</command:name> <command:verb>Get</command:verb> <command:noun>IAlarmClient</command:noun> <maml:description> <maml:para>Gets a working IAlarmClient for making direct calls to the Event Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Other Alarm cmdlets are wrappers for the commands you can send directly through the IAlarmClient interface. If you need access to additional functionality not provided in the cmdlets, this cmdlet will give you direct access to the Event Server and the ability to query/send events and alarms. Just remember to call CloseClient() when you're finished as this will not be done for you.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-IAlarmClient</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.AlarmClient.IAlarmClient</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$client = Get-IAlarmClient $client | Get-Member</dev:code> <dev:remarks> <maml:para>Gets an IAlarmClient instance that can be used to interact directly with the alarm and event features supported in MIP SDK.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-IAlarmClient/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=miphelp/interface_video_o_s_1_1_platform_1_1_proxy_1_1_alarm_client_1_1_i_alarm_client.html&tree=tree_search.html?search=ialarmclient</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-IConfigurationService</command:name> <command:verb>Get</command:verb> <command:noun>IConfigurationService</command:noun> <maml:description> <maml:para>Gets an instance of an IConfigurationService WCF client.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-IConfigurationService` cmdlet returns a Windows Communication Foundation (WCF) client proxy which can be used to call various methods on the management server. This is useful when you want to perform an action that is not available in an existing cmdlet in the MilestonePSTools module but which is possible using MIP SDK directly.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-IConfigurationService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.IConfigurationService</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$svc = Get-IConfigurationService $svc.GetItem("/")</dev:code> <dev:remarks> <maml:para>Creates an IConfigurationService client and gets the management server ConfigurationItem object using the management server path "/".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$svc = Get-IConfigurationService $svc.GetChildItems("/") | Sort-Object DisplayName</dev:code> <dev:remarks> <maml:para>Creates an IConfigurationService client and gets all the child items of the management Server in alphabetical order by DisplayName.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-IConfigurationService/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=miphelp/interface_video_o_s_1_1_configuration_api_1_1_client_service_1_1_i_configuration_service.html&tree=tree_search.html?search=iconfigurationservice</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-InputSetting</command:name> <command:verb>Get</command:verb> <command:noun>InputSetting</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-InputSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>{{ Fill Input Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-InputSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>{{ Fill Input Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>{{ Fill Input Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-InputSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-IServerCommandService</command:name> <command:verb>Get</command:verb> <command:noun>IServerCommandService</command:noun> <maml:description> <maml:para>Gets an instance of a ServerCommandService client.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-IServerCommandService` cmdlet returns a Windows Communication Foundation (WCF) client proxy which can be used to call various methods on the management server. This is useful when you want to perform an action that is not available in an existing cmdlet in the MilestonePSTools module but which is possible using MIP SDK directly.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-IServerCommandService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.IServerCommandService</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$svc = Get-IServerCommandService $svc.GetConfiguration((Get-VmsToken))</dev:code> <dev:remarks> <maml:para>Returns a `VideoOS.Common.Proxy.Server.WCF.ConfigurationInfo` object which can sometimes be easier and faster than enumerating through the configuration api hierarchy.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-IServerCommandService/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=serversoaphelp/class_server_command_service.html&tree=tree_search.html?search=servercommandservice</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ItemState</command:name> <command:verb>Get</command:verb> <command:noun>ItemState</command:noun> <maml:description> <maml:para>Gets the ItemState of all known items in the site</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends a MessageCommunication.ProvideCurrentStateRequest message and returns the response.</maml:para> <maml:para>The ProvideCurrentStateResponse contains a flat collection of ItemState objects representing the state of all known items in the site. Each ItemState contains an FQID, and State property. The FQID.Kind and FQID.ObjectId can be used to determine what type of object the state represents, and the ID of that object.</maml:para> <maml:para>Most of the time, you will probably only be interested in Camera objects, so you can filter the output with the -CamerasOnly switch.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ItemState</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CamerasOnly</maml:name> <maml:description> <maml:para>Filter the ItemState results to Camera items</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CamerasOnly</maml:name> <maml:description> <maml:para>Filter the ItemState results to Camera items</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Messaging.ItemState</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ItemState -CamerasOnly | Where-Object State -ne "Responding" | Foreach-Object { $camera = Get-VmsCamera -Id $_.FQID.ObjectId; Write-Warning "Camera $($camera.Name) state is $($_.State)" }</dev:code> <dev:remarks> <maml:para>Write a warning for every camera found with a state that is not "Responding"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ItemState | ForEach-Object { Get-VmsCamera -Id $_.FQID.ObjectId | Get-ConfigurationItem -ParentItem }</dev:code> <dev:remarks> <maml:para>Gets the associated Hardware object for every Camera ItemState result.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-ItemState/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Kind</command:name> <command:verb>Get</command:verb> <command:noun>Kind</command:noun> <maml:description> <maml:para>Gets the display name and category of a Kind by Guid, or lists all known Kinds from VideoOS.Platform.Kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Most configuration items in the VMS are identified by "Kind" such as Camera, Server, and Microphone. Some commands will return an obscure object like an FQID which the VMS knows how to use to locate the item in the configuration but there is very little meaningful identifiable information for a user in an FQID.</maml:para> <maml:para>The Kind property is a Guid, and the VideoOS.Platform.Kind class can convert a Kind ID into a display name describing the Kind, and a category name such as VideoIn or AudioOut.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Kind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Item.FQID.Kind value as a Guid</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Kind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>List all known Kinds</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Item.FQID.Kind value as a Guid</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>List all known Kinds</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>Item.FQID.Kind value as a Guid</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ItemState | ForEach-Object { $name = ($_.FQID | Get-VmsVideoOSItem).Name; $kind = $_.FQID | Get-Kind; Write-Output "$name is a $($kind.DisplayName) in category $($kind.Category)"}</dev:code> <dev:remarks> <maml:para>Retrieve the Item name and write the name and ItemState</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-Kind/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LoginSettings</command:name> <command:verb>Get</command:verb> <command:noun>LoginSettings</command:noun> <maml:description> <maml:para>Gets list of MIP SDK Login Settings for debugging purposes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LoginSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Login.LoginSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-LoginSettings</dev:code> <dev:remarks> <maml:para>Returns one or more LoginSettings objects - one for each site either connected or available to connect.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-LoginSettings/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MetadataSetting</command:name> <command:verb>Get</command:verb> <command:noun>MetadataSetting</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MetadataSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>{{ Fill Metadata Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-MetadataSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>{{ Fill Metadata Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>{{ Fill Metadata Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-MetadataSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MethodInfo</command:name> <command:verb>Get</command:verb> <command:noun>MethodInfo</command:noun> <maml:description> <maml:para>Gets MethodId's and their display names along with the TranslationId value to lookup language-specific display names.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets MethodId's and their display names along with the TranslationId value to lookup language-specific display names.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MethodInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>MethodId</maml:name> <maml:description> <maml:para>Specifies the MethodId property for the MethodInfo to retrieve. This would usually come from the MethodIds property of a ConfigurationItem object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>MethodId</maml:name> <maml:description> <maml:para>Specifies the MethodId property for the MethodInfo to retrieve. This would usually come from the MethodIds property of a ConfigurationItem object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Specifies the MethodId property for the MethodInfo to retrieve. This would usually come from the MethodIds property of a ConfigurationItem object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.MethodInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-MethodInfo</dev:code> <dev:remarks> <maml:para>Gets all possible MethodInfo objects</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-MethodInfo RemoveAlarmDefinition</dev:code> <dev:remarks> <maml:para>Gets the MethodInfo for the RemoveAlarmDefinition MethodId</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-MethodInfo/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Docs - Configuration API</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=gettingstarted/intro_configurationapi.html&tree=tree_4.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MicrophoneSetting</command:name> <command:verb>Get</command:verb> <command:noun>MicrophoneSetting</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MicrophoneSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>{{ Fill Microphone Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-MicrophoneSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>{{ Fill Microphone Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>{{ Fill Microphone Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-MicrophoneSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MipMessageIdList</command:name> <command:verb>Get</command:verb> <command:noun>MipMessageIdList</command:noun> <maml:description> <maml:para>Gets a list of all known MessageIds</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of all known MessageIds. This includes all the message id's defined by the PlatformPlugin and environment as well as for all loaded plug-ins.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MipMessageIdList</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-MipMessageIdList</dev:code> <dev:remarks> <maml:para>Returns a full list of all message ID's defined in `[VideoOS.Platform.EnvironmentManager]::Instance.MessageIdList`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-MipMessageIdList/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MipSdkEula</command:name> <command:verb>Get</command:verb> <command:noun>MipSdkEula</command:noun> <maml:description> <maml:para>Returns the MIP SDK end-user license agreement as a string</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This module is built upon Milestone's MIP SDK and requires the use of the redistributable MIP SDK binaries. As such, it is required for the user of this module to accept the agreement prior to use.</maml:para> <maml:para>This command will return the contents of the MIPSDK_EULA.txt file included with MilestonePSTools.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MipSdkEula</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-MipSdkEula</dev:code> <dev:remarks> <maml:para>Gets the content of the EULA for the MIP SDK.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-MipSdkEula/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OutputSetting</command:name> <command:verb>Get</command:verb> <command:noun>OutputSetting</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OutputSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>{{ Fill Output Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OutputSetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>{{ Fill Output Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>{{ Fill Output Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-OutputSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OverallSecurity</command:name> <command:verb>Get</command:verb> <command:noun>OverallSecurity</command:noun> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity` instead.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity` instead.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OverallSecurity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Deprecated</dev:code> <dev:remarks> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity` instead.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-OverallSecurity/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PlatformItem</command:name> <command:verb>Get</command:verb> <command:noun>PlatformItem</command:noun> <maml:description> <maml:para>Gets a VideoOS.Platform.Item object representing a configuration item</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Item is a generic object representing a configuration item in the VMS. An Item might represent a camera, hardware, server, or generic event. This cmdlet is especially useful for converting an FQID from Get-ItemState into an item, in order to get the device name faster than possible using Configuration API commands like Get-ConfigurationItem.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Fqid</maml:name> <maml:description> <maml:para>VideoOS.Platform.FQID of a Milestone configuration Item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Hierarchy</maml:name> <maml:description> <maml:para>Filter the results based on the system hierarchy, user-defined hierarchies like camera groups, or both.</maml:para> <maml:para>Possible values: UserDefined, SystemDefined, Both</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemHierarchy</command:parameterValue> <dev:type> <maml:name>ItemHierarchy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemDefined</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>IncludeFolders</maml:name> <maml:description> <maml:para>Only child objects with no child items of their own are included by default. Example: Cameras and user-defined events.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Enumerate all Items in the configuration</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="ObjectId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid identifier for an item</maml:para> <maml:para>Use only when you have an ID but no knowledge of the device type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Specifies the GUID constant for the Kind of object you want to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Specifies the name or string to search for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MaxResultCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of results allowed. When a search returns more than this, it is considered an error. Default = 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the timeout in seconds before a search is terminated. Default = 60 seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Fqid</maml:name> <maml:description> <maml:para>VideoOS.Platform.FQID of a Milestone configuration Item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Hierarchy</maml:name> <maml:description> <maml:para>Filter the results based on the system hierarchy, user-defined hierarchies like camera groups, or both.</maml:para> <maml:para>Possible values: UserDefined, SystemDefined, Both</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemHierarchy</command:parameterValue> <dev:type> <maml:name>ItemHierarchy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemDefined</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="ObjectId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid identifier for an item</maml:para> <maml:para>Use only when you have an ID but no knowledge of the device type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>IncludeFolders</maml:name> <maml:description> <maml:para>Only child objects with no child items of their own are included by default. Example: Cameras and user-defined events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Specifies the GUID constant for the Kind of object you want to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Enumerate all Items in the configuration</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MaxResultCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of results allowed. When a search returns more than this, it is considered an error. Default = 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Specifies the name or string to search for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the timeout in seconds before a search is terminated. Default = 60 seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> </dev:type> <maml:description> <maml:para>VideoOS.Platform.FQID of a Milestone configuration Item</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Specifies the name or string to search for</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>Specifies the GUID constant for the Kind of object you want to return</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ItemState | ForEach-Object { $name = ($_.FQID | Get-PlatformItem).Name; "$name - $($_.State)" }</dev:code> <dev:remarks> <maml:para>Retrieve the Item name and write the name and ItemState</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PlatformItem -ListAvailable</dev:code> <dev:remarks> <maml:para>Retrieve all configuration items from the VMS which are not considered Parent objects</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$kind = (Get-Kind -List | Where-Object DisplayName -eq Transact).Kind; Get-PlatformItem -Kind $kind</dev:code> <dev:remarks> <maml:para>Retrieve all Transact sources configured in the VMS. First we get the GUID associated with 'Kind.Transact' then we pass that GUID into the Get-PlatformItem -Kind parameter. You can then inspect the Properties collection associated with the returned Items.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-PlatformItem/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RecorderStatusService2</command:name> <command:verb>Get</command:verb> <command:noun>RecorderStatusService2</command:noun> <maml:description> <maml:para>Gets a RecorderStatusService2 class for directly interacting with the RecorderStatusService2 api.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>See the MIP SDK documentation for detailed information about the RecorderStatusService2 api.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RecorderStatusService2</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RecordingServer</maml:name> <maml:description> <maml:para>Specifies the RecordingServer for which a RecorderStatusService2 client should be instantiated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RecordingServer</command:parameterValue> <dev:type> <maml:name>RecordingServer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RecorderStatusService2</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Specifies the URI of the Recording Server for which the RecorderStatusService2 should be instantiated. For example: http://localhost:7563</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RecordingServer</maml:name> <maml:description> <maml:para>Specifies the RecordingServer for which a RecorderStatusService2 client should be instantiated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RecordingServer</command:parameterValue> <dev:type> <maml:name>RecordingServer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Specifies the URI of the Recording Server for which the RecorderStatusService2 should be instantiated. For example: http://localhost:7563</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> </dev:type> <maml:description> <maml:para>Specifies the RecordingServer for which a RecorderStatusService2 client should be instantiated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.SDK.Proxy.Status2.RecorderStatusService2</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Connect-ManagementServer -ShowDialog -AcceptEula $recorder = Get-VmsRecordingServer | Out-GridView -OutputMode Single $service = $recorder | Get-RecorderStatusService2 $cameraIds = ($recorder | Get-VmsHardware | Get-VmsCamera).Id $service.GetVideoDeviceStatistics((Get-VmsToken), $cameraIds)</dev:code> <dev:remarks> <maml:para>After ensuring there is an open connection to the Management Server, a grid view is displayed with a list of Recording Servers. Once a Recording Server is selected, a RecorderStatusService2 instance is created, and that service is used to retrieve raw VideoDeviceStatistics from the Recording Server.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-RecorderStatusService2/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RegisteredService</command:name> <command:verb>Get</command:verb> <command:noun>RegisteredService</command:noun> <maml:description> <maml:para>Gets a list of matching registered service records.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-RegisteredService` cmdlet gets a list of matching registered service records. Registered services are records available in Management Client under Tools > Registered Services. These records are used by clients, and/or integrations to discover the availability and addresses of optional VMS services like the Event Server, Log Server, Mobile Servers, or 3rd party integrations with their own service addresses.</maml:para> <maml:para>| Default Service | ServiceType | | -------------------------|--------------------------------------| | Log server | 3d6f1153-92ad-43f1-b467-9482ffd291b2 | | Legacy log server | 002b1b2f-0817-4592-8c62-2fe5107c160c | | Event Server service | 08ab8f23-9aef-4298-9caa-f39259fe7cda | | Incident Manager service | 3ce6b5e2-d861-4c0b-9085-00b938b2f45a | | Report Server | a9f27a6a-9488-44e3-ac0b-0cb1c86ccd2a | | Management Server | a10cd823-bb4e-4d31-a162-dd236fc78fa6 | REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RegisteredService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the registered service entry to return, with support for wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceType</maml:name> <maml:description> <maml:para>Specifies the type of registered service entry (or entries) to return. Each registered service has a ServiceType `[guid]` which may not be unique, and an InstanceId `[guid]` which must be unique within the Milestone XProtect VMS site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the registered service entry to return, with support for wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServiceType</maml:name> <maml:description> <maml:para>Specifies the type of registered service entry (or entries) to return. Each registered service has a ServiceType `[guid]` which may not be unique, and an InstanceId `[guid]` which must be unique within the Milestone XProtect VMS site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$incidentManagerUri = (Get-RegisteredService -ServiceType 3ce6b5e2-d861-4c0b-9085-00b938b2f45a).UriArray[0] $incidentManagerUri</dev:code> <dev:remarks> <maml:para>Gets the URL for the incident manager service. For example `http://management1/IncidentManager/`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-RegisteredService/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SequenceData</command:name> <command:verb>Get</command:verb> <command:noun>SequenceData</command:noun> <maml:description> <maml:para>Get sequence data defining the start and end time of a motion or recording sequence.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this command to discover all the the time ranges where recordings and/or motion are present for a device. This can be useful to generate a report showing the percentage of time a device has been recording, or to look for unusual patterns where there is a much higher or lower than usual percentage of motion/recordings.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SequenceData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>UTC time representing the start of the sequence search period. Default is 24 hours ago.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>UTC time representing the end of the sequence search period. Default is "now".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SequenceType</maml:name> <maml:description> <maml:para>Specifies whether to search for recording sequences or motion sequences.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">MotionSequence</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RecordingSequence</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RecordingWithTriggerSequence</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>RecordingSequence</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CropToTimeSpan</maml:name> <maml:description> <maml:para>Crop the StartDateTime and EndDateTime to the provided StartTime and EndTime parameters. By default a sequence with an EndDateTime on or after StartTime, or a StartDateTime on or before EndTime will be returned even if most of the sequence falls outside the bounds of StartTime and EndTime. For example, if you are recording always, a RecordingSequence may be several days or weeks long, even though you may only be interested in a specific day or hour timespan. Using this switch can save you some effort when you're generating a report by adding up the duration of all sequences in a given time period.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>A larger page size may result in a longer wait for the first set of results, but overall shorter processing time. Default is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies an object with a Path property in the format ItemType[00000000-0000-0000-0000-000000000000]. This could be a Camera object, or a generic ConfigurationItem object received from Get-ConfigurationItem.</maml:para> <maml:para>Example: Camera[724b4f96-6e45-432f-abb2-a71fc87f1c20]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the time in seconds before this command times out while searching for the camera item associated with the given Path. On a very large system (10k+ devices) this may take several seconds, though it is believed to be a quick search because the Path string defines the device by type and ID.</maml:para> <maml:para>Default is 10 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CropToTimeSpan</maml:name> <maml:description> <maml:para>Crop the StartDateTime and EndDateTime to the provided StartTime and EndTime parameters. By default a sequence with an EndDateTime on or after StartTime, or a StartDateTime on or before EndTime will be returned even if most of the sequence falls outside the bounds of StartTime and EndTime. For example, if you are recording always, a RecordingSequence may be several days or weeks long, even though you may only be interested in a specific day or hour timespan. Using this switch can save you some effort when you're generating a report by adding up the duration of all sequences in a given time period.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>UTC time representing the end of the sequence search period. Default is "now".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>A larger page size may result in a longer wait for the first set of results, but overall shorter processing time. Default is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies an object with a Path property in the format ItemType[00000000-0000-0000-0000-000000000000]. This could be a Camera object, or a generic ConfigurationItem object received from Get-ConfigurationItem.</maml:para> <maml:para>Example: Camera[724b4f96-6e45-432f-abb2-a71fc87f1c20]</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SequenceType</maml:name> <maml:description> <maml:para>Specifies whether to search for recording sequences or motion sequences.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>RecordingSequence</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>UTC time representing the start of the sequence search period. Default is 24 hours ago.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the time in seconds before this command times out while searching for the camera item associated with the given Path. On a very large system (10k+ devices) this may take several seconds, though it is believed to be a quick search because the Path string defines the device by type and ID.</maml:para> <maml:para>Default is 10 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Specifies an object with a Path property in the format ItemType[00000000-0000-0000-0000-000000000000]. This could be a Camera object, or a generic ConfigurationItem object received from Get-ConfigurationItem.</maml:para> <maml:para>Example: Camera[724b4f96-6e45-432f-abb2-a71fc87f1c20]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.SequenceData</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$camera | Get-SequenceData -SequenceType MotionSequence -StartTime ([DateTime]::UtcNow).AddDays(-7)</dev:code> <dev:remarks> <maml:para>Gets an array of SequenceData objects representing motion sequences beginning or ending within the last 7 days. The EventSequence property of the SequenceData object contains a StartDateTime and EndDateTime property.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-SequenceData/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Snapshot</command:name> <command:verb>Get</command:verb> <command:noun>Snapshot</command:noun> <maml:description> <maml:para>Gets live or recorded still images from a camera connected to a Milestone VMS.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-Snapshot` cmdlet is used to retrieve a live still image, a recorded still image, or a series of recorded images between two `[DateTime]` timestamps on a given interval.</maml:para> <maml:para>Currently these images are in JPEG format, and in a future update the output format will be configurable.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Snapshot</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CameraId</maml:name> <maml:description> <maml:para>Specifies the ID of a camera from which to retrieve a snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp from which the nearest snapshot should be retrieved from recorded video.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Behavior</maml:name> <maml:description> <maml:para>Specifies whether to get the oldest, or newest recorded image available, or whether to get the nearest image to the specified timestamp. The default behavior is to get the nearest recorded image to the specified timestamp.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GetBegin</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GetEnd</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GetNearest</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder to which snapshots should be saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the filename to use when saving a snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies the camera from which to retrieve a snaphot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end timestamp for retrieving many snapshots of recorded video between two timestamps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:description> <maml:para>When it is desired to scale the snapshot, this specifies the desired image height.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeBlackBars</maml:name> <maml:description> <maml:para>Specifies whether the image should be centered on a black background resulting in black bars when the resulting image resolution does not match the original camera resolution.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interval</maml:name> <maml:description> <maml:para>Specifies an interval, in seconds, on which to retrieve snapshots from recorded video between Timestamp and EndTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeepAspectRatio</maml:name> <maml:description> <maml:para>Specifies that the original image aspect ratio should be maintained when resizing the snapshot.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LiftPrivacyMask</maml:name> <maml:description> <maml:para>Specifies that the privacy mask, if present, should be lifted on the snapshot, assuming the current user has permission to lift privacy masks.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LiveTimeoutMS</maml:name> <maml:description> <maml:para>Specifies the number of milliseconds to wait for a live snapshot image to arrive. The default value is 2000ms or 2 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LocalTimestamp</maml:name> <maml:description> <maml:para>Specifies that a local timestamp should be used in the file name instead of a UTC timestamp.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quality</maml:name> <maml:description> <maml:para>Specifies the image quality of the resulting JPEG as a percentage. The default value is 75%.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Save</maml:name> <maml:description> <maml:para>Specifies that the image should be saved to disk.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseFriendlyName</maml:name> <maml:description> <maml:para>Specifies that the display name should be used in the filename of saved images.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:description> <maml:para>Specifies the desired image width for the resulting snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Snapshot</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CameraId</maml:name> <maml:description> <maml:para>Specifies the ID of a camera from which to retrieve a snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Live</maml:name> <maml:description> <maml:para>Specifies that the snapshots should come from the live stream instead of recorded video.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder to which snapshots should be saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the filename to use when saving a snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies the camera from which to retrieve a snaphot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:description> <maml:para>When it is desired to scale the snapshot, this specifies the desired image height.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeBlackBars</maml:name> <maml:description> <maml:para>Specifies whether the image should be centered on a black background resulting in black bars when the resulting image resolution does not match the original camera resolution.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeepAspectRatio</maml:name> <maml:description> <maml:para>Specifies that the original image aspect ratio should be maintained when resizing the snapshot.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LiftPrivacyMask</maml:name> <maml:description> <maml:para>Specifies that the privacy mask, if present, should be lifted on the snapshot, assuming the current user has permission to lift privacy masks.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LiveTimeoutMS</maml:name> <maml:description> <maml:para>Specifies the number of milliseconds to wait for a live snapshot image to arrive. The default value is 2000ms or 2 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LocalTimestamp</maml:name> <maml:description> <maml:para>Specifies that a local timestamp should be used in the file name instead of a UTC timestamp.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quality</maml:name> <maml:description> <maml:para>Specifies the image quality of the resulting JPEG as a percentage. The default value is 75%.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Save</maml:name> <maml:description> <maml:para>Specifies that the image should be saved to disk.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseFriendlyName</maml:name> <maml:description> <maml:para>Specifies that the display name should be used in the filename of saved images.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:description> <maml:para>Specifies the desired image width for the resulting snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Behavior</maml:name> <maml:description> <maml:para>Specifies whether to get the oldest, or newest recorded image available, or whether to get the nearest image to the specified timestamp. The default behavior is to get the nearest recorded image to the specified timestamp.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies the camera from which to retrieve a snaphot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CameraId</maml:name> <maml:description> <maml:para>Specifies the ID of a camera from which to retrieve a snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end timestamp for retrieving many snapshots of recorded video between two timestamps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the filename to use when saving a snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Height</maml:name> <maml:description> <maml:para>When it is desired to scale the snapshot, this specifies the desired image height.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeBlackBars</maml:name> <maml:description> <maml:para>Specifies whether the image should be centered on a black background resulting in black bars when the resulting image resolution does not match the original camera resolution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interval</maml:name> <maml:description> <maml:para>Specifies an interval, in seconds, on which to retrieve snapshots from recorded video between Timestamp and EndTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeepAspectRatio</maml:name> <maml:description> <maml:para>Specifies that the original image aspect ratio should be maintained when resizing the snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LiftPrivacyMask</maml:name> <maml:description> <maml:para>Specifies that the privacy mask, if present, should be lifted on the snapshot, assuming the current user has permission to lift privacy masks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Live</maml:name> <maml:description> <maml:para>Specifies that the snapshots should come from the live stream instead of recorded video.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LiveTimeoutMS</maml:name> <maml:description> <maml:para>Specifies the number of milliseconds to wait for a live snapshot image to arrive. The default value is 2000ms or 2 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LocalTimestamp</maml:name> <maml:description> <maml:para>Specifies that a local timestamp should be used in the file name instead of a UTC timestamp.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder to which snapshots should be saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Quality</maml:name> <maml:description> <maml:para>Specifies the image quality of the resulting JPEG as a percentage. The default value is 75%.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Save</maml:name> <maml:description> <maml:para>Specifies that the image should be saved to disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp from which the nearest snapshot should be retrieved from recorded video.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseFriendlyName</maml:name> <maml:description> <maml:para>Specifies that the display name should be used in the filename of saved images.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Width</maml:name> <maml:description> <maml:para>Specifies the desired image width for the resulting snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Live.LiveSourceContent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.JPEGData</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $camera | Get-Snapshot -Live</dev:code> <dev:remarks> <maml:para>Returns a `VideoOS.Platform.Live.LiveSourceContent` (https://doc.developer.milestonesys.com/html/index.html?base=miphelp/class_video_o_s_1_1_platform_1_1_live_1_1_live_source_content.html&tree=tree_search.html?search=livesourcecontent)object where the JPEG image is defined as a byte array in the Contents property.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $null = $camera | Get-Snapshot -Live -Save -Path c:\temp -UseFriendlyName</dev:code> <dev:remarks> <maml:para>Saves a file to C:\temp\ in JPG format with the camera's display name followed by a timestamp as the file name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $null = $camera | Get-Snapshot -Timestamp (Get-Date).AddHours(-1) -EndTime (Get-Date) -Interval 10 -Save -Path C:\snaps\ -LiftPrivacyMask -Quality 100</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $null = $camera | Get-Snapshot -Behavior GetBegin</dev:code> <dev:remarks> <maml:para>Gets the oldest recorded image for a camera.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $null = $camera | Get-Snapshot -Behavior GetEnd</dev:code> <dev:remarks> <maml:para>Gets the most recent recorded image for a camera.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $null = $camera | Get-Snapshot -Timestamp (Get-Date).AddDays(-1)</dev:code> <dev:remarks> <maml:para>Gets a recorded image with a timestamp nearest to 24 hours ago.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-Snapshot/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SpeakerSetting</command:name> <command:verb>Get</command:verb> <command:noun>SpeakerSetting</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpeakerSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>{{ Fill Speaker Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpeakerSetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>{{ Fill Speaker Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>{{ Fill Speaker Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueInfo</maml:name> <maml:description> <maml:para>{{ Fill ValueInfo Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-SpeakerSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Stream</command:name> <command:verb>Get</command:verb> <command:noun>Stream</command:noun> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Stream</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>StreamIds</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Stream</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>LiveDefault</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>StreamIds</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Stream</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Recorded</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>StreamIds</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>LiveDefault</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Recorded</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>StreamIds</maml:name> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Deprecated</dev:code> <dev:remarks> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-Stream/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Translations</command:name> <command:verb>Get</command:verb> <command:noun>Translations</command:noun> <maml:description> <maml:para>Gets a translation table mapping internal property keys or guids to a language-specific display name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a translation table mapping internal property keys or guids to a language-specific display name.</maml:para> <maml:para>This is specifically useful when you need to get a display name, or a non-English translation, for a property where a translationId is present.</maml:para> <maml:para>Note that the GetTranslations command appears to fall back to en-US when no matching language code is available.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Translations</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>LanguageId</maml:name> <maml:description> <maml:para>Specifies the language ID string such as en-US, in order to retrieve the appropriate translations</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>En-US</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>LanguageId</maml:name> <maml:description> <maml:para>Specifies the language ID string such as en-US, in order to retrieve the appropriate translations</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>En-US</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Translations es-ES</dev:code> <dev:remarks> <maml:para>Invokes the AddUserDefinedEvent method which returns a ConfigurationItem of type InvokeInfo. Fill out the Name property of this ConfigurationItem and resend to the Invoke-Method command to create a new User Defined Event.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-Translations/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Docs - Configuration API</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=gettingstarted/intro_configurationapi.html&tree=tree_4.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UserDefinedEvent</command:name> <command:verb>Get</command:verb> <command:noun>UserDefinedEvent</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UserDefinedEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-UserDefinedEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-UserDefinedEvent/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VideoSource</command:name> <command:verb>Get</command:verb> <command:noun>VideoSource</command:noun> <maml:description> <maml:para>Gets a MIP SDK VideoSource object for a given camera which can be used to navigate the media database to retrieve images</maml:para> </maml:description> </command:details> <maml:description> <maml:para>WARNING: This is experimental and has a significant memory leak until a strategy for disposing of unused resources in a powershell environment can be determined.</maml:para> <maml:para>Gets one of a BitmapVideoSource, JPEGVideoSource or RawVideoSource object depending on the provided Format value. The default is Raw since that puts no video decoding burden on the Recording Server.</maml:para> <maml:para>See the MIP SDK documentation link in the related links of this help info for details on how to navigate recordings with these VideoSource objects. The objects include methods like GetBegin(), GetEnd(), GetNearest(datetime), GetNext() and GetPrevious(), and the results provide information about the timestamp, whether a next or previous image is available and what the timestamp of that image is, in addition to the image data itself.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VideoSource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CameraId</maml:name> <maml:description> <maml:para>Specifies the Guid value of a Camera object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies the format in which data should be returned</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Bitmap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Jpeg</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Raw</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Raw</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-VmsCamera command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Fqid</maml:name> <maml:description> <maml:para>Specifies a camera by FQID. Useful when all you have is the FQID such as when you're using a Get-ItemState result, or the output of some event header data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-VmsCamera command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CameraId</maml:name> <maml:description> <maml:para>Specifies the Guid value of a Camera object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies the format in which data should be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Raw</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Fqid</maml:name> <maml:description> <maml:para>Specifies a camera by FQID. Useful when all you have is the FQID such as when you're using a Get-ItemState result, or the output of some event header data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> </dev:type> <maml:description> <maml:para>Specifies a camera by FQID. Useful when all you have is the FQID such as when you're using a Get-ItemState result, or the output of some event header data.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-VmsCamera command.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.VideoSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$src = $camera | Get-VideoSource -Format Jpeg $src.GetBegin() $src.GetNext()</dev:code> <dev:remarks> <maml:para>Gets the first and second images in the media database for the camera referenced in the variable $camera.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VideoSource/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsCamera</command:name> <command:verb>Get</command:verb> <command:noun>VmsCamera</command:noun> <maml:description> <maml:para>Gets the matching camera records from the Milestone XProtect Management Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Milestone's Configuration API to retrieve matching camera records. The objects returned are read/write representations of the matching cameras. You may use these for reporting purposes, or for changing configuration properties.</maml:para> <maml:para>To change properties on the camera records, you may directly modify the value of properties, or you may use the Set-VmsCamera cmdlet. When directly modifying the object's properties, you must call the ".Save()" method, or the changes will not be communicated to the Management Server.</maml:para> <maml:para>By default, this cmdlet only returns enabled cameras. To return cameras that are disabled, or to return all cameras, use the EnableFilter parameter to set your preference.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsCamera</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a camera name, or any part of a camera name to search for. Any cameras with a matching name will be returned. The default behavior is to return cameras where the supplied value appears anywhere in the camera's name. You may change this behavior by providing an alternate comparison operator using the Comparison parameter.</maml:para> <maml:para>Please note that if you supply both a Name and a Description value, the search results returned will include only cameras where the name and description both match the query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a camera description, or any part of a camera description to search for. Any cameras with a matching description will be returned. The default behavior is to return cameras where the supplied value appears anywhere in the camera's description. You may change this behavior by providing an alternate comparison operator using the Comparison parameter.</maml:para> <maml:para>Please note that if you supply both a Name and a Description value, the search results returned will include only cameras where the name and description both match the query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the camera channel number, or numbers, to return. Numbering starts at zero, so channel 0 corresponds to the first camera on the hardware device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all cameras when querying by hardware or searching by name or description. The default is to return only enabled cameras.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Enabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>Specifies the type of string comparison to perform when searching by name, or description. By default, cameras will be returned if the camera name contains the values specified in the Name or Description parameters anywhere in the string, and the comparison will be case-insensitive.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of results to return when searching by name or description. By default, the maximum number of results is 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[int]::MaxValue</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsCamera</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object from which to return matching cameras. Results can be filtered further by providing values for one or more additional parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a camera name, or any part of a camera name to search for. Any cameras with a matching name will be returned. The default behavior is to return cameras where the supplied value appears anywhere in the camera's name. You may change this behavior by providing an alternate comparison operator using the Comparison parameter.</maml:para> <maml:para>Please note that if you supply both a Name and a Description value, the search results returned will include only cameras where the name and description both match the query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a camera description, or any part of a camera description to search for. Any cameras with a matching description will be returned. The default behavior is to return cameras where the supplied value appears anywhere in the camera's description. You may change this behavior by providing an alternate comparison operator using the Comparison parameter.</maml:para> <maml:para>Please note that if you supply both a Name and a Description value, the search results returned will include only cameras where the name and description both match the query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the camera channel number, or numbers, to return. Numbering starts at zero, so channel 0 corresponds to the first camera on the hardware device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all cameras when querying by hardware or searching by name or description. The default is to return only enabled cameras.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Enabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>Specifies the type of string comparison to perform when searching by name, or description. By default, cameras will be returned if the camera name contains the values specified in the Name or Description parameters anywhere in the string, and the comparison will be case-insensitive.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsCamera</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more camera ID's in GUID format. All cameras matching the supplied GUID's will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the camera channel number, or numbers, to return. Numbering starts at zero, so channel 0 corresponds to the first camera on the hardware device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>Specifies the type of string comparison to perform when searching by name, or description. By default, cameras will be returned if the camera name contains the values specified in the Name or Description parameters anywhere in the string, and the comparison will be case-insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a camera description, or any part of a camera description to search for. Any cameras with a matching description will be returned. The default behavior is to return cameras where the supplied value appears anywhere in the camera's description. You may change this behavior by providing an alternate comparison operator using the Comparison parameter.</maml:para> <maml:para>Please note that if you supply both a Name and a Description value, the search results returned will include only cameras where the name and description both match the query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all cameras when querying by hardware or searching by name or description. The default is to return only enabled cameras.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Enabled</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object from which to return matching cameras. Results can be filtered further by providing values for one or more additional parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more camera ID's in GUID format. All cameras matching the supplied GUID's will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of results to return when searching by name or description. By default, the maximum number of results is 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a camera name, or any part of a camera name to search for. Any cameras with a matching name will be returned. The default behavior is to return cameras where the supplied value appears anywhere in the camera's name. You may change this behavior by providing an alternate comparison operator using the Comparison parameter.</maml:para> <maml:para>Please note that if you supply both a Name and a Description value, the search results returned will include only cameras where the name and description both match the query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-ManagementServer -ShowDialog -AcceptEula Get-VmsCamera <# OUTPUT Name Channel Enabled LastModified Id ---- ------- ------- ------------ -- Axis A8105-E (10.1.77.153) - Camera 1 0 True 1/15/2022 12:22:27 PM 3DCCE3DA-021D-4968-831C-24F09031EEDA Axis M1125 (10.1.77.129) - Camera 1 0 True 1/15/2022 11:29:10 AM 44E1D43D-4A54-4B8A-8E3D-513EB7007AAC Axis P1375 (10.1.77.178) - Camera 1 0 True 1/15/2022 11:22:44 AM DD9F523E-AFB2-4E6F-A11D-262A4E760B5A Axis P3225-LV (10.1.77.130) - Camera 1 0 True 1/15/2022 11:22:48 AM 71D46BAA-9810-45B0-8461-DD5B369FFB0B #></dev:code> <dev:remarks> <maml:para>In this example, we first ensure we are logged in to the Management Server. Then we call the "Get-VmsCamera" cmdlet with no parameters which will return all enabled cameras. By piping these results to "Out-GridView" we can view the output in a sortable, searchable table.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmsCamera -Name 'Garage' <# OUTPUT Name Channel Enabled LastModified Id ---- ------- ------- ------------ -- Garage Camera 0 True 1/18/2022 3:41:21 PM CA146DFD-72C9-4BBA-83DD-8B680E70DA1B #></dev:code> <dev:remarks> <maml:para>This example demonstrates how to find all enabled cameras with the word "Garage" anywhere in the camera name. The search is case-insensitive and will return cameras named "Shop Garage" or "Rear garage door".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmsCamera -Name 'Garage' -EnableFilter All <# OUTPUT Name Channel Enabled LastModified Id ---- ------- ------- ------------ -- Garage 1 0 True 12/1/2021 4:23:24 PM 430FA37D-CBE6-4248-9CBA-989AEF7F0428 Garage 2 1 False 1/13/2022 1:27:42 PM 22436AA5-CC64-4F82-A35C-3EF9ADEFED74 Garage 3 0 True 1/17/2022 4:32:00 PM 80DA2327-D178-457A-8216-0F7D6CF2F746 #></dev:code> <dev:remarks> <maml:para>Find all cameras, enabled or disabled, with the word "Garage" anywhere in the camera name. The search is case-insensitive, and uses a fast search feature introduced in XProtect 2020 R2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VmsHardware | Where-Object Name -like '*Elevator*' | Get-VmsCamera -EnableFilter All <# OUTPUT Name Channel Enabled LastModified Id ---- ------- ------- ------------ -- North Elevator 0 True 1/18/2022 3:41:21 PM CA146DFD-72C9-4BBA-83DD-8B680E70DA1B #></dev:code> <dev:remarks> <maml:para>Find all hardware where the word "elevator" appears in the name, and then return all camera channels associated with those hardware devices, both enabled and disabled.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VmsCamera -Id '42C055AA-3EAC-45AF-B956-5C253384BDF1' <# OUTPUT Name Channel Enabled LastModified Id ---- ------- ------- ------------ -- Garage Cam 1 0 True 1/18/2022 3:41:21 PM 42C055AA-3EAC-45AF-B956-5C253384BDF1 #></dev:code> <dev:remarks> <maml:para>Returns one camera matching the supplied ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>(Get-ItemState -CamerasOnly | Where-Object State -ne 'Responding').FQID.ObjectId | Get-VmsCamera <# Name Channel Enabled LastModified Id ---- ------- ------- ------------ -- Canon VB-M40 - Camera 1 0 True 12/7/2021 3:37:23 PM 3E337A3D-8C48-4B9E-A61A-972CDD261B27 Canon VB-S900F - Camera 1 0 True 12/7/2021 3:04:59 PM 539FDA6D-1167-4C3D-854D-577B60FEAB88 #></dev:code> <dev:remarks> <maml:para>Retrieves the state of all enabled cameras, and extracts the ID of all cameras that are not responding, according to the Milestone Event Server. These camera ID's are then used to retrieve the camera configuration records for these cameras.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>Get-VmsHardware | Get-VmsCamera -Channel (1..15) <# OUTPUT Name Channel Enabled LastModified Id ---- ------- ------- ------------ -- TH6TC2 1 True 1/17/2022 4:32:00 PM 96F49AF3-861C-4037-8950-8B933644E861 TH6TC3 2 True 1/17/2022 4:32:00 PM 8A175713-823A-46EF-A0E4-1768EA7A5A04 TH6TC4 3 True 1/17/2022 4:32:00 PM C958EE67-4C72-4884-A77F-A3882FB12F97 #></dev:code> <dev:remarks> <maml:para>Returns all enabled cameras from all hardware devices where the channel number is between 1 and 15, representing camera 2 through camera 16. You might use this if you only want the first channel enabled, and you want to use the results of this query to disable unwanted camera channels.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsCamera/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsHardware</command:name> <command:verb>Get</command:verb> <command:noun>VmsHardware</command:noun> <maml:description> <maml:para>Gets existing Hardware devices added to recording servers on the currently connected management server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `GetVmsHardware` cmdlet returns all hardware on all recording servers on the currently connected management server, or all hardware on a specific recording server.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsHardware</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Obsolete. Specifies that all hardware from all recorders should be returned. This is the default behavior when no parameters are specified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="50" aliases="none"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Specifies that the Name parameter should be used to perform a case-sensitive filter. The default behavior is to filter based on case-insensitive matching.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsHardware</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="50" aliases="none"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Specifies that the Name parameter should be used to perform a case-sensitive filter. The default behavior is to filter based on case-insensitive matching.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="HardwareId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the hardware ID of an existing hardware device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name with support for wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecorderId</maml:name> <maml:description> <maml:para>Specifies the ID of a recording server from which to retrieve hardware.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RecordingServer</maml:name> <maml:description> <maml:para>Specifies a recording server object from which to retrieve hardware. Use `Get-VmsRecordingServer` to retrieve a recording server object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RecordingServer</command:parameterValue> <dev:type> <maml:name>RecordingServer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Obsolete. Specifies that all hardware from all recorders should be returned. This is the default behavior when no parameters are specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="50" aliases="none"> <maml:name>CaseSensitive</maml:name> <maml:description> <maml:para>Specifies that the Name parameter should be used to perform a case-sensitive filter. The default behavior is to filter based on case-insensitive matching.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="HardwareId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the hardware ID of an existing hardware device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name with support for wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecorderId</maml:name> <maml:description> <maml:para>Specifies the ID of a recording server from which to retrieve hardware.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RecordingServer</maml:name> <maml:description> <maml:para>Specifies a recording server object from which to retrieve hardware. Use `Get-VmsRecordingServer` to retrieve a recording server object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RecordingServer</command:parameterValue> <dev:type> <maml:name>RecordingServer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsHardware</dev:code> <dev:remarks> <maml:para>Returns all hardware on all recording servers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmsHardware | Where-Object Enabled</dev:code> <dev:remarks> <maml:para>Returns all enabled hardware on all recording servers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$recorder = Get-VmsRecordingServer | Select-Object -First 1 $recorder | Get-VmsHardware</dev:code> <dev:remarks> <maml:para>Returns all hardware on one recording server.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsHardware/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsInput</command:name> <command:verb>Get</command:verb> <command:noun>VmsInput</command:noun> <maml:description> <maml:para>Gets input devices from the currently connected XProtect VMS site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsInput` cmdlet gets input devices from the currently connected XProtect VMS site. Inputs are logical child devices attached to "hardware" which are most often an IP camera. The `VideoOS.Platform.ConfigurationItems.InputEvent` object returned from this command represents a configurable device on the XProtect VMS.</maml:para> <maml:para>The corresponding `Set-VmsInput` command can be used in conjunction with this cmdlet to modify the device settings.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsInput</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsInput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsInput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsInput</dev:code> <dev:remarks> <maml:para>Get all enabled input devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$recorder = Get-VmsRecordingServer | Out-GridView -OutputMode Multiple $recorder | Get-VmsHardware | Get-VmsInput</dev:code> <dev:remarks> <maml:para>Get all enabled input devices from the selected recording server(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmsInput -Name 'garage'</dev:code> <dev:remarks> <maml:para>Get all enabled inputs with the case-insensitive word "garage" in the name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VmsInput -EnableFilter Disabled</dev:code> <dev:remarks> <maml:para>Get all disabled inputs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VmsInput -EnableFilter All -Channel 0 | Set-VmsInput -Enabled $true -PassThru Get-VmsInput -EnableFilter All -Channel (1..64) | Set-VmsInput -Enabled $false -PassThru</dev:code> <dev:remarks> <maml:para>Get all inputs with a channel value of "0" (port number 1), and enable them if they aren't enabled already. Then get all inputs with a higher channel number from 1 to 64, and disable them. In most cases this should leave you with only the first input enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsInput/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsIServiceRegistrationService</command:name> <command:verb>Get</command:verb> <command:noun>VmsIServiceRegistrationService</command:noun> <maml:description> <maml:para>Gets an instance of an IServiceRegistrationService WCF client.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsIServiceRegistrationService` cmdlet returns a Windows Communication Foundation (WCF) client for the IServiceRegistrationService management server API. This API provides methods for retrieving, adding, updating and removing registered services.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsIServiceRegistrationService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Util.Svc.IServiceRegistrationService</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This cmdlet is intended for PowerShell and .NET developers who are comfortable working directly with .NET objects. See the MIP SDK documentation for more information about the IServiceRegistrationService interface.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$svc = Get-VmsIServiceRegistrationService $svc.GetServices() | Select-Object Name, Description, Instance, Type</dev:code> <dev:remarks> <maml:para>Gets a client for the IServiceRegistrationService API, and uses it to list some basic properties available from all registered service entries that are currently enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsIServiceRegistrationService/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Documentation - IServiceRegistrationService</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=miphelp/interface_video_o_s_1_1_platform_1_1_util_1_1_svc_1_1_i_service_registration_service.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsLog</command:name> <command:verb>Get</command:verb> <command:noun>VmsLog</command:noun> <maml:description> <maml:para>Gets log records from the Milestone XProtect Log Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet uses `[VideoOS.Platform.Log.LogClient]::Instance` to read logs of the specified LogType. The log entries available are the same as the logs available in Management Client, and do not include individual component logs such as you will find in C:\ProgramData\Milestone*.</maml:para> <maml:para>The LogClient implementation in MIP SDK can result in exponentially slower read performance when requesting logs over a long time span, so this cmdlet uses a "windowing" strategy to break up the given range of time between StartTime and EndTime. Initially, each request for logs uses a 10-minute range. If the number of log entries in that 10-minute span of time is less than 500, the size of the window will be increased in 5-minute increments.</maml:para> <maml:para>If the number of log entries in a given period exceed 2000, then the window will be adjusted down so that the next request contains closer to 1000 entries. The minimum window size is 1 minute, and the maximum is 60 minutes.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Specifies the type of log entry requested.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">System</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Audit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rules</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="BeginTime"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start of the time range from which logs should be returned. Default value is [DateTime]::Now.AddHours(-24).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end of the time range from which logs should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>The culture value determines the language of logs returned by the MIP SDK LogClient. The default value should be "System.Globalization.CultureInfo.CurrentCulture.Name" and any alternative can be provided. If translations are not available for the language associated with the provided culture, then the logs will be returned in english.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Specifies the type of log entry requested.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">System</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Audit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rules</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Tail</maml:name> <maml:description> <maml:para>Specifies that the "tail", or the most recent entries from the specified log should be returned. The StartTime for the request is determined by subtracting the value specified by "Minutes" from [DateTime]::Now.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Minutes</maml:name> <maml:description> <maml:para>Specifies the number of minutes to go back for the most recent logs. The logs returned will reflect all log entries between "Minutes" ago, and "now".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>The culture value determines the language of logs returned by the MIP SDK LogClient. The default value should be "System.Globalization.CultureInfo.CurrentCulture.Name" and any alternative can be provided. If translations are not available for the language associated with the provided culture, then the logs will be returned in english.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>The culture value determines the language of logs returned by the MIP SDK LogClient. The default value should be "System.Globalization.CultureInfo.CurrentCulture.Name" and any alternative can be provided. If translations are not available for the language associated with the provided culture, then the logs will be returned in english.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end of the time range from which logs should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Specifies the type of log entry requested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Minutes</maml:name> <maml:description> <maml:para>Specifies the number of minutes to go back for the most recent logs. The logs returned will reflect all log entries between "Minutes" ago, and "now".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="BeginTime"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start of the time range from which logs should be returned. Default value is [DateTime]::Now.AddHours(-24).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Tail</maml:name> <maml:description> <maml:para>Specifies that the "tail", or the most recent entries from the specified log should be returned. The StartTime for the request is determined by subtracting the value specified by "Minutes" from [DateTime]::Now.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-ManagementServer -ShowDialog -AcceptEula Get-VmsLog -LogType Audit -StartTime (Get-Date).Date.AddDays(-1) -EndTime (Get-Date).Date <# OUTPUT Local time : 1/31/2022 11:40:26 AM Message text : User has accessed logs. Log type: Audit Time: 2022-01-28 21:00:41 to 2022-01-28 21:01:41 (UTC time) Permission : Granted Category : Log read Source type : Audit Source name : User : [BASIC]\DEMO User location : 55.55.55.55 #></dev:code> <dev:remarks> <maml:para>Login to a Management Server using the login dialog, and then retrieve all audit logs from the previous day, from midnight of the previous day to midnight of today.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsLog <# OUTPUT Log level : Error Local time : 1/31/2022 3:56:20 AM Message text : Communication error (hardware) Category : Hardware and devices Source type : Hardware Source name : Mobotix M16 series (192.168.32.25) Event type : Communication Error (Hardware) #></dev:code> <dev:remarks> <maml:para>Without any parameters, the default behavior is to return the last 24 hours of log entries from the System log.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsLog -LogType Audit -Tail -Minutes 90</dev:code> <dev:remarks> <maml:para>Returns the last 90 minutes of audit logs.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsLog/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsManagementServer</command:name> <command:verb>Get</command:verb> <command:noun>VmsManagementServer</command:noun> <maml:description> <maml:para>Gets the Management Server for the currently selected site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a ManagementServer object representing the Management Server for the currently selected site. The ManagementServer object can be used directly to access all VMS configuration properties available through the Configuration API.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsManagementServer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.ManagementServer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-ManagementServer -ShowDialog -AcceptEula Get-VmsManagementServer | Select-Object Name, ComputerName, Version <# OUTPUT Name ComputerName Version ---- ------------ ------- Milestone Demo AMERICASDEMO 21.2.0.1 #></dev:code> <dev:remarks> <maml:para>Presents a login dialog, gets a Configuration API object representing the Management Server, and displays the Name, ComputerName, and Version properties.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ms = Get-VmsManagementServer $ms.ViewGroupFolder.ViewGroups | Select-Object Name, LastModified <# OUTPUT Name LastModified ---- ------------ [BASIC]\test 3/30/2020 4:53:01 PM Public View Group 9/19/2018 1:48:35 PM Interconnects 8/12/2020 12:19:49 PM #></dev:code> <dev:remarks> <maml:para>Gets a Configuration API object representing the Management Server, and navigates into the ViewGroup child objects to return the name of each ViewGroup and the LastModified timestamp. Timestamps are always in UTC until you call .ToLocalTime() on the DateTime object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsManagementServer/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsMetadata</command:name> <command:verb>Get</command:verb> <command:noun>VmsMetadata</command:noun> <maml:description> <maml:para>Gets metadata devices from the currently connected XProtect VMS site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsMetadata` cmdlet gets metadata devices from the currently connected XProtect VMS site. Metadatas are logical child devices attached to "hardware" which are most often an IP camera. The `VideoOS.Platform.ConfigurationItems.Metadata` object returned from this command represents a configurable device on the XProtect VMS.</maml:para> <maml:para>The corresponding `Set-VmsMetadata` command can be used in conjunction with this cmdlet to modify the device settings.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsMetadata</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsMetadata</dev:code> <dev:remarks> <maml:para>Get all enabled metadata devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$recorder = Get-VmsRecordingServer | Out-GridView -OutputMode Multiple $recorder | Get-VmsHardware | Get-VmsMetadata</dev:code> <dev:remarks> <maml:para>Get all enabled metadata devices from the selected recording server(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmsMetadata -Name 'garage'</dev:code> <dev:remarks> <maml:para>Get all enabled metadatas with the case-insensitive word "garage" in the name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VmsMetadata -EnableFilter Disabled</dev:code> <dev:remarks> <maml:para>Get all disabled metadatas.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VmsMetadata -EnableFilter All -Channel 0 | Set-VmsMetadata -Enabled $true -PassThru Get-VmsMetadata -EnableFilter All -Channel (1..64) | Set-VmsMetadata -Enabled $false -PassThru</dev:code> <dev:remarks> <maml:para>Get all metadatas with a channel value of "0" (port number 1), and enable them if they aren't enabled already. Then get all metadatas with a higher channel number from 1 to 64, and disable them. In most cases this should leave you with only the first metadata enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsMetadata/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsMetadataLiveRecord</command:name> <command:verb>Get</command:verb> <command:noun>VmsMetadataLiveRecord</command:noun> <maml:description> <maml:para>Gets one or more records from a live metadata device stream.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsMetadataLiveRecord` cmdlet gets one or more records from a live metadata device stream. Metadata records are usually XML documents based on the ONVIF Metadata Stream schema (https://github.com/onvif/specs/blob/development/wsdl/ver10/schema/metadatastream.xsd). The actual format for metadata records depends on the device driver used in XProtect.</maml:para> <maml:para>Metadata records can be retrieved until the value of the `Until` parameter if provided, or a number of records can be returned based on the `Count` parameters.</maml:para> <maml:para>The resulting metadata objects can be difficult to understand, and the contents will vary widely from one camera model to the next. The configuration of analytics/metadata directly on the camera will have a significant impact on the type of metadata records returned by this cmdlet.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsMetadataLiveRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object returned by `Get-VmsCamera` which has one "Related metadata" listed in the Client tab in the camera settings in Management Client. If the camera has no related metadata, or more than one related metadata, you must be more specific by using the `Metadata` or `Id` parameters instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of live metadata records to return. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records received will be returned until this time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMetadataLiveRecord</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of live metadata records to return. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of the metadata device for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records received will be returned until this time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMetadataLiveRecord</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of live metadata records to return. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies the metadata device object for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records received will be returned until this time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object returned by `Get-VmsCamera` which has one "Related metadata" listed in the Client tab in the camera settings in Management Client. If the camera has no related metadata, or more than one related metadata, you must be more specific by using the `Metadata` or `Id` parameters instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of live metadata records to return. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of the metadata device for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies the metadata device object for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records received will be returned until this time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Metadata.MetadataContent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$destination = 'C:\temp\' $camera = Select-Camera -SingleSelect $camera | Get-VmsMetadataLiveRecord -Until (Get-Date).AddHours(1) | Where-Object { 'Vehical' -in $_.GetMetadataStream().VideoAnalyticsItems.Frames.Objects.Appearance.Class.ClassCandidates.Type } | ForEach-Object { $camera | Get-Snapshot -Timestamp $_.GetMetadataStream().VideoAnalyticsItems.Frames[0].UtcTime -Quality 100 -Save -Path $destination } | Select-Object DateTime, Width, Height, HardwareDecodingStatus</dev:code> <dev:remarks> <maml:para>This example retrieves live metadata records for an hour from a user-selected camera with at least one vehicle, and saves a JPEG snapshot using the timestamp from the metadata record.</maml:para> <maml:para>Note that any bounding boxes defined in the metadata are not drawn on the JPEG. However, if the camera overlays bounding boxes directly to the video stream, they will be visible.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsMetadataLiveRecord/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsMetadataRecord</command:name> <command:verb>Get</command:verb> <command:noun>VmsMetadataRecord</command:noun> <maml:description> <maml:para>Gets one or more records from a metadata device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsMetadataRecord` cmdlet gets one or more records from a metadata device. Metadata records are usually XML documents based on the ONVIF Metadata Stream schema (https://github.com/onvif/specs/blob/development/wsdl/ver10/schema/metadatastream.xsd). The actual format for metadata records depends on the device driver used in XProtect.</maml:para> <maml:para>Metadata records can be retrieved based on a timespan defined by the `Timestamp` and `Until` parameters, or a number of records can be returned based on the `Count` parameters, starting from the provided timestamp.</maml:para> <maml:para>The resulting metadata objects can be difficult to understand, and the contents will vary widely from one camera model to the next. The configuration of analytics/metadata directly on the camera will have a significant impact on the type of metadata records returned by this cmdlet.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsMetadataRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object returned by `Get-VmsCamera` which has one "Related metadata" listed in the Client tab in the camera settings in Management Client. If the camera has no related metadata, or more than one related metadata, you must be more specific by using the `Metadata` or `Id` parameters instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of metadata records to return, beginning from the time specified by `Timestamp`. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp from which to look for metadata records. The strategy used to retrieve metadata is GetNearest , which means you may receive a metadata record with a timestamp before, or after the provided timestamp.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records between `Timestamp` and `Until` will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMetadataRecord</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of metadata records to return, beginning from the time specified by `Timestamp`. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of the metadata device for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp from which to look for metadata records. The strategy used to retrieve metadata is GetNearest , which means you may receive a metadata record with a timestamp before, or after the provided timestamp.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records between `Timestamp` and `Until` will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMetadataRecord</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of metadata records to return, beginning from the time specified by `Timestamp`. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies the metadata device object for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp from which to look for metadata records. The strategy used to retrieve metadata is GetNearest , which means you may receive a metadata record with a timestamp before, or after the provided timestamp.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records between `Timestamp` and `Until` will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object returned by `Get-VmsCamera` which has one "Related metadata" listed in the Client tab in the camera settings in Management Client. If the camera has no related metadata, or more than one related metadata, you must be more specific by using the `Metadata` or `Id` parameters instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of metadata records to return, beginning from the time specified by `Timestamp`. This parameter is ignored when using the `Until` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of the metadata device for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies the metadata device object for which to retrieve records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that the `MetadataPlaybackData` object returned by the `MetadataPlaybackSource` class should be returned instead of the `MetadataContent` object. Use this if you require access to the VMS timestamp associated with the metadata record in addition to the timestamp defined within the metadata content.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp from which to look for metadata records. The strategy used to retrieve metadata is GetNearest , which means you may receive a metadata record with a timestamp before, or after the provided timestamp.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Until</maml:name> <maml:description> <maml:para>When specified, all metadata records between `Timestamp` and `Until` will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Metadata.MetadataContent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$destination = 'C:\temp\' $camera = Select-Camera -SingleSelect $camera | Get-VmsMetadataRecord -Timestamp (Get-Date).AddHours(-1) -Until (Get-Date) | Where-Object { 'Face' -in $_.GetMetadataStream().VideoAnalyticsItems.Frames.Objects.Appearance.Class.ClassCandidates.Type } | ForEach-Object { $camera | Get-Snapshot -Timestamp $_.GetMetadataStream().VideoAnalyticsItems.Frames[0].UtcTime -Quality 100 -Save -Path $destination } | Select-Object DateTime, Width, Height, HardwareDecodingStatus</dev:code> <dev:remarks> <maml:para>This example retrieves all metadata records for the last hour for a user-selected camera with at least one face, and saves a JPEG snapshot using the timestamp from the metadata record.</maml:para> <maml:para>Note that any bounding boxes defined in the metadata are not drawn on the JPEG. However, if the camera overlays bounding boxes directly to the video stream, they will be visible.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsMetadataRecord/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsMicrophone</command:name> <command:verb>Get</command:verb> <command:noun>VmsMicrophone</command:noun> <maml:description> <maml:para>Gets microphone devices from the currently connected XProtect VMS site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsMicrophone` cmdlet gets microphone devices from the currently connected XProtect VMS site. Microphones are logical child devices attached to "hardware" which are most often an IP camera. The `VideoOS.Platform.ConfigurationItems.Microphone` object returned from this command represents a configurable device on the XProtect VMS.</maml:para> <maml:para>The corresponding `Set-VmsMicrophone` command can be used in conjunction with this cmdlet to modify the device settings.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsMicrophone</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMicrophone</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsMicrophone</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsMicrophone</dev:code> <dev:remarks> <maml:para>Get all enabled microphone devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$recorder = Get-VmsRecordingServer | Out-GridView -OutputMode Multiple $recorder | Get-VmsHardware | Get-VmsMicrophone</dev:code> <dev:remarks> <maml:para>Get all enabled microphone devices from the selected recording server(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmsMicrophone -Name 'garage'</dev:code> <dev:remarks> <maml:para>Get all enabled microphones with the case-insensitive word "garage" in the name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VmsMicrophone -EnableFilter Disabled</dev:code> <dev:remarks> <maml:para>Get all disabled microphones.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VmsMicrophone -EnableFilter All -Channel 0 | Set-VmsMicrophone -Enabled $true -PassThru Get-VmsMicrophone -EnableFilter All -Channel (1..64) | Set-VmsMicrophone -Enabled $false -PassThru</dev:code> <dev:remarks> <maml:para>Get all microphones with a channel value of "0" (port number 1), and enable them if they aren't enabled already. Then get all microphones with a higher channel number from 1 to 64, and disable them. In most cases this should leave you with only the first microphone enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsMicrophone/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsModuleConfig</command:name> <command:verb>Get</command:verb> <command:noun>VmsModuleConfig</command:noun> <maml:description> <maml:para>Gets an object representing the MilestonePSTools module settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsModuleConfig` cmdlet gets an object representing the MilestonePSTools module settings. These settings determine whether debug logging is enabled or disabled, and can make other minor changes to the behavior of the module.</maml:para> <maml:para>The settings are determined based on the content of the `appsettings.json` file in the bin folder of the PowerShell module. When settings are modified using `Set-VmsModuleConfig`, the customized user settings are stored in `~\AppData\Local\Milestone\MilestonePSTools\appsettings.user.json` which takes precendce over the built-in module settings.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsModuleConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MilestonePSTools.Models.ModuleSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>(Get-VmsModuleConfig).Mip.EnvironmentManager.EnvironmentOptions <# OUTPUT Name Value ---- ----- LogPrefix MilestonePSTools ToolkitFork Yes UsePing No UseControlForMessaging Yes CompanyNameFolder Milestone SoftwareDecodingThreads 2,2 ConnectionCheckTimeout 5 ConfigurationChangeCheckInterval 300 HardwareDecodingMode Auto #></dev:code> <dev:remarks> <maml:para>Displays the current values applied to `VideoOS.Platform.EnvironmentManager`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>(Get-VmsModuleConfig).Mip.EnvironmentManager.DebugLoggingEnabled</dev:code> <dev:remarks> <maml:para>Returns a boolean value indicating whether debug logging is enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsModuleConfig/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsOutput</command:name> <command:verb>Get</command:verb> <command:noun>VmsOutput</command:noun> <maml:description> <maml:para>Gets output devices from the currently connected XProtect VMS site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsOutput` cmdlet gets output devices from the currently connected XProtect VMS site. Outputs are logical child devices attached to "hardware" which are most often an IP camera. The `VideoOS.Platform.ConfigurationItems.Output` object returned from this command represents a configurable device on the XProtect VMS.</maml:para> <maml:para>The corresponding `Set-VmsOutput` command can be used in conjunction with this cmdlet to modify the device settings.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsOutput</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsOutput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsOutput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsOutput</dev:code> <dev:remarks> <maml:para>Get all enabled output devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$recorder = Get-VmsRecordingServer | Out-GridView -OutputMode Multiple $recorder | Get-VmsHardware | Get-VmsOutput</dev:code> <dev:remarks> <maml:para>Get all enabled output devices from the selected recording server(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmsOutput -Name 'garage'</dev:code> <dev:remarks> <maml:para>Get all enabled outputs with the case-insensitive word "garage" in the name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VmsOutput -EnableFilter Disabled</dev:code> <dev:remarks> <maml:para>Get all disabled outputs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VmsOutput -EnableFilter All -Channel 0 | Set-VmsOutput -Enabled $true -PassThru Get-VmsOutput -EnableFilter All -Channel (1..64) | Set-VmsOutput -Enabled $false -PassThru</dev:code> <dev:remarks> <maml:para>Get all outputs with a channel value of "0" (port number 1), and enable them if they aren't enabled already. Then get all outputs with a higher channel number from 1 to 64, and disable them. In most cases this should leave you with only the first output enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsOutput/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsSite</command:name> <command:verb>Get</command:verb> <command:noun>VmsSite</command:noun> <maml:description> <maml:para>Gets a `VideoOS.Platform.Item` object representing a Milestone XProtect management server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsSite` cmdlet can be used to identify which site is currently selected, or which sites are available to be selected. When logged into a Milestone Federated Hierarchy, many cmdlets only operate on the currently "selected" site which will be the site that was directly logged in to using `Connect-ManagementServer`.</maml:para> <maml:para>To view and modify the configuration of resources on a child site, you can pipe the output from `Get-VmsSite` to `Select-VmsSite`.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsSite</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the display name of a site, with support for wildcards, used to filter the list of available sites.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>List all available sites in a Milestone Federated Hierarchy to choose from.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>List all available sites in a Milestone Federated Hierarchy to choose from.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the display name of a site, with support for wildcards, used to filter the list of available sites.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-VmsSite</dev:code> <dev:remarks> <maml:para>This command returns a `[VideoOS.Platform.Item]` object representing the currently selected site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-VmsSite -ListAvailable</dev:code> <dev:remarks> <maml:para>This command lists all available sites in a Milestone Federated Hierarchy and works the same way as `Get-VmsSite -Name *`.</maml:para> <maml:para>Note that it will include child sites even if you did not login to them by using `-IncludeChildSites` with `Connect-ManagementServer`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-VmsSite -Name Site2</dev:code> <dev:remarks> <maml:para>This command command will return an object representing the site named "Site2". If no such site exists, it will return an error because there is no wildcard in the Name parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-VmsSite -Name DR-*</dev:code> <dev:remarks> <maml:para>This command gets all Items representing sites where the display name begins with "DR-". If no matching sites exist, no values are returned. Due to the presence of the wildcard character "*", there will be no error.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsSite/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmsSpeaker</command:name> <command:verb>Get</command:verb> <command:noun>VmsSpeaker</command:noun> <maml:description> <maml:para>Gets speaker devices from the currently connected XProtect VMS site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-VmsSpeaker` cmdlet gets speaker devices from the currently connected XProtect VMS site. Speakers are logical child devices attached to "hardware" which are most often an IP camera. The `VideoOS.Platform.ConfigurationItems.Speaker` object returned from this command represents a configurable device on the XProtect VMS.</maml:para> <maml:para>The corresponding `Set-VmsSpeaker` command can be used in conjunction with this cmdlet to modify the device settings.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmsSpeaker</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsSpeaker</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmsSpeaker</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Comparison</maml:name> <maml:description> <maml:para>When providing a value for the `Name`, or `Description` parameters, the `Comparison` operator determines how thes values are compared with the corresponding device properties. The default value is Contains .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Operator</command:parameterValue> <dev:type> <maml:name>Operator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Contains</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies all, or part of a device description which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EnableFilter</maml:name> <maml:description> <maml:para>Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EnableFilter</command:parameterValue> <dev:type> <maml:name>EnableFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the hardware object(s) from which to return matching devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware[]</command:parameterValue> <dev:type> <maml:name>Hardware[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Id of an existing device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number may result in better performance. The default value is `[int]::MaxValue` or 2147483647.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies all, or part of a device name which is used with the `Comparison` parameter to filter the results of the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsSpeaker</dev:code> <dev:remarks> <maml:para>Get all enabled speaker devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$recorder = Get-VmsRecordingServer | Out-GridView -OutputMode Multiple $recorder | Get-VmsHardware | Get-VmsSpeaker</dev:code> <dev:remarks> <maml:para>Get all enabled speaker devices from the selected recording server(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmsSpeaker -Name 'garage'</dev:code> <dev:remarks> <maml:para>Get all enabled speakers with the case-insensitive word "garage" in the name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VmsSpeaker -EnableFilter Disabled</dev:code> <dev:remarks> <maml:para>Get all disabled speakers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VmsSpeaker -EnableFilter All -Channel 0 | Set-VmsSpeaker -Enabled $true -PassThru Get-VmsSpeaker -EnableFilter All -Channel (1..64) | Set-VmsSpeaker -Enabled $false -PassThru</dev:code> <dev:remarks> <maml:para>Get all speakers with a channel value of "0" (port number 1), and enable them if they aren't enabled already. Then get all speakers with a higher channel number from 1 to 64, and disable them. In most cases this should leave you with only the first speaker enabled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-VmsSpeaker/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WhoIsOnline</command:name> <command:verb>Get</command:verb> <command:noun>WhoIsOnline</command:noun> <maml:description> <maml:para>Gets the response to the MIP message 'MessageCommunication.WhoAreOnlineRequest'</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The MIP SDK provides the MessageCommunication.WhoAreOnlineRequest and MessageCommunication.WhoAreOnlineResponse messages for getting a list of endpoint FQID's which can then potentially be used as destination addresses for other MIP messages. Each EndPointIdentityData object provides an 'IdentityName' property with the format 'Administrator (0.0.0.0)' which can be used to get a general idea of who is connected to the Management Server and from which network location. Note that this is not meant as a perfect user session monitoring solution and you may see duplicate entries including entries representing the Milestone services themselves such as for the Event Server or Log Server.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WhoIsOnline</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Time, in seconds, to wait for the first result.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Time, in seconds, to wait for the first result.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Messaging.EndPointIdentityData</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-WhoIsOnline</dev:code> <dev:remarks> <maml:para>Get a list of user sessions with a default timeout value of 10 seconds</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-WhoIsOnline -Timeout 2</dev:code> <dev:remarks> <maml:para>Get a list of user sessions with a custom timeout value of 2 seconds</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Get-WhoIsOnline/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-Method</command:name> <command:verb>Invoke</command:verb> <command:noun>Method</command:noun> <maml:description> <maml:para>Invokes a method or command on a given ConfigurationItem</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Some ConfigurationItem objects have MethodIds defining commands that can be invoked. The response to an Invoke-Method command may be a ConfigurationItem of type 'InvokeInfo' which may have one or more properties that need to be filled out before sending the updated InvokeInfo item to the Invoke-Method command again. Alternatively, if no additional information or Invoke-Method call is needed, the result may be of type InvokeResult.</maml:para> <maml:para>The result may also be a Task, indicating the operation may take some time. You can then poll periodically for task status until the State property is 'Completed'.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-Method</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>MethodId</maml:name> <maml:description> <maml:para>Specifies the MethodId string to invoke on the ConfigurationItem</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specifies the source ConfigurationItem on which the given MethodId will be invoked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specifies the source ConfigurationItem on which the given MethodId will be invoked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>MethodId</maml:name> <maml:description> <maml:para>Specifies the MethodId string to invoke on the ConfigurationItem</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para>Specifies the source ConfigurationItem on which the given MethodId will be invoked</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ConfigurationItem -Path /UserDefinedEventFolder | Invoke-Method -MethodId AddUserDefinedEvent</dev:code> <dev:remarks> <maml:para>Invokes the AddUserDefinedEvent method which returns a ConfigurationItem of type InvokeInfo. Fill out the Name property of this ConfigurationItem and resend to the Invoke-Method command to create a new User Defined Event.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Invoke-Method/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Configuration API docs</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=gettingstarted/intro_configurationapi.html&tree=tree_4.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-MipSdkEula</command:name> <command:verb>Invoke</command:verb> <command:noun>MipSdkEula</command:noun> <maml:description> <maml:para>Opens the end-user license agreement file for MIP SDK in the default RTF file viewer</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This module is built upon Milestone's MIP SDK and requires the use of the redistributable MIP SDK binaries. As such, it is required for the user of this module to accept the agreement prior to use.</maml:para> <maml:para>This command will open the MIPSDK_EULA.txt file included with MilestonePSTools in the default viewer. If you prefer to get the raw text as a string, you can use Get-MipSdkEula instead.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-MipSdkEula</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-MipSdkEula</dev:code> <dev:remarks> <maml:para>Opens the EULA in the default .TXT file viewer.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Invoke-MipSdkEula/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-Alarm</command:name> <command:verb>New</command:verb> <command:noun>Alarm</command:noun> <maml:description> <maml:para>Generates a partially filled Alarm object to be sent using Send-Alarm.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The partially completed Alarm object can be modified as needed before sending to the Event Server with the Send-Alarm cmdlet.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-Alarm</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CustomTag</maml:name> <maml:description> <maml:para>Specifies the Alarm.EventHeader.CustomTag value which could be used later for searching or filtering in calls to Get-AlarmLines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the detailed description of the alarm. This appears in the XProtect Smart Client under the alarm's Instructions field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the alarm message</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools Default Alarm Message</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RelatedItems</maml:name> <maml:description> <maml:para>Specifies one or more items such as cameras as references or related items so that video from all related cameras is associated with the alarm.</maml:para> <maml:para>To get an Item object, try passing a Camera or Input object for example into the Get-PlatformItem cmdlet.</maml:para> <maml:para>Alternatively you can construct your own Item. All you need is the FQID property to contain a ServerId, ObjectId and Kind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Item[]</command:parameterValue> <dev:type> <maml:name>Item[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies an alarm source to automatically fill in the Alarm.EventHeader.Source property.</maml:para> <maml:para>To get an Item object, try passing a Camera or Input object for example into the Get-VmsVideoOSItem cmdlet.</maml:para> <maml:para>Alternatively you can construct your own Item. All you need is the FQID property to contain a ServerId, ObjectId and Kind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Item</command:parameterValue> <dev:type> <maml:name>Item</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp associated with the alarm.</maml:para> <maml:para>Default is DateTime.UtcNow. All DateTimes will be converted to UTC time automatically if needed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Vendor</maml:name> <maml:description> <maml:para>Specifies a vendor name as the source for the alarm. Default is MilestonePSTools.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CustomTag</maml:name> <maml:description> <maml:para>Specifies the Alarm.EventHeader.CustomTag value which could be used later for searching or filtering in calls to Get-AlarmLines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the detailed description of the alarm. This appears in the XProtect Smart Client under the alarm's Instructions field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the alarm message</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools Default Alarm Message</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RelatedItems</maml:name> <maml:description> <maml:para>Specifies one or more items such as cameras as references or related items so that video from all related cameras is associated with the alarm.</maml:para> <maml:para>To get an Item object, try passing a Camera or Input object for example into the Get-PlatformItem cmdlet.</maml:para> <maml:para>Alternatively you can construct your own Item. All you need is the FQID property to contain a ServerId, ObjectId and Kind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Item[]</command:parameterValue> <dev:type> <maml:name>Item[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies an alarm source to automatically fill in the Alarm.EventHeader.Source property.</maml:para> <maml:para>To get an Item object, try passing a Camera or Input object for example into the Get-VmsVideoOSItem cmdlet.</maml:para> <maml:para>Alternatively you can construct your own Item. All you need is the FQID property to contain a ServerId, ObjectId and Kind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Item</command:parameterValue> <dev:type> <maml:name>Item</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>Specifies the timestamp associated with the alarm.</maml:para> <maml:para>Default is DateTime.UtcNow. All DateTimes will be converted to UTC time automatically if needed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Vendor</maml:name> <maml:description> <maml:para>Specifies a vendor name as the source for the alarm. Default is MilestonePSTools.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.Alarm</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$cameraItem = Get-VmsCamera -Id '948aa6a2-9a46-4c4c-8279-af0485428d75' | Get-VmsVideoOSItem -Kind Camera $alarm = New-Alarm -Message "Important Alarm Message" -Source $cameraItem $alarm | Send-Alarm</dev:code> <dev:remarks> <maml:para>Retrieves the Item object for Camera with the given Id and creates an Alarm with this camera as the source.</maml:para> <maml:para>The Alarm object is then sent to the Event Server which generates a new alarm.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/New-Alarm/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AlarmCondition</command:name> <command:verb>New</command:verb> <command:noun>AlarmCondition</command:noun> <maml:description> <maml:para>Creates a new filter condition to specify which alarms should be returned in a query using Get-AlarmLines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The IAlarmCommand.GetAlarmLines can be provided with an AlarmFilter containing conditions and sorting orders.</maml:para> <maml:para>The cmdlet allows you to reduce the scope of the search for alarm lines.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AlarmCondition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Operator</maml:name> <maml:description> <maml:para>Specifies the condition comparison operator such as 'BeginsWith' or 'Equals'.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">BeginsWith</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEquals</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Equals</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the AlarmLine property to be used for this condition.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AssignedTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraId</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Category</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CategoryName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomTag</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Description</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LocalId</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Modified</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectId</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectValue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Priority</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PriorityName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RuleType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SourceName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">State</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StateName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Timestamp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Type</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VendorName</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the AlarmLine property value to compare against.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Operator</maml:name> <maml:description> <maml:para>Specifies the condition comparison operator such as 'BeginsWith' or 'Equals'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Equals</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the AlarmLine property to be used for this condition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the AlarmLine property value to compare against.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Condition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$condition = New-AlarmCondition -Operator NotEquals -Target StateName -Value Closed $condition</dev:code> <dev:remarks> <maml:para>Creates a condition which will ensure only alarms which are not closed will be returned.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/New-AlarmCondition/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AlarmOrder</command:name> <command:verb>New</command:verb> <command:noun>AlarmOrder</command:noun> <maml:description> <maml:para>Creates a new OrderBy object which is used when working with and filtering alarms.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>One or more OrderBy objects can be used in an AlarmFilter to specify the order of alarms to be returned.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AlarmOrder</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Specifies the order as either Ascending or Descending. Default is Ascending.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Ascending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Descending</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ascending</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target AlarmLine property to be sorted. Default is Timestamp.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AssignedTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraId</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Category</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CategoryName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomTag</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Description</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LocalId</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Modified</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectId</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectValue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Priority</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PriorityName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RuleType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SourceName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">State</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StateName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Timestamp</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Type</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VendorName</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Timestamp</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Specifies the order as either Ascending or Descending. Default is Ascending.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ascending</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target AlarmLine property to be sorted. Default is Timestamp.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Timestamp</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.OrderBy</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$order = New-AlarmOrder -Order Descending -Target SourceName $order</dev:code> <dev:remarks> <maml:para>Create a new OrderBy object to specify that alarms should be sorted by SourceName in descending order.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/New-AlarmOrder/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-Bookmark</command:name> <command:verb>Remove</command:verb> <command:noun>Bookmark</command:noun> <maml:description> <maml:para>Removes / deletes a bookmark</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a bookmark, or a bookmark ID from the pipeline or parameters, and deletes it.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Bookmark</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bookmark</command:parameterValue> <dev:type> <maml:name>Bookmark</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-Bookmark</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>BookmarkId</maml:name> <maml:description> <maml:para>Specifies the ID of the bookmark object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bookmark</command:parameterValue> <dev:type> <maml:name>Bookmark</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>BookmarkId</maml:name> <maml:description> <maml:para>Specifies the ID of the bookmark object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> </dev:type> <maml:description> <maml:para>Specifies the bookmark object to be deleted.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>Specifies the ID of the bookmark object to be deleted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Bookmark -DeviceId $id | Remove-Bookmark</dev:code> <dev:remarks> <maml:para>Remove all bookmarks for the last hour of video for device with ID $id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Bookmark -Timestamp '2019-06-04 14:00:00' -Minutes 120 | Remove-Bookmark</dev:code> <dev:remarks> <maml:para>Removes all bookmarks for any device where the bookmark time is between 2PM and 4PM local time on the 4th of June.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Remove-Bookmark/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EvidenceLock</command:name> <command:verb>Remove</command:verb> <command:noun>EvidenceLock</command:noun> <maml:description> <maml:para>Removes an evidence lock record which makes it possible for previously-protected recordings to be deleted.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EvidenceLock` cmdlet removes an evidence lock record which makes it possible for previously-protected recordings to be deleted.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> <maml:para>- Requires VMS feature "EvidenceLock"</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EvidenceLock</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLockIds</maml:name> <maml:description> <maml:para>Specifies one or more evidence lock record IDs for the records that should be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies that the evidence lock records should be deleted even though it may result in the associated recordings being deleted if they are older than the configured retention time in the storage profile they reside in.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-EvidenceLock</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLocks</maml:name> <maml:description> <maml:para>Specifies one or more evidence lock records to be deleted. Retrieve evidence lock records using `Get-EvidenceLock`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData[]</command:parameterValue> <dev:type> <maml:name>MarkedData[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies that the evidence lock records should be deleted even though it may result in the associated recordings being deleted if they are older than the configured retention time in the storage profile they reside in.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLockIds</maml:name> <maml:description> <maml:para>Specifies one or more evidence lock record IDs for the records that should be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLocks</maml:name> <maml:description> <maml:para>Specifies one or more evidence lock records to be deleted. Retrieve evidence lock records using `Get-EvidenceLock`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData[]</command:parameterValue> <dev:type> <maml:name>MarkedData[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies that the evidence lock records should be deleted even though it may result in the associated recordings being deleted if they are older than the configured retention time in the storage profile they reside in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$lock = Get-EvidenceLock | Out-GridView -OutputMode Single $lock | Remove-EvidenceLock</dev:code> <dev:remarks> <maml:para>This example would remove the selected evidence lock, however the Remove-EvidenceLock cmdlet requires the `-Force` switch and has a ConfirmImpact value of "High" which normally results in a confirmation prompt before a record is deleted.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Remove-EvidenceLock/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-GenericEvent</command:name> <command:verb>Remove</command:verb> <command:noun>GenericEvent</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-GenericEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>GenericEvent</maml:name> <maml:description> <maml:para>{{ Fill GenericEvent Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GenericEvent</command:parameterValue> <dev:type> <maml:name>GenericEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>GenericEvent</maml:name> <maml:description> <maml:para>{{ Fill GenericEvent Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GenericEvent</command:parameterValue> <dev:type> <maml:name>GenericEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Remove-GenericEvent/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-RegisteredService</command:name> <command:verb>Remove</command:verb> <command:noun>RegisteredService</command:noun> <maml:description> <maml:para>Removes a registered service entry from a Milestone XProtect VMS.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-RegisteredService` cmdlet removes a registered service entry from a Milestone XProtect VMS. You can see a list of registered services in the Management Client under Tools > Registered Services.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RegisteredService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RegisteredService</maml:name> <maml:description> <maml:para>Specifies a registered service entry returned by `Get-RegisteredService`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>ServiceURIInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VideoOS.Platform.Configuration+ServiceURIInfo</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RegisteredService</maml:name> <maml:description> <maml:para>Specifies a registered service entry returned by `Get-RegisteredService`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>ServiceURIInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VideoOS.Platform.Configuration+ServiceURIInfo</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-RegisteredService | Out-GridView -OutputMode Single | Remove-RegisteredService</dev:code> <dev:remarks> <maml:para>Prompts to select a registered service entry, and then removes the selected registered service.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Remove-RegisteredService/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-Stream</command:name> <command:verb>Remove</command:verb> <command:noun>Stream</command:noun> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Stream</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Specifies a stream usage child item to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Specifies a stream usage child item to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Deprecated</dev:code> <dev:remarks> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Remove-Stream/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-UserDefinedEvent</command:name> <command:verb>Remove</command:verb> <command:noun>UserDefinedEvent</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-UserDefinedEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-UserDefinedEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-UserDefinedEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>UserDefinedEvent</maml:name> <maml:description> <maml:para>{{ Fill UserDefinedEvent Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>UserDefinedEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>UserDefinedEvent</maml:name> <maml:description> <maml:para>{{ Fill UserDefinedEvent Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>UserDefinedEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Remove-UserDefinedEvent/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-VmsSite</command:name> <command:verb>Select</command:verb> <command:noun>VmsSite</command:noun> <maml:description> <maml:para>Selects a Management Server "site" to perform further commands against.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Select-VmsSite cmdlet allows you to switch between two or more sites in a Milestone Federated Architecture. Most commands in this module operate against only the selected site, so a script intended to perform operations across two or more sites should be designed to enumerate through the available sites.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-VmsSite</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MasterSite"> <maml:name>MainSite</maml:name> <maml:description> <maml:para>Select the original, parent site connected to with `Connect-VmsManagementServer`.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-VmsSite</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the display name of a site with support for wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-VmsSite</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="SiteItem"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specifies a `VideoOS.Platform.Item` object representing a site returned by `Get-VmsSite`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Item</command:parameterValue> <dev:type> <maml:name>Item</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MasterSite"> <maml:name>MainSite</maml:name> <maml:description> <maml:para>Select the original, parent site connected to with `Connect-VmsManagementServer`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the display name of a site with support for wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="SiteItem"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specifies a `VideoOS.Platform.Item` object representing a site returned by `Get-VmsSite`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Item</command:parameterValue> <dev:type> <maml:name>Item</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> </dev:type> <maml:description> <maml:para>Specifies an Item object representing a Management Server, typically returned by the Get-VmsSite cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Select-VmsSite -MainSite</dev:code> <dev:remarks> <maml:para>This command selects the site you initially connected to in the current Connect-ManagementServer session.</maml:para> <maml:para>Note: While this switch parameter is named MainSite, it is possible that the main site for this session is a child to another site. But since you logged into this site, it is considered the main site for the duration of this PowerShell session.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Select-VmsSite -Name 'High School'</dev:code> <dev:remarks> <maml:para>This command selects the first site named exactly 'High School'.</maml:para> <maml:para>Note: It is possible for two sites to have the same display name. This command selects the first site with the given name, and the order is not guaranteed. It is recommended to uniquely name your sites.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Select-VmsSite -Name '*School'</dev:code> <dev:remarks> <maml:para>This command gets the Item representing a site where the Name property equals "Site2".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-VmsSite -ListAvailable | ForEach-Object { $_ | Select-VmsSite; Get-VmsManagementServer | Select-Object Name, Version }</dev:code> <dev:remarks> <maml:para>This snippet will enumerate all sites available to the current user, and retrieve the Management Server Name and Version.</maml:para> <maml:para>Note: The % symbol in this command is shorthand for the Foreach-Object cmdlet, and $_ within the foreach code block is a reference to each instance of a site item returned from Get-VmsSite.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Select-VmsSite/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-Alarm</command:name> <command:verb>Send</command:verb> <command:noun>Alarm</command:noun> <maml:description> <maml:para>Sends a new Alarm object to the Event Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A new alarm object can be created with New-Alarm, then after the properties are filled out as desired, you can send the alarm to the Event Server to create a new AlarmLine directly.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-Alarm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Alarm</maml:name> <maml:description> <maml:para>An alarm object to send to the Event Server through an AlarmClient instance.</maml:para> <maml:para>Create an alarm with New-Alarm and fill out the properties before sending it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Alarm</command:parameterValue> <dev:type> <maml:name>Alarm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Alarm</maml:name> <maml:description> <maml:para>An alarm object to send to the Event Server through an AlarmClient instance.</maml:para> <maml:para>Create an alarm with New-Alarm and fill out the properties before sending it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Alarm</command:parameterValue> <dev:type> <maml:name>Alarm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.Data.Alarm</maml:name> </dev:type> <maml:description> <maml:para>An alarm object to send to the Event Server through an AlarmClient instance.</maml:para> <maml:para>Create an alarm with New-Alarm and fill out the properties before sending it.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$cameraItem = Get-VmsCamera -Id 948aa6a2-9a46-4c4c-8279-af0485428d75 | Get-VmsVideoOSItem -Kind Camera $alarm = New-Alarm -Message "Important Alarm Message" -Source $cameraItem $alarm | Send-Alarm</dev:code> <dev:remarks> <maml:para>Retrieves the Item object for Camera with the given Id and creates an Alarm with this camera as the source.</maml:para> <maml:para>The Alarm object is then sent to the Event Server which generates a new alarm.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Send-Alarm/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-GenericEvent</command:name> <command:verb>Send</command:verb> <command:noun>GenericEvent</command:noun> <maml:description> <maml:para>Sends a TCP or UDP message to the Event Server to trigger a Generic Event</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generic Events are a way to receive predefined strings or patterns as strings over TCP/UDP in order to trigger events, which can then be used as a trigger for a rule to perform some action.</maml:para> <maml:para>This command simplifies testing of generic events by automatically retrieving the correct host/ip and port, appending the 'separator bytes' if defined in the Data Source configuration in Management Client under Tools > Options > Generic Events, and parsing the response in the event the Data Source is configured to echo 'Statistics'.</maml:para> <maml:para>For debugging, try adding -Verbose and reviewing some of the details provided.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-GenericEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>EventString</maml:name> <maml:description> <maml:para>Specifies the string to send to the Event Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DataSourceName</maml:name> <maml:description> <maml:para>Specifies the name of the GenericEventDataSource to send the EventString to</maml:para> <maml:para>If omitted, the first enabled data source will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ReadTimeout</maml:name> <maml:description> <maml:para>Specifies the timeout in milliseconds to wait for a response when Echo is not "None" and the protocol is not UDP.</maml:para> <maml:para>Default is 2000ms</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the GenericEventDataSource to send the EventString to</maml:para> <maml:para>If omitted, the first enabled data source will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GenericEventDataSource</command:parameterValue> <dev:type> <maml:name>GenericEventDataSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DataSource</maml:name> <maml:description> <maml:para>Specifies the GenericEventDataSource to send the EventString to</maml:para> <maml:para>If omitted, the first enabled data source will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GenericEventDataSource</command:parameterValue> <dev:type> <maml:name>GenericEventDataSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DataSourceName</maml:name> <maml:description> <maml:para>Specifies the name of the GenericEventDataSource to send the EventString to</maml:para> <maml:para>If omitted, the first enabled data source will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>EventString</maml:name> <maml:description> <maml:para>Specifies the string to send to the Event Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ReadTimeout</maml:name> <maml:description> <maml:para>Specifies the timeout in milliseconds to wait for a response when Echo is not "None" and the protocol is not UDP.</maml:para> <maml:para>Default is 2000ms</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Send-GenericEvent "Hello World"</dev:code> <dev:remarks> <maml:para>Sends the string "Hello World" to the first enabled Generic Event Data Source, which is usually named "Compatible" and listens on TCP port 1234.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Send-GenericEvent "Hello World" CustomDataSource</dev:code> <dev:remarks> <maml:para>Sends the string "Hello World" a Data Source named CustomDataSource. The port and protocol would be defined in that data source but you can see those values in the output when you provide the -Verbose switch.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Send-GenericEvent/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-MipMessage</command:name> <command:verb>Send</command:verb> <command:noun>MipMessage</command:noun> <maml:description> <maml:para>Sends a custom MIP message and optionally awaits the response.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Messaging is a core feature and component of the MIP SDK. Almost all actions and queries are handled through messaging. This cmdlet provides a mechanism for interacting with the messaging framework from PowerShell which gives you a fairly low-level interface into the VMS. As such, it can be complex to use and you should consult the MIP SDK documentation to better understand the available messages and how to use them.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-MipMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>MessageId</maml:name> <maml:description> <maml:para>MessageId string to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>UseEnvironmentManager</maml:name> <maml:description> <maml:para>Specifies that the message should be sent using EnvironmentManager.Instance instead of MessageCommunicationManager. Some MIP SDK messages are only delivered correctly when sent using the EnvironmentManager.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RelatedFqid</maml:name> <maml:description> <maml:para>Defines the FQID of the device or item related to the provided MessageId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Data</maml:name> <maml:description> <maml:para>Some MessageIds such as those related to PTZ are accompanied by some kind of object. Reference the MIP SDK documentation for more information about expected objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason the message is being sent. Not commonly used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>DestinationEndpoint</maml:name> <maml:description> <maml:para>Defines the FQID of the destination client or server endpoint for this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>DestinationObject</maml:name> <maml:description> <maml:para>Defines the FQID of an object on the DestinationEndpoint to receive this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Defines the FQID of the sender (or null if the recipients don't care)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>ResponseMessageId</maml:name> <maml:description> <maml:para>Defines the MessageId to listen for as a response to this message. Optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Time, in seconds, to wait for a response. If ResponseMessageId is null or whitespace, then a response is not expected and this cmdlet will return immediately after sending the message. Default is 10 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Data</maml:name> <maml:description> <maml:para>Some MessageIds such as those related to PTZ are accompanied by some kind of object. Reference the MIP SDK documentation for more information about expected objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>DestinationEndpoint</maml:name> <maml:description> <maml:para>Defines the FQID of the destination client or server endpoint for this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>DestinationObject</maml:name> <maml:description> <maml:para>Defines the FQID of an object on the DestinationEndpoint to receive this message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>MessageId</maml:name> <maml:description> <maml:para>MessageId string to send.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Specifies the reason the message is being sent. Not commonly used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RelatedFqid</maml:name> <maml:description> <maml:para>Defines the FQID of the device or item related to the provided MessageId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>ResponseMessageId</maml:name> <maml:description> <maml:para>Defines the MessageId to listen for as a response to this message. Optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Defines the FQID of the sender (or null if the recipients don't care)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FQID</command:parameterValue> <dev:type> <maml:name>FQID</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Time, in seconds, to wait for a response. If ResponseMessageId is null or whitespace, then a response is not expected and this cmdlet will return immediately after sending the message. Default is 10 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>UseEnvironmentManager</maml:name> <maml:description> <maml:para>Specifies that the message should be sent using EnvironmentManager.Instance instead of MessageCommunicationManager. Some MIP SDK messages are only delivered correctly when sent using the EnvironmentManager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Send-MipMessage -MessageId Control.TriggerCommand -DestinationEndpoint $presets[0].FQID -UseEnvironmentManager</dev:code> <dev:remarks> <maml:para>Activates a PTZ preset using the Control.TriggerCommand message. The DestinationEndpoint should be the FQID of a PtzPreset object. To get a list of PtzPreset items for a camera, you could do $presets = $camera.PtzPresetFolder.PtzPresets | Get-VmsVideoOSItem -Kind Preset</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Send-MipMessage/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-UserDefinedEvent</command:name> <command:verb>Send</command:verb> <command:noun>UserDefinedEvent</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-UserDefinedEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>{{ Fill Inputs Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent[]</command:parameterValue> <dev:type> <maml:name>InputEvent[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Outputs</maml:name> <maml:description> <maml:para>{{ Fill Outputs Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output[]</command:parameterValue> <dev:type> <maml:name>Output[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Cameras</maml:name> <maml:description> <maml:para>{{ Fill Cameras Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera[]</command:parameterValue> <dev:type> <maml:name>Camera[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Microphones</maml:name> <maml:description> <maml:para>{{ Fill Microphones Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone[]</command:parameterValue> <dev:type> <maml:name>Microphone[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Speakers</maml:name> <maml:description> <maml:para>{{ Fill Speakers Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker[]</command:parameterValue> <dev:type> <maml:name>Speaker[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Metadatas</maml:name> <maml:description> <maml:para>{{ Fill Metadatas Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata[]</command:parameterValue> <dev:type> <maml:name>Metadata[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Send-UserDefinedEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>UserDefinedEvent</maml:name> <maml:description> <maml:para>{{ Fill UserDefinedEvent Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>UserDefinedEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>{{ Fill Inputs Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent[]</command:parameterValue> <dev:type> <maml:name>InputEvent[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Outputs</maml:name> <maml:description> <maml:para>{{ Fill Outputs Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output[]</command:parameterValue> <dev:type> <maml:name>Output[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Cameras</maml:name> <maml:description> <maml:para>{{ Fill Cameras Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera[]</command:parameterValue> <dev:type> <maml:name>Camera[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Microphones</maml:name> <maml:description> <maml:para>{{ Fill Microphones Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone[]</command:parameterValue> <dev:type> <maml:name>Microphone[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Speakers</maml:name> <maml:description> <maml:para>{{ Fill Speakers Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker[]</command:parameterValue> <dev:type> <maml:name>Speaker[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Metadatas</maml:name> <maml:description> <maml:para>{{ Fill Metadatas Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata[]</command:parameterValue> <dev:type> <maml:name>Metadata[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Cameras</maml:name> <maml:description> <maml:para>{{ Fill Cameras Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera[]</command:parameterValue> <dev:type> <maml:name>Camera[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>{{ Fill Inputs Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent[]</command:parameterValue> <dev:type> <maml:name>InputEvent[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Metadatas</maml:name> <maml:description> <maml:para>{{ Fill Metadatas Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata[]</command:parameterValue> <dev:type> <maml:name>Metadata[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Microphones</maml:name> <maml:description> <maml:para>{{ Fill Microphones Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone[]</command:parameterValue> <dev:type> <maml:name>Microphone[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Outputs</maml:name> <maml:description> <maml:para>{{ Fill Outputs Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output[]</command:parameterValue> <dev:type> <maml:name>Output[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Speakers</maml:name> <maml:description> <maml:para>{{ Fill Speakers Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker[]</command:parameterValue> <dev:type> <maml:name>Speaker[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>UserDefinedEvent</maml:name> <maml:description> <maml:para>{{ Fill UserDefinedEvent Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>UserDefinedEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Send-UserDefinedEvent/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-CameraSetting</command:name> <command:verb>Set</command:verb> <command:noun>CameraSetting</command:noun> <maml:description> <maml:para>Sets a general, or stream setting for a camera based on the setting name/key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CameraSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>{{ Fill Camera Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CameraSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>{{ Fill Camera Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>{{ Fill Camera Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-CameraSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ConfigurationItem</command:name> <command:verb>Set</command:verb> <command:noun>ConfigurationItem</command:noun> <maml:description> <maml:para>Store the updated ConfigurationItem including all properties and any filled childItems with Category=ChildItem</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Store the updated ConfigurationItem including all properties and any filled childItems with Category=ChildItem</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ConfigurationItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specifies the ConfigurationItem object to be updated.</maml:para> <maml:para>Usually you will get the ConfigurationItem object using Get-ConfigurationItem.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ConfigurationItem</maml:name> <maml:description> <maml:para>Specifies the ConfigurationItem object to be updated.</maml:para> <maml:para>Usually you will get the ConfigurationItem object using Get-ConfigurationItem.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>ConfigurationItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> </dev:type> <maml:description> <maml:para>Specifies the ConfigurationItem object to be updated.</maml:para> <maml:para>Usually you will get the ConfigurationItem object using Get-ConfigurationItem.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ValidateResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$ms = Get-ConfigurationItem -Path "/" $name = $ms.Properties | Where-Object Key -eq "Name" $name.Value = "New Name" $ms | Set-ConfigurationItem</dev:code> <dev:remarks> <maml:para>Changes the Name property of the Management Server</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-ConfigurationItem/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Configuration API docs</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=gettingstarted/intro_configurationapi.html&tree=tree_4.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DeviceAcl</command:name> <command:verb>Set</command:verb> <command:noun>DeviceAcl</command:noun> <maml:description> <maml:para>Applies the specified device permissions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-DeviceAcl` cmdlet applies any changes made to a `DeviceAcl` object returned by a prior call to `Get-DeviceAcl`. This is used to update the permissions for a given role on a specific device.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DeviceAcl</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DeviceAcl</maml:name> <maml:description> <maml:para>Specifies a DeviceAcl object returned by `Get-DeviceAcl`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DeviceAcl</command:parameterValue> <dev:type> <maml:name>DeviceAcl</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DeviceAcl</maml:name> <maml:description> <maml:para>Specifies a DeviceAcl object returned by `Get-DeviceAcl`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DeviceAcl</command:parameterValue> <dev:type> <maml:name>DeviceAcl</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>MilestoneLib.DeviceAcl</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$camera = Get-VmsCamera | Select-Object -First 1 $role = Get-VmsRole -RoleType UserDefined | Select-Object -First 1 $acl = Get-DeviceAcl -Camera $camera -Role $role $acl.SecurityAttributes.GENERIC_READ = 'True' $acl | Set-DeviceAcl</dev:code> <dev:remarks> <maml:para>Grants "read" permission for a camera to a role.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-DeviceAcl/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-HardwareSetting</command:name> <command:verb>Set</command:verb> <command:noun>HardwareSetting</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HardwareSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>{{ Fill Hardware Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware</command:parameterValue> <dev:type> <maml:name>Hardware</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>{{ Fill Hardware Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hardware</command:parameterValue> <dev:type> <maml:name>Hardware</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-HardwareSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-InputSetting</command:name> <command:verb>Set</command:verb> <command:noun>InputSetting</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-InputSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>{{ Fill Input Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-InputSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>{{ Fill Input Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Input</maml:name> <maml:description> <maml:para>{{ Fill Input Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputEvent</command:parameterValue> <dev:type> <maml:name>InputEvent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-InputSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-MetadataSetting</command:name> <command:verb>Set</command:verb> <command:noun>MetadataSetting</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-MetadataSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>{{ Fill Metadata Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-MetadataSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>{{ Fill Metadata Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>{{ Fill Metadata Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Metadata</command:parameterValue> <dev:type> <maml:name>Metadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-MetadataSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-MicrophoneSetting</command:name> <command:verb>Set</command:verb> <command:noun>MicrophoneSetting</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-MicrophoneSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>{{ Fill Microphone Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-MicrophoneSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>{{ Fill Microphone Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Microphone</maml:name> <maml:description> <maml:para>{{ Fill Microphone Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microphone</command:parameterValue> <dev:type> <maml:name>Microphone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-MicrophoneSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-OutputSetting</command:name> <command:verb>Set</command:verb> <command:noun>OutputSetting</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-OutputSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>{{ Fill Output Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-OutputSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>{{ Fill Output Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Output</maml:name> <maml:description> <maml:para>{{ Fill Output Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Output</command:parameterValue> <dev:type> <maml:name>Output</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-OutputSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-OverallSecurity</command:name> <command:verb>Set</command:verb> <command:noun>OverallSecurity</command:noun> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity`.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deprecated. Use `Get-VmsRoleOverallSecurity` and `Set-VmsRoleOverallSecurity`.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-OverallSecurity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityPermissions</maml:name> <maml:description> <maml:para>Specifies new overall security permissions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies a role object as is returned by `Get-VmsRole`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Role</command:parameterValue> <dev:type> <maml:name>Role</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityPermissions</maml:name> <maml:description> <maml:para>Specifies new overall security permissions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># Deprecated.</dev:code> <dev:remarks> <maml:para>Deprecated.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-OverallSecurity/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-SpeakerSetting</command:name> <command:verb>Set</command:verb> <command:noun>SpeakerSetting</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SpeakerSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>{{ Fill Speaker Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SpeakerSetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>{{ Fill Speaker Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>General</maml:name> <maml:description> <maml:para>{{ Fill General Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>{{ Fill Name Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Speaker</maml:name> <maml:description> <maml:para>{{ Fill Speaker Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Speaker</command:parameterValue> <dev:type> <maml:name>Speaker</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>{{ Fill Stream Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StreamNumber</maml:name> <maml:description> <maml:para>{{ Fill StreamNumber Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>{{ Fill Value Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>{{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-SpeakerSetting/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-Stream</command:name> <command:verb>Set</command:verb> <command:noun>Stream</command:noun> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deprecated. Use `Get-VmsCameraStream` and `Set-VmsCameraStream` instead.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Stream</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>StreamId</maml:name> <maml:description> <maml:para>Specifies the ID of the stream to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new display name for the stream usage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LiveMode</maml:name> <maml:description> <maml:para>Specifies whether the live stream should be retrieved from the camera Always, Never, or WhenNeeded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>LiveDefault</maml:name> <maml:description> <maml:para>Specifies that the stream should be the default live stream.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>Specifies that the stream should be the recorded stream.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Specifies the stream to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>LiveDefault</maml:name> <maml:description> <maml:para>Specifies that the stream should be the default live stream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LiveMode</maml:name> <maml:description> <maml:para>Specifies whether the live stream should be retrieved from the camera Always, Never, or WhenNeeded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new display name for the stream usage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>Specifies that the stream should be the recorded stream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Specifies the stream to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>StreamId</maml:name> <maml:description> <maml:para>Specifies the ID of the stream to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$stream | Set-Stream -LiveDefault -Record -LiveMode WhenNeeded</dev:code> <dev:remarks> <maml:para>Sets the stream as the default live stream, and recorded stream, and sets LiveMode to "WhenNeeded" which means a stream will only be pulled from the camera if the rules engine requires it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-Stream/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmsCamera</command:name> <command:verb>Set</command:verb> <command:noun>VmsCamera</command:noun> <maml:description> <maml:para>Sets one or more configuration properties for the specified device(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Milestone's Configuration API to modify properties of devices and saves the changes to the Management Server. Most parameters represent the Milestone MIP SDK property names of the underlying devices. However, there are a few custom parameter names including "Coordinates", "Direction", "FieldOfView" and "Depth" which accept values that are easier to understand than the values expected by the MIP SDK.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmsCamera</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Camera` objects as returned by `Get-VmsCamera`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Metric</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imperial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="23" aliases="none"> <maml:name>RecordKeyframesOnly</maml:name> <maml:description> <maml:para>Specifies that only key-frames should be recorded. Typically, key frames are received once per second but the value can vary widely depending on stream settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="24" aliases="none"> <maml:name>RecordingFramerate</maml:name> <maml:description> <maml:para>Specifies the desired recording frame rate. This applies only when the recorded stream is in MJPEG format. This setting has no impact when the recorded stream is MPEG4, H264, or H265.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="25" aliases="none"> <maml:name>RecordOnRelatedDevices</maml:name> <maml:description> <maml:para>Specifies whether or not related devices should be recorded whenever recording is triggered for the camera. Related devices typically include microphones, speakers and metadata associated with the camera.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Camera` objects as returned by `Get-VmsCamera`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="24" aliases="none"> <maml:name>RecordingFramerate</maml:name> <maml:description> <maml:para>Specifies the desired recording frame rate. This applies only when the recorded stream is in MJPEG format. This setting has no impact when the recorded stream is MPEG4, H264, or H265.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="23" aliases="none"> <maml:name>RecordKeyframesOnly</maml:name> <maml:description> <maml:para>Specifies that only key-frames should be recorded. Typically, key frames are received once per second but the value can vary widely depending on stream settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="25" aliases="none"> <maml:name>RecordOnRelatedDevices</maml:name> <maml:description> <maml:para>Specifies whether or not related devices should be recorded whenever recording is triggered for the camera. Related devices typically include microphones, speakers and metadata associated with the camera.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-Vms -ShowDialog -AcceptEula Get-VmsHardware | Get-VmsCamera -Channel (1..63) -Verbose | Set-VmsCamera -Enabled $false</dev:code> <dev:remarks> <maml:para>In this example, we first ensure we are logged in to the Management Server. Then we gets all enabled cameras with a channel number between 1 and 63 (camera 2 to camera 64), and disable them. You might do this if you only use the first channel on every camera, and all other channels should be disabled. In this case, channels higher than 63 would be unchanged. If you had devices with more unused channels than this, you could use "(1..511)" to select all cameras from the 2nd to the 512th channel.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$selectedCameras = Select-Camera -AllowFolders -AllowServers -RemoveDuplicates $splat = @{ PrebufferEnabled = $true PrebufferSeconds = 10 PrebufferInMemory = $true } $selectedCameras | Set-VmsCamera @splat</dev:code> <dev:remarks> <maml:para>Prompts for a camera selection and accepts the selection of camera groups or recording servers, and removes duplicate entries in the results just in case the same cameras are present in multiple groups or subgroups. Cameras are retrieved from the selected group(s) recursively.</maml:para> <maml:para>Next, each camera is configured to use an in-memory pre-buffer of up to 10 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$vmsCameraParams = @{ Camera = Get-VmsCamera -Name 'Office Entrance' Coordinates = '45.4171601197572, -122.732137977298' Direction = 90 FieldOfView = 180 Depth = 15 } Set-VmsCamera @vmsCameraParams</dev:code> <dev:remarks> <maml:para>A hashtable named $vmsCameraParams is defined with all the parameters needed to change the GPS location, direction, field of view, and depth of field for the camera(s) named "Office Entrance". The hashtable is then "splatted" into the cmdlet and because we included the Verbose switch, all changes made to the camera are logged to the console.</maml:para> <maml:para>Note that if the settings already matched these values, there would be nothing logged to the console because no changes had to be made.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-VmsCamera/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmsInput</command:name> <command:verb>Set</command:verb> <command:noun>VmsInput</command:noun> <maml:description> <maml:para>Sets one or more configuration properties for the specified device(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Milestone's Configuration API to modify properties of devices and saves the changes to the Management Server. Most parameters represent the Milestone MIP SDK property names of the underlying devices. However, there are a few custom parameter names including "Coordinates", "Direction", "FieldOfView" and "Depth" which accept values that are easier to understand than the values expected by the MIP SDK.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmsInput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `InputEvent` objects as returned by `Get-VmsInput`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Metric</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imperial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `InputEvent` objects as returned by `Get-VmsInput`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-Vms -ShowDialog -AcceptEula Get-VmsHardware | Get-VmsInput -Channel (1..63) -Verbose | Set-VmsInput -Enabled $false -Verbose</dev:code> <dev:remarks> <maml:para>In this example, we first ensure we are logged in to the Management Server. Then we gets all enabled inputs with a channel number between 1 and 63 (input 2 to input 64), and disable them. You might do this if you only use the first channel on every input, and all other channels should be disabled. In this case, channels higher than 63 would be unchanged. If you had devices with more unused channels than this, you could use "(1..511)" to select all inputs from the 2nd to the 512th channel.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsInput -Name 'Office Entrance' Coordinates = '45.4171601197572, -122.732137977298' Direction = 90 FieldOfView = 180 Depth = 15 Verbose = $true } Set-VmsInput @splat</dev:code> <dev:remarks> <maml:para>A hashtable named $splat is defined with all the parameters needed to change the GPS location, direction, field of view, and depth of field for the matching device(s) named "Office Entrance". The hashtable is then "splatted" into the cmdlet and because we included the Verbose switch, all changes made to the devices are logged to the console.</maml:para> <maml:para>Note that if the settings already matched these values, there would be nothing logged to the console because no changes had to be made.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-VmsInput/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmsMetadata</command:name> <command:verb>Set</command:verb> <command:noun>VmsMetadata</command:noun> <maml:description> <maml:para>Sets one or more configuration properties for the specified device(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Milestone's Configuration API to modify properties of devices and saves the changes to the Management Server. Most parameters represent the Milestone MIP SDK property names of the underlying devices. However, there are a few custom parameter names including "Coordinates", "Direction", "FieldOfView" and "Depth" which accept values that are easier to understand than the values expected by the MIP SDK.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmsMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Metadata` objects as returned by `Get-VmsMetadata`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Metric</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imperial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Metadata` objects as returned by `Get-VmsMetadata`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-Vms -ShowDialog -AcceptEula Get-VmsHardware | Get-VmsMetadata -Channel (1..63) -Verbose | Set-VmsMetadata -Enabled $false</dev:code> <dev:remarks> <maml:para>In this example, we first ensure we are logged in to the Management Server. Then we gets all enabled metadatas with a channel number between 1 and 63 (metadata 2 to metadata 64), and disable them. You might do this if you only use the first channel on every metadata, and all other channels should be disabled. In this case, channels higher than 63 would be unchanged. If you had devices with more unused channels than this, you could use "(1..511)" to select all metadatas from the 2nd to the 512th channel.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsMetadata PrebufferEnabled = $true PrebufferSeconds = 10 PrebufferInMemory = $true } Set-VmsMetadata @splat</dev:code> <dev:remarks> <maml:para>Configure an in-memory prebuffer on all enabled metadatas with a duration of 10 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsMetadata -Name 'Office Entrance' Coordinates = '45.4171601197572, -122.732137977298' Direction = 90 FieldOfView = 180 Depth = 15 Verbose = $true } Set-VmsMetadata @splat</dev:code> <dev:remarks> <maml:para>A hashtable named $splat is defined with all the parameters needed to change the GPS location, direction, field of view, and depth of field for the matching device(s) named "Office Entrance". The hashtable is then "splatted" into the cmdlet and because we included the Verbose switch, all changes made to the devices are logged to the console.</maml:para> <maml:para>Note that if the settings already matched these values, there would be nothing logged to the console because no changes had to be made.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-VmsMetadata/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmsMicrophone</command:name> <command:verb>Set</command:verb> <command:noun>VmsMicrophone</command:noun> <maml:description> <maml:para>Sets one or more configuration properties for the specified device(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Milestone's Configuration API to modify properties of devices and saves the changes to the Management Server. Most parameters represent the Milestone MIP SDK property names of the underlying devices. However, there are a few custom parameter names including "Coordinates", "Direction", "FieldOfView" and "Depth" which accept values that are easier to understand than the values expected by the MIP SDK.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmsMicrophone</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Microphone` objects as returned by `Get-VmsMicrophone`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Metric</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imperial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numbers. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to `$null` or an empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numbers. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to `$null` or an empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Microphone` objects as returned by `Get-VmsMicrophone`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-Vms -ShowDialog -AcceptEula Get-VmsHardware | Get-VmsMicrophone -Channel (1..63) -Verbose | Set-VmsMicrophone -Enabled $false</dev:code> <dev:remarks> <maml:para>In this example, we first ensure we are logged in to the Management Server. Then we gets all enabled microphones with a channel number between 1 and 63 (microphone 2 to microphone 64), and disable them. You might do this if you only use the first channel on every microphone, and all other channels should be disabled. In this case, channels higher than 63 would be unchanged. If you had devices with more unused channels than this, you could use "(1..511)" to select all microphones from the 2nd to the 512th channel.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsMicrophone PrebufferEnabled = $true PrebufferSeconds = 10 PrebufferInMemory = $true } Set-VmsMicrophone @splat</dev:code> <dev:remarks> <maml:para>Configure an in-memory prebuffer on all enabled microphones with a duration of 10 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsMicrophone -Name 'Office Entrance' Coordinates = '45.4171601197572, -122.732137977298' Direction = 90 FieldOfView = 180 Depth = 15 Verbose = $true } Set-VmsMicrophone @splat</dev:code> <dev:remarks> <maml:para>A hashtable named $splat is defined with all the parameters needed to change the GPS location, direction, field of view, and depth of field for the matching device(s) named "Office Entrance". The hashtable is then "splatted" into the cmdlet and because we included the Verbose switch, all changes made to the devices are logged to the console.</maml:para> <maml:para>Note that if the settings already matched these values, there would be nothing logged to the console because no changes had to be made.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-VmsMicrophone/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmsModuleConfig</command:name> <command:verb>Set</command:verb> <command:noun>VmsModuleConfig</command:noun> <maml:description> <maml:para>Used to change MilestonePSTools module settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-VmsModuleConfig` cmdlet is used to change MilestonePSTools module settings. The settings available include telemetry, debug logging, hardware acceleration behavior, and more.</maml:para> <maml:para>REQUIREMENTS - Does not require a VMS connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmsModuleConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableDebugLogging</maml:name> <maml:description> <maml:para>Specifies whether or not to log debug messages to `ProgramData\Milestone\MIPSDK`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableTelemetry</maml:name> <maml:description> <maml:para>Specifies whether anonymous telemetry is sent to Azure Application Insights. See about_Telemetry (./about_Telemetry.md)for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LogTelemetry</maml:name> <maml:description> <maml:para>Specifies whether or not to log a JSON object representing all telemetry sent to Azure Application Insights. See about_Telemetry (./about_Telemetry.md)for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPoolSize</maml:name> <maml:description> <maml:para>Specifies how many WCF client proxies to create for each type. A value of two or more may improve performance for operations that are not limited by serialization of commands by the management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VmsModuleConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a modified version of the ModuleSettings object returned by `Get-VmsModuleConfig`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModuleSettings</command:parameterValue> <dev:type> <maml:name>ModuleSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableDebugLogging</maml:name> <maml:description> <maml:para>Specifies whether or not to log debug messages to `ProgramData\Milestone\MIPSDK`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableTelemetry</maml:name> <maml:description> <maml:para>Specifies whether anonymous telemetry is sent to Azure Application Insights. See about_Telemetry (./about_Telemetry.md)for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies a modified version of the ModuleSettings object returned by `Get-VmsModuleConfig`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModuleSettings</command:parameterValue> <dev:type> <maml:name>ModuleSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LogTelemetry</maml:name> <maml:description> <maml:para>Specifies whether or not to log a JSON object representing all telemetry sent to Azure Application Insights. See about_Telemetry (./about_Telemetry.md)for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyPoolSize</maml:name> <maml:description> <maml:para>Specifies how many WCF client proxies to create for each type. A value of two or more may improve performance for operations that are not limited by serialization of commands by the management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>MilestonePSTools.Models.ModuleSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VmsModuleConfig -EnableDebugLogging $false -EnableTelemetry $false</dev:code> <dev:remarks> <maml:para>Disable debug logging and telemetry.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-VmsModuleConfig/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_Telemetry</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmsOutput</command:name> <command:verb>Set</command:verb> <command:noun>VmsOutput</command:noun> <maml:description> <maml:para>Sets one or more configuration properties for the specified device(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Milestone's Configuration API to modify properties of devices and saves the changes to the Management Server. Most parameters represent the Milestone MIP SDK property names of the underlying devices. However, there are a few custom parameter names including "Coordinates", "Direction", "FieldOfView" and "Depth" which accept values that are easier to understand than the values expected by the MIP SDK.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmsOutput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Output` objects as returned by `Get-VmsOutput`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Metric</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imperial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Output` objects as returned by `Get-VmsOutput`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-Vms -ShowDialog -AcceptEula Get-VmsHardware | Get-VmsOutput -Channel (1..63) -Verbose | Set-VmsOutput -Enabled $false -Verbose</dev:code> <dev:remarks> <maml:para>In this example, we first ensure we are logged in to the Management Server. Then we gets all enabled outputs with a channel number between 1 and 63 (output 2 to output 64), and disable them. You might do this if you only use the first channel on every output, and all other channels should be disabled. In this case, channels higher than 63 would be unchanged. If you had devices with more unused channels than this, you could use "(1..511)" to select all outputs from the 2nd to the 512th channel.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsOutput -Name 'Office Entrance' Coordinates = '45.4171601197572, -122.732137977298' Direction = 90 FieldOfView = 180 Depth = 15 Verbose = $true } Set-VmsOutput @splat</dev:code> <dev:remarks> <maml:para>A hashtable named $splat is defined with all the parameters needed to change the GPS location, direction, field of view, and depth of field for the matching device(s) named "Office Entrance". The hashtable is then "splatted" into the cmdlet and because we included the Verbose switch, all changes made to the devices are logged to the console.</maml:para> <maml:para>Note that if the settings already matched these values, there would be nothing logged to the console because no changes had to be made.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-VmsOutput/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmsSpeaker</command:name> <command:verb>Set</command:verb> <command:noun>VmsSpeaker</command:noun> <maml:description> <maml:para>Sets one or more configuration properties for the specified device(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses Milestone's Configuration API to modify properties of devices and saves the changes to the Management Server. Most parameters represent the Milestone MIP SDK property names of the underlying devices. However, there are a few custom parameter names including "Coordinates", "Direction", "FieldOfView" and "Depth" which accept values that are easier to understand than the values expected by the MIP SDK.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmsSpeaker</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Speaker` objects as returned by `Get-VmsSpeaker`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Metric</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Imperial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Coordinates</maml:name> <maml:description> <maml:para>Specifies GPS coordinates in a "latitude, longitude" format where latitude and longitude are positive or negative numberic values with no alphabetic characters. For example, "45.4171601197572, -122.732137977298".</maml:para> <maml:para>To remove the coordinates from a device, you may set the value to $null or ''.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>CoverageDepth</maml:name> <maml:description> <maml:para>Specifies the depth of the device's field of view in meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>CoverageDirection</maml:name> <maml:description> <maml:para>Specifies the orientation of the device as a 360-degree compass bearing expressed as a value between 0 and 1. For example, a value of 0 represents North while a value of 0.5 represents South, and 0.75 represents West. You can produce the right value by dividing the compass heading value, such as 90 degrees (East), by 360, for a value of 0.25.</maml:para> <maml:para>Alternatively, you may choose to use the Direction parameter which allows for specifying a value in degrees between 0 and 360. If the Direction parameter is provided, it takes priority over CoverageDirection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>CoverageFieldOfView</maml:name> <maml:description> <maml:para>Specifies the angle of the field of view of the device in degrees, expressed as a value between 0 and 1. For example, a value of 0.25 represents 90 degrees and a value of 0.5 represents 180 degrees. You can produce the right value by dividing the field of view in degrees, by 360.</maml:para> <maml:para>Alternatively, you may choose to use the FieldOfView parameter which allows for specifying a value in degrees between 0 and 360. If the FieldOfView parameter is provided, it takes precedence over CoverageFieldOfView.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="12" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies the depth of the field of view, either in meters, or in feet, depending on the region settings of the environment in which PowerShell is running. If PowerShell is running on a PC in the United States, the value will usually be treated as a measurement in feet. In most other cases the value will be interpreted as meters. To override the regional default or explicitly include the units in your script, you may use the Units parameter.</maml:para> <maml:para>This parameter overrides the CoverageDepth parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the desired device description. This is visible in the Management Client and may be searchable in some clients or utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Direction</maml:name> <maml:description> <maml:para>Specifies the compass orientation of the device in degrees between 0 and 360. This parameter overrides the CoverageDirection parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="21" aliases="none"> <maml:name>EdgeStorageEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not edge storage should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="22" aliases="none"> <maml:name>EdgeStoragePlaybackEnabled</maml:name> <maml:description> <maml:para>Specifies that playback may or may not be done directly from edge storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies whether or not the device should be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>FieldOfView</maml:name> <maml:description> <maml:para>Specifies the field of view of the device in degrees between 0 and 360. This parameter overrides the CoverageFieldOfView parameter if that parameter is also provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>GisPoint</maml:name> <maml:description> <maml:para>Specifies the GPS coordinates of the device in a custom format. The value is accepted as a string in the format "POINT EMPTY" to "un-set" the coordinates, or "POINT (X Y [Z])" where the elevation field "Z" is optional and not usually provided, X represents the longitude, and Y represents the latitude. It's important to note that this format reverses the standard "latitude, longitude" order because it is expressed internally in Milestone as a "point" with X/Y coordinates.</maml:para> <maml:para>You may use the Coordinates parameter for a more user-friendly format for setting coordinates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="Camera, Microphone, Speaker, Metadata, InputEvent, Output"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more `Speaker` objects as returned by `Get-VmsSpeaker`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IConfigurationItem[]</command:parameterValue> <dev:type> <maml:name>IConfigurationItem[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="16" aliases="none"> <maml:name>ManualRecordingTimeoutEnabled</maml:name> <maml:description> <maml:para>Specifies that the timeout used to stop a manual recording session should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="17" aliases="none"> <maml:name>ManualRecordingTimeoutMinutes</maml:name> <maml:description> <maml:para>Specifies the maximum time the device can be recording due to a manual recording trigger.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="14" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies that the modified device object should be returned to the pipeline or caller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="18" aliases="none"> <maml:name>PrebufferEnabled</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="20" aliases="none"> <maml:name>PrebufferInMemory</maml:name> <maml:description> <maml:para>Specifies that the pre-buffer feature should pre-buffer to memory, or to disk. When PrebufferInMemory is set to $false, then the pre-buffer will reside on disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="19" aliases="none"> <maml:name>PrebufferSeconds</maml:name> <maml:description> <maml:para>Specifies the size of the pre-buffer in seconds. The maximum size for the pre-buffer is 15 seconds when pre-buffering to memory. When pre-buffering to disk, the maximum value is 10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="15" aliases="none"> <maml:name>RecordingEnabled</maml:name> <maml:description> <maml:para>Specifies whether or not recording is enabled for this device. When enabled, recording can be triggered manually from a client application or automatically based on the configured set of rules. When disabled, the device cannot be recorded, and any existing recordings cannot be played back.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ShortName</maml:name> <maml:description> <maml:para>Specifies the new short-name for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="13" aliases="none"> <maml:name>Units</maml:name> <maml:description> <maml:para>Specifies whether the unit of measurement provided in the Depth parameter is in feet or meters. By default, the value will be interpreted based on your PowerShell environment's region settings. Set Units to Metric to explicitly specify that the Depth value represents meters. Set it to Imperial to specify that the Depth value represents feet.</maml:para> <maml:para>This parameter does not affect the behavior of the CoverageDepth parameter. That value is always interpreted as meters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MeasurementSystem</command:parameterValue> <dev:type> <maml:name>MeasurementSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-Vms -ShowDialog -AcceptEula Get-VmsHardware | Get-VmsSpeaker -Channel (1..63) -Verbose | Set-VmsSpeaker -Enabled $false</dev:code> <dev:remarks> <maml:para>In this example, we first ensure we are logged in to the Management Server. Then we gets all enabled speakers with a channel number between 1 and 63 (speaker 2 to speaker 64), and disable them. You might do this if you only use the first channel on every speaker, and all other channels should be disabled. In this case, channels higher than 63 would be unchanged. If you had devices with more unused channels than this, you could use "(1..511)" to select all speakers from the 2nd to the 512th channel.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsSpeaker PrebufferEnabled = $true PrebufferSeconds = 10 PrebufferInMemory = $true } Set-VmsSpeaker @splat</dev:code> <dev:remarks> <maml:para>Configure an in-memory prebuffer on all enabled speakers with a duration of 10 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$splat = @{ InputObject = Get-VmsSpeaker -Name 'Office Entrance' Coordinates = '45.4171601197572, -122.732137977298' Direction = 90 FieldOfView = 180 Depth = 15 Verbose = $true } Set-VmsSpeaker @splat</dev:code> <dev:remarks> <maml:para>A hashtable named $splat is defined with all the parameters needed to change the GPS location, direction, field of view, and depth of field for the matching device(s) named "Office Entrance". The hashtable is then "splatted" into the cmdlet and because we included the Verbose switch, all changes made to the devices are logged to the console.</maml:para> <maml:para>Note that if the settings already matched these values, there would be nothing logged to the console because no changes had to be made.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Set-VmsSpeaker/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-Export</command:name> <command:verb>Start</command:verb> <command:noun>Export</command:noun> <maml:description> <maml:para>Starts exporting audio/video from specified devices in the specified format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command performs AVI, MKV and Database exports of video and audio. It can take a list of camera, microphone, and speaker device ID's, or it can receive an Evidence Lock object as pipeline input.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-Export</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AddSignature</maml:name> <maml:description> <maml:para>Add a digital signature to the database export which can help verify the authenticity of an export.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CameraIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more cameras using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end of the range of media to be exported. Timestamps will be parsed in the same way as StartTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLock</maml:name> <maml:description> <maml:para>Specifies the evidence lock record to use as a source for the camera and audio device ID's, start and end timestamps, and export name.</maml:para> <maml:para>Note 1: If -Name is not supplied, the Header value of the evidence lock will be used to specify the folder or file name where the export is stored.</maml:para> <maml:para>Note 2: If exporting in anything but DB format, only the first device will be exported, and the order is not guaranteed. As such it is recommended only to pipe Evidence Locks into this command when you know there is only one device in the evidence lock.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData</command:parameterValue> <dev:type> <maml:name>MarkedData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore communication errors with recording servers by removing any devices on unresponsive servers from the overall export and proceeding without error.</maml:para> <maml:para>Omitting this flag will result in a complete export failure in the event one or more devices cannot be reached due to a recording server not responding.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies the desired format for the export. AVI and MKV files can contain only one camera and only the first device supplied will be exported.</maml:para> <maml:para>Note: MKV will almost always be a better option than AVI. MKV exports are much faster, require fewer resources to produce, and have the best quality. AVI exports require transcoding from the original codec to a new codec. There will be loss of quality, high CPU resource utilization and the time required is substantially higher than either MKV or DB.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AVI</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MKV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DB</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MKV</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MicrophoneIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more microphones using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resulting AVI or MKV file, or the subfolder for the DB export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password to be used for encrypting and decrypting the database export when UseEncryption is specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the directory where the export will be placed. AVI and MKV's will be saved as a file in this directory while DB exports will be saved in a subfolder in this directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventReExport</maml:name> <maml:description> <maml:para>Disallow recipients of a database export from performing a new export of their own.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SpeakerIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more speakers using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start of the range of media to be exported. Time must always be interpreted internally as UTC, so if you supply an ambiguously formatted timestamp, it is likely to be interpreted as local time and will be adjusted to UTC.</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM local time - '2019-06-07 17:00:00'</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM local time - '2019-06-07 5:00:00 PM'</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM UTC time - '2019-06-07 17:00:00Z'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseEncryption</maml:name> <maml:description> <maml:para>Encrypt the Database export</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-Export</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CameraIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more cameras using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Codec</maml:name> <maml:description> <maml:para>Specifies the codec to use to encode video in an AVI export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end of the range of media to be exported. Timestamps will be parsed in the same way as StartTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLock</maml:name> <maml:description> <maml:para>Specifies the evidence lock record to use as a source for the camera and audio device ID's, start and end timestamps, and export name.</maml:para> <maml:para>Note 1: If -Name is not supplied, the Header value of the evidence lock will be used to specify the folder or file name where the export is stored.</maml:para> <maml:para>Note 2: If exporting in anything but DB format, only the first device will be exported, and the order is not guaranteed. As such it is recommended only to pipe Evidence Locks into this command when you know there is only one device in the evidence lock.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData</command:parameterValue> <dev:type> <maml:name>MarkedData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore communication errors with recording servers by removing any devices on unresponsive servers from the overall export and proceeding without error.</maml:para> <maml:para>Omitting this flag will result in a complete export failure in the event one or more devices cannot be reached due to a recording server not responding.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies the desired format for the export. AVI and MKV files can contain only one camera and only the first device supplied will be exported.</maml:para> <maml:para>Note: MKV will almost always be a better option than AVI. MKV exports are much faster, require fewer resources to produce, and have the best quality. AVI exports require transcoding from the original codec to a new codec. There will be loss of quality, high CPU resource utilization and the time required is substantially higher than either MKV or DB.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AVI</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MKV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DB</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MKV</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxAviSizeInBytes</maml:name> <maml:description> <maml:para>Some exports can be very large in size. AVI exports can be split into multiple files. Default MaxAviSizeInBytes is 512MB or 536870912 bytes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>536870912</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MicrophoneIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more microphones using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resulting AVI or MKV file, or the subfolder for the DB export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the directory where the export will be placed. AVI and MKV's will be saved as a file in this directory while DB exports will be saved in a subfolder in this directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SpeakerIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more speakers using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start of the range of media to be exported. Time must always be interpreted internally as UTC, so if you supply an ambiguously formatted timestamp, it is likely to be interpreted as local time and will be adjusted to UTC.</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM local time - '2019-06-07 17:00:00'</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM local time - '2019-06-07 5:00:00 PM'</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM UTC time - '2019-06-07 17:00:00Z'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AddSignature</maml:name> <maml:description> <maml:para>Add a digital signature to the database export which can help verify the authenticity of an export.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CameraIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more cameras using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Codec</maml:name> <maml:description> <maml:para>Specifies the codec to use to encode video in an AVI export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end of the range of media to be exported. Timestamps will be parsed in the same way as StartTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLock</maml:name> <maml:description> <maml:para>Specifies the evidence lock record to use as a source for the camera and audio device ID's, start and end timestamps, and export name.</maml:para> <maml:para>Note 1: If -Name is not supplied, the Header value of the evidence lock will be used to specify the folder or file name where the export is stored.</maml:para> <maml:para>Note 2: If exporting in anything but DB format, only the first device will be exported, and the order is not guaranteed. As such it is recommended only to pipe Evidence Locks into this command when you know there is only one device in the evidence lock.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData</command:parameterValue> <dev:type> <maml:name>MarkedData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore communication errors with recording servers by removing any devices on unresponsive servers from the overall export and proceeding without error.</maml:para> <maml:para>Omitting this flag will result in a complete export failure in the event one or more devices cannot be reached due to a recording server not responding.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Specifies the desired format for the export. AVI and MKV files can contain only one camera and only the first device supplied will be exported.</maml:para> <maml:para>Note: MKV will almost always be a better option than AVI. MKV exports are much faster, require fewer resources to produce, and have the best quality. AVI exports require transcoding from the original codec to a new codec. There will be loss of quality, high CPU resource utilization and the time required is substantially higher than either MKV or DB.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MKV</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxAviSizeInBytes</maml:name> <maml:description> <maml:para>Some exports can be very large in size. AVI exports can be split into multiple files. Default MaxAviSizeInBytes is 512MB or 536870912 bytes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>536870912</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MicrophoneIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more microphones using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resulting AVI or MKV file, or the subfolder for the DB export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password to be used for encrypting and decrypting the database export when UseEncryption is specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the directory where the export will be placed. AVI and MKV's will be saved as a file in this directory while DB exports will be saved in a subfolder in this directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventReExport</maml:name> <maml:description> <maml:para>Disallow recipients of a database export from performing a new export of their own.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SpeakerIds</maml:name> <maml:description> <maml:para>Specifies the ID of one or more speakers using the GUID-based identifier typical of objects in a Milestone configuration. Multiple IDs should be separated by a comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start of the range of media to be exported. Time must always be interpreted internally as UTC, so if you supply an ambiguously formatted timestamp, it is likely to be interpreted as local time and will be adjusted to UTC.</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM local time - '2019-06-07 17:00:00'</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM local time - '2019-06-07 5:00:00 PM'</maml:para> <maml:para>Example: This timestamp will be interpreted as 5PM UTC time - '2019-06-07 17:00:00Z'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseEncryption</maml:name> <maml:description> <maml:para>Encrypt the Database export</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> </dev:type> <maml:description> <maml:para>Specifies the evidence lock record to use as a source for the camera and audio device ID's, start and end timestamps, and export name.</maml:para> <maml:para>Note 1: If -Name is not supplied, the Header value of the evidence lock will be used to specify the folder or file name where the export is stored.</maml:para> <maml:para>Note 2: If exporting in anything but DB format, only the first device will be exported, and the order is not guaranteed. As such it is recommended only to pipe Evidence Locks into this command when you know there is only one device in the evidence lock.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Start-Export -CameraIds $id -Format DB -StartTime '2019-06-04 14:00:00' -EndTime '2019-06-04 14:15:00' -Path C:\Exports -Name Sample</dev:code> <dev:remarks> <maml:para>Exports 15 minutes of video from camera with ID $id in the native Milestone Database format, starting at 2:15 PM local time, and saving to a folder at C:\Exports\Sample.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Start-Export/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-Playback</command:name> <command:verb>Test</command:verb> <command:noun>Playback</command:noun> <maml:description> <maml:para>Tests whether the recording server has recordings at, before, or after the given DateTime.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Test-Playback` cmdlet tests whether the recording server has recordings at, before, or after the given DateTime.</maml:para> <maml:para>Recordings in a Milestone XProtect VMS are stored with UTC timestamps, so the provided DateTime object will be converted to UTC if the Kind property on the specified timestamp is either "Local" or "Unspecified".</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-Playback</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>{{ Fill Camera Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CameraId</maml:name> <maml:description> <maml:para>{{ Fill CameraId Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mode</maml:name> <maml:description> <maml:para>{{ Fill Mode Description }}</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Forward</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Reverse</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Any</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>{{ Fill Timestamp Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Camera</maml:name> <maml:description> <maml:para>{{ Fill Camera Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Camera</command:parameterValue> <dev:type> <maml:name>Camera</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CameraId</maml:name> <maml:description> <maml:para>{{ Fill CameraId Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mode</maml:name> <maml:description> <maml:para>{{ Fill Mode Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timestamp</maml:name> <maml:description> <maml:para>{{ Fill Timestamp Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmsCamera | Where-Object { ($_ | Test-Playback -Timestamp (Get-Date).AddDays(-30) -Mode Reverse) -eq $false }</dev:code> <dev:remarks> <maml:para>Returns a list of cameras without recordings older than 30 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmsCamera | Where-Object { $false -eq ($_ | Test-Playback -Mode Any -Timestamp (Get-Date)) }</dev:code> <dev:remarks> <maml:para>Returns a list of cameras without any available recordings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------------------------- Camera ----------------------------</maml:title> <dev:code>Type: Camera Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------------------- CameraId ---------------------------</maml:title> <dev:code>Type: Guid Parameter Sets: (All) Aliases: Required: False Position: Named Default value: 00000000-0000-0000-0000-000000000000 Accept pipeline input: False Accept wildcard characters: False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------------------- Mode -----------------------------</maml:title> <dev:code>Type: String Parameter Sets: (All) Aliases: Accepted values: Forward, Reverse, Any Required: False Position: Named Default value: Any Accept pipeline input: False Accept wildcard characters: False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Timestamp --------------------------</maml:title> <dev:code>Type: DateTime Parameter Sets: (All) Aliases: Required: False Position: Named Default value: 1/1/0001 12:00:00 AM Accept pipeline input: False Accept wildcard characters: False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------------- CommonParameters -----------------------</maml:title> <dev:code></dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Test-Playback/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>VideoOS.Platform.Data.RawVideoSource.GoToWithResult()</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html?base=miphelp/class_video_o_s_1_1_platform_1_1_data_1_1_raw_video_source.html%23ab2f2ee15190d0bc8fa1ab7c16700b79d</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Trace-Events</command:name> <command:verb>Trace</command:verb> <command:noun>Events</command:noun> <maml:description> <maml:para>Subscribes to Milestone events from the Event Server</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Subscribes to events from the Event Server. By default only MessageId.Server.NewEventsIndication events are subscribed to, but you can either manually supply your own MessageId's in the Message parameter or you can use the built-in switches to include configuration changes and failover event messages.</maml:para> <maml:para>Events are transposed to a more PowerShell-friendly shape by default but with the -Raw switch you can get the original event objects which will have far more detail. For example, you can dig in to analytic events to retrieve information like plate # and confidence value.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Trace-Events</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EventHeaderMessage</maml:name> <maml:description> <maml:para>Filter the NewEventIndication messages to include only those with the a message value matching a specific value. Only valid if EventHeaderType is null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EventHeaderType</maml:name> <maml:description> <maml:para>Filter the NewEventIndication messages to include only those with the designated Event Header Type.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Access Control System Event</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LPR Event</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LPR Server Event</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LPR Video Source Event</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">System Alarm</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">System Event</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MAD</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeNewEventsIndication</maml:name> <maml:description> <maml:para>Specifies that you wish not to see NewEventsIndication messages. Use this if you're looking for more specific events and you know the MessageId for those events</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeConfigurationChanged</maml:name> <maml:description> <maml:para>Specifies that you wish to receive events sent about configuration changes</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeFailover</maml:name> <maml:description> <maml:para>Specifies that you wish to receive events sent about Recording Server failovers</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxEvents</maml:name> <maml:description> <maml:para>Specifies that you want to stop listening for events after a given number of events have been received. If the value is less than 1, there will be no limit imposed and you may need to interrupt the trace manually to stop it with CTRL+C</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxInterEventDelay</maml:name> <maml:description> <maml:para>Specifies a TimeSpan to wait between events before stopping the trace. There is no limit by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Optional user-defined MessageId values to register a listener for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that you want to receive an unaltered copy of the event indications from the Event Server. The event will be wrapped in a MessageQueueMessage object which contains the Message and a datetime value named TimeReceived which represents the time the message was received in this PowerShell session. The TimeReceived may be a few seconds older than the time the event is written to the pipeline since there may be some event queuing in the local session depending on how long your event post-processing takes.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies that you want to listen for events for a limited time. There is no Timeout by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TraceAllSites</maml:name> <maml:description> <maml:para>Specifies that you want to listen for events from all sites in a Milestone Federated Hierarchy.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EventHeaderMessage</maml:name> <maml:description> <maml:para>Filter the NewEventIndication messages to include only those with the a message value matching a specific value. Only valid if EventHeaderType is null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EventHeaderType</maml:name> <maml:description> <maml:para>Filter the NewEventIndication messages to include only those with the designated Event Header Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExcludeNewEventsIndication</maml:name> <maml:description> <maml:para>Specifies that you wish not to see NewEventsIndication messages. Use this if you're looking for more specific events and you know the MessageId for those events</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeConfigurationChanged</maml:name> <maml:description> <maml:para>Specifies that you wish to receive events sent about configuration changes</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeFailover</maml:name> <maml:description> <maml:para>Specifies that you wish to receive events sent about Recording Server failovers</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxEvents</maml:name> <maml:description> <maml:para>Specifies that you want to stop listening for events after a given number of events have been received. If the value is less than 1, there will be no limit imposed and you may need to interrupt the trace manually to stop it with CTRL+C</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxInterEventDelay</maml:name> <maml:description> <maml:para>Specifies a TimeSpan to wait between events before stopping the trace. There is no limit by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Optional user-defined MessageId values to register a listener for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Specifies that you want to receive an unaltered copy of the event indications from the Event Server. The event will be wrapped in a MessageQueueMessage object which contains the Message and a datetime value named TimeReceived which represents the time the message was received in this PowerShell session. The TimeReceived may be a few seconds older than the time the event is written to the pipeline since there may be some event queuing in the local session depending on how long your event post-processing takes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies that you want to listen for events for a limited time. There is no Timeout by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TraceAllSites</maml:name> <maml:description> <maml:para>Specifies that you want to listen for events from all sites in a Milestone Federated Hierarchy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>MilestonePSTools.EventCommands.TraceEventsMessage</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Trace-Events -MaxEvents 10 -Timeout (New-Timespan -Seconds 60)</dev:code> <dev:remarks> <maml:para>Captures up to 10 events and times out after 60 seconds if less than 10 events are received.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Trace-Events/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AlarmLine</command:name> <command:verb>Update</command:verb> <command:noun>AlarmLine</command:noun> <maml:description> <maml:para>Updates the provided properties on the alarm matching the given id.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Useful for automatically updating the state or other properties of alarms.</maml:para> <maml:para>Following are the valid keys for the Updates hashtable: - "AssignedTo" - "Comment" - "Priority" - "PriorityInt" - "PriorityName" - "ReasonCode" - "State" - "StateInt" - "StateName"</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AlarmLine</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specifies the user to which the alarm should now be assigned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the new priority of the alarm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the new state of the alarm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>The text associated with this update which will be shown as a comment in the Alarm history.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-AlarmLine</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Updates</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be updated.</maml:para> <maml:para>Valid property names are listed in the cmdlet description but no validation is performed before sending the request to the Event Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specifies the user to which the alarm should now be assigned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the new priority of the alarm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the new state of the alarm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>The text associated with this update which will be shown as a comment in the Alarm history.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Updates</maml:name> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be updated.</maml:para> <maml:para>Valid property names are listed in the cmdlet description but no validation is performed before sending the request to the Event Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid[]</maml:name> </dev:type> <maml:description> <maml:para>Specifies the Guid of a single AlarmLine entry to be updated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$c1 = New-AlarmCondition -Target State -Operator NotEquals -Value 11 Get-AlarmLine -Conditions $c1 | Update-AlarmLine -Updates @{ StateName = 'Closed'; StateInt = '11' }</dev:code> <dev:remarks> <maml:para>Get all alarms which are not marked as closed, and close them by updating their state</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$c1 = New-AlarmCondition -Target Message -Operator Contains -Value "Tailgating" Get-AlarmLine -Conditions $c1 | Update-AlarmLine -Text "Investigation completed" -State 11</dev:code> <dev:remarks> <maml:para>Get's alarms with a message containing the word 'Tailgating' and closes them with the comment 'Investigation completed'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Update-AlarmLine/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-Bookmark</command:name> <command:verb>Update</command:verb> <command:noun>Bookmark</command:noun> <maml:description> <maml:para>Updates the properties of a bookmark</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates a bookmark in the VMS by pushing changes to the bookmark object up to the Management Server.</maml:para> <maml:para>The expected workflow is that a bookmark is retrieved using Get-Bookmark. Then properties of the local bookmark object are changed as desired. Finally the modified local bookmark object is used to update the record on the Management Server by piping it to this cmdlet.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-Bookmark</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bookmark</command:parameterValue> <dev:type> <maml:name>Bookmark</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Bookmark</command:parameterValue> <dev:type> <maml:name>Bookmark</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> </dev:type> <maml:description> <maml:para>Specifies the bookmark object to be updated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Bookmark -Timestamp '2019-06-04 14:00:00' -Minutes 120 | ForEach-Object { $_.Description = 'Testing'; $_ | Update-Bookmark }</dev:code> <dev:remarks> <maml:para>Gets all bookmarks for any device where the bookmark time is between 2PM and 4PM local time on the 4th of June, changes the Description to 'Testing', and sends the updated bookmark to the Management Server.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Update-Bookmark/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-EvidenceLock</command:name> <command:verb>Update</command:verb> <command:noun>EvidenceLock</command:noun> <maml:description> <maml:para>Updates an evidence lock entry with the changes made to an evidence lock object in the local PowerShell session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Update-EvidenceLock` cmdlet updates an evidence lock entry with the changes made to an evidence lock object in the local PowerShell session.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> <maml:para>- Requires VMS feature "EvidenceLock"</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-EvidenceLock</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLock</maml:name> <maml:description> <maml:para>Specifies an object retrieved using `Get-EvidenceLock` which has changes to be sent to the Management Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData</command:parameterValue> <dev:type> <maml:name>MarkedData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>EvidenceLock</maml:name> <maml:description> <maml:para>Specifies an object retrieved using `Get-EvidenceLock` which has changes to be sent to the Management Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MarkedData</command:parameterValue> <dev:type> <maml:name>MarkedData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$lock = Get-EvidenceLock -SearchText 'Case 1234 - Test Evidence Lock' $lock.RetentionOption.RetentionOptionType = 'Months' $lock.RetentionOption.RetentionUnits = 1 $lock | Update-EvidenceLock</dev:code> <dev:remarks> <maml:para>Locate evidence locks with the text "Case 1234 - Test Evidence Lock" in the header or description, and update the retention time to "1 Month" assuming the "1 Month" duration is present in the Evidence Lock profile settings in Management Client found in Tools > Options > Evidence Lock.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$lock = Get-EvidenceLock -DeviceIds 3D9DD26B-9A48-43D2-BFEA-3FEB6E8CD2EE $lock.DeviceIds = $lock.DeviceIds | Where-Object { $_ -ne '3D9DD26B-9A48-43D2-BFEA-3FEB6E8CD2EE' } if ($lock.DeviceIds.Count -eq 0) { $lock | Remove-EvidenceLock -Force } else { $lock | Update-EvidenceLock }</dev:code> <dev:remarks> <maml:para>Locate all evidence locks with the device id "3D9DD26B-9A48-43D2-BFEA-3FEB6E8CD2EE" in the list of associated devices, and either removes the device from the evidence lock, or deletes the evidence lock if it was the only device in the evidence lock entry.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Update-EvidenceLock/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-RegisteredService</command:name> <command:verb>Update</command:verb> <command:noun>RegisteredService</command:noun> <maml:description> <maml:para>Updates Registered Service properties by sending the changes to the Management Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Update-RegisteredService` cmdlet updates Registered Service properties by sending the modified RegisteredService object's properties to the Management Server.</maml:para> <maml:para>REQUIREMENTS - Requires VMS connection and will attempt to connect automatically</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RegisteredService</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RegisteredService</maml:name> <maml:description> <maml:para>Specifies a registered service object provided by the `Get-RegisteredService` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>ServiceURIInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VideoOS.Platform.Configuration+ServiceURIInfo</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>RegisteredService</maml:name> <maml:description> <maml:para>Specifies a registered service object provided by the `Get-RegisteredService` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>ServiceURIInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VideoOS.Platform.Configuration+ServiceURIInfo</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$logServer = Get-RegisteredService -ServiceType 3d6f1153-92ad-43f1-b467-9482ffd291b2 $logServer.UriArray.Clear() $logServer.UriArray.Add('http://MyLogServer:22337/LogServer/') $logServer | Update-RegisteredService</dev:code> <dev:remarks> <maml:para>Get the log server registered service, if available, and set the uri to "http://mylogserver:22337/LogServer/".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://www.milestonepstools.com/commands/en-US/Update-RegisteredService/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |