IAdmCreateHomeDirectoryAction

The IAdmCreateHomeDirectoryAction interface represents the Create a home directory action.

Inheritance: IAdmSetPropertiesAction

Properties

  • Property

  • Description

  • HomeDirectory

  • Gets or sets a UNC path to the home directory.

  • HomeDrive

  • Gets or sets the drive letter to map the user's home directory to.

  • UserAccessPermissions

  • Gets or sets the user access permissions that need to be applied to the home directory.

  • InheritParentPermissions

  • Gets or sets a value indicating whether the home directory must inherit permission entries from its parent directory.

  • SetUserAsOwner

  • Gets or sets a value indicating whether the user must be set as the owner of the home directory.

Details

HomeDirectory

Gets or sets a UNC path to the home directory. You can use value references in the path (e.g. \\SERVER\Share\%username%). Value references will be replaced with corresponding property values of the user account on which the action is executed.

  • Type:
  • string
  • Access:
  • Read/Write

HomeDrive

Gets or sets the drive letter to map the user's home directory to.

  • Type:
  • string
  • Access:
  • Read/Write

Remarks

The drive letter must be specified in the DriveLetter: format, where DriveLetter is the letter of the drive to map. DriveLetter must be a single uppercase letter, and the colon character (:) is required. Example: Z:.


UserAccessPermissions

Gets or sets the user access permissions that need to be applied to the home directory.


InheritParentPermissions

Gets or sets a value indicating whether the home directory must inherit permission entries from its parent directory.

  • Type:
  • bool
  • Access:
  • Read/Write

SetUserAsOwner

Gets or sets a value indicating whether the user must be set as the owner of the home directory.

  • Type:
  • bool
  • Access:
  • Read/Write

Requirements

Minimum required version: 2009.1

See also