Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcLunComment


NAME
Set-NcLunComment

SYNOPSIS
Set the optional descriptive comment for a LUN.

SYNTAX
Set-NcLunComment [-Path] <String> [-Comment] <String> [-VserverContext <Stri
ng>] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>
]


DESCRIPTION
Set the optional descriptive comment for a LUN.


PARAMETERS
-Path <String>
Path of the LUN.

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

-Comment <String>
Comment to set for given LUN. Specify an empty string to clear the comm
ent.

Required? true
Position? 2
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

-WhatIf


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

-Confirm


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.Lun.LunInfo


NOTES


Category: lun
API: lun-set-comment
Family: vserver

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

C:\PS>Set-NcLunComment /vol/testvol/exchangeLun "Exchange"


Set comment on LUN 'exchangeLun' to 'Exchange'.


Path Size Protocol Online Mapped Thin Vserver Commen
t
---- ---- -------- ------ ------ ---- ------- ------
-
/vol/testvol/exchangeLun 20.0 GB hyper_v False True True costea01 Exchan
ge



RELATED LINKS
Get-NcLun







 Data ONTAP® PowerShell Toolkit