# Create LoadRunner Professional telemetry instances

To create an instance of the LoadRunner provider, build a YAML file (`instance.yml` in this example) with the definition of the instance:

```yaml
# LoadRunner Telemetry Provider Instance
provider: LoadRunner
config:
 hostname: cifsserver.mycompany.com
 username: akamas
 password: mypassword
 shareName: akamas_lr_results
```

Then you can create the instance for the `system` using the Akamas CLI:

```bash
akamas create telemetry-instance instance.yml system
```

### Configuration options <a href="#configuration-options" id="configuration-options"></a>

When you create an instance of the LoadRunner provider, you should specify some configuration information to allow the provider to correctly extract and process metrics from LoadRunner.

You can specify configuration information within the `config` part of the YAML of the instance definition.

#### Required properties <a href="#required-properties" id="required-properties"></a>

* `hostname`: The hostname or IP of the server that hosts the CIFS share where the LoadRunner results have been exported. See [LoadRunner operator](https://docs.akamas.io/akamas-docs/3.6/reference/workflow-operators/loadrunner-operator).
* `username`: The username and the domain required to access the network share. Supported formats are:
  * username
  * domain\username
  * username\@domain
* `password`: The password required to access the network share
* `shareName`: The name of the network share as it is exposed by the server

### Telemetry instance reference <a href="#hardbreak-telemetry-instance-reference" id="hardbreak-telemetry-instance-reference"></a>

The following YAML file provides the reference for the definition of a telemetry instance.

```yaml
provider: LoadRunner # this is an instance of the LoadRunner provider
config:
 hostname: cifsserver.mycompany.com # Share server
 username: user@mycompany
 password: mypassword
 shareName: akamas_lr_results
 pathPrefix: YAML
 resultsFolder: YAML
```

The following table describes the reference for the `config` section within the definition of the LoadRunner provider instance:

| Field        | Type   | Description                                                                                                                                                                                                                                  | Default Value                            | Restrictions                                                                                                                    | Required |
| ------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -------- |
| hostname     | String | the hostname or IP of the server that hosts the CIFS share where the LoadRunner results have been exported. See [LoadRunner operator](https://docs.akamas.io/akamas-docs/3.6/reference/workflow-operators/loadrunner-operator)               | -                                        | IP address or FQDN                                                                                                              | Yes      |
| username     | String | The username and the domain required to access the share                                                                                                                                                                                     | -                                        | <p>Supported formats:</p><ul><li><em>username</em></li><li><em>domain\username</em></li><li><em>username\@domain</em></li></ul> | Yes      |
| password     | String | The password required to access the share                                                                                                                                                                                                    | -                                        | -                                                                                                                               | Yes      |
| shareName    | String | The name of the share as it is exposed by the server                                                                                                                                                                                         | -                                        | -                                                                                                                               | Yes      |
| resultFolder | String | <p>The name of the folder where to look for test results. The final path is {pathPrefix}{resultsFolder}.</p><p>The default path is</p><p>See <a href="../../../reference/workflow-operators/loadrunner-operator">LoadRunner operator</a></p> | *{studyName}\\{experimentId}\\{trialId}* | A valid Windows path segment, might contain the placeholders: *{studyName}, {experimentId}, {trialId}*                          | No       |
| pathPrefix   | String | A prefix the for path where to look for test results.                                                                                                                                                                                        | -                                        | A valid Windows path                                                                                                            | No       |