Set-VmsRecordingServer
SYNOPSIS
Sets properties of one or more recording servers.
SYNTAX
Set-VmsRecordingServer [-RecordingServer] <RecordingServer[]> [-Name <String>] [-Description <String>]
[-PublicAccessEnabled <Boolean>] [-PublicWebserverPort <Int32>] [-PublicWebserverHostName <String>]
[-ShutdownOnStorageFailure <Boolean>] [-MulticastServerAddress <String>] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Sets properties of one or more recording servers.
EXAMPLES
Example 1
PS C:\> {{ Add example code here }}
{{ Add example description here }}
PARAMETERS
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Specifies an optional description for the recording server.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MulticastServerAddress
Specifies a multicast server address to use when clients should receive live video from the recording server using multicast instead of unicast.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
Specifies a new display name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PassThru
Return the modified object to the caller or the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PublicAccessEnabled
Specifies that the recording server should advertise a different address for users connecting from any network not considered by the management server to be "local". This means any client logging in to the management server with a source IP address (from the management server's perspective) that does not fall within the subnet of one of the management server's network interfaces, or within one of the local network ranges defined in Management Client under Tools > Options > Network, will be considered "external" and they will be provided with the "public" address for all recording servers instead of the "Local web server address".
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PublicWebserverHostName
Specifies the public hostname, IP, or DNS name for clients to use when connecting from a "non-local" network IP.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PublicWebserverPort
Specifies the public TCP port for clients to use when connecting from a "non-local" network IP.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RecordingServer
Specifies the recording server to modify, either by object or by name.
Type: RecordingServer[]
Parameter Sets: (All)
Aliases: Recorder
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ShutdownOnStorageFailure
Specifies that the recording server should shut down when there is a storage failure resulting in an inability to record. This may be important when you have a failover recording server that should take over during such an event.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.