Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcVscanStatus


NAME
Get-NcVscanStatus

SYNOPSIS
Get Vscan status information.

SYNTAX
Get-NcVscanStatus [[-Vserver] <String[]>] [-Attributes <VscanStatusInfo>] [-
VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]

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

Get-NcVscanStatus -Query <VscanStatusInfo> [-Attributes <VscanStatusInfo>] [
-VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters>
]


DESCRIPTION
Get Vscan status information.


PARAMETERS
-Vserver <String[]>
Restrict results to one or more vservers. Data ONTAP wildcards are acce
pted.

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

-Attributes <VscanStatusInfo>
For improved scalability in large clusters, provide a VscanStatusInfo 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-NcVscanSt
atus -Template" to get the initially empty VscanStatusInfo object. If n
ot 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 VscanStatusInfo 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 <VscanStatusInfo>
For advanced queries, provide a VscanStatusInfo object with various fiel
ds set to indicate which records to retrieve. Other fields should remai
n set to null. Use "Get-NcVscanStatus -Template" to get the initially e
mpty VscanStatusInfo 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.Vscan.VscanStatusInfo


NOTES


Category: vscan
API: vscan-status-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcVscanStatus


Get the Vscan status for all Vservers in the current cluster.


Enabled Vserver
------- -------
False pstk01


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

C:\PS>Get-NcVscanStatus -Query @{Enabled=$false}


Get the Vscan status for all Vservers where Vscan is disabled.


Enabled Vserver
------- -------
False pstk01


-------------- Example 3 --------------

C:\PS>$query = Get-NcVscanStatus -Template
$query.Enabled = $false
Get-NcVscanStatus -Query $query


Get the Vscan status for all Vservers where Vscan is disabled.


Enabled Vserver
------- -------
False pstk01



RELATED LINKS
Enable-NcVscan
Disable-NcVscan







 Data ONTAP® PowerShell Toolkit