The following verbs are supported by most cmdlets and are associated with a specific action.

Transcription

1 Common Cmdlet Actions The following verbs are supported by most cmdlets and are associated with a specific action. New The New verb creates a new instance of something, such as a new configuration setting, a new database, or a new SMTP connector. The Remove verb removes an instance of something, such as a mailbox or transport rule. Remove All Remove cmdlets support the WhatIf and Confirm parameters. For more information about these parameters, see Important Parameters. Enable The Enable verb enables a setting or mail-enables a recipient. Disable The Disable verb disables an enabled setting or mail-disables a recipient. All Disable tasks also support the WhatIf and Confirm parameters. For more information about these parameters, see Important Parameters. Set Get The Set verb modifies specific settings of an object, such as the alias of a contact or the deleted item retention of a mailbox database. The Get verb queries a specific object or a subset of a type of object, such as a specific mailbox, all mailbox users, or mailbox users in a domain. Important Parameters The following parameters help you control how your commands run and indicate exactly what a command will do before it affects data. Identity The Identity parameter identifies the unique object for the task. It is typically used with Enable, Disable, Remove, Set, and Get cmdlets. Identity is also a positional parameter, which means that you don't have to specify Identity when you specify the parameter's value on the command line. For example: Get-Mailbox -Identity user1 queries for the mailbox of user1. Get-Mailbox user1 is equivalent to Get-Mailbox -Identity user1. WhatIf The WhatIf parameter instructs the cmdlet to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without actually applying any of the changes. The default value is $True. Confirm The Confirm parameter causes the cmdlet to pause processing and requires the administrator to acknowledge what the cmdlet will do before processing

2 continues. The default value is $True. The Validate parameter causes the cmdlet to check that all prerequisites for Validate running the operation are satisfied and that the operation will complete successfully. Tips and Tricks This cmdlet retrieves all tasks that can be executed in Exchange Server Get-Command Get-Command This cmdlet retrieves tasks that have keyword in the cmdlet. *keyword* Get-task Get-Member Get-task Format-List Help task Help task<tab> Get-task Format-List > file.txt This cmdlet retrieves all properties and methods of task. This cmdlet displays the output of the query in a formatted list. You can pipe the output of any Get cmdlet to Format-List to view the whole set of properties that exist on the object returned by that command, or you can specify specific properties that you want to view, separated by commas, as in the following example: Get-Mailbox *john* Format-List alias,*quota This cmdlet retrieves Exchange Management Shell help information for any task in Exchange 2007, as in the following example: Help Get- Mailbox Enter a partial name for task, and then press the TAB key to cycle through all cmdlets that contain the text that you specified. You can also use wildcard characters, as in the following example: Help *UM* This cmdlet exports the output of task to a text file: file.txt Recipients Contact Management Enabl contact -Identity "John Smith" -alias smith - external address smith@contoso.com This command mail-enables the contact John Smith by specifying the distinguished name (DN) for the contact, and providing the alias smith and an external address smith@contoso.com. Disabl Contact -Identity smith Set-MailContact -Identity smith - This command mail-disables the contact by specifying the alias of the contact in the Identity parameter. This command changes the alias of the mail-

