Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcFcpPortName


NAME
Get-NcFcpPortName

SYNOPSIS
Get a list of valid Fibre Channel target port names on a Vserver's FCP LIFs.

SYNTAX
Get-NcFcpPortName [[-PortName] <String[]>] [[-Adapter] <String[]>] [-Vserver
<String[]>] [-Attributes <FcpPortNameInfo>] [-VserverContext <String>] [-Co
ntroller <NcController[]>] [<CommonParameters>]

Get-NcFcpPortName -Template [-VserverContext <String>] [-Controller <NcContr
oller[]>] [<CommonParameters>]

Get-NcFcpPortName -Query <FcpPortNameInfo> [-Attributes <FcpPortNameInfo>] [
-VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters>
]


DESCRIPTION
Get a list of valid Fibre Channel target port names on a Vserver's FCP LIFs.


PARAMETERS
-PortName <String[]>
A Fibre Channel WWPN in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a he
xadecimal digit. Data ONTAP wildcards are permitted.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Adapter <String[]>
The name of an FCP data LIF. Data ONTAP wildcards are permitted.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Vserver <String[]>
Restrict results to the specified vserver(s). Data ONTAP wildcards are
permitted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Attributes <FcpPortNameInfo>
For improved scalability in large clusters, provide an FcpPortNameInfo o
bject with various fields set to indicate which fields to return on all
objects. Undesired fields should remain set to null. Use "Get-NcFcpPor
tName -Template" to get the initially empty FcpPortNameInfo object. If
not specified, all data is returned for each object.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NcController[]>
A Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Template
Specify to get an empty FcpPortNameInfo object for use with advanced que
ries involving the Query attribute.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Query <FcpPortNameInfo>
For advanced queries, provide an FcpPortNameInfo object with various fie
lds set to indicate which records to retrieve. Other fields should rema
in set to null. Use "Get-NcFcpPortName -Template" to get the initially
empty FcpPortNameInfo object.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
NetApp.Ontapi.Filer.C.Fcp810.FcpPortNameInfo


NOTES


Category: fcp
API: fcp-port-name-get-iter
Family: cluster, vserver

-------------- Example 1 --------------

C:\PS>Get-NcFcpPortName


Get all the fcp port names on the current cluster.


FcpAdapter : costea01_lif_data4
IsUsed : True
PortName : 20:01:00:a0:98:29:49:ba
Vserver : costea01
IsUsedSpecified : True


-------------- Example 2 --------------

C:\PS>$q = Get-NcFcpPortName -Template
$q.IsUsed = $true
Get-NcFcpPortName -Query $q


Get all of the fcp port names tat are currently in use.


FcpAdapter : costea01_lif_data4
IsUsed : True
PortName : 20:01:00:a0:98:29:49:ba
Vserver : costea01
IsUsedSpecified : True



RELATED LINKS
Set-NcFcpPortName







 Data ONTAP® PowerShell Toolkit