Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcVscanScannerPool


NAME
Set-NcVscanScannerPool

SYNOPSIS
Modify a Vscan scanner pool.

SYNTAX
Set-NcVscanScannerPool [-Name] <String> [[-VscanServer] <String[]>] [[-Privi
legedUser] <String[]>] [-RequestTimeout <Int32>] [-ScanQueueTimeout <Int32>]
[-SessionSetupTimeout <Int32>] [-SessionTeardownTimeout <Int32>] [-MaxSessi
onSetupRetries <Int32>] [-VserverContext <String>] [-Controller <NcControlle
r[]>] [<CommonParameters>]

Set-NcVscanScannerPool [-Name] <String> [-ScannerPolicy <String>] [-VserverC
ontext <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Modify a Vscan scanner pool.


PARAMETERS
-Name <String>
Name of the virus scanner pool.

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

-VscanServer <String[]>
One or more IP addresses of Vscan servers which are allowed to connect t
o clustered Data ONTAP.

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

-PrivilegedUser <String[]>
One or more privileged users.

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

-RequestTimeout <Int32>
Total request-service time-limit in seconds. The default value is 30.

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

-ScanQueueTimeout <Int32>
Scan-queue wait time-limit in seconds. The default is 20.

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

-SessionSetupTimeout <Int32>
Total session setup time-limit in seconds. The default value is 10.

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

-SessionTeardownTimeout <Int32>
Total session teardown time-limit in seconds. The default value is 10.

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

-MaxSessionSetupRetries <Int32>
Maximum number of consecutive session-setup attempts. The default is 5.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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

-ScannerPolicy <String>
Scanner policy. Currently only system policies are supported.

Possible values:
'primary' - Makes it active always,
'secondary' - Makes it active only when no primary Vscan server is conne
cted,
'idle' - Makes it inactive always

Required? false
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.VscanScannerPoolInfo


NOTES


Category: vscan
API: vscan-scanner-pool-modify
Family: vserver

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

C:\PS>Set-NcVscanScannerPool -Name pstk_scanner1 -VscanServer 10.61.169.75


Change the Vscan server for the given Vscan scanner pool.


AdminOwner : vserver
IsCurrentlyActive : True
MaxSessionSetupRetries : 5
NcController : 10.63.10.33
PrivilegedUsers : {RTPRRE\Administrator}
RequestTimeout : 30
ScannerPolicy : primary
ScannerPool : pstk_scanner1
ScanQueueTimeout : 20
Servers : {10.61.169.75}
SessionSetupTimeout : 10
SessionTeardownTimeout : 10
Vserver : pstk01


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

C:\PS>Set-NcVscanScannerPool -Name pstk_scanner1 -ScannerPolicy primary


Make the given scanner pool always active.


AdminOwner : vserver
IsCurrentlyActive : True
MaxSessionSetupRetries : 5
NcController : 10.63.10.33
PrivilegedUsers : {RTPRRE\Administrator}
RequestTimeout : 30
ScannerPolicy : primary
ScannerPool : pstk_scanner1
ScanQueueTimeout : 20
Servers : {10.61.169.73}
SessionSetupTimeout : 10
SessionTeardownTimeout : 10
Vserver : pstk01



RELATED LINKS
Get-NcVscanScannerPool
New-NcVscanScannerPool
Remove-NcVscanScannerPool







 Data ONTAP® PowerShell Toolkit