3 Alias jsmith Set-Contact -Identity jsmith - Manager user1 enabled contact specified in the Identity parameter from smith to jsmith by using the Alias parameter. This command modifies the contact jsmith's Active Directory directory service information by changing jsmith's manager to User1. Note: If the contact is not mail-enabled, you can't retrieve it by using an alias. You must use the contact's full name, GUID, or DN. Group Management Enable-DistributionGroup -Identity "contoso\distribution Group" -Alias DG Disable-DistributionGroup -Identity DG Set-DistributionGroup -Identity DG - Alias group1 Add-DistributionGroupMember - Identity DG -Member user1 Get-DistributionGroupMember - Identity DG Set-Group -Identity DG -DisplayName "Universal DG" New-DynamicDistributionGroup - Name DDG -Alias DDGAlias - OrganizationalUnit OU - IncludedRecipients MailboxUsers Set-DynamicDistributionGroup - Identity DDG -DisplayName DDG1 This command mail-enables the existing universal distribution group named Distribution Group that is in the contoso domain. It is the alias DG. This command mail-disables the mail-enabled universal distribution group named DG. This command modifies the settings of the universal distribution group named DG in Exchange by changing its alias to group1. This command adds the recipient user1 as a member of the universal distribution group DG. This command retrieves all the members of the distribution group named DG. This command modifies the Active Directory settings of the Windows group named DG by changing its display name to "Universal DG". This command creates a new query-based dynamic distribution group named DDG. The IncludedRecipients parameter accepts the following values: None MailboxUsers Resources MailContacts MailGroups MailUsers AppRecipients. This command modifies the display name of the dynamic distribution group named DDG1 by changing the name to DDG1. Mailbox Management Enabl box -Identity contoso\user1 -Database This command mailbox-enables an existing Active Directory user with the domain and alias

4 MailboxDatabase Disable -Mailbox -Identity user1 Set-Mailbox -Identity user1 -alias user2 Get-Mailbox Export-Mailbox - PSTFolderPath C:\PSTFiles Import-Mailbox john@contoso.com - PSTFolderPath C:\PSTFiles\john.pst Get-Mailbox Format-Table alias, *quota Get-Mailbox -Database MailboxDatabase Get-Mailbox -server Server Get-MailboxStatistics -Database MailboxDatabase Get-MailboxStatistics -Server Server Mov box -Identity user1 - TargetDatabase Server\MailboxDatabase combination contoso\user1 by creating a mailbox in the mailbox database named MailboxDatabase. This command mailbox-disables the user with the alias user1 by removing its associated mailbox. This command modifies a mailbox by changing the existing alias user1 to user2. This command retrieves all mailbox users and exports their mailboxes to.pst files. The.pst files are stored in C:\PSTFiles. Note: You can export mailbox data to.pst files by using the Export-Mailbox cmdlet in Exchange 2007 SP1 only. This command imports the mailbox data for the user john@contoso.com from the.pst file c:\pstfiles\john.pst. Note: The Import-Mailbox cmdlet is available in Exchange 2007 SP1 only. This command retrieves all mailbox users and formats the output to include the alias of the mailbox and the mailbox quotas. This command retrieves a summary list of all mailboxes in the mailbox database named MailboxDatabase. This command retrieves a summary list of all mailboxes on the server named Server. This command retrieves the mailbox statistics for all mailboxes that are located in the mailbox database named MailboxDatabase. This command retrieves the mailbox statistics for all mailboxes that are located on the server named Server. This command moves the mailbox associated with the alias user1 to the server named Server. The mailbox is moved to the mailbox database named MailboxDatabase.

5 Customizable Mailbox Quota Messages New-SystemMessage - QuotaMessageType ProhibitSendMailbox -Text "Prohibit Send Mailbox Quota Message Text" -Language En This command creates a new customized quota message for the ProhibitSendMailbox quota message type. The text "Prohibit Send Mailbox Quota Message Text" is displayed in English, as specified by the locale code En. The valid values for the QuotaMessageType parameter are WarningMailboxUnlimitedSize and WarningPublicFolder. Set-SystemMessage En\ProhibitSendMailbox -Text "New Prohibit Send Mailbox Quota Message Text" Get-SystemMessage En\ProhibitSendMailbox Remove-SystemMessage En\ProhibitSendMailbox This command modifies the existing customized quota message for the ProhibitSendMailbox quota message type that is displayed in English, as specified by the locale code En. The new text is "New Prohibit Send Mailbox Quota Message Text". This command retrieves the existing customized quota message for the ProhibitSendMailbox quota message type that is displayed in English, as specified by the locale code En. This command removes the existing customized quota message for the ProhibitSendMailbox quota message type that is displayed in English, as specified by the locale code En. Recipient Get-Recipient - RecipientType MailboxUser Get-Recipient - Anr "user" Get-Recipient - ResultSize 100 This command retrieves a summary list of all recipients that match the RecipientType MailboxUser. The RecipientType parameter accepts the following values: User MailboxUser MailEnabledUser Contact MailEnabledContact Group MailEnabledUniversalDistributionGroup MailEnabledUniversalSecurityGroup MailEnabledNonUniversalGroup DynamicDL PublicFolder PublicDatabase SystemAttendantMailbox SystemMailbox MicrosoftExchange. This command retrieves a summary list of all recipients that contain the string "user" in the mailbox name. The Anr parameter indicates that the argument will be resolved by using ambiguous name resolution (ANR). This command retrieves a summary list of recipients and returns only the first 100 recipients. Unified Messaging Get-UMMailbox This command retrieves a summary list of all Unified Message (UM)-enabled recipients.

