Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcUcmAdapter


NAME
Get-NcUcmAdapter

SYNOPSIS
Get a list of UC Adapter objects.

SYNTAX
Get-NcUcmAdapter [[-Name] <String[]>] [[-Node] <String[]>] [-Attributes <UcA
dapterInfo>] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcUcmAdapter -Template [-Controller <NcController[]>] [<CommonParameters
>]

Get-NcUcmAdapter -Query <UcAdapterInfo> [-Attributes <UcAdapterInfo>] [-Cont
roller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get a list of UC Adapter objects.


PARAMETERS
-Name <String[]>
Ucm adapter name(s) to get. Data ONTAP wildcards are accepted.

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

-Node <String[]>
Name of one or more nodes where the adapters are installed. Data ONTAP
wildcards are accepted.

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

-Attributes <UcAdapterInfo>
For improved scalability in large clusters, provide a UcAdapterInfo obje
ct with various fields set to indicate which fields to return on all obj
ects. Undesired fields should remain set to null. Use "Get-NcUcmAdapte
r -Template" to get the initially empty UcAdapterInfo object. If not sp
ecified, all data is returned for each object.

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 UcAdapterInfo object for use with advanced queri
es involving the Query attribute.

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

-Query <UcAdapterInfo>
For advanced queries, provide a UcAdapterInfo object with various fields
set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcUcmAdapter -Template" to get the initially empt
y UcAdapterInfo 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.Ucm.UcAdapterInfo


NOTES


Category: ucm
API: ucm-adapter-get-iter
Family: cluster


RELATED LINKS
Set-NcUcmAdapter







 Data ONTAP® PowerShell Toolkit