Export-FIMConfig

Export-FIMConfig

Extracts configuration resources from the Microsoft® Forefront Identity Manager (FIM) 2010 FIM Service.

When you use the Export-FIMConfig cmdlet, you must specify at least one of the following configuration identifying parameters or the cmdlet fails: policyConfig, portalConfig, schemaConfig, or customConfig.

Syntax

Export-FIMConfig [-uri <string>] [-credential <Credential>] [-messagesize <string>] [-PolicyConfig] [-SchemaConfig] [-PortalConfig] [-CustomConfig <System.String[]>] [<CommonParameters>]

Detailed Description

The Export-FIMConfig cmdlet extracts configuration resources from the FIM Service. You can use the Export-FIMConfig cmdlet to follow references recursively that are contained in its resources to extract a full representation of the service's configuration. If a reference points to a resource that is not marked as a configuration resource, the cmdlet downloads the entire representation but it does not follow the non-configuration resource’s references. The cmdlet returns a collection of ExportObject instances.

The following are the pre-defined groupings of configuration for export.

Policy Configuration is defined as the following resource types:

  • ManagementPolicyRule

  • Set

  • WorkflowDefinition

  • EmailTemplate

  • FilterScope

  • ActivityInformationConfiguration

  • Function

  • SynchronizationRule

  • SynchronizationFilter

Schema Configuration is defined as the following resource types:

  • AttributeTypeDescription

  • BindingDescription

  • ObjectTypeDescription

  • ConstantSpecifier

  • SchemaSupportedLocales

Portal Configuration is defined as the following resource types:

  • Homepage Configuration

  • PortalUI

  • Configuration

  • NavigationBarConfiguration

  • SearchScopeConfiguration

  • Configuration

  • ObjectVisualizationConfiguration

Custom Configuration is defined by the provided XPath filter. For example /ContosoContact or /Person[DisplayName=’Administrator’].

For more information about the Microsoft® Forefront Identity Manager (FIM) 2010 Windows PowerShell™ cmdlet set see Forefront Identity Manager Configuration with Windows PowerShell.

Parameters

--Uri <string>

Specifies the Uniform Resource Identifier (URI) of the FIM Service. The following example shows how to set this parameter to a specific FIM Service.

-uri “http://localhost:5725/ResourceManagementService”

Attributes

Name Value

Required?

false

Accept Wildcard Characters?

false

Accept Pipeline Input?

false

Position?

named

--Credential <Credential>

Specifies the Windows PowerShell credential to use. The following example shows how to set this parameter.

$credential = Get-Credential

-credential $credential

Attributes

Name Value

Required?

false

Accept Wildcard Characters?

false

Accept Pipeline Input?

false

Position?

named

--MessageSize <string>

Specifies the maximum SOAP message size in bytes. The following example shows how to set the maximum SOAP message size to 200 bytes.

-messagesize 200

Attributes

Name Value

Required?

false

Accept Wildcard Characters?

false

Accept Pipeline Input?

false

Position?

named

--PolicyConfig <SwitchParameter>

If present, include resources that define policy in FIM.

The following example shows how to use this parameter.

-policyConfig

Attributes

Name Value

Required?

false

Accept Wildcard Characters?

false

Accept Pipeline Input?

false

Position?

named

--SchemaConfig <SwitchParameter>

If present, include resources that define the schema in FIM.

The following example shows how to use this parameter.

-schemaConfig

Attributes

Name Value

Required?

false

Accept Wildcard Characters?

false

Accept Pipeline Input?

false

Position?

named

--PortalConfig <SwitchParameter>

If present, include the resources that define portal behavior in FIM.

The following example shows how to use this parameter.

-portalConfig

Attributes

Name Value

Required?

false

Accept Wildcard Characters?

false

Accept Pipeline Input?

false

Position?

named

--CustomConfig <System.String[]>

Specifies a list of System.String objects that refer to resource types to include as configuration. The following example shows how to use this parameter.

-customConfig ("/ConstosoCustomResource", "/Group")

Attributes

Name Value

Required?

false

Accept Wildcard Characters?

false

Accept Pipeline Input?

false

Position?

named

--CommonParameters

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

-CommonParameter

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Notes

The cmdlet returns null if no ExportObject instances are present.

Examples

EXAMPLE 1

 
          $pilot = Export-FIMConfig -uri http://localhost:5725/ResourceManagementService -policyConfig -portalConfig 
        

This example retrieves basic policy and portal configuration resources.

Note

Note that the schema is not included in this export.

EXAMPLE 2

 
          $pilot = Export-FIMConfig -policyConfig -customConfig ("/ConstosoCustomResource", "/Group") 
        

This example retrieves custom resource type and groups in addition to policy configuration.

Note

Note that you may specify custom resource types. Also note that you may export groups and person resources by using this mechanism. Only audit resources such as Request and WorkflowInstances may not be exported.

EXAMPLE 3

 
          $pilot = Export-FIMConfig -uri http://pilot:5725/ResourceManagementService -policyConfig 
          $pilot | ConvertFrom-FIMResource -file pilot.xml 
 
 
          $pilot = ConvertTo-FIMResource -file pilot.xml 
          $production = Export-FIMConfig -uri http://production:5725/ResourceManagementService -policyConfig 
          $matches = Join-FIMConfig -source $pilot -target $production -defaultJoin "DisplayName" 
          $imports = $matches | Compare-FIMConfig 
          $imports | ConvertFrom-FIMResource -file imports.xml 
          $UndoneImports = $imports | Import-FIMConfig -uri http://production:5725/ResourceManagementService 
        

This is an end-to-end scenario for migrating configuration from a pilot FIM environment to a production FIM environment.

EXAMPLE 4

 
          $pilot = Export-FIMConfig –customConfig “/Request[Target=/Person[DisplayName=’Administrator’]]” 
          $pilot | ConvertFrom-FIMResource -file report.xml 
        

This example shows how to extract additional, non-configuration information that may be useful in other scenarios. Scripters can take the ExportObject instances from the output and use them for other purposes. One such purpose is generating reports.

See Also

Reference

Join-FIMConfig
Compare-FIMConfig
Import-FIMConfig
ConvertFrom-FIMResource
ConvertTo-FIMResource