HelpCache/ImportExportIscsiTargetConfiguration.psm1-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Export-IscsiTargetServerConfiguration</command:name><maml:description><maml:para>Exports an iSCSI Target Server configuration. </maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Export</command:verb><command:noun>IscsiTargetServerConfiguration</command:noun><dev:version /></command:details><maml:description><maml:para>The Export-IscsiTargetServerConfiguration cmdlet exports a Microsoft iSCSI Target Server configuration. Use this cmdlet to archive an iSCSI Target Server configuration, or to create a file to import by using the Import-IscsiTargetServerConfiguration cmdlet.</maml:para><maml:para>The configuration information includes the following: -- If the cmdlet exports the configuration from a clustered iSCSI Target Server instance, the resource group name. -- For an import of the configuration into an iSCSI Target Server clustered instance, the name of the resource group into which to import the configuration. This resource group name is the same as the iSCSI virtual disk attribute named MigrationResourceGroup. -- The following attributes for each iSCSI target that iSCSI Target Server hosts: Enabled (target state), HostName, TargetIQN, Description, ResourceGroup, MigrationResourceGroup, EnforceIdleTimeoutDetection, FirstBurstLength, MaxBurstLength, MaxRecvDataSegmentLength, NumRecvBuffers, EnableCHAP, CHAPUserName, EnableReverseCHAP, ReverseCHAPUserName, InitiatorIDs, and LunMappings. -- The following attributes for each iSCSI virtual disk that iSCSI Target Server recognizes: DiskId, Type, Enabled, DevicePath, ParentPath, Description, SnapshotStorageSize, MigrationDevicePath, MigrationParentPath, and MigrationResourceGroup.</maml:para><maml:para>MigrationParentPath and ParentPath always have a value of null. </maml:para><maml:para>This cmdlet does not export Challenge Handshake Authentication Protocol (CHAP) secret keys, logical unit (LU) snapshot information, or transient state information such as current session information.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Export-IscsiTargetServerConfiguration</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Filename</maml:name><maml:description><maml:para>Specifies a file name. The cmdlet exports the configuration to the file that you specify. If a file already exists, the cmdlet overwrites the file after you confirm. If you specify the Force parameter, the cmdlet overwrites the file without confirmation. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. </maml:para><maml:para>The cmdlet exports the configuration for the iSCSI Target Server instance that runs on the computer or cluster that you specify. If you do not specify a value for this parameter, the cmdlet uses the local computer. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the credentials when connecting to a remote computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Indicates that the cmdlet overwrites an existing export file without confirmation.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. </maml:para><maml:para>The cmdlet exports the configuration for the iSCSI Target Server instance that runs on the computer or cluster that you specify. If you do not specify a value for this parameter, the cmdlet uses the local computer. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>localhost</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the credentials when connecting to a remote computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Filename</maml:name><maml:description><maml:para>Specifies a file name. The cmdlet exports the configuration to the file that you specify. If a file already exists, the cmdlet overwrites the file after you confirm. If you specify the Force parameter, the cmdlet overwrites the file without confirmation. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Indicates that the cmdlet overwrites an existing export file without confirmation.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Export configuration of a standalone server</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Export-IscsiTargetServerConfiguration -Filename "D:\Server07Config.xml" –ComputerName "StandAloneIscsiServer07.Contoso.com" " </dev:code><dev:remarks><maml:para>This command exports the iSCSI Target Server configuration of a standalone iSCSI Target Server to a specified file.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Export configuration of a clustered server</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Export-IscsiTargetServerConfiguration -Filename "D:\Server07Config.xml" –ComputerName "ClusteredIscsiInstance07.Contoso.com" –Force </dev:code><dev:remarks><maml:para>This command exports the iSCSI Target Server configuration of a clustered iSCSI Target Server to a specified file. The command includes the Force, and, therefore, it overwrites an existing file without prompting you.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 3: Export configuration of all clustered servers in a specified node</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Export-IscsiTargetServerConfiguration -Filename "D:\Node22config.xml" –ComputerName "Node22-iSCSIServer.Contoso.com" </dev:code><dev:remarks><maml:para>This command exports the iSCSI Target Server configuration of all clustered iSCSI Target Server instances hosted on the named cluster node to a specified file.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?LinkID=294065</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Import-IscsiTargetServerConfiguration</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Import-IscsiTargetServerConfiguration</command:name><maml:description><maml:para>Imports an iSCSI Target Server configuration. </maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Import</command:verb><command:noun>IscsiTargetServerConfiguration</command:noun><dev:version /></command:details><maml:description><maml:para>The Import-IscsiTargetServerConfiguration cmdlet imports a Microsoft iSCSI Target Server configuration. </maml:para><maml:para>The configuration information includes the following: -- If you exported the configuration from a clustered iSCSI Target Server instance, the resource group name. -- If the cmdlet imports the configuration into an iSCSI Target Server clustered instance, the name of the resource group into which to import the configuration. This resource group name is the same as the iSCSI virtual disk attribute named MigrationResourceGroup. -- The following attributes for each iSCSI target that iSCSI Target Server hosts: Enabled (target state), HostName, TargetIQN, Description, ResourceGroup, MigrationResourceGroup, EnforceIdleTimeoutDetection, FirstBurstLength, MaxBurstLength, MaxRecvDataSegmentLength, NumRecvBuffers, EnableCHAP, CHAPUserName, EnableReverseCHAP, ReverseCHAPUserName, InitiatorIDs, and LunMappings. -- The following attributes for each iSCSI virtual disk that iSCSI Target Server recognizes: DiskId, Type, Enabled, DevicePath, ParentPath, Description, SnapshotStorageSize, MigrationDevicePath, MigrationParentPath, and MigrationResourceGroup.</maml:para><maml:para>MigrationParentPath and ParentPath always have a value of null. </maml:para><maml:para>Before you import a configuration, perform the following tasks: -- Move the files for all the virtual disks that are eligible for migration from the source server to the destination server. If there are any file path changes, note the source to destination changes. -- In a cluster configuration, ensure that the destination path of the file copy is on a cluster disk and that the cluster disk has been assigned to the desired iSCSI Target Server resource group, which you created on the destination cluster. Note the resource group that owns the path. -- If the file paths have changed between the source and the destination servers, open the exported configuration .xml file in a text editor, and identify the MigrationDevicePath tags to change to reflect the changes. -- In a cluster configuration, if the file path or the resource group name have changed between the source server and the destination server, open the exported configuration xml file in a text editor, and identify the MigrationResourceGroup tags to change to reflect the new resource group.</maml:para><maml:para>After you import a configuration, perform the following tasks: -- You must manually reconfigure the forward and reverse Challenge Handshake Authentication Protocol (CHAP) secret keys. -- Because importing does not include logical unit (LU) snapshot information, you must take necessary snapshots. -- Manually apply any iSNS settings that are relevant to the new configuration. -- Manually apply any iSCSI target portal settings that are relevant to the new configuration.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Import-IscsiTargetServerConfiguration</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Filename</maml:name><maml:description><maml:para>Specifies a file name. The cmdlet imports the configuration from the file that you specify.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. </maml:para><maml:para>The cmdlet imports the iSCSI Target Server configuration to the computer or cluster that you specify. If you do not specify this parameter, the cmdlet imports the configuration into the iSCSI Target Server that runs on the same computer. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the credentials when connecting to a remote computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Indicates that the cmdlet deletes an existing iSCSITarget or iSCSIVirtualDisk with the same name or device path on the target node, and then imports the ones in the configuration file.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. </maml:para><maml:para>The cmdlet imports the iSCSI Target Server configuration to the computer or cluster that you specify. If you do not specify this parameter, the cmdlet imports the configuration into the iSCSI Target Server that runs on the same computer. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the credentials when connecting to a remote computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Filename</maml:name><maml:description><maml:para>Specifies a file name. The cmdlet imports the configuration from the file that you specify.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Indicates that the cmdlet deletes an existing iSCSITarget or iSCSIVirtualDisk with the same name or device path on the target node, and then imports the ones in the configuration file.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Import configuration into the current computer or cluster</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Import-IscsiTargetServerConfiguration -Filename "D:\ServerConfig78.xml" </dev:code><dev:remarks><maml:para>This command imports the iSCSI Target Server configuration of a standalone iSCSI Target Server or clustered iSCSI Target Servers from a specified file. The cmdlet imports into the current standalone computer or the current clustered node.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Import configuration into a specified computer or cluster</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Import-IscsiTargetServerConfiguration -Filename "D:\ServerConfig78.xml" –ComputerName "TargetServer09.Contoso.com" </dev:code><dev:remarks><maml:para>This command imports the iSCSI Target Server configuration of a standalone iSCSI Target Server or clustered iSCSI Target Servers from a specified file. The command imports the servers into the specified remote standalone computer or remote clustered node.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?LinkID=294066</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Export-IscsiTargetServerConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-IscsiServerTarget</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |