Set-CsVideoInteropServer
Use the Set-CsVideoInteropServer
to modify the property values of one or more Video Interop Servers (VIS).
The Video Interop Server is a Skype service that is used to communicate with a Video Gateway via a Session Initiation Protocol (SIP) trunk.
Video Gateways route traffic between internal and 3rd party video devices such as an internal Skype endpoint exchanging video with a 3rd party PBX supporting 3rd party video teleconferencing systems (VTCs).
The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between 3rd party VTCs and internal endpoints.
Syntax
Default (Default)
Set-CsVideoInteropServer
[[-Identity] <XdsGlobalRelativeIdentity>]
[-AudioPortCount <UInt16>]
[-AudioPortStart <UInt16>]
[-Confirm]
[-Force]
[-Registrar <String>]
[-RegistrationTcpPort <UInt16>]
[-RegistrationTlsPort <UInt16>]
[-SipTrunkTcpPort <UInt16>]
[-SipTrunkTlsPort <UInt16>]
[-VideoPortCount <UInt16>]
[-VideoPortStart <UInt16>]
[-WhatIf]
[<CommonParameters>]
Description
The Video Interop Server (VIS) in Skype for Business Server incorporates 3rd party video teleconferencing systems (VTCs) into your Skype for Business Server infrastructure. The VIS is a service that runs on a standalone pool and cannot be co-located on an FE pool.
To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. Video Gateways route traffic between internal and 3rd party video devices such as an internal Skype endpoint receiving video from a 3rd party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a VIS use a Session Initiation Protocol (SIP) trunk to connect video calls between 3rd party VTCs and internal endpoints.
After the Video Interop Server has been defined by using the Topology Builder, you can then modify the properties of that server by using the Set-CsVideoInteropServer
cmdlet.
To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt.
Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "Set-CsVideoInteropServer"}
Examples
Example 1
Set-CsVideoInteropServer -Identity "VideoInteropServer:atl-cs-001.litwareinc.com" -SipTrunkTlsPort 444
This example sets the SIP trunk TLS port for the Video Interop server VideoInteropServer:atl-cs-001.litwareinc.com to port 444.
Example 2
Get-CsService -VideoInteropServer | Set-CsVideoInteropServer -SipTrunkTlsPort 444
This example sets the SIP trunk TLS port for all the organization's Video Interop servers is set to port 444.
This the command first calls the Get-CsService
cmdlet, along with the VideoInteropServer parameter, to return a collection of all the Video Interop servers configured for use in the organization.
That collection is then piped to the Set-CsVideoInteropServer
cmdlet, which changes the TLS port for each server in the collection.
Parameters
-AudioPortCount
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-AudioPortStart
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
First port in the range of ports allocated for sending and receiving audio traffic.
For example: -AudioPortStart 60000
.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Confirm
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Force
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error message that might occur when running the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Identity
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Video Interop Server to be modified.
For example: -Identity "VideoInteropServer:atl-cs-001.litwareinc.com"
.
Parameter properties
Type: | XdsGlobalRelativeIdentity |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 2 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Registrar
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Service identity of the Registrar associated with the Video Interop Server.
For example: -Registrar "Registrar:atl-cs-001.litwareinc.com"
.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-RegistrationTcpPort
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
This parameter is reserved for internal Microsoft use.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-RegistrationTlsPort
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
This parameter is reserved for internal Microsoft use.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-SipTrunkTcpPort
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
TCP (Transmission Control Protocol) listening port on the Video Interop Server used for SIP trunk communication with a Video Gateway.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-SipTrunkTlsPort
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
TLS (Transport Layer Security) listening port on the Video Interop Server used for SIP trunk communication with a Video Gateway.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-VideoPortCount
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Total number of ports allocated for sending and receiving video traffic. The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-VideoPortStart
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
First port in the range of ports allocated for sending and receiving video traffic.
For example: -AudioPortStart 60000
.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-WhatIf
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Rtc.Management.Xds.DisplayVideoInteropServer
The Set-CsVideoInteropServer
accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayVideoInteropServer object.
Outputs
None
The Set-CsVideoInteropServer
cmdlet does not return any objects or values.