6 Get-UMMailbox -Identity user1 Format-List Set-UMMailbox -Identity user1 -UMEnabled $True This command retrieves the detailed configuration of the UM mailbox that is associated with the alias user1. This command modifies the UM mailbox associated with the alias user1 by changing the value of the UMEnabled parameter to $True. User Enabl User -Identity contoso\user2 -External Address Disabl User -Identity user2 Set-MailUser -Identity user2 - External Address user2@research.northwindtraders.com This command mail-enables the Active Directory user contoso\user2 with an external address user2@northwindtraders.com. With this cmdlet, a default primary SMTP address user2@contoso.com is also created. This command mail-disables the Active Directory mail-enabled user user2. This command modifies the Active Directory mail-enabled user user2 by changing its external address to user@research.northwindtraders.com Storage Database Management New-MailboxDatabase -Name MailboxDatabase -StorageGroup StorageGroup Set-MailboxDatabase -Identity MailboxDatabase - IssueWarningQuota 500MB This command creates a new mailbox database named MailboxDatabase in the storage group StorageGroup. This command modifies the mailbox database MailboxDatabase by changing its mailbox warning quota limit to 500MB. Get-MailboxDatabase -StorageGroup StorageGroup This command retrieves a summary list of all mailbox databases in the storage group named StorageGroup. Get-MailboxDatabase -Server Server Mount-Database -Identity MailboxDatabase Dismount-Database -Identity MailboxDatabase Enable-DatabaseCopy -Identity This command retrieves a summary list of all mailbox databases in the server named Server. This command mounts the existing mailbox database named MailboxDatabase. This command dismounts the existing mailbox database named MailboxDatabase. This command enables local continuous backup for the mailbox database named

7 MailboxDatabase Storage Group Management New-StorageGroup -Name StorageGroup -Server server1 MailboxDatabase. This command creates a new storage group named StorageGroup on the server named server1. Set-StorageGroup -Identity This command modifies the storage group named StorageGroup -Name "Research StorageGroup by changing its display name to Storage Group" "Research Storage Group". This command enables local continuous backup on storage group named StorageGroup. Enable-StorageGroupCopy - Identity StorageGroup Disable-StorageGroupCopy - Identity StorageGroup Note: You must first enable local continuous backup by using the Enable-DatabaseCopy cmdlet for each database in the storage group on which you want to enable local continuous backup. This command disables the continuous backup of storage group named StorageGroup. Transport Connectors and Delivery New-SendConnector -Name SendConnector -AddressSpaces contoso.com Set-SendConnector -Identity SendConnector -AddressSpaces northwindtraders.com New-ReceiveConnector -Name ReceiveConnector - RemoteIpRanges Bindings :25 Set-ReceiveConnector -Identity ReceiveConnector - MaxMessageSize 20MB Queues Suspend-Queue -Identity Server\Queue Resume-Queue -Identity This command creates a new Internet Send connector named SendConnector. The associated address space for the Send connector is contoso.com. This command modifies the Send connector named SendConnector by changing its address spaces to northwindtraders.com. This command creates a new Receive connector named ReceiveConnector. The associated remote IP range is to By setting the Bindings parameter to :25, you instruct the server to listen for connections on all locally configured IP addresses on port 25. This command modifies the Receive connector ReceiveConnector by changing the value of the MaxMessageSize parameter to 20MB. This command stops all messages in queue Server\Queue from being delivered. This command allows the suspended queue

