This project is read-only.

Start-FIMManagementAgent

NAME
    Start-FIMManagementAgent
    
SYNOPSIS
    Executes the run profile for the specified management agent(s).
    
SYNTAX
    Start-FIMManagementAgent [-ManagementAgent] <ManagementObject> [-RunProfile] <String> [-ExpectedStatus <ScriptBlock>] [-AsJob] [<CommonParameters>]
    
    Start-FIMManagementAgent [-MaName] <String> [-ComputerName <String>] [-RunProfile] <String> [-ExpectedStatus <ScriptBlock>] [-AsJob] [<CommonParameters>]
    
    
DESCRIPTION
    

PARAMETERS
    -ManagementAgent <ManagementObject>
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  
        
    -MaName <String>
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  
        
    -ComputerName <String>
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  
        
    -RunProfile <String>
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  
        
    -ExpectedStatus <ScriptBlock>
        The default run statuses that are considered successful are 'success' or 'completed-*' when it is not 'completed-*-errors'. 
        
        Use this parameter to override the behavior of when to throw an error.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  
        
    -AsJob [<SwitchParameter>]
        This will spawn a PowerShell job to run the management agent and return the output from the Start-Job cmdlet.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer and OutVariable. For more information, type,
        "get-help about_commonparameters".
    
INPUTS
    
OUTPUTS
    
NOTES
    
    
        This is a simple example of how you can execute a several run profiles to optimize execution time.
        
        It uses a mixture of both synchronization and asynchronous runs.
        
        Start-FIMManagementAgent -Name 'HR' -Profile 'Full Import' -AsJob
        Start-FIMManagementAgent -Name 'AD' -Profile 'Delta Import' -AsJob
        Start-FIMManagementAgent -Name 'FIM' -Profile 'Delta Import' -AsJob
        Get-Job | Wait-Job | Receive-Job
        
        Start-FIMManagementAgent -Name 'HR' -Profile 'Delta Synchronization'
        Start-FIMManagementAgent -Name 'AD' -Profile 'Delta Synchronization'
        Start-FIMManagementAgent -Name 'FIM' -Profile 'Delta Synchronization'
        
        Start-FIMManagementAgent -Name 'AD' -Profile 'Export' -AsJob
        Start-FIMManagementAgent -Name 'FIM' -Profile 'Export' -AsJob
        Get-Job | Wait-Job | Receive-Job
        
        Start-FIMManagementAgent -Name 'AD' -Profile 'Delta Import' -AsJob
        Start-FIMManagementAgent -Name 'FIM' -Profile 'Delta Import' -AsJob
        Get-Job | Wait-Job | Receive-Job
    
    -------------------------- EXAMPLE 1 --------------------------
    
    C:\PS>Get-FIMServer | Get-FIMManagementAgent | Start-FIMManagementAgent -Profile 'Full Synchronization'
    
    
    Executes the profile 'Full Synchronization' on every management agent on the local server. This is synchronous and will wait for each management agent to run before starting the next one.
    
    
    
    
    
    -------------------------- EXAMPLE 2 --------------------------
    
    C:\PS>Get-FIMServer | Get-FIMManagementAgent | Start-FIMManagementAgent -Profile 'Full Import' -AsJob
    
    
    Executes the profile 'Full Import' on every management agent on the local server. This is asynchronous and start the run profile for each management agent and return immediately.
    
    
    
    
    
    -------------------------- EXAMPLE 3 --------------------------
    
    C:\PS>Start-FIMManagementAgent -Name 'FIM' -Profile 'Export' -AsJob | Wait-Job | Receive-Job
    
    
    Executes the profile 'Export' on the 'FIM' management agent on the local server as a PowerShell job but then waits for the job to complete and then retrieves the output.
    
    
    
    
    
    
RELATED LINKS

Last edited Jan 16, 2012 at 4:19 AM by adweigert, version 2

Comments

No comments yet.