lib/MilestonePSTools.Extensions.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-IServerProxyService --> <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-IServerProxyService</command:name> <command:verb>Get</command:verb> <command:noun>IServerProxyService</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IServerProxyService</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: IServerProxyService --> <command:returnValue> <dev:type> <maml:name>IServerProxyService</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ManagementServerConfig --> <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-ManagementServerConfig</command:name> <command:verb>Get</command:verb> <command:noun>ManagementServerConfig</command:noun> <maml:description> <maml:para>Gets an object representing the local Recording Server configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets an object representing the local Recording Server configuration from C:\ProgramData\Milestone\XProtect Recording Server\RecorderConfig.xml. This object can then be queried or manipulated as needed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ManagementServerConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Set-ManagementServerConfig --> <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-ManagementServerConfig</command:name> <command:verb>Set</command:verb> <command:noun>ManagementServerConfig</command:noun> <maml:description> <maml:para>Sets common parameters in ServerConfig.xml and re-registers with the Authorization Server if needed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Several common settings are stored in the Management Server's ProgramData directory inside ServerConfig.xml. This cmdlet updates a subset of these properties, including the settings necessary to re-register the server with the Authorization Server component running on the Management Server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ManagementServerConfig</maml:name> <!-- Parameter: AuthServerAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AuthServerAddress</maml:name> <maml:description> <maml:para>Specifies the IP address, hostname, or fully qualified domain name of the Authorization Server.</maml:para> <maml:para>Should not include any URI components like http/https.</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: WebApiPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WebApiPort</maml:name> <maml:description> <maml:para>Specifies the TCP port to which the Management Server will listen for connections from the Recording Servers.</maml:para> <maml:para>Usually 9000</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: ServerEncryptionCertHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ServerEncryptionCertHash</maml:name> <maml:description> <maml:para>Specifies the certificate hash or "thumbprint" identifying the public/private certificate key pair to use for inbound communications from the Management Server on LocalServerPort (usually TCP 9001).</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: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential used for registration with the Authorization Server component of the Management Server.</maml:para> <maml:para>Required when updating the ServerAddress or ServerPort, or when using the Register switch.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthServerAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AuthServerAddress</maml:name> <maml:description> <maml:para>Specifies the IP address, hostname, or fully qualified domain name of the Authorization Server.</maml:para> <maml:para>Should not include any URI components like http/https.</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: WebApiPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WebApiPort</maml:name> <maml:description> <maml:para>Specifies the TCP port to which the Management Server will listen for connections from the Recording Servers.</maml:para> <maml:para>Usually 9000</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: ServerEncryptionCertHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ServerEncryptionCertHash</maml:name> <maml:description> <maml:para>Specifies the certificate hash or "thumbprint" identifying the public/private certificate key pair to use for inbound communications from the Management Server on LocalServerPort (usually TCP 9001).</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: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential used for registration with the Authorization Server component of the Management Server.</maml:para> <maml:para>Required when updating the ServerAddress or ServerPort, or when using the Register switch.</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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Set-ManagementServerConfig -AuthServerAddress mgmtsrv.example.com -ServerEncryptionCertHash CC57422F5A874F3C656D70F2CD87661ECAE5CA59 -Verbose</dev:code> <dev:remarks> <maml:para>This command, when executed on a computer with Management Server installed, changes the address used to connect to the Authorization Server, and specifies a certificate hash identifying a certificate to be used for server-side encryption of communications with the Recording Servers.</maml:para> <maml:para>If running, the Management Server service will be restarted to put the changes into effect.</maml:para> <maml:para>On a system running XProtect VMS 2019 R2 or later, the Management Server will be re-registered with the Authorization Server using the credentials of the user executing the command. If running the command remotely via PSSession, you must explicitly supply credentials for a member of the Administrators role on the Management Server using the -Credential parameter.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-RecorderConfig --> <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-RecorderConfig</command:name> <command:verb>Get</command:verb> <command:noun>RecorderConfig</command:noun> <maml:description> <maml:para>Gets an object representing the local Recording Server configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets an object representing the local Recording Server configuration from C:\ProgramData\Milestone\XProtect Recording Server\RecorderConfig.xml. This object can then be queried or manipulated as needed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-RecorderConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Set-RecorderConfig --> <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-RecorderConfig</command:name> <command:verb>Set</command:verb> <command:noun>RecorderConfig</command:noun> <maml:description> <maml:para>Sets common parameters in RecorderConfig.xml and re-registers with Management Server if needed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Several common settings are stored in the Recording Server's ProgramData directory inside RecorderConfig.xml. This cmdlet updates a subset of these properties, including the settings necessary to re-register the Recording Server with the Authorization Server component running on the Management Server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-RecorderConfig</maml:name> <!-- Parameter: ServerAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServerAddress</maml:name> <maml:description> <maml:para>Specifies the IP address, hostname, or fully qualified domain name of the Management Server.</maml:para> <maml:para>Should not include any URI components like http/https.</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: LocalServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port to which the Recording Server will listen for connections from the Management Server.</maml:para> <maml:para>Usually 9001</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: ServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port to which the Recording Server will connect when communicating with the Management Server.</maml:para> <maml:para>Usually 9000</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: WebServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>WebServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port which the Recording Server will listen on for incoming connections from any clients.</maml:para> <maml:para>Usually 7563</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: AlertServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AlertServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port which the Recording Server device drivers will listen on for incoming event messages from cameras.</maml:para> <maml:para>Usually 5432</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: ClientEncryptionCertHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ClientEncryptionCertHash</maml:name> <maml:description> <maml:para>Specifies the certificate hash or "thumbprint" identifying the public/private certificate key pair to use for client-side communication encryption.</maml:para> <maml:para>Setting this will result in encryption of all traffic over WebServerPort (usually TCP 7563). Only applications compatible with XProtect VMS 2019 R1 or later are compatible with this client-side encryption.</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: ServerEncryptionCertHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ServerEncryptionCertHash</maml:name> <maml:description> <maml:para>Specifies the certificate hash or "thumbprint" identifying the public/private certificate key pair to use for inbound communications from the Management Server on LocalServerPort (usually TCP 9001).</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: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential used for registration with the Authorization Server component of the Management Server.</maml:para> <maml:para>Required when updating the ServerAddress or ServerPort, or when using the Register switch.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServerAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServerAddress</maml:name> <maml:description> <maml:para>Specifies the IP address, hostname, or fully qualified domain name of the Management Server.</maml:para> <maml:para>Should not include any URI components like http/https.</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: ServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port to which the Recording Server will connect when communicating with the Management Server.</maml:para> <maml:para>Usually 9000</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: LocalServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port to which the Recording Server will listen for connections from the Management Server.</maml:para> <maml:para>Usually 9001</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: WebServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>WebServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port which the Recording Server will listen on for incoming connections from any clients.</maml:para> <maml:para>Usually 7563</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: AlertServerPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AlertServerPort</maml:name> <maml:description> <maml:para>Specifies the TCP port which the Recording Server device drivers will listen on for incoming event messages from cameras.</maml:para> <maml:para>Usually 5432</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: ClientEncryptionCertHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ClientEncryptionCertHash</maml:name> <maml:description> <maml:para>Specifies the certificate hash or "thumbprint" identifying the public/private certificate key pair to use for client-side communication encryption.</maml:para> <maml:para>Setting this will result in encryption of all traffic over WebServerPort (usually TCP 7563). Only applications compatible with XProtect VMS 2019 R1 or later are compatible with this client-side encryption.</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: ServerEncryptionCertHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ServerEncryptionCertHash</maml:name> <maml:description> <maml:para>Specifies the certificate hash or "thumbprint" identifying the public/private certificate key pair to use for inbound communications from the Management Server on LocalServerPort (usually TCP 9001).</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: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credential used for registration with the Authorization Server component of the Management Server.</maml:para> <maml:para>Required when updating the ServerAddress or ServerPort, or when using the Register switch.</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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\PS>Set-RecorderConfig -ServerAddress mgmtsrv.example.com -ClientEncryptionCertHash CC57422F5A874F3C656D70F2CD87661ECAE5CA59 -ServerEncryptionCertHash CC57422F5A874F3C656D70F2CD87661ECAE5CA59 -Verbose</dev:code> <dev:remarks> <maml:para>This command, when executed on a computer with Recording Server installed, changes the address used to connect to the Management Server, and specifies a certificate hash identifying a certificate to be used for both client-side communications encryption as well as server-side encryption of communications with the Management Server.</maml:para> <maml:para>If running, the Recording Server service will be restarted to put the changes into effect.</maml:para> <maml:para>On a system running XProtect VMS 2019 R2 or later, the Recording Server will be re-registered with the Management Server using the credentials of the user executing the command. If running the command remotely via PSSession, you must explicitly supply credentials for a member of the Administrators role on the Management Server using the -Credential parameter.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VmoClient --> <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-VmoClient</command:name> <command:verb>Get</command:verb> <command:noun>VmoClient</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-VmoClient</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: VmoClient --> <command:returnValue> <dev:type> <maml:name>VideoOS.Management.VmoClient.VmoClient</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> </helpItems> |