8 Server\Queue Get-Message -Identity Server\Queue\Message Suspend-Message -Identity Server\Queue\Message Get-Queue Freeze-Queue Resume-Message -Identity Server\Queue\Message Delete-Message -Identity Server\Queue\Message Export-Message -Identity Server\Queue\Message -Path FilePath Address Rewriting New-AddressRewriteEntry -Name RewriteEntryName - InternalAddress david@contoso.com - ExternalAddress support@contoso.com Server\Queue to resume delivery of messages. This command retrieves the specific message Server\Queue\Message. This command stops the message Server\Queue\Message in a queue from being delivered. This command freezes all queues on the local server. This command allows the suspended message Server\Queue\Message in a queue to be delivered. This command deletes the specified message Server\Queue\Message. This command exports the specified message Server\Queue\Message to FilePath. Note: Before you can export a message, you must first suspend it by using the Suspend-Message cmdlet. This command creates a new address rewrite entry for the internal address david@contoso.com. All messages sent from david@contoso.com are rewritten to support@contoso.com, and all inbound messages to support@contoso.com are rewritten to david@contoso.com. Set-AddressRewriteEntry -Identity RewriteEntryName - InternalAddress chris@contoso.com Anti-Spam Set-RecipientFilterConfig - BlockedRecipients info@contoso.com, corp@contoso.com This command modifies the existing address rewrite entry RewriteEntryName by changing the value of the InternalAddress parameter to chris@contoso.com. This command modifies the recipient filtering configuration by adding the blocked recipients info@contoso.com and corp@contoso.com. Set-SenderFilterConfig - BlockedSenders badsender@northwindtraders.com This command modifies the sender filtering configuration for spam by adding a blocked sender badsender@northwindtraders.com.

9 Add-ContentFilterPhrase -Phrase "spam" -Influence BadWord Add-IPAllowListEntry -IpRange Add-IPAllowListEntry -IpRange " ( )" Add-IPAllowListEntry -IpRange Add-IPBlockListEntry -IpRange This command adds the phrase "spam" to the content filter by setting its Influence parameter to BadWord. The Influence parameter accepts the values BadWord and GoodWord. This command adds the IP address to the IP Allow list. The IP mask defaults to because it is not specified. This command adds the IP address to the IP Allow list, which has a specified IP mask of This command adds an allowed range of IP addresses. In this case, the IP range is between and This command adds the IP address to the IP Block list. In this case, the IP mask defaults to because it is not specified. Test-IPAllowListProvider -Identity AllowListProvider -IPAddress Add-IPAllowListProvider -Name Provider1 -LookupDomain -IPAddressesMatch Add-IPBlockListProvider -Name Provider2 -LookupDomain -IPAddressesMatch This command tests a specified IP address to see whether it is listed as an allowed IP address with the IP Allow List provider IPAllowListProvider. This command adds an IP Allow List provider called Provider1, which is used to verify which IP addresses are allowed. The associated lookup domain is and the IP address that must match the result returned by the IP Allow List provider is This command adds an IP Block List provider named Provider2, which is used to verify which IP addresses should be blocked. The associated lookup domain is and the IP address that must match the result returned by the IP Block List provider is Get-SenderIdConfig Add-AttachmentFilterEntry -Name image/jpeg -Type ContentType This command retrieves the Sender ID configuration settings. This command adds an attachment filter entry that is used to block all JPEG attachments, based on the attachment's content type

