---
alias: user-guide-automation-task-filedrivers-mount
tags:
- automation tasks
description: "This task creates a local link to a remote network share, requiring administrator privileges"
---

# Mount

![Screenshot showing a directory creation event with mount details.](images/eventdirectorycreated-lg.svg)

!!! note
    This task is exclusively supported on Windows-based environments.

When activated, the `mount`  task will create a link from a remote to a local `path`. The `path`  can be provided either by the input port or in the task settings.

![Screenshot showing a mount configuration interface with fields for "i" and "path".](./images/image29.png)

## Inputs

| Name                  | DataType  | Description                                                    |
|-----------------------|-----------|----------------------------------------------------------------|
| path                  | `String`  | Remote path to mount                                           |
| username              | `String`  | Username of the share                                          |
| password              | `String`  | Password of the share                                          |
| localPath             | `String`  | Local directory to use                                         |
| failIfLocalPathExists | `Boolean` | Fail if the local path already exists. Can delete it otherwise |
| Activate              | `any`     | Activate the task                                              |

## Outputs

| Name    | DataType | Description  |
| ------  | --------- | --------- |
|  path  |       `String`       | Local path where the mount is accessible |
| Success | `Boolean` | Triggered when the task is executed with success |
|  Error           |        `Error`                | Triggered when the task failed for some reason |

## Settings

On the `General` tab, you have the usual settings and the following settings:

| Name    | DataType | Values | Default | Description  |
| ------  | --------- | --------- | --------- | --------- |
| Path                      | `String`  |        |         | Remote path to mount                                         |
| Username | `String` |  |  | Username of the share |
| Password | `String` |  |  | Password of the share |
| Local Path | `String` |  |  | Local directory to use |
| Fail if local path exists | `Boolean` |        | False | Fail if the local path already exists. Can delete it otherwise |

For the `Local Path` you can use tokens as represented below:

```bash
Available tokens:
  ${temp} - Temporary directory of the user
  ${id} - DriverId ("\" chars replaced with "_")

Examples:
  ${temp}\files\${id}
  c:\Locationshared
```

![Screenshot showing settings options in a system configuration menu.](./images/image30.png)

## Behavior

In this task you choose a driver when dropping it into the workflow (if you have more than one driver associated with the controller).

Upon activation, will send a `Mount` command to the driver where it will try to mount the network path provided in the `path`parameter, using (optionally) the `username` and `password`.
It will map it into the `localPath` location using a symbolic Link.

When the operation is executed with success, both `Success` and  `result` outputs emit their respective values. In case of the task , for some reason, is not able perform the operation, an `Error` is emitted.

## Remarks

The Mount command provided will create a symbolic link between the network share and the computer. Due to Microsoft restrictions, this can only be performed by and administrator or by a pre-defined set of users by:

- Change in Local Security Policy (`secpol.msc`)
- Navigate to: Local Policies > User Rights Assignment
- Double click: **Create Symbolic Links**
- Add your username to the list, click OK
- Log off