[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Exports the Microsoft Communications Server “14” topology. By importing this data on another computer, you enable topology information to be passed to that computer without waiting for replication to take place.


Export-CsConfiguration -FileName <String> [-Force <SwitchParameter>] [-LocalStore <SwitchParameter>]
Export-CsConfiguration [-AsBytes <SwitchParameter>] [-Force <SwitchParameter>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description




Path to the .ZIP file to be created when you run Export-CsConfiguration. For example: -FileName "C:\Config.zip". Note that you must include either the –FileName or the –AsBytes parameters, but not both, when calling Export-CsConfiguration.



Switch Parameter

Returns topology information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsConfiguration cmdlet. You cannot use both –AsBytes and –FileName in the same command.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.

Detailed Description

Computers that run Microsoft Communications Server “14” services or server roles must have a copy of the current topology before they can function in their appointed role. When you set up a new Communications Server computer (for example, a new Monitoring or Archiving server) you typically wait for the regular replication cycle to transmit the current topology to the new computer. Alternatively, you can use the Export-CsConfiguration and Import-CsConfiguration cmdlets to manually replicate the topology to the new computer. Export-CsConfiguration enables you to retrieve the current topology and store it either as a .ZIP file or in a variable; that .ZIP file or variable can then be read in on the new computer by using Import-CsConfiguration. The net effect: topology information will be copied to the new computer, without having to wait for replication.

Return Types

Export-CsConfiguration does not return any values or objects.


-------------------------- Example 1 --------------------------

Copy Code
Export-CsConfiguration -FileName "C:\Config.zip"

The command shown in Example 1 exports the current topology to a file named C:\Config.zip. The resulting .ZIP file will contain a copy of the current topology in XML format.

-------------------------- Example 2 --------------------------

Copy Code
$x = Export-CsConfiguration -AsBytes
Import-CsConfiguration -ByteInput $x

The two commands shown in Example 2 export and import the current topology without using a .ZIP file. To do this, the first command uses Export-CsConfiguration and the –AsBytes parameter to return a current topology as a byte array; this byte array is stored in a variable named $x. In the second command, Import-CsConfiguration and the –ByteInput parameter are used to read in the topology information stored in $x.