Set-CsGroupPickupUserOrbit
Use the Set-CsGroupPickupUserOrbit cmdlet to modify an Enterprise Voice user's group pickup orbit number.
Syntax
Default (Default)
Set-CsGroupPickupUserOrbit
[-User] <String>
-Orbit <String>
[-Confirm]
[-Force]
[-WhatIf]
[<CommonParameters>]
Description
The same orbit can be assigned to multiple users. This cmdlet will throw an exception if the user is not assigned a group pickup orbit number, or if the specified orbit does not exist or is of the wrong type.
Examples
Example 1
Set-CsGroupPickupUserOrbit "Ken Myer" -Orbit "*101"
This example replaces the user's current group pickup orbit number with orbit *101. User is a positional parameter. The first parameter after the cmdlet is assumed to be the User parameter value. In this case, the display name "Ken Myer".
Parameters
-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 messages and completes the cmdlet operation.
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 |
-Orbit
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Specifies the new group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. For more information on creating call park orbits, see New-CsCallParkOrbit.
Values for the Orbit parameter must match the regular expression ([*|#]?[1-9]\d{0,7})|([1-9]\d{0,8}).
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-User
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Specifies the user whose group pickup orbit number will be modified. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value.
Users can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DisplayName, SipAddress, Identity |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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
System.String
This cmdlet supports pipelined input from the Get-CsUser cmdlet.
Outputs
Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit
This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit object.