cmdlet

When SupportsShouldProcess is specified, cmdlets that attempt to declare these parameters will fail when trying to register the cmdlet.

When you're ready to go much deeper into creating your own custom cmdlets, be sure to check out the Windows PowerShell SDK.

Notice that only one property type can be displayed at a time, specified by a property name that follows the Format-Wide cmdlet.

You may not know, however, that you can extend Windows PowerShell by writing your own cmdlets.

The MaxMessageSize parameter is only one of many Receive connector settings that are available for use with the Set-ReceiveConnector cmdlet.

This can lead to some confusion when you're trying to figure out why your cmdlet doesn't have the parameters you think it should have.

The Enable-StorageGroupCopy cmdlet did not perform automatic initial seeding for the specified storage group.

This setting indicates whether the parameter can receive its value as an input through a pipeline from another cmdlet.

This cmdlet returns only the configuration information for the Edge Transport server on which this cmdlet runs.

You can use the Get-Message cmdlet to retrieve a set of messages and then pipe the results to one of the intrusive cmdlets.

The Set-ActiveSyncMailboxPolicy cmdlet enables you to set each parameter in a mailbox policy.

The Set-AuthenticodeSignature cmdlet takes the name of the file to be signed as its first positional parameter.

The Instance parameter enables you to pass an entire object to the cmdlet to be processed.

By default, all certificate requests and certificates created by this cmdlet will not allow the private key to be exported.

When this cmdlet is run on an Edge Transport server, only the transportation configuration settings for the local computer are shown.

This should describe what the cmdlet does and what sort of resource the cmdlet works with.

The Set-ActiveSyncMailboxPolicy cmdlet enables you to apply a variety of mailbox policy settings to a server.

If you have a load balanced set of Client Access servers, you do not have to specify the name of each server when you run the cmdlet.

In the example, the objects that are returned by the Get-Alias cmdlet represent all the defined aliases on the system.

You do not have to wait for nightly maintenance or run the Clean-MailboxDatabase cmdlet for the mailbox to be disconnected.

The mailbox is not deleted, and can be reconnected to its user at a later date by using the Connect-Mailbox cmdlet.

If you do not specify a server, the cmdlet checks if the local server is an Exchange 2007 Mailbox server that has a public folder database.

If the Format-List cmdlet is called without any parameters specified, all properties are output.

This cmdlet allows you to retrieve the permissions set for an Active Directory object.

The Set-EmailAddressPolicy cmdlet allows administrators to set the Active Directory attributes for a specific e-mail address policy.

To get a complete list of all the fields in the output, run the cmdlet with an fl (formatted list) or ft (formatted table) option.

This allows you to create formatting directives for the objects that the cmdlets emit.

This topic provides an overview of the cmdlet you can use to generate these reports and information about the content of these reports.

Sometimes it's useful to convert the output of a cmdlet to a string to interoperate with native cmdlets.

This setting indicates whether the cmdlet will run if you do not supply the parameter.

You could then use any of the three aliases to run the Move-Mailbox cmdlet.

This cmdlet can be used to set UM properties individually by using either the Identity parameter or the Instance parameter.

The Set-UMDialplan cmdlet can be used to set various properties on a Unified Messaging (UM) dial plan.

You can override sending the output to the console window by calling the Out-Host cmdlet as the last cmdlet in the command.

For most general tasks, running cmdlets one at a time or together through pipelines is sufficient.

You can use the Start-EdgeSynchronization cmdlet to start immediate synchronization and bring ADAM up to date.

Using the Retry-Queue cmdlet without the Resubmit parameter forces the delivery queue to try to connect to the next hop immediately.

To tell the Get cmdlet to return verbose information when you run a command, pipe the command to the Format-List cmdlet.

If you do not specify the server name, the cmdlet will search for the database on the local server.

If more than one object is passed to the Format-List cmdlet, all specified properties for an object are displayed and grouped by object.

Confirm specifies whether user confirmation is required before a cmdlet performs an action that modifies the system.

The Get-StorageGroupCopyStatus cmdlet reports a SummaryCopyStatus of Synchronizing when it has not completed incremental reseed.

The Format-List cmdlet takes input from the pipeline and outputs a vertical columned list of all the specified properties of each object.

This allows the cmdlet to call the ShouldProcess method before performing its action.

If this parameter is specified, the cmdlet returns the IP port to use for communication for a Secure Sockets Layer (SSL) session.

However, when List is specified, the cmdlet returns information about the log files themselves (not the event information they contain).

The first argument on a cmdlet is assumed to be the Identity parameter when no parameter label is specified.

The Set-TransportServer cmdlet does not require the Identity parameter to be specified when you run the command.

You must supply any required parameters and their values exactly as if you had called the cmdlet name.

As mentioned earlier, the Get-StorageGroupCopyStatus cmdlet also displays the values of these counters.

The Cmdlet class provides virtual methods, shown in Figure 2, that can be used to process records.

The Get-TransportAgent cmdlet is used to view the configuration of a transport agent on an Edge Transport server or a Hub Transport server.

This Set-OABVirtualDirectory cmdlet allows you to change the configuration of an OAB web distribution point on a Client Access server.

Finally, cmdlets are record-oriented and generally process a single object at a time.

Use the Suspend-PublicFolderReplication cmdlet to stop public folder replication for the organization.

Use the Restore-Mailbox cmdlet to extract mailbox content from a database restored to a recovery storage group.

The Get-ReceiveConnector cmdlet retrieves the configuration information for a Receive connector.

The Get-ForeignConnector cmdlet retrieves the configuration information for a Foreign connector.

Use the Set-ResourceConfig cmdlet to set resource property schema and resource locations on the Resource Config object in Active Directory.

The Get-AttachmentFilterListConfig cmdlet enables the administrator to view the configuration information for the Attachment Filter agent.

The Get-Group cmdlet returns all the existing groups in Microsoft Windows that match the specified filtering parameters.

Use the Get-DynamicDistributionGroup cmdlet to retrieve the settings on an existing dynamic distribution group.

Use the Set-MailboxDatabase cmdlet to set the attributes of a mailbox database.

For more information about Exchange Management Shell cmdlets for routing group connectors, see Routing Group Connector Cmdlets.

Use the Update-PublicFolderHierarchy cmdlet to start content synchronization of the public folder hierarchy.

The Get-UMMailboxPolicy cmdlet displays the properties and values of a Unified Messaging (UM) mailbox policy.

For a dynamic distribution group, the manager is controlled by the ManagedBy parameter in the Set-DynamicDistributionGroup cmdlet.

However, if you think that your code will be used in more than just Windows PowerShell, you should use Cmdlet as a base class.

The Out-Host cmdlet is an unseen default cmdlet at the end of the pipeline.

Support for log file copying over a mixed network is configured using a new cmdlet called Enable-ContinuousReplicationHostName.

The results that are returned when you run the Test-EdgeSynchronization cmdlet indicate whether the recipient is synchronized.

Even though you don't see them from the command line, the aliases are collected and passed to the Where cmdlet through the pipeline.

This cmdlet resumes delivery of a previously suspended message.

The Move-ClusteredMailboxServer cmdlet is used to initiate a scheduled outage of a clustered mailbox server between nodes.

One or more of these methods must be overridden by all derived cmdlet classes.

Anything that you do after you run this cmdlet will be recorded to a text file that you specify.

To apply additional roles to a user or group, run the Add Exchange Administrator wizard again or use the Add-ExchangeAdministrator cmdlet.

To determine whether the Attachment Filter agent is enabled, run the Get-TransportAgent cmdlet.

This cmdlet lets you view the configuration details of the queues that are present on transport servers.

Cmdlets derived from the Cmdlet class offer only the fewest dependencies on the Windows PowerShell runtime.

Use the Get-UMDialPlan cmdlet to obtain the FQDN of a SIP URI dial plan, and then create its corresponding location profile.

The Export-Alias cmdlet writes the current alias list to a file in comma-separated values (CSV) format.

This section provides information about the recipient cmdlets that are available in the Microsoft Exchange Management Shell.

Use the Get-PublicFolderClientPermission cmdlet to retrieve the user permissions for a public folder.

Use the Get-PublicFolder cmdlet to retrieve the attributes of a public folder or a set of public folders.

This cmdlet must be run locally on the computer for which you want to retrieve the network adapter GUID.

By default, the Format-Wide cmdlet tries to display as many columns of property values as possible on a line of output.

The Format-Table cmdlet lets you display items in a table format with label headers and columns of property data.

Although the specific requirements for each cmdlet may be different, you use templates in the same manner for all cmdlets.

Use the Instance parameter to pass a complete object to the cmdlet to be processed.

The following examples show the different ways that you can view the same data returned by the Get-Mailbox cmdlet.

The Set-MailboxCalendarSettings cmdlet lets you enable calendar processing for a mailbox.

The Get-SendConnector cmdlet displays the configuration information for a Send connector.

The Get-Queue cmdlet displays information about existing queues on a Hub Transport server or an Edge Transport server.

Remote The Test-UMConnectivity cmdlet tries to connect to a remote Unified Messaging server by placing a call through an IP gateway.

You cannot import data by using the Import-Mailbox cmdlet into a public folder database.

You can assign the CSV file to a variable or you can pipe its contents directly to another cmdlet.

You can use the Set-Contact cmdlet to modify the settings of contact objects that are visible in Active Directory Users and Computers.

Running the cmdlet without parameters retrieves the configuration information for all Send connectors.

Use the Get-AgentLog cmdlet to run usage queries against the default logs that anti-spam agents generate.

This parameter is useful in scripts where an entire object must be passed to the cmdlet.

Use the Set-DynamicDistributionGroup cmdlet to modify the settings of an existing dynamic distribution group.

This integer indicates the position on the command line where the cmdlet can find the parameter's value.

Use the Get-EmailAddressPolicy cmdlet to return all of the attributes on a policy or set of policies.

This parameter determines whether the cmdlet will test internal or external URLs.

Use this switch parameter to overwrite an existing certificate request file that matches the same file path as specified in this cmdlet.

The Get-Mailbox cmdlet retrieves the attributes and objects for a mailbox.

Cmdlets generally output objects rather than text and should not format their output.

When you run the Get-TransportServer cmdlet on an Edge Transport server, you cannot specify the Identity parameter.

Use the Set-MailboxCalendarSettings cmdlet to enable calendar processing for a mailbox.

In the second example, the output of the Get-Mailbox cmdlet is piped to the Format-List cmdlet, together with specific properties.

To convert the data that you want to view into HTML, you must pipe the results of your command to the ConvertTo-Html cmdlet.

Each has its own distinct output style that differs from the other formatting cmdlets.

Nouns refer to the object on which the cmdlet takes action.

To specify the fully qualified domain name (FQDN) of the domain controller, include the DomainController parameter on the cmdlet.

The Retry-Queue cmdlet forces a connection attempt for a queue that has a status of Retry.

This cmdlet lets you view the details of the messages that are currently queued for delivery.

Include the parameters and values that you want in the cmdlet.

You can use any Active Directory user attribute to construct a filter string for the Filter parameter in the Get-User cmdlet.

Use the Update-AddressList cmdlet to update the recipients that are included in the address list that you specify.

Use the GUID of the desired network adapter as the value for the InternalDNSAdapterGUID parameter on the Set-TransportServer cmdlet.

Use the Get-OrganizationConfig cmdlet to get configuration data for an Exchange organization.

Use the Update-PublicFolder cmdlet to start content synchronization of a public folder.

You can use the Set-Group cmdlet to modify group object settings that are visible in Active Directory Users and Computers.

This cmdlet suspends delivery of a message that is located in a queue on an Exchange 2007 transport server.

Use the Resume-PublicFolderReplication cmdlet to resume content replication when it has been stopped.

The last thing you want to do is use something like System. Console. WriteLine from a cmdlet.

The Set-IPAllowListProvidersConfig cmdlet sets the configuration used by the Connection Filter agent.

To enable tracing and examine each command step in a script, use the Set-PSDebug cmdlet with the Trace parameter set to a value of 1.

The Enable-DatabaseCopy cmdlet failed to check the status of the copy's database file because the specified server is not accessible.

Using this parameter does not change the behavior of the cmdlet.

If you want information about the basic (not mail related) settings of mail-enabled public folders, use the Get-PublicFolder cmdlet instead.

In addition, these cmdlets can be easily included in other applications without the Windows PowerShell runtime.

The Set-User cmdlet modifies the attributes of an existing user in Active Directory.

Notice that the Start-Transcript cmdlet overwrites the destination text file by default.

Cmdlets that end in "Config" manage singleton configuration, either one per server or organization.

To resolve the Information event, resume content replication on the public folder database using the Resume-PublicFolderReplication cmdlet.

By default, the FQDN of the server where the cmdlet is run will be used as the CN in the resulting certificate.

Use the Stop-ManagedFolderAssistant cmdlet to stop the Managed Folder Assistant as soon as processing of the current mailbox is completed.

All the parameters that are available with the Get-MessageTrackingLog cmdlet are optional.

A cmdlet should not parse its own arguments and it should not specify a presentation for errors.

You can use the Set-ReceiveConnector cmdlet to modify all available settings for an existing Receive connector.

You can use the Set-ForeignConnector cmdlet to modify all available settings for an existing Foreign connector.

Use the Set-Group cmdlet to modify the settings of an existing Microsoft Windows group.

The Identity parameter is a special parameter that you can use with most cmdlets.

The Test-OutlookWebServices cmdlet uses a specified e-mail address to verify that the Outlook provider is configured correctly.

In the most basic usage, calling the Format-Wide cmdlet without any parameters arranges the output in as many columns as will fit the page.

The display order depends on the default parameter for the cmdlet.

Three additional parameters, WhatIf, Confirm, and ValidateOnly, may also be added to cmdlets.

The Set-EmailAddressPolicy cmdlet, however, does not apply the changes to the e-mail address policy.

Use the Import-Mailbox cmdlet to import mailbox data from a. Pst file to a mailbox.

Provides a remote procedure call (RPC) server that can be used to invoke diagnostic cmdlets.

When you specify the CmdletAttribute attribute, you must specify a verb and noun name pair, which will be used as the name of the cmdlet.

The Get-LogonStatistics cmdlet retrieves logon information about sessions that are currently active.

If you don't provide a value for a required parameter, the New-ReceiveConnector cmdlet will prompt you so that the command may continue.

To declare parameters for a cmdlet, you must first define the properties that represent the parameters.

The Name parameter is required when you run the Set-SendConnector cmdlet.

In the Get-SystemMessage cmdlet, the Identity parameter consists of several pieces of data that are configured on each DSN message object.

Use the Get-AddressList cmdlet, piped to Format-List, to get the GUID, distinguished name, or path and name of an existing address list.

The preceding cmdlet syntax provides you with a quick view of the copy status.

To resolve this warning, set the value of the SendProtocolLogPath parameter on the Set-TransportServer cmdlet to a local file path.

Determine whether replication failed by running the Get-StorageGroupCopyStatus cmdlet.

Exchange 2007 includes a set of cmdlets to create, request, and manage TLS certificates.

After all formatting is applied, the Out-Host cmdlet sends the final output to the console window for display.

You can see how this works by using the CSV file in "Example of a CSV File with Optional Parameters Populated" earlier in this topic.

To stop recording your session, use the Stop-Transcript cmdlet.

You can use the Set-TransportServer cmdlet for all message tracking configuration tasks on a Hub Transport server or Edge Transport server.

Use the Set-DistributionGroup cmdlet to modify the settings of an existing distribution group.

Use the Get-MailboxCalendarSettings cmdlet to retrieve the Calendar Attendant configuration on the target mailbox.

The values that you specify by using the Set-ForeignConnector cmdlet replace the existing values that are configured on the Send connector.

The cmdlet then duplicates the configuration exactly on the target Edge Transport server.

This cmdlet resumes deliveries of messages from a previously suspended queue.

They do not have to match the parameter name on the cmdlet.

You must verify that the location specified exists and is accessible before running the Enable-StorageGroupCopy cmdlet.

Windows PowerShell supports cmdlets that are derived from two different base classes: PSCmdlet and Cmdlet.

The transport rule configuration stored in the XML file is read by the Import-TransportRuleCollection cmdlet.

In the second example, the mail settings for the user Ted are retrieved and then piped to the Format-List cmdlet for display.

The Set-UMAutoAttendant cmdlet lets you change or modify the settings of an existing UM auto attendant.

Use the Remove-ManagedFolderMailboxPolicy cmdlet to delete Managed Folder Mailbox Policies.

You can use this cmdlet for one mailbox at a time.

Use the Get-ADPermission cmdlet to get permissions on an Active Directory object.

The task produces the Get-ClusteredMailboxServerStatus cmdlet output when it completes.

These statistics are viewable when using a new parameter for the Get-StorageGroupCopyStatus cmdlet called DumpsterStatistics.

The cmdlet automatically resumes replication to the storage group copy.

You cannot import data by using the Import-Mailbox cmdlet from a. Pst file to a mailbox that is in a recovery storage group (RSG).

Use the Remove-DynamicDistributionGroup cmdlet to delete an existing dynamic distribution group.

For more information about cmdlets, see Understanding Cmdlets.

This cmdlet allows you to grant permissions to a mailbox, for example, granting a user full access to another user's mailbox.

Use the Remove-DistributionGroupMember cmdlet to remove an existing recipient from a distribution group.

You must verify that the directory exists and that there are no files in it before running the Enable-StorageGroupCopy cmdlet.

This example shows the Get-ADPermission cmdlet used to get the permissions for Ted.

Use the Export-ExchangeCertificate cmdlet to export an existing certificate from the certificate store on the local computer.

Use the Set-Mailbox cmdlet to modify the settings of an existing mailbox.

Use the Set-Contact cmdlet to modify the settings of an existing contact.

The cmdlet attribution indicates that I'm using a common verb, in this case Set.

If Force is not provided in the cmdlet, administrative input is prompted.

To configure this option, use the Set-RemoteDomain cmdlet with the MeetingForwardNotificationEnabled parameter.

This check is not performed until the Enable-StorageGroupCopy cmdlet is run.

In this case, the cmdlet will return the logon statistics for all mailboxes on all databases on the local server.

The Export-ActiveSyncLog cmdlet parses the IIS log files and returns information about Exchange ActiveSync usage.

Use the New-RemoteDomain cmdlet to create a managed connection for a remote domain.

WriteWarning is yet another way to communicate with the user, providing information about the execution of your cmdlet.

Cmdlets have a specific structure; they must be attributed in a particular way and they must be derived from a specific base class.

Specifically, when run on a node in the cluster, the Test-ReplicationHealth cmdlet performs the tests described in the following table.

Use the Remove-OABVirtualDirectory cmdlet to remove a server from the offline address book (OAB) distribution points list.

In the following example, the Get-ClusteredMailboxServerStatus cmdlet is used to view the status of a clustered mailbox server named CMS1.

You can also use this cmdlet to verify that e-mail is sent between Mailbox servers within a defined latency threshold.

Using this parameter will reset the test account credentials to use with the Test-PopConnectivity cmdlet.

You can use the Add-AdPermission cmdlet to grant individual permissions on a Send connector or Receive connector.

Use the Move-OfflineAddressBook cmdlet to designate a new server responsible for generating the offline address book (OAB).

The Enable-TransportAgent cmdlet is used to enable a transport agent on an Edge Transport server or a Hub Transport server.

The properties of the class correspond to the parameters available when using the cmdlet.

Use the Disable-JournalRule cmdlet to disable an existing journal rule on a computer that has the Hub Transport server role installed.

The Get-ClientAccessServer cmdlet returns information about all Client Access servers.

This cmdlet forces EdgeSync to replicate the replication account data to the target Edge Transport servers.

Use the Get-MailPublicFolder cmdlet to retrieve mail-related information about mail-enabled public folders.

The Get-StorageGroupCopyStatus cmdlet produces a list of information about each storage group copy.

The Set-UMDialplan cmdlet lets you change or modify the properties of an existing UM dial plan.

The following list of cmdlets is an example of a complete cmdlet set.

Such aliases can be useful when you frequently use certain cmdlets and want to reduce the typing that you must do.

The Enable-UMMailbox cmdlet enables Unified Messaging for an existing mail-enabled Exchange 2007 user.

This variable contains objects for which an error occurred when they are processed in a cmdlet.

The LCR copy is automatically disabled as part of running the Restore-StorageGroupCopy cmdlet.

Use the Add-PublicFolderClientPermission cmdlet to add permissions to public folders.

You can't use the Remove-DistributionGroupMember cmdlet to remove a recipient from a dynamic distribution group.

A cmdlet processes its input objects from an object pipeline rather than from a stream of text.

The corresponding parameter in the Set-TransportServer cmdlet is DelayNotificationTimeout.

Much of the information displayed on the new tab is also available using the Get-ClusteredMailboxServerStatus cmdlet.

Now I need to create the code that will implement my cmdlets, starting with my Set-IsolatedStorageData cmdlet.

Run the Get-NetworkConnectionInfo cmdlet locally on the Hub Transport server or Edge Transport server.

Use the Set-PublicFolder cmdlet to set the attributes of public folders.

Use the Add-MailboxPermission cmdlet to add permissions to a mailbox.

You can use the Add-ADPermission cmdlet to grant the necessary permissions in the domain and configuration partitions.

The Get-MailUser cmdlet retrieves all mail-related attributes of the specified user.

You can use the Start-EdgeSynchronization cmdlet to force synchronization to start immediately.

After you save the file, you can then use the script as a regular cmdlet.

To perform an operation on a queue by specifying its unique database identity, you must first run the Get-Queue cmdlet.

Use the Set-MailPublicFolder cmdlet to configure the mail-related settings of mail-enabled public folders.

To perform an operation on a message by specifying its database identity, you must first run the Get-Message cmdlet.

Use the Add-ContentFilterPhrase cmdlet to define custom words for the Content Filter agent.

You must use the Export-TransportRuleCollection cmdlet to save the transport rule configuration to an XML file.

You can use the Set-MailboxServer cmdlet for all message tracking configuration tasks on a Mailbox server.

The Set-Mailbox cmdlet lets you set the properties of the new mailbox.

You can also use this cmdlet to copy a. Wav audio file from the UM prompt publishing point to a file.

Use the Remove-EdgeSubscription cmdlet to remove the Edge Subscription from the Edge Transport server.

These examples all use the Get-Date cmdlet, from three different locations.

This parameter accepts pipeline input from the Get-Mailbox cmdlet.

To run the Enable-Mailbox cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

You cannot use the Set-Group cmdlet to modify dynamic distribution groups.

If the path doesn't exist, the cmdlet will create the path for you.