10 image/jpeg, regardless of the file name. Add-AttachmentFilterEntry -Name *.EXE -Type FileName Remove-AttachmentFilterEntry ContentType:image/jpeg Remove-AttachmentFilterEntry FileName:*.EXE Set-AttachmentFilterListConfig - RejectResponse "The attachment you included in your message was not allowed." -Action Reject This command adds an attachment file entry that is used to block all attachments that have the file name extension *.EXE. This command removes an attachment filter entry that is used to filter JPEG attachments based on the attachment's content type image/jpeg. This command removes an attachment filter entry that is used to filter all attachments that have the file name extension *.EXE. This command configures the Attachment Filter agent to reject all messages that contain filtered attachments. Both the attachment and message are blocked, and the configured text is used in the message body of the non-delivery report (NDR) that is sent to senders whose messages contain an attachment that is blocked. Available actions are Reject, Strip and SilentDelete. Customizable Delivery Status Notification (DSN) Messages New-SystemMessage - DsnCode Text "DSN Message Text" -Internal $False -Language En Set-SystemMessage - Identity En\External\ Text "New DSN Message Text" This command creates a new customized DSN message for the DSN code The text of the DSN message is "DSN Message Text", the language the message is displayed in is English, specified by the locale code En, and the DSN message is sent to both internal and external senders. This command modifies the existing customized DSN message for the DSN code The identity consists of the language, specified by the locale code En, whether the DSN message scope is internal or external, and the DSN code En\External\ The text of the DSN message is changed to "New DSN Message Text". Get-SystemMessage - Identity En\External\5.7.0 Get-SystemMessage - Original $True Remove-SystemMessage - This command retrieves the existing customized DSN message for the DSN code by using the identity En\External\ This command retrieves a list of all built-in DSN messages. This command removes the existing customized DSN message for the DSN code by using the identity

11 Identity En\External\5.7.0 En\External\ Policy and Compliance Hub Transport Rules $Condition = Get- TransportRulePredicate BetweenMemberOf $Condition.Addresses = (Get- DistributionGroup "Group1") $Condition.Addreses2 = (Get- DistributionGroup "Group2") $Action = Get- TransportRuleAction RejectMessage This command creates the transport rule RuleName on a Hub Transport server. The rule rejects all messages sent between the Group1 and Group2 distribution groups. A NDR is sent to the sender of the messages that have the text RejectText. $Action.RejectReason = "RejectText" New-TransportRule -Name "RuleName" Get-TransportRule -Identity RuleName Format-List (Get-TransportRule -Identity RuleName).Conditions Format- List (Get-TransportRule -Identity RuleName).Exceptions Format- List (Get-TransportRule -Identity RuleName).Actions Format-List Remove-TransportRule -Identity RuleName Journal Rules New-JournalRule -Name "JournalRuleName" -Recipient This command retrieves the detailed configuration of the transport rule RuleName. This command retrieves a list of conditions and their values that are configured on the transport rule RuleName. This command retrieves a list of exceptions and their values that are configured on the transport rule RuleName. This command retrieves a list of actions and their values that are configured on the transport rule RuleName. This command removes the transport rule RuleName. This command creates the journal rule JournalRuleName. Copies of all

12 - Journal Address "Journal Reports" - Scope Global messages set to and from MailboxToJournal@contoso.com are sent to the mailbox Journal Reports as attachments within journal message envelope. The journal rule is enabled upon creation. Valid values for the Scope parameter are Internal, External, and Global. This command modifies the journal rule Set-JournalRule -Identity JournalRuleName JournalRuleName by setting the value of -Recipient the Recipient parameter to DistributionGroupToJournal@contoso.com DistributionGroupToJournal@contoso.com. Set-TransportConfig - JournalingReportNdrTo AltJournalReports@contoso.com This command configures Exchange to redirect journal reports to AltJournalReports@contoso.com if the primary journaling mailbox is temporarily unavailable. Servers Get-ExchangeServer Get-ExchangeServer - Domain contoso.com Get-ExchangeServer - Status This command retrieves a summary list of all existing servers. This command retrieves a summary list of all servers in the domain contoso.com. This command retrieves a summary list of all existing servers and forces a call to update the server's current status. Without the Status parameter, some fields that change in real-time are not populated.