< Back
New-VsanIscsiTarget
Post
NAME New-VsanIscsiTarget
SYNOPSIS
This cmdlet adds a new vSAN iSCSI target to a cluster.
SYNTAX
New-VsanIscsiTarget [-AuthenticationType <VsanIscsiTargetAuthenticationType>] -Cluster <Cluster>
[-IncomingChapSecret <SecureString>] [-IncomingChapUser <String>] [-IscsiQualifiedName <String>] -Name <String>
[-NetworkInterface <String>] [-OutgoingChapSecret <SecureString>] [-OutgoingChapUser <String>] [-RunAsync]
[-Server <VIServer[]>] [-StoragePolicy <SpbmStoragePolicy>] [-TcpPort <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet adds a new vSAN iSCSI target to a cluster.
PARAMETERS
-AuthenticationType <VsanIscsiTargetAuthenticationType>
Specifies the authentication type for the vSAN iSCSI target.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Cluster <Cluster>
Specifies the vSAN cluster on which you want to create the vSAN iSCSI target.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-IncomingChapSecret <SecureString>
Specifies the CHAP user secret for the target. Applicable when the authentication type is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncomingChapUser <String>
Specifies the CHAP user name for the target. Applicable when the authentication type is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IscsiQualifiedName <String>
Specifies the IQN of the target. This parameter is optional and should be unique if specified. If not
specified, the server generates a unique IQN.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the newly created vSAN iSCSI target. The name should be unique within a cluster.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NetworkInterface <String>
Specifies the VMkernel network interface which handles the iSCSI traffic. If not specified, the default
VMkernel network interface defined in iSCSI target service is used. This parameter accepts an object of type
HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OutgoingChapSecret <SecureString>
Specifies the CHAP user secret you want to attach to the initiator. Applicable when the authentication type is
MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OutgoingChapUser <String>
Specifies the CHAP user name you want to attach to the initiator. Applicable when the authentication type is
MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-StoragePolicy <SpbmStoragePolicy>
Specifies the storage policy applied to the vSAN namespace of the iSCSI target. If not specified, the default
storage policy defined in iSCSI service is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TcpPort <Int32>
Specifies the network port on which the target is accessible. If specified, NetworkInterface should also be
specified. If not specified, and if NetworkInterface is also not specified, the default port specified in
iSCSI target service is used. If NetworkInterface is specified, the default port 3260 is used. The server
automatically opens the firewall for the specified port.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created VsanIscsiTarget target
NOTES
-------------------------- Example 1 --------------------------
New-VsanIscsiTarget -Name "Target1" -Cluster "vsan-cluster" -NetworkInterface "vmk0"
Creates a new vSAN iSCSI target named "Target1" in the "vsan-cluster" cluster which uses a VMkernel network
interface named "vmk0" for traffic.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... arget.html
New-VsanIscsiTarget
Get-VsanIscsiTarget
Remove-VsanIscsiTarget
Set-VsanIscsiTarget
SYNOPSIS
This cmdlet adds a new vSAN iSCSI target to a cluster.
SYNTAX
New-VsanIscsiTarget [-AuthenticationType <VsanIscsiTargetAuthenticationType>] -Cluster <Cluster>
[-IncomingChapSecret <SecureString>] [-IncomingChapUser <String>] [-IscsiQualifiedName <String>] -Name <String>
[-NetworkInterface <String>] [-OutgoingChapSecret <SecureString>] [-OutgoingChapUser <String>] [-RunAsync]
[-Server <VIServer[]>] [-StoragePolicy <SpbmStoragePolicy>] [-TcpPort <Int32>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet adds a new vSAN iSCSI target to a cluster.
PARAMETERS
-AuthenticationType <VsanIscsiTargetAuthenticationType>
Specifies the authentication type for the vSAN iSCSI target.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Cluster <Cluster>
Specifies the vSAN cluster on which you want to create the vSAN iSCSI target.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-IncomingChapSecret <SecureString>
Specifies the CHAP user secret for the target. Applicable when the authentication type is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncomingChapUser <String>
Specifies the CHAP user name for the target. Applicable when the authentication type is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IscsiQualifiedName <String>
Specifies the IQN of the target. This parameter is optional and should be unique if specified. If not
specified, the server generates a unique IQN.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the newly created vSAN iSCSI target. The name should be unique within a cluster.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NetworkInterface <String>
Specifies the VMkernel network interface which handles the iSCSI traffic. If not specified, the default
VMkernel network interface defined in iSCSI target service is used. This parameter accepts an object of type
HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OutgoingChapSecret <SecureString>
Specifies the CHAP user secret you want to attach to the initiator. Applicable when the authentication type is
MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OutgoingChapUser <String>
Specifies the CHAP user name you want to attach to the initiator. Applicable when the authentication type is
MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-StoragePolicy <SpbmStoragePolicy>
Specifies the storage policy applied to the vSAN namespace of the iSCSI target. If not specified, the default
storage policy defined in iSCSI service is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TcpPort <Int32>
Specifies the network port on which the target is accessible. If specified, NetworkInterface should also be
specified. If not specified, and if NetworkInterface is also not specified, the default port specified in
iSCSI target service is used. If NetworkInterface is specified, the default port 3260 is used. The server
automatically opens the firewall for the specified port.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created VsanIscsiTarget target
NOTES
-------------------------- Example 1 --------------------------
New-VsanIscsiTarget -Name "Target1" -Cluster "vsan-cluster" -NetworkInterface "vmk0"
Creates a new vSAN iSCSI target named "Target1" in the "vsan-cluster" cluster which uses a VMkernel network
interface named "vmk0" for traffic.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... arget.html
New-VsanIscsiTarget
Get-VsanIscsiTarget
Remove-VsanIscsiTarget
Set-VsanIscsiTarget