Share via

2.2.1.4.1 Element-Specific Attributes

  • Article

Attribute name

Description

action

(optional) If specified, the value MUST be C, D, R, or U, corresponding to Create, Delete, Replace, and Update. If unspecified, the default value is U.

  • Create: This action MUST be used to create a new mapped drive for users. If the drive map already exists, then the protocol MUST NOT create a new drive map and MUST NOT return an error.

  • Delete: This action MUST be used to remove a mapped drive for users. The protocol MUST NOT perform an action if the drive map does not exist and MUST NOT return an error.

  • Replace: This action MUST be used to delete and re-create mapped drives for users. The net result of the Replace action MUST overwrite all existing settings associated with the mapped drive. If the drive mapping does not exist, then the Replace action MUST create a new drive mapping.

  • Update: This action MUST be used to modify the settings of an existing mapped drive. This action differs from Replace in that it MUST only update settings defined within the preference item. All other settings MUST remain as configured on the mapped drive. If the drive mapping does not exist, then the Update action MUST create a new drive mapping.

path

To configure a new drive mapping or to re-create a drive mapping, the user MUST provide a fully qualified Universal Naming Convention (UNC) path for the network share (such as \\server\sharename, \\server\hiddenshare$, or \\server\sharename\foldername). To modify an existing drive mapping (identified by the drive letter), the user MUST leave this field blank.

persistent

 If "0", then the client MUST discard the mapping when the user logs off. If "1", then the client MUST attempt to restore the mapping each time the user logs on.

label

(optional) An optional descriptive label for the mapping that the client MAY present to the user in an implementation-dependent manner.

letter

MUST specify a single drive letter on the client. Depending on the value of useLetter, this letter represents either a single drive letter or the start of a range of letters; see the table in this section for more details.

userName

(optional) MUST be set to the domain user name used to connect to the drive path. The domain user name MUST be in the NETBIOS format domain\userName.

cpassword

(optional) MUST be set to the password used to connect to the drive path. The password is encrypted using an AES-derived encryption key when the preference is created, and decrypted in the client during client processing.

useLetter

If "1", then letter refers to a single drive letter on which the action operates. If "0", then letter is the alphabetic beginning of a range of drive letters to which the action applies.

thisDrive

(optional) Configures the visibility of the mapped drive.

  • To make no change to the visibility of the mapped drive, this MUST be set to "NOCHANGE". This setting MUST NOT take precedence over the Hide/Show setting for allDrives.

  • To prevent the drive from being displayed, this MUST be set to "HIDE". This MUST take precedence over the Hide/Show setting for allDrives.

  • To allow this drive to be displayed, this MUST be set to "SHOW". This MUST take precedence over the Hide/Show setting for allDrives. The default is "NOCHANGE".

allDrives

(optional) Configures the visibility of all mapped and physical drives. The three available options are the same as those for the thisDrive attribute, but apply globally to all drives. The default is NOCHANGE.

The intent of a particular instance of the schema is defined by the action, useLetter, and letter attributes, according to the following table. The client MUST ignore drive letters that map to local devices rather than to remote filesystem paths.

action

useLetter

Effect

D

1

Delete the mapped drive specified in letter.

D

0

Delete all mapped drives from the one specified in letter through Z:.

C, R or U

1

Apply the requested action to the mapped drive specified in letter.

C

0

Look for an unassigned drive letter, starting at the one specified in letter and proceeding alphabetically to Z:. If an unassigned letter is found, create a new mapping using that letter. Otherwise, do nothing.

R or U

0

Updates or replaces the first mapped drive, starting with whatever drive is specified in letter.