Get-SmigServerFeature

Applies To: Windows Server 2008 R2

Get-SmigServerFeature

Gets the set of all Windows features that can be migrated from the local server or from a migration store.

Syntax

Get-SmigServerFeature [-Password <SecureString>] [-Path <string>] [<CommonParameters>]

• Password

• Path

Detailed Description

Gets the set of all Windows features that can be migrated from the local server or from a migration store. If a migration store is specified in the Path parameter, this cmdlet returns only the features in the migration store that can be installed on the local server.

Parameters

Password

Specifies the password, as a secure string, to decrypt the migration store. The secure string can be obtained by entering the command Read-Host -AsSecureString or Convertto-Securestring.

Default Value:

Data Type: SecureString

Attributes

Value Attributes

Path

Specifies the path to the migration store from which you want to retrieve Windows features. The path must be a well-formed local or Universal Naming Convention (UNC) path; if it is a share on a remote computer, the share must be notated as a drive letter on the local computer. The path length cannot be longer than 246 characters. Wildcard characters are not supported. The returned list of Windows features contains only those Windows features that are both in the migration store and installable on the local computer.

Default Value:

Data Type: string

Attributes

Value Attributes

Input Type

Return Type

Microsoft.Windows.ServerManager.Migration.Feature[]

Gets the set of all Windows features that can be migrated from the local server or from a migration store. If a migration store is specified in the Path parameter, this cmdlet returns only the features in the migration store that can be installed on the local server.

Notes

• The Windows Server Migration Tools deployment log file is located in %windir%\Logs\SmigDeploy.log. Other Windows Server Migration Tools log files are created at the following locations:
  - %windir%\Logs\ServerMigration.log
  - On Windows Server 2008 and Windows Server 2008 R2: %localappdata%\SvrMig\Log
  - On Windows Server 2003: %userprofile%\Local Settings\Application Data\SvrMig\Log

  If the log files cannot be created at these locations, ServerMigration.log and SmigDeploy.log will be created at %temp%, and other logs will be created at %windir%\System32.

  The maximum size of all log files (in MB) is stored in the following registry key. When the log file grows larger than the size specified in the registry key, the log file is deleted. Logging begins again in a new log file that uses the same file name and path. The default maximum log size is 200 MB.
  - Key: HKLM\Software\Microsoft\ServerMigration
  - Value: MaxLogSize (REG_DWORD)
  - Data: Whole numbers between 1 and 1000 (represents log size, in MB)

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

Get-SmigServerFeature

This command displays all Windows features that can be migrated from the local computer.

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

Get-SmigServerFeature -Path "c:\temp\store"

This command retrieves and displays the set of Windows features that can be migrated from the migration store specified by the Path parameter as located at c:\temp\store. Because a password is not provided in this sample command, after entering the command, the user is prompted to provide a password for decrypting the migration store. Password characters are displayed as asterisks (*). When the password is entered, the value is passed to the command as a SecureString.

-------------------------- EXAMPLE 3 --------------------------

Command Prompt: C:\PS>

$c = Get-SmigServerFeature -Path "c:\temp\store" -Password (Read-Host "Enter a Password:" -AsSecureString)

The first line of the command uses the Get-SmigServerFeature cmdlet to retrieve role or feature objects from the migration store in the location specified by the Path parameter, and save them in the $c variable.

The command also instructs the migration tools to display the string "Enter a Password:" to prompt users to enter the password to decrypt the migration store. Password characters are displayed as asterisks (*). When the password is entered, the value is passed to the command as a SecureString.

-------------------------- EXAMPLE 4 --------------------------

Command Prompt: C:\PS>

Get-SmigServerFeature -Path "c:\temp\store" | Import-SmigServerSetting -Path "c:\temp\store" -Verbose

The preceding sample command pipes a set of features that have already been retrieved by using the Get-SmigServerFeature cmdlet to the Import-SmigServerSetting cmdlet.

The first part of the command, before the pipe (|) character, retrieves all role or feature objects listed by using the Get-SmigServerFeature cmdlet that are found in the store specified by the Path parameter. The second part of the command imports those Windows features that are both listed by Get-SmigServerFeature and available in the migration store.

Because a password is not provided in this sample command, after entering the command, the user is prompted to enter a password to decrypt the migration store. Password characters are displayed as asterisks (*). When the password is entered, the value is passed to the command as a SecureString.

By using the -Verbose parameter, the command also displays detailed information about the migration operation.

-------------------------- EXAMPLE 5 --------------------------

Command Prompt: C:\PS>

$pass = convertto-securestring -string "password" -asplaintext -force 

C:\PS>Get-SmigServerFeature -Path "c:\temp\store" -Password $pass |Import-SmigServerSetting -Path "c:\temp\store" -Password $pass -Verbose

Description

-----------

In the preceding example, the first command converts the store encryption password, represented by "password," to a secure string, and store it in the variable $pass.

The second command has two parts. The first, by using the Get-SmigServerFeature cmdlet, retrieves the set of Windows features that can be migrated from the migration store specified by the Path parameter as located at c:\temp\store, and provides the password to decrypt the migration store as represented by the variable $pass. The second part of the command pipes the Windows features retrieved by the Get cmdlet to the Import-SmigServerSetting cmdlet for installation on a destination computer. This command also supplies the password to decrypt the migration store, in the variable $pass.

By using the -Verbose parameter, the command also displays detailed information about the migration operation.

See Also

Reference

Export-SmigServerSetting