Edit

Share via


Set-IscsiTargetServerSetting

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

Syntax

IpScoped (Default)

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

ServerGlobal

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.

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Credential

Specifies the credentials when connecting to a remote computer.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ServerGlobal
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Enable

Specifies the portal state as set by the user.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

IpScoped
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IP

Specifies an IP address.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

IpScoped
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Port

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

IpScoped
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None.

Outputs

Microsoft.Iscsi.Target.Commands.IscsiTargetServerSetting