lib/MilestonePSTools.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: New-Alarm --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-Alarm</maml:name> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the alarm message</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools Default Alarm Message</dev:defaultValue> </command:parameter> <!-- Parameter: CustomTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the detailed description of the alarm. This appears in the Smart Client under the alarm's Instructions field.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Item[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Item[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Source --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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-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">Item</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: Vendor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the alarm message</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools Default Alarm Message</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the detailed description of the alarm. This appears in the Smart Client under the alarm's Instructions field.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CustomTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Source --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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-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">Item</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Item[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Item[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Vendor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MilestonePSTools</dev:defaultValue> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.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> <!-- OutputType: Alarm --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.Alarm</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $cameraItem = Get-Camera -Id 948aa6a2-9a46-4c4c-8279-af0485428d75 | Get-PlatformItem PS C:\> $alarm = New-Alarm -Message "Important Alarm Message" -Source $cameraItem PS C:\> $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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Send-Alarm --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Send-Alarm</maml:name> <!-- Parameter: Alarm --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">Alarm</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Data.Alarm</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Alarm --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">Alarm</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Data.Alarm</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $cameraItem = Get-Camera -Id 948aa6a2-9a46-4c4c-8279-af0485428d75 | Get-PlatformItem PS C:\> $alarm = New-Alarm -Message "Important Alarm Message" -Source $cameraItem PS C:\> $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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-AlarmCondition --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-AlarmCondition</maml:name> <!-- Parameter: Operator --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Equals</dev:defaultValue> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Operator --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Equals</dev:defaultValue> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Condition --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Condition</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>$condition = New-AlarmCondition -Operator NotEquals -Target StateName -Value Closed</dev:code> <dev:remarks> <maml:para>Creates a condition which will ensure only alarms which are not closed will be returned.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-AlarmDefinition --> <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"> <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-ManagementServer).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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-AlarmDefinition</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: AlarmDefinition --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.AlarmDefinition</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS>$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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-AlarmLine --> <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"> <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:description> <command:syntax> <!-- Parameter set: Get --> <command:syntaxItem> <maml:name>Get-AlarmLine</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: GetAlarmLines --> <command:syntaxItem> <maml:name>Get-AlarmLine</maml:name> <!-- Parameter: Conditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Condition[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Condition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <!-- Parameter: SinglePage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SortOrders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">OrderBy[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.OrderBy[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartAt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Conditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Condition[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Condition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SortOrders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">OrderBy[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.OrderBy[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartAt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <!-- Parameter: SinglePage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </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> <!-- OutputType: AlarmLine --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.AlarmLine</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $c1 = New-AlarmCondition -Operator GreaterThan -Target Timestamp -Value (Get-Date).Date.AddDays(-1).ToUniversalTime() PS C:\> $c2 = New-AlarmCondition -Operator LessThan -Target Timestamp -Value (Get-Date).Date.ToUniversalTime() PS C:\> $order = New-AlarmOrder -Order Descending -Target Timestamp PS C:\> Get-AlarmLine -Conditions $c1,$c2 -SortOrders $order | Select 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-AlarmLine --> <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"> <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:description> <command:syntax> <!-- Parameter set: UpdateAlarmValues --> <command:syntaxItem> <maml:name>Update-AlarmLine</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Updates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateAlarm --> <command:syntaxItem> <maml:name>Update-AlarmLine</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Text --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AssignedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the new priority of the alarm.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the new state of the alarm.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Updates --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Text --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the new state of the alarm.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the new priority of the alarm.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: AssignedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Pass the alarm object back into the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $c1 = New-AlarmCondition -Target State -Operator NotEquals -Value 11 PS C:\> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $c1 = New-AlarmCondition -Target Message -Operator Contains -Value "Tailgating" PS C:\> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-AlarmOrder --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-AlarmOrder</maml:name> <!-- Parameter: Order --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ascending</dev:defaultValue> </command:parameter> <!-- Parameter: Target --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Timestamp</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Order --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ascending</dev:defaultValue> </command:parameter> <!-- Parameter: Target --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Timestamp</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: OrderBy --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.OrderBy</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>$order = New-AlarmOrder -Order Descending -Target SourceName</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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-AlarmStatistics --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-AlarmStatistics</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: Statistic[] --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Statistic[]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Add-Bookmark --> <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"> <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 Smart Client and any other integration using the timeline UI component.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-Bookmark</maml:name> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: MarginSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: Reference --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Header --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created 2021-08-18 23:10:32.235Z</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created by MilestonePSTools</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: MarginSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: Reference --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Header --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created 2021-08-18 23:10:32.236Z</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Created by MilestonePSTools</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bookmark --> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS>Get-Hardware | Get-Camera | ? Name -Like '*Elevator*' | % { Add-Bookmark -DeviceId $_.Id -Timestamp '2019-06-04 14:00:00' -Header 'Vandalism' }</dev:code> <dev:remarks> <maml:para>Find all 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Bookmark --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Bookmark</maml:name> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <!-- Parameter: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Users --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <!-- Parameter: Users --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bookmark --> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-Bookmark --> <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"> <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:description> <command:syntax> <!-- Parameter set: FromBookmark --> <command:syntaxItem> <maml:name>Remove-Bookmark</maml:name> <!-- Parameter: Bookmark --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">Bookmark</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromId --> <command:syntaxItem> <maml:name>Remove-Bookmark</maml:name> <!-- Parameter: BookmarkId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bookmark --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">Bookmark</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BookmarkId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.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> <maml:uri /> </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> <maml:uri /> </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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-Bookmark --> <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"> <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:description> <command:syntax> <!-- Parameter set: FromBookmark --> <command:syntaxItem> <maml:name>Update-Bookmark</maml:name> <!-- Parameter: Bookmark --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be updated.</maml:para> </maml:description> <command:parameterValue required="true">Bookmark</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bookmark --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Bookmark</maml:name> <maml:description> <maml:para>Specifies the bookmark object to be updated.</maml:para> </maml:description> <command:parameterValue required="true">Bookmark</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.Bookmark</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the bookmark object to be updated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Get-Bookmark -Timestamp '2019-06-04 14:00:00' -Minutes 120 | % { $_.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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Camera --> <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"> <command:details> <command:name>Get-Camera</command:name> <command:verb>Get</command:verb> <command:noun>Camera</command:noun> </command:details> <command:syntax> <!-- Parameter set: GetAll --> <command:syntaxItem> <maml:name>Get-Camera</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByChannel --> <command:syntaxItem> <maml:name>Get-Camera</maml:name> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Camera</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-Camera</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Camera --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-CameraSetting --> <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"> <command:details> <command:name>Get-CameraSetting</command:name> <command:verb>Get</command:verb> <command:noun>CameraSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Get-CameraSetting</maml:name> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueTypeInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueTypeInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Get-CameraSetting</maml:name> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueTypeInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueTypeInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueTypeInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueTypeInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-CameraSetting --> <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"> <command:details> <command:name>Set-CameraSetting</command:name> <command:verb>Set</command:verb> <command:noun>CameraSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Set-CameraSetting</maml:name> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Set-CameraSetting</maml:name> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-ConfigurationItem --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ConfigurationItem</maml:name> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChildItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ConfigurationItem --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ItemType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ParentItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Sort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sort</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConfigurationItem --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ItemType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChildItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ParentItem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Sort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sort</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </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> <maml:uri /> </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> <maml:uri /> </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> <maml:uri /> </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> <!-- OutputType: ConfigurationItem --> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> $ms = Get-ConfigurationItem -Path "/"; $name = $ms.Properties[0] | Where-Object Key -eq "Name"; $name = "New Name"; $ms | Set-ConfigurationItem</dev:code> <dev:remarks> <maml:para>Changes the Name property of the Management Server</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <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> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ConfigurationItem --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ConfigurationItem</maml:name> <!-- Parameter: ConfigurationItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConfigurationItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </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> <!-- OutputType: ValidateResult --> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ValidateResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> $ms = Get-ConfigurationItem -Path "/"; $name = $ms.Properties[0] | Where-Object Key -eq "Name"; $name = "New Name"; $ms | Set-ConfigurationItem</dev:code> <dev:remarks> <maml:para>Changes the Name property of the Management Server</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <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> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ConnectionString --> <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"> <command:details> <command:name>Get-ConnectionString</command:name> <command:verb>Get</command:verb> <command:noun>ConnectionString</command:noun> <maml:description> <maml:para>Gets the Management Server's SQL connection string from the registry.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ConnectionString cmdlet gets the Connectionstring value from HKEY_LOCAL_MACHINE\SOFTWARE\VideoOS\Server\Common.</maml:para> <maml:para>This cmdlet is not required or used by any other cmdlet in MilestonePSTools and is purely a convenience command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ConnectionString</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Get-ConnectionString</dev:code> <dev:remarks> <maml:para>Gets the current Connectionstring value used by the Management Server service and outputs a string.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DeviceAcl --> <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"> <command:details> <command:name>Get-DeviceAcl</command:name> <command:verb>Get</command:verb> <command:noun>DeviceAcl</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromCamera --> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromMicrophone --> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromSpeaker --> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromInput --> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromOutput --> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromMetadata --> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromHardware --> <command:syntaxItem> <maml:name>Get-DeviceAcl</maml:name> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceAcl --> <command:returnValue> <dev:type> <maml:name>MilestoneLib.DeviceAcl</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-DeviceAcl --> <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"> <command:details> <command:name>Set-DeviceAcl</command:name> <command:verb>Set</command:verb> <command:noun>DeviceAcl</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-DeviceAcl</maml:name> <!-- Parameter: DeviceAcl --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DeviceAcl</maml:name> <command:parameterValue required="true">DeviceAcl</command:parameterValue> <dev:type> <maml:name>MilestoneLib.DeviceAcl</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceAcl --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DeviceAcl</maml:name> <command:parameterValue required="true">DeviceAcl</command:parameterValue> <dev:type> <maml:name>MilestoneLib.DeviceAcl</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>MilestoneLib.DeviceAcl</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Add-DeviceGroup --> <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"> <command:details> <command:name>Add-DeviceGroup</command:name> <command:verb>Add</command:verb> <command:noun>DeviceGroup</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-DeviceGroup</maml:name> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-DeviceGroup --> <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"> <command:details> <command:name>Get-DeviceGroup</command:name> <command:verb>Get</command:verb> <command:noun>DeviceGroup</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DeviceGroup</maml:name> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Remove-DeviceGroup --> <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"> <command:details> <command:name>Remove-DeviceGroup</command:name> <command:verb>Remove</command:verb> <command:noun>DeviceGroup</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-DeviceGroup</maml:name> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Add-DeviceGroupMember --> <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"> <command:details> <command:name>Add-DeviceGroupMember</command:name> <command:verb>Add</command:verb> <command:noun>DeviceGroupMember</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromPipeline --> <command:syntaxItem> <maml:name>Add-DeviceGroupMember</maml:name> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceGroup --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DeviceGroup</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeviceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Device --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Device</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromPath --> <command:syntaxItem> <maml:name>Add-DeviceGroupMember</maml:name> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeviceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Device --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Device</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceGroup --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DeviceGroup</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceCategory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DeviceCategory</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeviceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Device --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Device</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-EventLine --> <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"> <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:description> <command:syntax> <!-- Parameter set: Get --> <command:syntaxItem> <maml:name>Get-EventLine</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: GetEventLines --> <command:syntaxItem> <maml:name>Get-EventLine</maml:name> <!-- Parameter: Conditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Condition[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Condition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <!-- Parameter: SinglePage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SortOrders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">OrderBy[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.OrderBy[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartAt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Conditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Condition[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.Condition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SortOrders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">OrderBy[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.OrderBy[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartAt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <!-- Parameter: SinglePage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </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> <!-- OutputType: EventLine --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.Alarm.EventLine</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $c = New-AlarmCondition -Target Timestamp -Operator GreaterThan -Value (Get-Date).Date.ToUniversalTime() PS C:\> $order = New-AlarmOrder -Order Descending -Target Timestamp PS C:\> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Trace-Events --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Trace-Events</maml:name> <!-- Parameter: EventHeaderMessage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventHeaderType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeNewEventsIndication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeConfigurationChanged --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeFailover --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxEvents --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: MaxInterEventDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> <!-- Parameter: TraceAllSites --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventHeaderType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventHeaderMessage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeConfigurationChanged --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeFailover --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeNewEventsIndication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TraceAllSites --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxEvents --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> <!-- Parameter: MaxInterEventDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-00:00:00.0010000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: TraceEventsMessage --> <command:returnValue> <dev:type> <maml:name>MilestonePSTools.EventCommands.TraceEventsMessage</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-EvidenceLock --> <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"> <command:details> <command:name>Add-EvidenceLock</command:name> <command:verb>Add</command:verb> <command:noun>EvidenceLock</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-EvidenceLock</maml:name> <!-- Parameter: FootageFrom --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: FootageTo --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Header --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Header</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CameraIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpireDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpireDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeRelatedDevices --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeRelatedDevices</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RetentionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetentionType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Header --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Header</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CameraIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeRelatedDevices --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeRelatedDevices</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: FootageFrom --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: FootageTo --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ExpireDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpireDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RetentionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetentionType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: MarkedDataResult --> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedDataResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Copy-EvidenceLock --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-EvidenceLock</maml:name> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <command:parameterValue required="true">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <command:parameterValue required="true">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: MarkedDataResult --> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedDataResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>$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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-EvidenceLock --> <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"> <command:details> <command:name>Get-EvidenceLock</command:name> <command:verb>Get</command:verb> <command:noun>EvidenceLock</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-EvidenceLock</maml:name> <!-- Parameter: CreatedFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: CreatedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpireFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpireFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ExpireTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpireTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: FootageFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: FootageTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageSize</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <!-- Parameter: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchText</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SortBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortBy</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CreateTime</dev:defaultValue> </command:parameter> <!-- Parameter: SortDecending --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortDecending</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Users --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DeviceIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceIds</maml:name> <command:parameterValue required="true">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchText</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Users --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Users</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreatedFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: CreatedTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreatedTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: FootageFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: FootageTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FootageTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: ExpireFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpireFrom</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ExpireTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExpireTo</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageSize</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <!-- Parameter: SortBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortBy</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CreateTime</dev:defaultValue> </command:parameter> <!-- Parameter: SortDecending --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortDecending</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: MarkedData --> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-EvidenceLock --> <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"> <command:details> <command:name>Remove-EvidenceLock</command:name> <command:verb>Remove</command:verb> <command:noun>EvidenceLock</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromMarkedData --> <command:syntaxItem> <maml:name>Remove-EvidenceLock</maml:name> <!-- Parameter: EvidenceLocks --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>EvidenceLocks</maml:name> <command:parameterValue required="true">MarkedData[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Required in order to remove evidence locks due to the possible loss of sensitive recordings if used by mistake</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromId --> <command:syntaxItem> <maml:name>Remove-EvidenceLock</maml:name> <!-- Parameter: EvidenceLockIds --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>EvidenceLockIds</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Required in order to remove evidence locks due to the possible loss of sensitive recordings if used by mistake</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: EvidenceLocks --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>EvidenceLocks</maml:name> <command:parameterValue required="true">MarkedData[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EvidenceLockIds --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>EvidenceLockIds</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Required in order to remove evidence locks due to the possible loss of sensitive recordings if used by mistake</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Update-EvidenceLock --> <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"> <command:details> <command:name>Update-EvidenceLock</command:name> <command:verb>Update</command:verb> <command:noun>EvidenceLock</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromMarkedData --> <command:syntaxItem> <maml:name>Update-EvidenceLock</maml:name> <!-- Parameter: EvidenceLock --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>EvidenceLock</maml:name> <command:parameterValue required="true">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: EvidenceLock --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>EvidenceLock</maml:name> <command:parameterValue required="true">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Start-Export --> <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"> <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:description> <command:syntax> <!-- Parameter set: AVI --> <command:syntaxItem> <maml:name>Start-Export</maml:name> <!-- Parameter: CameraIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Codec --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EvidenceLock --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MKV</dev:defaultValue> </command:parameter> <!-- Parameter: MaxAviSizeInBytes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>536870912</dev:defaultValue> </command:parameter> <!-- Parameter: MicrophoneIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\</dev:defaultValue> </command:parameter> <!-- Parameter: SpeakerIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: DB --> <command:syntaxItem> <maml:name>Start-Export</maml:name> <!-- Parameter: AddSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CameraIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EvidenceLock --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MKV</dev:defaultValue> </command:parameter> <!-- Parameter: MicrophoneIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\</dev:defaultValue> </command:parameter> <!-- Parameter: PreventReExport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SpeakerIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: UseEncryption --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseEncryption</maml:name> <maml:description> <maml:para>Encrypt the Database export</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: MKV --> <command:syntaxItem> <maml:name>Start-Export</maml:name> <!-- Parameter: CameraIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EvidenceLock --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MKV</dev:defaultValue> </command:parameter> <!-- Parameter: MicrophoneIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\</dev:defaultValue> </command:parameter> <!-- Parameter: SpeakerIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.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> <!-- Parameter: EvidenceLock --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">MarkedData</command:parameterValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MicrophoneIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SpeakerIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">Guid[]</command:parameterValue> <dev:type> <maml:name>System.Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MKV</dev:defaultValue> </command:parameter> <!-- Parameter: UseEncryption --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseEncryption</maml:name> <maml:description> <maml:para>Encrypt the Database export</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreventReExport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Codec --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxAviSizeInBytes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>536870912</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.MarkedData</maml:name> <maml:uri /> </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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-GenericEvent --> <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"> <command:details> <command:name>Add-GenericEvent</command:name> <command:verb>Add</command:verb> <command:noun>GenericEvent</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-GenericEvent</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expression --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Expression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpressionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExpressionType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Search</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Priority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: DataSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DataSourceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expression --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Expression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpressionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExpressionType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Search</dev:defaultValue> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Priority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: DataSourceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DataSourceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: GenericEvent --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-GenericEvent --> <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"> <command:details> <command:name>Get-GenericEvent</command:name> <command:verb>Get</command:verb> <command:noun>GenericEvent</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GenericEvent</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: GenericEvent --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-GenericEvent --> <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"> <command:details> <command:name>Remove-GenericEvent</command:name> <command:verb>Remove</command:verb> <command:noun>GenericEvent</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GenericEvent</maml:name> <!-- Parameter: GenericEvent --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>GenericEvent</maml:name> <command:parameterValue required="true">GenericEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GenericEvent --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>GenericEvent</maml:name> <command:parameterValue required="true">GenericEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Id</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEvent</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Send-GenericEvent --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Send-GenericEvent</maml:name> <!-- Parameter: EventString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataSourceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <!-- Parameter: DataSource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">GenericEventDataSource</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEventDataSource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DataSource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">GenericEventDataSource</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEventDataSource</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataSourceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GenericEventDataSource --> <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"> <command:details> <command:name>Get-GenericEventDataSource</command:name> <command:verb>Get</command:verb> <command:noun>GenericEventDataSource</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GenericEventDataSource</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: GenericEventDataSource --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.GenericEventDataSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Add-Hardware --> <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"> <command:details> <command:name>Add-Hardware</command:name> <command:verb>Add</command:verb> <command:noun>Hardware</command:noun> </command:details> <command:syntax> <!-- Parameter set: RecorderFromPipeline --> <command:syntaxItem> <maml:name>Add-Hardware</maml:name> <!-- Parameter: RecordingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>RecordingServer</maml:name> <command:parameterValue required="true">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DriverId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DriverId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableAllCameras --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAllCameras</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Enabled</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: GroupPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>/New Cameras</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: SkipConfiguration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipConfiguration</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseDefaultCredentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultCredentials</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: RecorderFromId --> <command:syntaxItem> <maml:name>Add-Hardware</maml:name> <!-- Parameter: RecorderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>RecorderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DriverId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DriverId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableAllCameras --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAllCameras</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Enabled</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: GroupPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>/New Cameras</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: SkipConfiguration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipConfiguration</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseDefaultCredentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultCredentials</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RecordingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>RecordingServer</maml:name> <command:parameterValue required="true">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RecorderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>RecorderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: UseDefaultCredentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultCredentials</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: GroupPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>/New Cameras</dev:defaultValue> </command:parameter> <!-- Parameter: DriverId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DriverId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Enabled</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnableAllCameras --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAllCameras</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SkipConfiguration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipConfiguration</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Hardware --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Hardware --> <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"> <command:details> <command:name>Get-Hardware</command:name> <command:verb>Get</command:verb> <command:noun>Hardware</command:noun> </command:details> <command:syntax> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Get-Hardware</maml:name> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Filtered --> <command:syntaxItem> <maml:name>Get-Hardware</maml:name> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HardwareId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HardwareId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RecorderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecorderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RecordingServer --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RecordingServer</maml:name> <command:parameterValue required="true">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RecordingServer --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RecordingServer</maml:name> <command:parameterValue required="true">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HardwareId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HardwareId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RecorderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RecorderId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Hardware --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-Hardware --> <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"> <command:details> <command:name>Remove-Hardware</command:name> <command:verb>Remove</command:verb> <command:noun>Hardware</command:noun> <maml:description> <maml:para>Deletes a hardware device, and all child devices and their recordings from a Recording Server</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a hardware device, and all child devices and their recordings from a Recording Server</maml:para> </maml:description> <command:syntax> <!-- Parameter set: HardwareFromPipeline --> <command:syntaxItem> <maml:name>Remove-Hardware</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the Hardware object to be removed. Usually this object is received from a Get-Hardware command.</maml:para> </maml:description> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Required in order to remove hardware due to the possible loss of sensitive recordings if used by mistake</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: HardwareFromId --> <command:syntaxItem> <maml:name>Remove-Hardware</maml:name> <!-- Parameter: HardwareId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>HardwareId</maml:name> <maml:description> <maml:para>Specifies the hardware ID in guid format</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Required in order to remove hardware due to the possible loss of sensitive recordings if used by mistake</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Hardware</maml:name> <maml:description> <maml:para>Specifies the Hardware object to be removed. Usually this object is received from a Get-Hardware command.</maml:para> </maml:description> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HardwareId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>HardwareId</maml:name> <maml:description> <maml:para>Specifies the hardware ID in guid format</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Required in order to remove hardware due to the possible loss of sensitive recordings if used by mistake</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the Hardware object to be removed. Usually this object is received from a Get-Hardware command.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> Get-Hardware -Name Stairs* | Remove-Hardware -Force</dev:code> <dev:remarks> <maml:para>Removes all hardware from all Recording Servers where the name begins with "Stairs".</maml:para> <maml:para>Note that omitting the -Force switch will result in a warning, and no objects will be deleted.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS> Get-MethodInfo RemoveAlarmDefinition</dev:code> <dev:remarks> <maml:para>Gets the MethodInfo for the RemoveAlarmDefinition MethodId</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-HardwareDriver --> <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"> <command:details> <command:name>Get-HardwareDriver</command:name> <command:verb>Get</command:verb> <command:noun>HardwareDriver</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromRecorder --> <command:syntaxItem> <maml:name>Get-HardwareDriver</maml:name> <!-- Parameter: RecordingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RecordingServer</maml:name> <command:parameterValue required="true">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromHardware --> <command:syntaxItem> <maml:name>Get-HardwareDriver</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RecordingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RecordingServer</maml:name> <command:parameterValue required="true">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: HardwareDriver --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.HardwareDriver</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-HardwarePassword --> <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"> <command:details> <command:name>Get-HardwarePassword</command:name> <command:verb>Get</command:verb> <command:noun>HardwarePassword</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-HardwarePassword</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-HardwarePassword --> <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"> <command:details> <command:name>Set-HardwarePassword</command:name> <command:verb>Set</command:verb> <command:noun>HardwarePassword</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-HardwarePassword</maml:name> <!-- Parameter: NewPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-HardwareSetting --> <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"> <command:details> <command:name>Get-HardwareSetting</command:name> <command:verb>Get</command:verb> <command:noun>HardwareSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-HardwareSetting</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeReadWriteOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeReadWriteOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueTypeInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueTypeInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueTypeInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueTypeInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeReadWriteOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeReadWriteOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-HardwareSetting --> <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"> <command:details> <command:name>Set-HardwareSetting</command:name> <command:verb>Set</command:verb> <command:noun>HardwareSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-HardwareSetting</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-IAlarmClient --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IAlarmClient</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: IAlarmClient --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Proxy.AlarmClient.IAlarmClient</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-IConfigurationService --> <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"> <command:details> <command:name>Get-IConfigurationService</command:name> <command:verb>Get</command:verb> <command:noun>IConfigurationService</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IConfigurationService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: IConfigurationService --> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.IConfigurationService</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Input --> <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"> <command:details> <command:name>Get-Input</command:name> <command:verb>Get</command:verb> <command:noun>Input</command:noun> </command:details> <command:syntax> <!-- Parameter set: GetAll --> <command:syntaxItem> <maml:name>Get-Input</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByChannel --> <command:syntaxItem> <maml:name>Get-Input</maml:name> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Input</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-Input</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: InputEvent --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-InputSetting --> <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"> <command:details> <command:name>Get-InputSetting</command:name> <command:verb>Get</command:verb> <command:noun>InputSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Get-InputSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Get-InputSetting</maml:name> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-InputSetting --> <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"> <command:details> <command:name>Set-InputSetting</command:name> <command:verb>Set</command:verb> <command:noun>InputSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Set-InputSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Set-InputSetting</maml:name> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Input</maml:name> <command:parameterValue required="true">InputEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-IServerCommandService --> <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"> <command:details> <command:name>Get-IServerCommandService</command:name> <command:verb>Get</command:verb> <command:noun>IServerCommandService</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IServerCommandService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: IServerCommandService --> <command:returnValue> <dev:type> <maml:name>VideoOS.Common.Proxy.Server.WCF.IServerCommandService</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ItemState --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ItemState</maml:name> <!-- Parameter: CamerasOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CamerasOnly</maml:name> <maml:description> <maml:para>Filter the ItemState results to Camera items</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CamerasOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CamerasOnly</maml:name> <maml:description> <maml:para>Filter the ItemState results to Camera items</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ItemState --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Messaging.ItemState</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> Get-ItemState -CamerasOnly | Where-Object State -ne "Responding" | Foreach-Object { $camera = Get-Camera -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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS> Get-ItemState | % { $camera = Get-Camera -Id $_.FQID.ObjectId; $hardware = $camera | Get-ConfigurationItem -ParentItem; # Do something else here}</dev:code> <dev:remarks> <maml:para>Gets the associated Hardware object for every Camera ItemState result.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Kind --> <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"> <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:description> <command:syntax> <!-- Parameter set: Convert --> <command:syntaxItem> <maml:name>Get-Kind</maml:name> <!-- Parameter: Kind --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Item.FQID.Kind value as a Guid</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: List --> <command:syntaxItem> <maml:name>Get-Kind</maml:name> <!-- Parameter: List --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>List</maml:name> <maml:description> <maml:para>List all known Kinds</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Kind --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Item.FQID.Kind value as a Guid</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: List --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>List</maml:name> <maml:description> <maml:para>List all known Kinds</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> <maml:description> <maml:para>Item.FQID.Kind value as a Guid</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> Get-ItemState | % { $name = ($_.FQID | Get-PlatformItem).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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Log --> <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"> <command:details> <command:name>Get-Log</command:name> <command:verb>Get</command:verb> <command:noun>Log</command:noun> <maml:description> <maml:para>Gets log entries from the Log Server component of a Milestone XProtect VMS system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet brings the contents of the System, Audit, and Rules logs to PowerShell. These are the same log entries available through Management Client, and do not include application/component log files typically found under C:\ProgramData\Milestone\..</maml:para> </maml:description> <command:syntax> <!-- Parameter set: TimestampFilter --> <command:syntaxItem> <maml:name>Get-Log</maml:name> <!-- Parameter: LogType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Specifies the type of log entries to retrieve. Default is System. Not to be confused with the System log from Windows Event Logs.</maml:para> <maml:para>System logs include events like motion started/stopped, connection errors and license errors.</maml:para> <maml:para>Audit logs include user actions like logon, playback and exporting. Note: Not all user actions are automatically audited and extensive audit logging must be enabled manually from Management Client > Tools > Options > Server Logs.</maml:para> <maml:para>Rules logs include any log entry generated within the set of actions defined in the Rules section in Management Client.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System</dev:defaultValue> </command:parameter> <!-- Parameter: BeginTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>BeginTime</maml:name> <maml:description> <maml:para>Specifies point in time to begin the log entry search. Default is 24 hours before the current time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the point in time to end the log entry search. Default is the current time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Tail --> <command:syntaxItem> <maml:name>Get-Log</maml:name> <!-- Parameter: LogType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Specifies the type of log entries to retrieve. Default is System. Not to be confused with the System log from Windows Event Logs.</maml:para> <maml:para>System logs include events like motion started/stopped, connection errors and license errors.</maml:para> <maml:para>Audit logs include user actions like logon, playback and exporting. Note: Not all user actions are automatically audited and extensive audit logging must be enabled manually from Management Client > Tools > Options > Server Logs.</maml:para> <maml:para>Rules logs include any log entry generated within the set of actions defined in the Rules section in Management Client.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System</dev:defaultValue> </command:parameter> <!-- Parameter: Tail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Tail</maml:name> <maml:description> <maml:para>Get the last Minutes minutes worth of log entries.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Minutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Minutes</maml:name> <maml:description> <maml:para>The number of minutes before now to retrieve the logs. Default is the last 60 minutes.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LogType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Specifies the type of log entries to retrieve. Default is System. Not to be confused with the System log from Windows Event Logs.</maml:para> <maml:para>System logs include events like motion started/stopped, connection errors and license errors.</maml:para> <maml:para>Audit logs include user actions like logon, playback and exporting. Note: Not all user actions are automatically audited and extensive audit logging must be enabled manually from Management Client > Tools > Options > Server Logs.</maml:para> <maml:para>Rules logs include any log entry generated within the set of actions defined in the Rules section in Management Client.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System</dev:defaultValue> </command:parameter> <!-- Parameter: BeginTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>BeginTime</maml:name> <maml:description> <maml:para>Specifies point in time to begin the log entry search. Default is 24 hours before the current time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the point in time to end the log entry search. Default is the current time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: Tail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Tail</maml:name> <maml:description> <maml:para>Get the last Minutes minutes worth of log entries.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Minutes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Minutes</maml:name> <maml:description> <maml:para>The number of minutes before now to retrieve the logs. Default is the last 60 minutes.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Get-Log</dev:code> <dev:remarks> <maml:para>Gets the log entries for the last 24 hours from the System log.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>Get-Log -LogType Audit -Tail -Minutes 10</dev:code> <dev:remarks> <maml:para>Gets the audit log entries for the last 10 minutes.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS>Get-Log -LogType Audit -BeginTime '2019-06-05 08:00:00' -EndTime '2019-06-05 11:00:00'</dev:code> <dev:remarks> <maml:para>Gets the audit log entries for the time between 8am and 11am local time on the 5th of June.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\PS>Get-Log -LogType Rules -BeginTime '2019-06-05 08:00:00Z' -EndTime '2019-06-05 11:00:00Z'</dev:code> <dev:remarks> <maml:para>Gets the audit log entries for the time between 8am and 11am UTC time on the 5th of June. If run from a system with a UTC offset of -7, then the results would be from between 1am and 4am local time.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-LoginSettings --> <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"> <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></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-LoginSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: LoginSettings --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Login.LoginSettings</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Connect-ManagementServer --> <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"> <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>The Connect-ManagementServer cmdlet is the first cmdlet used when working with MilestonePSTools to explore or modify a Milestone XProtect VMS.</maml:para> <maml:para>Authentication methods include Windows, Active Directory, or Basic users, and Milestone Federated Architecture is supported when using anything besides Basic authentication. The state of the session with the Management Server will be maintained in the background for the duration of the PowerShell session, or until Disconnect-ManagementServer is used.</maml:para> <maml:para>By default, this cmdlet will only authenticate with the Management Server provided in the -Server parameter. If child sites need to be accessed during the same session, you should supply the -IncludeChildSites switch, and use the Select-Site cmdlet to switch between sites</maml:para> <maml:para>Note: If you do not supply a Credential object, the current Windows user will be used for authentication automatically.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: NoLoginDialog --> <command:syntaxItem> <maml:name>Connect-ManagementServer</maml:name> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Deprecated - please use ServerAddress. Specifies, as an IP, hostname, or FQDN, the address of the Milestone XProtect Management Server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: WcfProxyTimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>WcfProxyTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies, as an integer value representing seconds, the maximum timeout value for any Milestone Configuration API operation.</maml:para> <maml:para>The Configuration API utilizes Windows Communication Foundation to establish a secure communication channel, and provides extensive access to Milestone XProtect VMS configuration elements.</maml:para> <maml:para>Most operations should complete very quickly, but in some environments it is possible for operations to take several minutes to complete.</maml:para> <maml:para>Default value is 300 seconds, or 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the username and password of either a Windows/AD or Milestone-specific Basic user. If the credentials are for a basic user, you must also supply the -BasicUser switch parameter. If this Credential parameter is omitted, the current Windows user credentials running the PowerShell session will be used by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BasicUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BasicUser</maml:name> <maml:description> <maml:para>Uses Basic User authentication. Use only to authenticate Basic Users which are users specific to Milestone and do not correspond to a Windows or Active Directory user account.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SecureOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>SecureOnly</maml:name> <maml:description> <maml:para>Specifies that a secure HTTPS connection is required. Supported on XProtect VMS versions 2021 R1 and newer.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AcceptEula --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeChildSites --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>IncludeChildSites</maml:name> <maml:description> <maml:para>Authenticates with the supplied Management Server, and all child Management Servers in a given Milestone Federated Architecture tree.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies that any existing Management Server connections should be closed before connecting to the specified Management Server</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServerAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="99"> <maml:name>ServerAddress</maml:name> <maml:description> <maml:para>Specifies the HTTP/HTTPS server address of the Milestone XProtect Management Server to connect to. Default is [system.net.dns]::GetHostEntry("localhost").HostName</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://uslt-jh-02.milestone.dk/</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>80</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ShowLoginDialog --> <command:syntaxItem> <maml:name>Connect-ManagementServer</maml:name> <!-- Parameter: WcfProxyTimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>WcfProxyTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies, as an integer value representing seconds, the maximum timeout value for any Milestone Configuration API operation.</maml:para> <maml:para>The Configuration API utilizes Windows Communication Foundation to establish a secure communication channel, and provides extensive access to Milestone XProtect VMS configuration elements.</maml:para> <maml:para>Most operations should complete very quickly, but in some environments it is possible for operations to take several minutes to complete.</maml:para> <maml:para>Default value is 300 seconds, or 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> <!-- Parameter: AcceptEula --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeChildSites --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>IncludeChildSites</maml:name> <maml:description> <maml:para>Authenticates with the supplied Management Server, and all child Management Servers in a given Milestone Federated Architecture tree.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies that any existing Management Server connections should be closed before connecting to the specified Management Server</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ShowDialog --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowDialog</maml:name> <maml:description> <maml:para>Shows a familiar Milestone login dialog to enter server address, credentials, credential type, and other options.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableAutoLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableAutoLogin</maml:name> <maml:description> <maml:para>Specifies that the login dialog should not login automatically if it had previously been set to do so.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServerAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="99"> <maml:name>ServerAddress</maml:name> <maml:description> <maml:para>Specifies the HTTP/HTTPS server address of the Milestone XProtect Management Server to connect to. Default is [system.net.dns]::GetHostEntry("localhost").HostName</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://uslt-jh-02.milestone.dk/</dev:defaultValue> </command:parameter> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Deprecated - please use ServerAddress. Specifies, as an IP, hostname, or FQDN, the address of the Milestone XProtect Management Server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>localhost</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>80</dev:defaultValue> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the username and password of either a Windows/AD or Milestone-specific Basic user. If the credentials are for a basic user, you must also supply the -BasicUser switch parameter. If this Credential parameter is omitted, the current Windows user credentials running the PowerShell session will be used by default.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BasicUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BasicUser</maml:name> <maml:description> <maml:para>Uses Basic User authentication. Use only to authenticate Basic Users which are users specific to Milestone and do not correspond to a Windows or Active Directory user account.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SecureOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>SecureOnly</maml:name> <maml:description> <maml:para>Specifies that a secure HTTPS connection is required. Supported on XProtect VMS versions 2021 R1 and newer.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AcceptEula --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeChildSites --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>IncludeChildSites</maml:name> <maml:description> <maml:para>Authenticates with the supplied Management Server, and all child Management Servers in a given Milestone Federated Architecture tree.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies that any existing Management Server connections should be closed before connecting to the specified Management Server</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ShowDialog --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowDialog</maml:name> <maml:description> <maml:para>Shows a familiar Milestone login dialog to enter server address, credentials, credential type, and other options.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableAutoLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableAutoLogin</maml:name> <maml:description> <maml:para>Specifies that the login dialog should not login automatically if it had previously been set to do so.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WcfProxyTimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>WcfProxyTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies, as an integer value representing seconds, the maximum timeout value for any Milestone Configuration API operation.</maml:para> <maml:para>The Configuration API utilizes Windows Communication Foundation to establish a secure communication channel, and provides extensive access to Milestone XProtect VMS configuration elements.</maml:para> <maml:para>Most operations should complete very quickly, but in some environments it is possible for operations to take several minutes to complete.</maml:para> <maml:para>Default value is 300 seconds, or 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Connect-ManagementServer -ShowDialog</dev:code> <dev:remarks> <maml:para>Prompts the user with a familiar Milestone login dialog to login to the Management Server</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>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 isn't wanted now.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disconnect-ManagementServer --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disconnect-ManagementServer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Disconnect-ManagementServer</dev:code> <dev:remarks> <maml:para>Disconnect from the current Management Server and all child sites if applicable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ManagementServer --> <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"> <command:details> <command:name>Get-ManagementServer</command:name> <command:verb>Get</command:verb> <command:noun>ManagementServer</command:noun> <maml:description> <maml:para>Gets an object representing the current selected site's Management Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Many cmdlets in this module return a .NET object which comes directly from Milestone's MIP SDK components. The ManagementServer object is such a component.</maml:para> <maml:para>There are many Milestone tasks that can be completed using "pure PowerShell", but some tasks may require you to explore the functionality exposed in these .NET types.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ManagementServer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: ManagementServer --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.ManagementServer</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Metadata --> <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"> <command:details> <command:name>Get-Metadata</command:name> <command:verb>Get</command:verb> <command:noun>Metadata</command:noun> </command:details> <command:syntax> <!-- Parameter set: GetAll --> <command:syntaxItem> <maml:name>Get-Metadata</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByChannel --> <command:syntaxItem> <maml:name>Get-Metadata</maml:name> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Metadata</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-Metadata</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Metadata --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-MetadataSetting --> <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"> <command:details> <command:name>Get-MetadataSetting</command:name> <command:verb>Get</command:verb> <command:noun>MetadataSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Get-MetadataSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Get-MetadataSetting</maml:name> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-MetadataSetting --> <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"> <command:details> <command:name>Set-MetadataSetting</command:name> <command:verb>Set</command:verb> <command:noun>MetadataSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Set-MetadataSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Set-MetadataSetting</maml:name> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Metadata</maml:name> <command:parameterValue required="true">Metadata</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Invoke-Method --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-Method</maml:name> <!-- Parameter: MethodId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConfigurationItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConfigurationItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">ConfigurationItem</command:parameterValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MethodId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </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> <!-- OutputType: ConfigurationItem --> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.ConfigurationItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <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> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-MethodInfo --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-MethodInfo</maml:name> <!-- Parameter: MethodId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MethodId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </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> <!-- OutputType: MethodInfo --> <command:returnValue> <dev:type> <maml:name>VideoOS.ConfigurationApi.ClientService.MethodInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> Get-MethodInfo</dev:code> <dev:remarks> <maml:para>Gets all possible MethodInfo objects</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS> Get-MethodInfo RemoveAlarmDefinition</dev:code> <dev:remarks> <maml:para>Gets the MethodInfo for the RemoveAlarmDefinition MethodId</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <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> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-Microphone --> <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"> <command:details> <command:name>Get-Microphone</command:name> <command:verb>Get</command:verb> <command:noun>Microphone</command:noun> </command:details> <command:syntax> <!-- Parameter set: GetAll --> <command:syntaxItem> <maml:name>Get-Microphone</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByChannel --> <command:syntaxItem> <maml:name>Get-Microphone</maml:name> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Microphone</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-Microphone</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Microphone --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-MicrophoneSetting --> <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"> <command:details> <command:name>Get-MicrophoneSetting</command:name> <command:verb>Get</command:verb> <command:noun>MicrophoneSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Get-MicrophoneSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Get-MicrophoneSetting</maml:name> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-MicrophoneSetting --> <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"> <command:details> <command:name>Set-MicrophoneSetting</command:name> <command:verb>Set</command:verb> <command:noun>MicrophoneSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Set-MicrophoneSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Set-MicrophoneSetting</maml:name> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Microphone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Microphone</maml:name> <command:parameterValue required="true">Microphone</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Send-MipMessage --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Send-MipMessage</maml:name> <!-- Parameter: MessageId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MessageId</maml:name> <maml:description> <maml:para>MessageId string to send.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseEnvironmentManager --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RelatedFqid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Source --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResponseMessageId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <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">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MessageId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MessageId</maml:name> <maml:description> <maml:para>MessageId string to send.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedFqid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Source --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResponseMessageId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <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">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: UseEnvironmentManager --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>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-PlatformItem</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-MipMessageIdList --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-MipMessageIdList</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-MipSdkEula --> <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"> <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 open the eula.rtf file included with MilestonePSTools in the default viewer, and return the contents as a plain text string.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-MipSdkEula</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Invoke-MipSdkEula --> <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"> <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 eula.rtf 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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-MipSdkEula</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-Output --> <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"> <command:details> <command:name>Get-Output</command:name> <command:verb>Get</command:verb> <command:noun>Output</command:noun> </command:details> <command:syntax> <!-- Parameter set: GetAll --> <command:syntaxItem> <maml:name>Get-Output</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByChannel --> <command:syntaxItem> <maml:name>Get-Output</maml:name> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Output</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-Output</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Output --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-OutputSetting --> <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"> <command:details> <command:name>Get-OutputSetting</command:name> <command:verb>Get</command:verb> <command:noun>OutputSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Get-OutputSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Get-OutputSetting</maml:name> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-OutputSetting --> <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"> <command:details> <command:name>Set-OutputSetting</command:name> <command:verb>Set</command:verb> <command:noun>OutputSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Set-OutputSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Set-OutputSetting</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Output</maml:name> <command:parameterValue required="true">Output</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-OverallSecurity --> <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"> <command:details> <command:name>Get-OverallSecurity</command:name> <command:verb>Get</command:verb> <command:noun>OverallSecurity</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OverallSecurity</maml:name> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecurityNamespaceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecurityNamespaceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecurityNamespaceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecurityNamespaceId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-OverallSecurity --> <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"> <command:details> <command:name>Set-OverallSecurity</command:name> <command:verb>Set</command:verb> <command:noun>OverallSecurity</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-OverallSecurity</maml:name> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecurityPermissions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecurityPermissions</maml:name> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecurityPermissions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecurityPermissions</maml:name> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PlatformItem --> <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"> <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:description> <command:syntax> <!-- Parameter set: ByFQID --> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <!-- Parameter: Fqid --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySearch --> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <!-- Parameter: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxResultCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByKind --> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <!-- Parameter: Kind --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ListAvailable --> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <!-- Parameter: Hierarchy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">ItemHierarchy</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ItemHierarchy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemDefined</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserDefined</command:parameterValue> <command:parameterValue required="false" variableLength="false">SystemDefined</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ListAvailable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Enumerate all Items in the configuration</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-PlatformItem</maml:name> <!-- Parameter: Id --> <command:parameter required="false" 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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Fqid --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Kind --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ListAvailable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Enumerate all Items in the configuration</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Hierarchy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">ItemHierarchy</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ItemHierarchy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SystemDefined</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserDefined</command:parameterValue> <command:parameterValue required="false" variableLength="false">SystemDefined</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxResultCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" 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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ObjectId"> <maml:name>ObjectId</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:para>This is an alias of the Id parameter.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.FQID</maml:name> <maml:uri /> </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> <maml:uri /> </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> <maml:uri /> </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> <!-- OutputType: Item --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> Get-ItemState | % { $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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS> Get-PlatformItem -ListAvailable</dev:code> <dev:remarks> <maml:para>Retrieve all configuration items from the VMS which are not considered Parent objects</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS> $kind = (Get-Kind -List | ? 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-Playback --> <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"> <command:details> <command:name>Test-Playback</command:name> <command:verb>Test</command:verb> <command:noun>Playback</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-Playback</maml:name> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CameraId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Any</dev:defaultValue> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timestamp</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.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> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CameraId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timestamp</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Any</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-PlaybackInfo --> <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"> <command:details> <command:name>Get-PlaybackInfo</command:name> <command:verb>Get</command:verb> <command:noun>PlaybackInfo</command:noun> <maml:description> <maml:para>Gets the timestamps of the beginning and end of the media database for a given camera</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the timestamps of the beginning and end of the media database for a given camera including a retention calculation provided as a Timespan object. The implementation of this command retrieves the first and last image from the media database so it can take a long time to complete if you're piping all cameras to this command.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PlaybackInfo</maml:name> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: UseLocalTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseLocalTime</maml:name> <maml:description> <maml:para>Convert the UTC timestamps from the Recording Server(s) to local time using the region settings of the current session.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-Camera command.</maml:para> </maml:description> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-Camera command.</maml:para> </maml:description> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: UseLocalTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseLocalTime</maml:name> <maml:description> <maml:para>Convert the UTC timestamps from the Recording Server(s) to local time using the region settings of the current session.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-Camera command.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSCustomObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> Get-Hardware | Get-Camera | Get-PlaybackInfo -UseLocalTime</dev:code> <dev:remarks> <maml:para>Gets the Begin datetime, End datetime, and Retention timespan values for all cameras, converting the timestamps to localtime based on the region settings of the computer where this command is executed.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-RecorderStatusService2 --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-RecorderStatusService2</maml:name> <!-- Parameter: RecordingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RecordingServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <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">RecordingServer</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </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> <!-- OutputType: RecorderStatusService2 --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.SDK.Proxy.Status2.RecorderStatusService2</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Get-RecordingServer | Get-RecorderStatusService2</dev:code> <dev:remarks> <maml:para>Gets a RecorderStatusService2 WCF proxy client for each Recording Server under the currently selected site.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-RecordingServer --> <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"> <command:details> <command:name>Get-RecordingServer</command:name> <command:verb>Get</command:verb> <command:noun>RecordingServer</command:noun> </command:details> <command:syntax> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Get-RecordingServer</maml:name> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-RecordingServer</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-RecordingServer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="20"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByHostname --> <command:syntaxItem> <maml:name>Get-RecordingServer</maml:name> <!-- Parameter: Hostname --> <command:parameter required="false" globbing="false" pipelineInput="false" position="30"> <maml:name>Hostname</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="20"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hostname --> <command:parameter required="false" globbing="false" pipelineInput="false" position="30"> <maml:name>Hostname</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="50"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: RecordingServer --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.RecordingServer</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Add-RegisteredService --> <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"> <command:details> <command:name>Add-RegisteredService</command:name> <command:verb>Add</command:verb> <command:noun>RegisteredService</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-RegisteredService</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Uri</maml:name> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ServiceType</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Uri</maml:name> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ServiceType</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ServiceURIInfo --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-RegisteredService --> <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"> <command:details> <command:name>Get-RegisteredService</command:name> <command:verb>Get</command:verb> <command:noun>RegisteredService</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-RegisteredService</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceType</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServiceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceType</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ServiceURIInfo --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-RegisteredService --> <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"> <command:details> <command:name>Remove-RegisteredService</command:name> <command:verb>Remove</command:verb> <command:noun>RegisteredService</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-RegisteredService</maml:name> <!-- Parameter: RegisteredService --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RegisteredService</maml:name> <command:parameterValue required="true">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VideoOS.Platform.Configuration+ServiceURIInfo</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RegisteredService --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RegisteredService</maml:name> <command:parameterValue required="true">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Update-RegisteredService --> <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"> <command:details> <command:name>Update-RegisteredService</command:name> <command:verb>Update</command:verb> <command:noun>RegisteredService</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-RegisteredService</maml:name> <!-- Parameter: RegisteredService --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RegisteredService</maml:name> <command:parameterValue required="true">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+ServiceURIInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>VideoOS.Platform.Configuration+ServiceURIInfo</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RegisteredService --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>RegisteredService</maml:name> <command:parameterValue required="true">ServiceURIInfo</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Configuration+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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Add-Role --> <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"> <command:details> <command:name>Add-Role</command:name> <command:verb>Add</command:verb> <command:noun>Role</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-Role</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequireDualAuth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RequireDualAuth</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AnonymousPtz --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AnonymousPtz</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowMobileClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AllowMobileClient</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: AllowSmartClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>AllowSmartClient</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: AllowWebClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AllowWebClient</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequireDualAuth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RequireDualAuth</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AnonymousPtz --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AnonymousPtz</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowMobileClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AllowMobileClient</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: AllowSmartClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>AllowSmartClient</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: AllowWebClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AllowWebClient</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Role --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Role --> <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"> <command:details> <command:name>Get-Role</command:name> <command:verb>Get</command:verb> <command:noun>Role</command:noun> </command:details> <command:syntax> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Get-Role</maml:name> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Role</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-Role</maml:name> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Role --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-Role --> <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"> <command:details> <command:name>Remove-Role</command:name> <command:verb>Remove</command:verb> <command:noun>Role</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromPipeline --> <command:syntaxItem> <maml:name>Remove-Role</maml:name> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromName --> <command:syntaxItem> <maml:name>Remove-Role</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromId --> <command:syntaxItem> <maml:name>Remove-Role</maml:name> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: CaseSensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CaseSensitive</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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.Role</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-SequenceData --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SequenceData</maml:name> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: SequenceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>RecordingSequence</dev:defaultValue> </command:parameter> <!-- Parameter: CropToTimeSpan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/17/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8/18/2021 11:10:32 PM</dev:defaultValue> </command:parameter> <!-- Parameter: SequenceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>RecordingSequence</dev:defaultValue> </command:parameter> <!-- Parameter: CropToTimeSpan --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </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> <!-- OutputType: SequenceData --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.SequenceData</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>$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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Site --> <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"> <command:details> <command:name>Get-Site</command:name> <command:verb>Get</command:verb> <command:noun>Site</command:noun> <maml:description> <maml:para>Gets an Item object representing a Management Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Site cmdlet can be used to identify which site is currently selected, or which sites are available to be selected.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Site</maml:name> <!-- Parameter: ListAvailable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Gets all sites available to the current logon session.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the friendly name of the site Item to get. Wildcard characters can be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ListAvailable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Gets all sites available to the current logon session.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the friendly name of the site Item to get. Wildcard characters can be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Item --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Get-Site</dev:code> <dev:remarks> <maml:para>This command returns the Item object representing the currently selected site.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>Get-Site -ListAvailable</dev:code> <dev:remarks> <maml:para>This command lists all available sites in the current logon session if you have used Connect-ManagementServer -IncludeChildSites.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS>Get-Site -ListAvailable -Name Site2</dev:code> <dev:remarks> <maml:para>This command gets the Item representing a site where the Name property equals "Site2".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\PS>Get-Site -ListAvailable -Name USA-*</dev:code> <dev:remarks> <maml:para>This command gets all Items representing sites where the Name property begins with "USA-", so if all USA-based sites are named with a USA- prefix, this command gets all Items for sites in the USA.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Select-Site --> <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"> <command:details> <command:name>Select-Site</command:name> <command:verb>Select</command:verb> <command:noun>Site</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-Site 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:description> <command:syntax> <!-- Parameter set: FromPipeline --> <command:syntaxItem> <maml:name>Select-Site</maml:name> <!-- Parameter: SiteItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SiteItem</maml:name> <maml:description> <maml:para>Specifies an Item object representing a Management Server, typically returned by the Get-Site cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Item</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Select-Site</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the case-insensitive site name to select. Supports wildcards. First matching site will be selected and order is not guaranteed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SelectMainSite --> <command:syntaxItem> <maml:name>Select-Site</maml:name> <!-- Parameter: MainSite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="MasterSite"> <maml:name>MainSite</maml:name> <maml:description> <maml:para>Select the site directly specified in the last call to Connect-ManagementServer.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteItem --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SiteItem</maml:name> <maml:description> <maml:para>Specifies an Item object representing a Management Server, typically returned by the Get-Site cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">Item</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the case-insensitive site name to select. Supports wildcards. First matching site will be selected and order is not guaranteed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: MainSite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="MasterSite"> <maml:name>MainSite</maml:name> <maml:description> <maml:para>Select the site directly specified in the last call to Connect-ManagementServer.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="MasterSite"> <maml:name>MasterSite</maml:name> <maml:description> <maml:para>Select the site directly specified in the last call to Connect-ManagementServer.</maml:para> <maml:para>This is an alias of the MainSite parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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.Item</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies an Item object representing a Management Server, typically returned by the Get-Site cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Item --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Item</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Select-Site -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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>Select-Site -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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\PS>Select-Site -Name '*School'</dev:code> <dev:remarks> <maml:para>This command gets the Item representing a site where the Name property equals "Site2".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Get-Site -ListAvailable | % { $_ | Select-Site; Get-ManagementServer | select 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-Site.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Snapshot --> <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"> <command:details> <command:name>Get-Snapshot</command:name> <command:verb>Get</command:verb> <command:noun>Snapshot</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromLive --> <command:syntaxItem> <maml:name>Get-Snapshot</maml:name> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CameraId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Live --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Live</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>C:\Users\jh\source\repos\MilestonePSTools\MilestonePSTools</dev:defaultValue> </command:parameter> <!-- Parameter: FileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>FileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Height --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Height</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeBlackBars --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeBlackBars</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepAspectRatio --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepAspectRatio</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LiftPrivacyMask --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiftPrivacyMask</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LiveTimeoutMS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiveTimeoutMS</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <!-- Parameter: LocalTimestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalTimestamp</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quality --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quality</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>75</dev:defaultValue> </command:parameter> <!-- Parameter: Save --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Save</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseFriendlyName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseFriendlyName</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Width --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Width</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromPlayback --> <command:syntaxItem> <maml:name>Get-Snapshot</maml:name> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CameraId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Timestamp</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Behavior --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Behavior</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GetNearest</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>C:\Users\jh\source\repos\MilestonePSTools\MilestonePSTools</dev:defaultValue> </command:parameter> <!-- Parameter: FileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>FileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Height --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Height</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeBlackBars --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeBlackBars</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Interval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interval</maml:name> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: KeepAspectRatio --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepAspectRatio</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LiftPrivacyMask --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiftPrivacyMask</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LiveTimeoutMS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiveTimeoutMS</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <!-- Parameter: LocalTimestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalTimestamp</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quality --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quality</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>75</dev:defaultValue> </command:parameter> <!-- Parameter: Save --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Save</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseFriendlyName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseFriendlyName</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Width --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Width</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CameraId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Live --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Live</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Timestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Timestamp</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: EndTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Interval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Interval</maml:name> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Behavior --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Behavior</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GetNearest</dev:defaultValue> </command:parameter> <!-- Parameter: Save --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Save</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>C:\Users\jh\source\repos\MilestonePSTools\MilestonePSTools</dev:defaultValue> </command:parameter> <!-- Parameter: FileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>FileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalTimestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalTimestamp</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Width --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Width</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Height --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Height</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: KeepAspectRatio --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepAspectRatio</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeBlackBars --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeBlackBars</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseFriendlyName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseFriendlyName</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LiftPrivacyMask --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiftPrivacyMask</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Quality --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quality</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>75</dev:defaultValue> </command:parameter> <!-- Parameter: LiveTimeoutMS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LiveTimeoutMS</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: JPEGData --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.JPEGData</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LiveSourceContent --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Live.LiveSourceContent</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Speaker --> <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"> <command:details> <command:name>Get-Speaker</command:name> <command:verb>Get</command:verb> <command:noun>Speaker</command:noun> </command:details> <command:syntax> <!-- Parameter set: GetAll --> <command:syntaxItem> <maml:name>Get-Speaker</maml:name> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByChannel --> <command:syntaxItem> <maml:name>Get-Speaker</maml:name> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Speaker</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-Speaker</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Hardware --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Hardware</maml:name> <command:parameterValue required="true">Hardware</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Channel</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.ConfigurationItems.Hardware</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Speaker --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-SpeakerSetting --> <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"> <command:details> <command:name>Get-SpeakerSetting</command:name> <command:verb>Get</command:verb> <command:noun>SpeakerSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Get-SpeakerSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Get-SpeakerSetting</maml:name> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueInfo</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-SpeakerSetting --> <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"> <command:details> <command:name>Set-SpeakerSetting</command:name> <command:verb>Set</command:verb> <command:noun>SpeakerSetting</command:noun> </command:details> <command:syntax> <!-- Parameter set: GeneralSettings --> <command:syntaxItem> <maml:name>Set-SpeakerSetting</maml:name> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: StreamSettings --> <command:syntaxItem> <maml:name>Set-SpeakerSetting</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Speaker --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Speaker</maml:name> <command:parameterValue required="true">Speaker</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: General --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>General</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StreamNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Add-Stream --> <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"> <command:details> <command:name>Add-Stream</command:name> <command:verb>Add</command:verb> <command:noun>Stream</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-Stream</maml:name> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: StreamUsageChildItem --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-Stream --> <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"> <command:details> <command:name>Get-Stream</command:name> <command:verb>Get</command:verb> <command:noun>Stream</command:noun> </command:details> <command:syntax> <!-- Parameter set: LiveDefault --> <command:syntaxItem> <maml:name>Get-Stream</maml:name> <!-- Parameter: LiveDefault --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LiveDefault</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StreamIds</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Recorded --> <command:syntaxItem> <maml:name>Get-Stream</maml:name> <!-- Parameter: Recorded --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Recorded</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StreamIds</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Get-Stream</maml:name> <!-- Parameter: All --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StreamIds</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Camera --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LiveDefault --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LiveDefault</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Recorded --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Recorded</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: All --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: StreamIds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StreamIds</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: StreamUsageChildItem --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-Stream --> <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"> <command:details> <command:name>Remove-Stream</command:name> <command:verb>Remove</command:verb> <command:noun>Stream</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-Stream</maml:name> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-Stream --> <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"> <command:details> <command:name>Set-Stream</command:name> <command:verb>Set</command:verb> <command:noun>Stream</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-Stream</maml:name> <!-- Parameter: StreamId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StreamId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LiveMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LiveMode</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LiveDefault --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LiveDefault</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Record --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Record</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Stream --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Stream</maml:name> <command:parameterValue required="true">StreamUsageChildItem</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StreamId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StreamId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LiveMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LiveMode</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LiveDefault --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LiveDefault</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Record --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Record</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.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.StreamUsageChildItem</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-Token --> <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"> <command:details> <command:name>Get-Token</command:name> <command:verb>Get</command:verb> <command:noun>Token</command:noun> <maml:description> <maml:para>Gets the current token issued by the Management Server to this PowerShell session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Token cmdlet returns the token issued by the Management Server to the current user session. Tokens are used internally to verify a user or service has been authenticated by the Management and is authorized to access resources. Tokens are renewed in the background automatically, and expire in 4 hours by default.</maml:para> <maml:para>Note: It is rare that you would need to use this cmdlet. It is added for convenience only for those rare cases when direct access to a token might be needed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Token</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Token</dev:code> <dev:remarks> <maml:para>Get the current token as a string.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Translations --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Translations</maml:name> <!-- Parameter: LanguageId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LanguageId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> 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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <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> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-User --> <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"> <command:details> <command:name>Add-User</command:name> <command:verb>Add</command:verb> <command:noun>User</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromPipeline --> <command:syntaxItem> <maml:name>Add-User</maml:name> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromName --> <command:syntaxItem> <maml:name>Add-User</maml:name> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromId --> <command:syntaxItem> <maml:name>Add-User</maml:name> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.User</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-User --> <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"> <command:details> <command:name>Get-User</command:name> <command:verb>Get</command:verb> <command:noun>User</command:noun> </command:details> <command:syntax> <!-- Parameter set: All --> <command:syntaxItem> <maml:name>Get-User</maml:name> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromPipeline --> <command:syntaxItem> <maml:name>Get-User</maml:name> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromId --> <command:syntaxItem> <maml:name>Get-User</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromName --> <command:syntaxItem> <maml:name>Get-User</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: All --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>All</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.User</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-User --> <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"> <command:details> <command:name>Remove-User</command:name> <command:verb>Remove</command:verb> <command:noun>User</command:noun> </command:details> <command:syntax> <!-- Parameter set: RoleFromPipeline --> <command:syntaxItem> <maml:name>Remove-User</maml:name> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RoleFromId --> <command:syntaxItem> <maml:name>Remove-User</maml:name> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RoleFromName --> <command:syntaxItem> <maml:name>Remove-User</maml:name> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Role</maml:name> <command:parameterValue required="true">Role</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RoleName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccountName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AccountName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sid --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sid</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Role</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Add-UserDefinedEvent --> <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"> <command:details> <command:name>Add-UserDefinedEvent</command:name> <command:verb>Add</command:verb> <command:noun>UserDefinedEvent</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-UserDefinedEvent</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: UserDefinedEvent --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-UserDefinedEvent --> <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"> <command:details> <command:name>Get-UserDefinedEvent</command:name> <command:verb>Get</command:verb> <command:noun>UserDefinedEvent</command:noun> </command:details> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-UserDefinedEvent</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-UserDefinedEvent</maml:name> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: UserDefinedEvent --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-UserDefinedEvent --> <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"> <command:details> <command:name>Remove-UserDefinedEvent</command:name> <command:verb>Remove</command:verb> <command:noun>UserDefinedEvent</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromPipeline --> <command:syntaxItem> <maml:name>Remove-UserDefinedEvent</maml:name> <!-- Parameter: UserDefinedEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserDefinedEvent</maml:name> <command:parameterValue required="true">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-UserDefinedEvent</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Remove-UserDefinedEvent</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserDefinedEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserDefinedEvent</maml:name> <command:parameterValue required="true">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Id</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.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.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Send-UserDefinedEvent --> <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"> <command:details> <command:name>Send-UserDefinedEvent</command:name> <command:verb>Send</command:verb> <command:noun>UserDefinedEvent</command:noun> </command:details> <command:syntax> <!-- Parameter set: FromObject --> <command:syntaxItem> <maml:name>Send-UserDefinedEvent</maml:name> <!-- Parameter: UserDefinedEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserDefinedEvent</maml:name> <command:parameterValue required="true">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Inputs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Inputs</maml:name> <command:parameterValue required="true">InputEvent[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Outputs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>Outputs</maml:name> <command:parameterValue required="true">Output[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cameras --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Cameras</maml:name> <command:parameterValue required="true">Camera[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Microphones --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Microphones</maml:name> <command:parameterValue required="true">Microphone[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Speakers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Speakers</maml:name> <command:parameterValue required="true">Speaker[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadatas --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Metadatas</maml:name> <command:parameterValue required="true">Metadata[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromId --> <command:syntaxItem> <maml:name>Send-UserDefinedEvent</maml:name> <!-- Parameter: Metadatas --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Metadatas</maml:name> <command:parameterValue required="true">Metadata[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Inputs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Inputs</maml:name> <command:parameterValue required="true">InputEvent[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Outputs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>Outputs</maml:name> <command:parameterValue required="true">Output[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Id</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cameras --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Cameras</maml:name> <command:parameterValue required="true">Camera[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Microphones --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Microphones</maml:name> <command:parameterValue required="true">Microphone[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Speakers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Speakers</maml:name> <command:parameterValue required="true">Speaker[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserDefinedEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserDefinedEvent</maml:name> <command:parameterValue required="true">UserDefinedEvent</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Id</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cameras --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Cameras</maml:name> <command:parameterValue required="true">Camera[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Microphones --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Microphones</maml:name> <command:parameterValue required="true">Microphone[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Microphone[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Speakers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Speakers</maml:name> <command:parameterValue required="true">Speaker[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Speaker[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadatas --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Metadatas</maml:name> <command:parameterValue required="true">Metadata[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Metadata[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Inputs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Inputs</maml:name> <command:parameterValue required="true">InputEvent[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.InputEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Outputs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>Outputs</maml:name> <command:parameterValue required="true">Output[]</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Output[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.UserDefinedEvent</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-VideoSource --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VideoSource</maml:name> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Raw</dev:defaultValue> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-Camera command.</maml:para> </maml:description> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Fqid --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Fqid --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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">FQID</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Camera --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Camera</maml:name> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-Camera command.</maml:para> </maml:description> <command:parameterValue required="true">Camera</command:parameterValue> <dev:type> <maml:name>VideoOS.Platform.ConfigurationItems.Camera</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CameraId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Raw</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VideoOS.Platform.FQID</maml:name> <maml:uri /> </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> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies a camera object - typically the output of a Get-Camera command.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: VideoSource --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Data.VideoSource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS> $src = $camera | Get-VideoSource -Format Jpeg; $first = $src.GetBegin(); $second = $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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>MIP SDK Documentation</maml:linkText> <maml:uri>https://doc.developer.milestonesys.com/html/index.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-WhoIsOnline --> <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"> <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:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-WhoIsOnline</maml:name> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: EndPointIdentityData --> <command:returnValue> <dev:type> <maml:name>VideoOS.Platform.Messaging.EndPointIdentityData</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Get-WhoIsOnline</dev:code> <dev:remarks> <maml:para>Get a list of user sessions with a default timeout value of 10 seconds</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\PS>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> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |