Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcFcpInterface


NAME
Get-NcFcpInterface

SYNOPSIS
Get a list of FCP Target Logical Interfaces (LIF).

SYNTAX
Get-NcFcpInterface [[-Interface] <String[]>] [[-Node] <String[]>] [-Vserver
<String[]>] [-Attributes <FcpInterfaceInfo>] [-VserverContext <String>] [-Co
ntroller <NcController[]>] [<CommonParameters>]

Get-NcFcpInterface -Template [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]

Get-NcFcpInterface -Query <FcpInterfaceInfo> [-Attributes <FcpInterfaceInfo>
] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonParamete
rs>]


DESCRIPTION
Get a list of FCP Target Logical Interfaces (LIF).


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

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

-Node <String[]>
The node currently hosting the 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 <FcpInterfaceInfo>
For improved scalability in large clusters, provide an FcpInterfaceInfo
object with various fields set to indicate which fields to return on all
objects. Undesired fields should remain set to null. Use "Get-NcFcpIn
terface -Template" to get the initially empty FcpInterfaceInfo 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 FcpInterfaceInfo object for use with advanced qu
eries involving the Query attribute.

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

-Query <FcpInterfaceInfo>
For advanced queries, provide an FcpInterfaceInfo object with various fi
elds set to indicate which records to retrieve. Other fields should rem
ain set to null. Use "Get-NcFcpInterface -Template" to get the initiall
y empty FcpInterfaceInfo 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.FcpInterfaceInfo


NOTES


Category: fcp
API: fcp-interface-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcFcpInterface


Get all the FCP interfaces in the current cluster.


CurrentNode : VxeRubble-01
CurrentPort : 0a
InterfaceName : costea01_lif_data4
NodeName : 20:00:00:a0:98:29:49:ba
PortAddress : 11501
PortName : 20:01:00:a0:98:29:49:ba
RelativePortId : 2
Vserver : costea01
RelativePortIdSpecified : True



RELATED LINKS







 Data ONTAP® PowerShell Toolkit