Set-Iscsi Target Server Setting

Module:
iscsitarget
Sets the global settings or common configurations for an iSCSI target virtual disk.

Syntax 

Set-IscsiTargetServerSetting
   [-IP] <String>
   [-Port <Int32>]
   [-Enable <Boolean>]
   [-PassThru]
   [-ComputerName <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Set-IscsiTargetServerSetting
   -DisableRemoteManagement <Boolean>
   [-PassThru]
   [-ComputerName <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

Description

The Set-IscsiTargetServerSetting cmdlet sets the global settings or common configurations for an iSCSI target.

Examples

Example 1: Set target portal port number 

PS C:\> Set-IscsiTargetServerSetting -IP 10.1.1.1 -Port 3200

This example sets the target portal with the IP address 10.1.1.1 to use port number 3200. The default is port number 3260.

Example 2: Disable target portal 

PS C:\> Set-IscsiTargetServerSetting -IP 10.1.1.1 -Enable $False

This example disables the target portal with the IP address 10.1.1.1.

Example 3: Enable target portal 

PS C:\> Set-IscsiTargetServerSetting -IP 10.1.1.1 -Port 3200 -Enable $True

This example enables the target portal with the IP address 10.1.1.1 and changes the port number to 3200.

Required Parameters

-DisableRemoteManagement

Indicates whether the computer that runs Microsoft iSCSI Target Server accepts any network-based management requests. If you specify a value of $True, iSCSI Target Server does not accept requests issued by thread tokens that contain a SECURITY_NETWORK_RID.

You can specify this parameter only as a local user on the computer that runs iSCSI Target Server or on the cluster node that owns the iSCSI Target Server clustered role.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IP

Specifies an IP address.

Type: String
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Optional Parameters

-ComputerName

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.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Credential

Specifies the credentials when connecting to a remote computer.

Type: PSCredential
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Enable

Specifies the portal state as set by the user.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Port

Specifies the port number to which the iSCSI target should listen.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Inputs

None.

Outputs

Microsoft.Iscsi.Target.Commands.IscsiTargetServerSetting