Set-UMMailboxPIN

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

The Set-UMMailboxPIN cmdlet resets the PIN for a Unified Messaging (UM)–enabled mailbox.

Syntax

Set-UMMailboxPIN -Identity <MailboxIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-LockedOut <$true | $false>] [-NotifyEmail <String>] [-Pin <String>] [-PinExpired <$true | $false>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-UMMailboxPIN cmdlet is used when a UM-enabled user has been locked out of their mailbox because they tried to log on by using an incorrect PIN multiple times or because they have forgotten their PIN. You can use this cmdlet to set the user's PIN. The new PIN must comply with the PIN policy rules that are specified on the user's mailbox policy. The new PIN will be sent to the user in e-mail, or sent to an alternative e-mail address. You can control whether the user must reset the PIN at logon, and if the mailbox will continue to be locked.

To run the Set-UMMailboxPIN cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

This parameter is required if the Instance parameter is not used.

Confirm

Optional

System.Management.Automation.SwitchParameter

This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. The default value is $true.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

This parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the whole forest as the scope. This allows the command to access Active Directory objects that are currently not in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You cannot use the DomainController parameter. The command will use an appropriate global catalog server automatically.

  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, are not accepted.

LockedOut

Optional

System.Boolean

This parameter specifies whether the mailbox will continue to be locked. If set to $true, the mailbox will be marked as locked out. By default, if this parameter is omitted or set to $false, the task will clear the locked out status on a mailbox.

NotifyEmail

Optional

System.String

This parameter specifies the e-mail address to which the server will send the e-mail message that contains the PIN reset information. By default, the message is sent to the SMTP address of the enabled user.

Pin

Optional

System.String

This parameter specifies a new PIN for use with this mailbox. The PIN will be checked against the PIN rules that are defined in the UM policy. If the PIN is not supplied, the task will generate a new PIN for the mailbox and include it in an e-mail message sent to the user.

PINExpired

Optional

System.Boolean

This parameter specifies whether the PIN will be treated as expired. If this parameter is supplied and is set to $false, the user will not be required to reset their PIN the next time that they log on. If the PIN is not supplied, the PIN will be treated as expired and the user will be prompted to reset their PIN the next time that they log on.

WhatIf

Optional

System.Management.Automation.SwitchParameter

This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. The default value is $true.

Input Types

Return Types

Errors

Error Description

 

 

Example

The first example resets the PIN on the UM-enabled mailbox for yanli@contoso.com.

The second example resets the initial PIN on the UM-enabled mailbox for yanli@contoso.com to 1985848 and then sets the PIN as expired so that the user will be asked to change the PIN the next time that they log on.

The third example locks the UM-enabled mailbox for yanli@contoso.com to prevent the user from accessing their mailbox.

The fourth example unlocks the UM-enabled mailbox for yanli@contoso.com and allows them to access to their mailbox.

Set-UMMailboxPIN -Identity yanli@contoso.com

Set-UMMailboxPIN -Identity yanli@contoso.com -PIN 1985848 -PinExpired $true

Set-UMMailboxPIN -Identity yanli@contoso.com -LockedOut $true

Set-UMMailboxPIN -Identity yanli@contoso.com -LockedOut $false