Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcFcpService


NAME
Get-NcFcpService

SYNOPSIS
Get a list of FCP Services.

SYNTAX
Get-NcFcpService [[-NodeName] <String[]>] [-Attributes <FcpServiceInfo>] [-V
serverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcFcpService -Template [-VserverContext <String>] [-Controller <NcContro
ller[]>] [<CommonParameters>]

Get-NcFcpService -Query <FcpServiceInfo> [-Attributes <FcpServiceInfo>] [-Vs
erverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get a list of FCP Services.


PARAMETERS
-NodeName <String[]>
The world-wide node name (WWNN) of the FCP target. Data ONTAP wildcards
are permitted.

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

-Attributes <FcpServiceInfo>
For improved scalability in large clusters, provide an FcpServiceInfo ob
ject with various fields set to indicate which fields to return on all o
bjects. Undesired fields should remain set to null. Use "Get-NcFcpServ
ice -Template" to get the initially empty FcpServiceInfo 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 clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach 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 FcpServiceInfo object for use with advanced quer
ies involving the Query attribute.

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

-Query <FcpServiceInfo>
For advanced queries, provide an FcpServiceInfo object with various fiel
ds set to indicate which records to retrieve. Other fields should remai
n set to null. Use "Get-NcFcpService -Template" to get the initially em
pty FcpServiceInfo 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
DataONTAP.C.Types.Fcp.FcpServiceInfo


NOTES


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

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

C:\PS>Get-NcFcpService


Get all of the FCP services on the current cluster.


NodeName IsAvailable Vserver
-------- ----------- -------
20:00:00:a0:98:29:49:ba True costea01
20:04:00:a0:98:29:49:ba True dlamotta01
20:02:00:a0:98:29:49:ba True rashidvs


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

C:\PS>$q = Get-NcFcpService -Template
$q.IsAvailable = $false
Get-NcFcpService -Query $q


Get all of the FCP services that are not available on the current cluster.


NodeName IsAvailable Vserver
-------- ----------- -------
20:04:00:a0:98:29:49:ba False dlamotta01



RELATED LINKS
Add-NcFcpService
Remove-NcFcpService







 Data ONTAP® PowerShell Toolkit