Skip to content

Commit 729c212

Browse files
committed
Formatting changes
1 parent 5cc82df commit 729c212

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

articles/iot-edge/configure-device.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ services: iot-edge
1111

1212
# Configure IoT Edge device settings
1313

14-
This article shows settings and options for configuring the IoT Edge *config.toml* file of an IoT Edge device. IoT Edge uses the *config.toml* file to initialize settings for the device. Each of the sections of the `config.toml` file has several options. Not all options are mandatory, as they apply to specific scenarios.
14+
This article shows settings and options for configuring the IoT Edge *config.toml* file of an IoT Edge device. IoT Edge uses the *config.toml* file to initialize settings for the device. Each of the sections of the *config.toml* file has several options. Not all options are mandatory, as they apply to specific scenarios.
1515

16-
A template containing all options can be found in the *config.toml.edge.template* file within the `/etc/aziot` directory on an IoT Edge device. You have the option to copy the contents of the whole template or sections of the template into your *config.toml* file. Uncomment the sections you need. Be aware not to copy over parameters you have already defined.
16+
A template containing all options can be found in the *config.toml.edge.template* file within the */etc/aziot* directory on an IoT Edge device. You have the option to copy the contents of the whole template or sections of the template into your *config.toml* file. Uncomment the sections you need. Be aware not to copy over parameters you have already defined.
1717

1818
## Global parameters
1919

20-
The `hostname`, `parent_hostname`, `trust_bundle_cert`, and `allow_elevated_docker_permissions` parameters must be at the beginning of the configuration file before any other sections. Adding parameters before defined sections ensures they are applied correctly. For more information on valid syntax, see [toml.io ](https://toml.io/).
20+
The `hostname`, `parent_hostname`, `trust_bundle_cert`, and `allow_elevated_docker_permissions` parameters must be at the beginning of the configuration file before any other sections. Adding parameters before defined sections ensures they're applied correctly. For more information on valid syntax, see [toml.io ](https://toml.io/).
2121

2222
### Hostname
2323

24-
To enable gateway discovery, every IoT Edge gateway (parent) device needs to specify a hostname parameter that its child devices use to find it on the local network. The edgeHub module also uses the hostname parameter to match with its server certificate. For more information, see [Why does EdgeGateway need to be told about its own hostname?](iot-edge-certs.md#why-does-edgegateway-need-to-be-told-about-its-own-hostname).
24+
To enable gateway discovery, every IoT Edge gateway (parent) device needs to specify a hostname parameter that its child devices use to find it on the local network. The *edgeHub* module also uses the hostname parameter to match with its server certificate. For more information, see [Why does EdgeGateway need to be told about its own hostname?](iot-edge-certs.md#why-does-edgegateway-need-to-be-told-about-its-own-hostname).
2525

2626
> [!NOTE]
27-
> When the hostname value is not set, IoT Edge attempts to determine it automatically. However, clients in the network may not be able to discover the device.
27+
> When the hostname value isn't set, IoT Edge attempts to find it automatically. However, clients in the network may not be able to discover the device if it isn't set.
2828
2929
For **hostname**, replace **fqdn-device-name-or-ip-address** with your device name to override the default hostname of the device. The value can be a fully qualified domain name (FQDN) or an IP address. Use this setting as the gateway hostname on a IoT Edge gateway device.
3030

@@ -68,7 +68,7 @@ allow_elevated_docker_permissions = false
6868

6969
You can provision a single device or multiple devices at-scale, depending on the needs of your IoT Edge solution. The options available for authenticating communications between your IoT Edge devices and your IoT hubs depend on what provisioning method you choose.
7070

71-
You can provision with a connection string, symmetric key, [X.509 certificate](how-to-provision-single-device-linux-x509.md), identity certificate private key, or an identity certificate. DPS provisioning is included with various options. Choose one method for your provisioning. Replace the sample values with your own.
71+
You can provision with a connection string, symmetric key, X.509 certificate, identity certificate private key, or an identity certificate. DPS provisioning is included with various options. Choose one method for your provisioning. Replace the sample values with your own.
7272

7373
### Manual provisioning with connection string
7474

@@ -163,7 +163,7 @@ subject = { L = "AQ", ST = "Antarctica", CN = "my-device" } # with the given DN
163163
```
164164
#### (Optional) Enable automatic renewal of the device ID certificate
165165

166-
Autorenewal requires a known certificate issuance method. Set **method** to either 'est' or 'local_ca'.
166+
Autorenewal requires a known certificate issuance method. Set **method** to either `est` or `local_ca`.
167167

168168
>[!IMPORTANT]
169169
> Only enable autorenewal if this device is configured for CA-based DPS enrollment. Using autorenewal for an individual enrollment causes the device to be unable to reprovision.
@@ -212,7 +212,7 @@ cloud_retries = 1
212212

213213
### Optional auto reprovisioning mode
214214

215-
The `auto_reprovisioning_mode` property specifies the conditions that determine when a device attempts to automatically reprovision with Device Provisioning Service. It's ignored if the device has been provisioned manually. One of the following values can be set:
215+
The **auto_reprovisioning_mode** parameter specifies the conditions that decide when a device attempts to automatically reprovision with Device Provisioning Service. It's ignored if the device has been provisioned manually. One of the following values can be set:
216216

217217
| Mode | Description |
218218
|------|-------------|

0 commit comments

Comments
 (0)