Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Set-NaLunComment


NAME
Set-NaLunComment

SYNOPSIS
Set the optional descriptive comment for a LUN.

SYNTAX
Set-NaLunComment [-Path] <String> [-Comment] <String> [-Controller <NaContro
ller>] [<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 (ByValue, ByPropertyName)
Accept wildcard characters? false

-Comment <String>
Comment to set for given LUN.

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

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

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


NOTES


Category: lun
API: lun-set-comment

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

C:\PS>Set-NaLunComment /vol/vol2/lun2 "Virtual machine 1 (Exchange)"


Sets the comment on lun 'lun2'.


BackingSnapshot :
BlockSize : 512
IsSpaceReservationEnabled : False
Mapped : True
MultiprotocolType : windows_gpt
Online : True
Path : /vol/vol2/lun2
ReadOnly : False
SerialNumber : HnSolJNfoTZK
ShareState : none
Size : 21476206080
Uuid : 7dcc97f4-17ef-11df-9cab-00a09806c227
Comment : Virtual machine 1 (Exchange)



RELATED LINKS
Get-NaLunComment







 Data ONTAP® PowerShell Toolkit