2.2.1.6.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 copy a file (or multiple files in one folder) from a source location to a destination location if it does not already exist at the destination, and then configure the selected attributes of those files for computers or users. If the file exists, the protocol MUST NOT copy the file or change attributes and MUST NOT return an error.

  • Delete: This action MUST be used to remove a file (or multiple files in one folder) for computers or users. The protocol MUST NOT perform an action if the files does not exist and MUST NOT return an error.

  • Replace: This action MUST be used to delete a file (or multiple files in one folder), replace it with another file or files, and configure the attributes of those files for computers or users. The net result of the Replace action MUST overwrite the files at the destination location. If the file does not exist at the destination, then the Replace action MUST copy the file from the source location to the destination.

  • Update: This action MUST be used to modify settings of an existing file (or multiple files in one folder) for computers or users. This action differs from Replace in that it MUST only update file attributes defined within the preference item. All other file attributes remain as configured on the file. If the file does not exist, then the Update action MUST copy the file from the source location to the destination.

fromPath

MUST be a fully qualified UNC or local filesystem path to the location from which to copy the Source files from the perspective of the client. This field can also contain single character (?) and multiple character (*) wildcards, allowing the user to copy or modify multiple files. The asterisk matches any sequence of characters, whereas the question mark matches any single character.

targetPath

MUST be a fully qualified UNC or local filesystem path to the location to which to copy a file or to the file to be modified from the perspective of the client. Parent folders will be created as necessary. The path MUST include the file name, and the instance can change the file name by providing a different name for it than specified in the fromPath field.

suppress

(optional) MUST be 1 to suppress errors during operations. Set to "0" to process errors. If suppress is set to 1 and an attempt is made to delete a read-only file in a folder with other writable files, the error MUST NOT be returned by the protocol. If set to 0, the error is returned by the protocol.

readonly

(optional) MUST be 1 to set the read-only attribute on the file, or 0 to clear the read-only attribute.

archive

(optional) MUST be 1 to set the archive attribute on the file, or 0 to clear the archive attribute.

hidden

(optional) MUST be 1 to set the hidden attribute on the file, or 0 to clear the hidden attribute.