Export-CsConfiguration
Topic Last Modified: 2012-03-23
Exports your Microsoft Lync Server 2010 topology, policies, and configuration settings to a file. Among other things, this file can then be used to restore this information to the Central Management store after an upgrade, a hardware failure, or some other issue has resulted in data loss.
Syntax
Export-CsConfiguration -FileName <String> [-Force <SwitchParameter>] [-LocalStore <SwitchParameter>]
Export-CsConfiguration [-AsBytes <SwitchParameter>] [-Force <SwitchParameter>] [-LocalStore <SwitchParameter>]
Detailed Description
Computers that run Lync Server 2010 services or server roles must have a copy of the current topology, current configuration settings, and current policies before they can function in their appointed role. Lync Server is responsible for ensuring that this information is passed along to each computer that needs it.
The Export-CsConfiguration and Import-CsConfiguration cmdlets are used to backup and restore your Lync Server topology, configuration settings, and policies during a Central Management store upgrade. The Export-CsConfiguration cmdlets enables you to export data to a .ZIP file; you can then use the Import-CsConfiguration cmdlet to read that .ZIP file and restore the topology, configuration settings, and policies to the Central Management store. After that, the replication services of Lync Server will replicate the restored information to other computers running Lync Server services.
The ability to export and import configuration data is also used when initially configuring computers located in your perimeter network (for example, Edge Servers). When configuring a computer in the perimeter network, you must first perform a manual replication using the CsConfiguration cmdlets: you will need to export the configuration data using Export-CsConfiguration and then copy the .ZIP file to the computer in the perimeter network. After that, you can use Import-CsConfiguration and the LocalStore parameter to import the data. You only need to do this once; after that, replication will take place automatically.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Export-CsConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Export-CsConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
FileName |
Optional |
String |
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. |
AsBytes |
Optional |
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. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. To set the Force parameter to True use this syntax: -Force:$True |
LocalStore |
Optional |
Switch Parameter |
Retrieves the configuration data from the local computer rather than from the Central Management store itself. |
Input Types
None. Export-CsConfiguration does not accept pipelined input.
Return Types
If called along with the AsBytes parameter, Export-CsConfiguration returns configuration information in the form of a byte array.
Example
-------------------------- Example 1 --------------------------
Export-CsConfiguration -FileName "C:\Config.zip"
The command shown in Example 1 exports Lync Server data from the Central Management store to a file named C:\Config.zip.