Set-VMSan
Set-VMSan
Configures a virtual storage area network (SAN) on one or more Hyper-V hosts.
Syntax
Parameter Set: HbaObject
Set-VMSan [-Name] <String> [-HostBusAdapter <CimInstance[]> ] [-Note <String> ] [-Passthru] [ <CommonParameters>]
Parameter Set: StringWwn
Set-VMSan [-Name] <String> -WorldWideNodeName <String[]> -WorldWidePortName <String[]> [-ComputerName <String[]> ] [-Note <String> ] [-Passthru] [ <CommonParameters>]
Detailed Description
The Set-VMSan cmdlet configures a virtual storage area network (SAN) on one or more Hyper-V hosts.
Parameters
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which the virtual storage area network (SAN) is to be configured. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-HostBusAdapter<CimInstance[]>
Specifies the Fibre Channel host bus adapter to be associated with the virtual storage area network (SAN).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the virtual storage area network (SAN) to be configured.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Note<String>
Specifies the note to be associated with the virtual storage area network (SAN).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Passthru
Specifies that an object is to be passed through to the pipeline representing the configured virtual storage area network (SAN).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WorldWideNodeName<String[]>
The World Wide Node name of the Fibre Channel host bus adapter to be associated with this virtual storage area network (SAN).
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WorldWidePortName<String[]>
The World Wide Port name of the Fibre Channel host bus adapter to be associated with this virtual storage area network (SAN).
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None by default; Microsoft.Virtualization.PowerShell.SAN if –PassThru is specified.
Examples
Example 1
Configures a virtual storage area network (SAN) named Production with the specified WorldWideNodeName and WorldWidePortName values.
PS C:\> Set-VMSan –Name Production -WorldWideNodeName C003FF0000FFFF22 –WorldWidePortName C003FF5778E50024