Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcLunDeviceId


NAME
Set-NcLunDeviceId

SYNOPSIS
Set a SCSI peripheral device identifying information value on a LUN.

SYNTAX
Set-NcLunDeviceId [-Path] <String> [[-Id] <String>] [[-Type] <String>] [-Vse
rverContext <String>] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<
CommonParameters>]


DESCRIPTION
Set a SCSI peripheral device identifying information value on a LUN.

The value set will be returned in response to the SCSI command REPORT IDENTI
FYING INFORMATION for the appropriate INFORMATION TYPE:

0000000b - Peripheral Device Identifying Information, a binary string 1 to 6
4 bytes long. In addition, if the Peripheral Device Identifying Information
is between 00000001h (1d) and 0000270Fh (9999d), it will be returned in resp
onse to the vendor unique SCSI command GET DEV ID.

0000010b - Peripheral Device Text Identifying Information, a UTF-8 string 1
to 255 bytes long.

Either or both peripheral device identifying information values may be set o
r cleared independently.


PARAMETERS
-Path <String>
Path of the LUN.

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

-Id <String>
SCSI Peripheral Device Identifying Information. Pass an empty string to
clear the device ID.

If Type is "legacy", the value must be an integer in the range [1..9999]
.
If Type is "binary", the value must be a 1 to 64 byte value encoded as a
hexadecimal string, for example "0000270F".
If Type is "text", the value is a free-form UTF-8 string between 1 and 2
55 bytes in length.

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

-Type <String>
Indicate which peripheral device identifying information value to change
. Possible values:

"legacy" - Set the Peripheral Device Identifying Information for REPORT
IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b) appropriate for the
the vendor unique SCSI command GET DEV ID and in the format compatible w
ith Data ONTAP 7-Mode.

"binary" - Set the Peripheral Device Identifying Information for REPORT
IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b). This format allows
setting all 64 bytes of the identifying information.

"text" - Set the Peripheral Device Text Identifying Information for REPO
RT IDENTIFYING INFORMATION (INFORMATION TYPE 0000010b).

The default value is "legacy".

Required? false
Position? 3
Default value legacy
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 Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each 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
NetApp.Ontapi.Filer.C.Lun810.LunInfo


NOTES


Category: lun
API: lun-set-device-id
Family: vserver

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

C:\PS>Set-NcLunDeviceId /vol/testvol/exchangeLun Exchange0001 -Type text


Set the Peripheral Device Text Identifying Information value for lun 'exchan
geLun' to 'Exchange0001'.


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



RELATED LINKS
Get-NcLun







 Data ONTAP® PowerShell Toolkit