Edit

Set-IscsiTargetServerSetting

  • Reference
Module:
IscsiTarget

Sets the global settings or common configurations for an iSCSI target server.

Syntax

Set-IscsiTargetServerSetting
   [-IP] <String>
   [-Port <Int32>]
   [-Enable <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

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

This example sets the target portal with the IP address 1.1.1.1 to use port number3200 (where the default is port number 3260).

EXAMPLE 2

PS C:\> Set-IscsiTargetServerSetting -IP 1.1.1.1 -Enable $false

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

EXAMPLE 3

PS C:\> Set-IscsiTargetServerSetting -IP 1.1.1.1 -Port 3200 -Enable $true

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

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
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Credential

Specifies the credentials when connecting to a remote computer.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Enable

Specifies the portal state as set by the user.

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

-IP

Specifies one or more IP addresses.

Type:String
Position:0
Default value:None
Required:True
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Iscsi.Target.Commands.IscsiCommonSettings

Outputs

Microsoft.Iscsi.Target.Commands.IscsiTargetServerSetting