You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/automation/troubleshoot/desired-state-configuration.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Troubleshooting Azure Automation State Configuration
3
-
description: This article provides information on troubleshooting Azure Automation Desired State Configuration (DSC).
3
+
description: This article provides information on troubleshooting Azure Automation State Configuration.
4
4
services: automation
5
5
ms.service: automation
6
6
ms.subservice:
@@ -15,7 +15,7 @@ manager: carmonm
15
15
This article provides information on troubleshooting issues that arise while you compile or deploy configurations in Azure Automation State Configuration.
16
16
17
17
>[!NOTE]
18
-
>This article has been updated to use the new Azure PowerShell Az module. You can still use the AzureRM module, which will continue to receive bug fixes until at least December 2020. To learn more about the new Az module and AzureRM compatibility, see [Introducing the new Azure PowerShell Az module](https://docs.microsoft.com/powershell/azure/new-azureps-module-az?view=azps-3.5.0). For Az module installation instructions on your Hybrid Runbook Worker, see [Install the Azure PowerShell Module](https://docs.microsoft.com/powershell/azure/install-az-ps?view=azps-3.5.0). For your Automation account, you can update your modules to the latest version using[How to update Azure PowerShell modules in Azure Automation](../automation-update-azure-modules.md).
18
+
>This article has been updated to use the new Azure PowerShell Az module. You can still use the AzureRM module, which will continue to receive bug fixes until at least December 2020. To learn more about the new Az module and AzureRM compatibility, see [Introducing the new Azure PowerShell Az module](https://docs.microsoft.com/powershell/azure/new-azureps-module-az?view=azps-3.5.0). For Az module installation instructions on your Hybrid Runbook Worker, see [Install the Azure PowerShell Module](https://docs.microsoft.com/powershell/azure/install-az-ps?view=azps-3.5.0). For your Automation account, you can update your modules to the latest version by following the steps in[How to update Azure PowerShell modules in Azure Automation](../automation-update-azure-modules.md).
19
19
20
20
## Diagnose an issue
21
21
@@ -27,25 +27,25 @@ Azure Automation State Configuration is built on PowerShell Desired State Config
27
27
28
28
By compiling a DSC configuration on your local machine, you can discover and resolve common errors, such as:
29
29
30
-
- Missing modules
31
-
- Syntax errors
32
-
- Logic errors
30
+
- Missing modules.
31
+
- Syntax errors.
32
+
- Logic errors.
33
33
34
34
### 2. View DSC logs on your node.
35
35
36
36
If your configuration compiles successfully, but fails when applied to a node, you can find detailed information in the DSC logs. For information about where to find these logs, see [Where are the DSC Event Logs](/powershell/scripting/dsc/troubleshooting/troubleshooting#where-are-dsc-event-logs).
37
37
38
38
The [xDscDiagnostics](https://github.com/PowerShell/xDscDiagnostics) module can assist you in parsing detailed information from the DSC logs. If you contact support, they require these logs to diagnose your issue.
39
39
40
-
You can install the `xDscDiagnostics` module on your local machine using the instructions found in [Install the stable version module](https://github.com/PowerShell/xDscDiagnostics#install-the-stable-version-module).
40
+
You can install the `xDscDiagnostics` module on your local machine by following the instructions in [Install the stable version module](https://github.com/PowerShell/xDscDiagnostics#install-the-stable-version-module).
41
41
42
-
To install the `xDscDiagnostics` module on your Azure machine, use [Invoke-AzVMRunCommand](https://docs.microsoft.com/powershell/module/az.compute/invoke-azvmruncommand?view=azps-3.7.0). You can also use the **Run command** option in the Azure portal by following the steps found in [Run PowerShell scripts in your Windows VM with Run Command](../../virtual-machines/windows/run-command.md).
42
+
To install the `xDscDiagnostics` module on your Azure machine, use [Invoke-AzVMRunCommand](https://docs.microsoft.com/powershell/module/az.compute/invoke-azvmruncommand?view=azps-3.7.0). You can also use the **Run command** option in the Azure portal by following the steps in [Run PowerShell scripts in your Windows VM with Run Command](../../virtual-machines/windows/run-command.md).
43
43
44
44
For information on using **xDscDiagnostics**, see [Using xDscDiagnostics to analyze DSC logs](/powershell/scripting/dsc/troubleshooting/troubleshooting#using-xdscdiagnostics-to-analyze-dsc-logs). See also [xDscDiagnostics Cmdlets](https://github.com/PowerShell/xDscDiagnostics#cmdlets).
45
45
46
46
### 3. Ensure that nodes and the Automation workspace have required modules.
47
47
48
-
DSC depends on modules installed on the node. When using Azure Automation State Configuration, import any required modules into your Automation account using the steps in [Import Modules](../shared-resources/modules.md#importing-modules). Configurations can also have a dependency on specific versions of modules. For more information, see [Troubleshoot modules](shared-resources.md#modules).
48
+
DSC depends on modules installed on the node. When you use Azure Automation State Configuration, import any required modules into your Automation account by following the steps in [Import Modules](../shared-resources/modules.md#importing-modules). Configurations can also have a dependency on specific versions of modules. For more information, see [Troubleshoot modules](shared-resources.md#modules).
49
49
50
50
## <aname="unsupported-characters"></a>Scenario: A configuration with special characters can't be deleted from the portal
51
51
@@ -88,7 +88,7 @@ This error is normally caused by a firewall, the machine being behind a proxy se
88
88
89
89
### Resolution
90
90
91
-
Verify that your machine has access to the proper endpoints for DSC and try again. For a list of ports and addresses needed, see [network planning](../automation-dsc-overview.md#network-planning)
91
+
Verify that your machine has access to the proper endpoints for DSC and try again. For a list of ports and addresses needed, see [Network planning](../automation-dsc-overview.md#network-planning).
92
92
93
93
## <aname="unauthorized"><a/>Scenario: Status reports return response code Unauthorized
94
94
@@ -112,21 +112,21 @@ This issue might also be caused by a proxy configuration not allowing access to
112
112
113
113
### Resolution
114
114
115
-
Use the following steps to re-register the failing DSC node.
115
+
Use the following steps to reregister the failing DSC node.
116
116
117
-
Step 1: Unregister the node.
117
+
#### Step 1: Unregister the node.
118
118
119
-
1. In Azure portal, go to **Home** > **Automation Accounts** > (your Automation account) > **State configuration (DSC)**.
119
+
1. In the Azure portal, go to **Home** > **Automation Accounts** > (your Automation account) > **State configuration (DSC)**.
120
120
1. Select **Nodes**, and select the node having trouble.
121
121
1. Select **Unregister** to unregister the node.
122
122
123
-
Step 2: Uninstall the DSC extension from the node.
123
+
#### Step 2: Uninstall the DSC extension from the node.
124
124
125
-
1. In Azure portal, go to **Home** > **Virtual Machine** > (failing node) > **Extensions**.
125
+
1. In the Azure portal, go to **Home** > **Virtual Machine** > (failing node) > **Extensions**.
126
126
1. Select **Microsoft.Powershell.DSC**, the PowerShell DSC extension.
127
127
1. Select **Uninstall** to uninstall the extension.
128
128
129
-
Step 3: Remove all bad or expired certificates from the node.
129
+
#### Step 3: Remove all bad or expired certificates from the node.
130
130
131
131
On the failing node from an elevated PowerShell prompt, run these commands:
132
132
@@ -146,7 +146,7 @@ If (($certs.Count) -gt 0)
146
146
}
147
147
```
148
148
149
-
Step 4: Re-register the failing node.
149
+
#### Step 4: Reregister the failing node.
150
150
151
151
1. In the Azure portal, go to **Home** > **Automation Accounts** > (your Automation account) > **State configuration (DSC)**.
152
152
1. Select **Nodes**.
@@ -198,7 +198,7 @@ Use one of the following solutions to fix the problem:
198
198
* Make sure that the expression next to the `Node` keyword in the configuration definition isn't evaluating to Null.
199
199
* If you're passing [ConfigurationData](../automation-dsc-compile.md) when you compile the configuration, make sure that you're passing the values that the configuration expects from the configuration data.
200
200
201
-
###<aname="dsc-in-progress"></a>Scenario: The DSC node report becomes stuck in the In Progress state
201
+
## <aname="dsc-in-progress"></a>Scenario: The DSC node report becomes stuck in the In Progress state
202
202
203
203
### Issue
204
204
@@ -214,7 +214,7 @@ You've upgraded your Windows Management Framework (WMF) version and have corrupt
214
214
215
215
### Resolution
216
216
217
-
Follow instructions in [DSC known issues and limitations](https://docs.microsoft.com/powershell/scripting/wmf/known-issues/known-issues-dsc).
217
+
Follow the instructions in [DSC known issues and limitations](https://docs.microsoft.com/powershell/scripting/wmf/known-issues/known-issues-dsc).
218
218
219
219
## <aname="issue-using-credential"></a>Scenario: Unable to use a credential in a DSC configuration
220
220
@@ -232,9 +232,9 @@ You've used a credential in a configuration but didn't provide proper `Configura
232
232
233
233
### Resolution
234
234
235
-
Make sure to pass in the proper `ConfigurationData` to set `PSDscAllowPlainTextPassword` to true for each node configuration that is mentioned in the configuration. See [Compiling DSC configurations in Azure Automation State Configuration](../automation-dsc-compile.md).
235
+
Make sure to pass in the proper `ConfigurationData` to set `PSDscAllowPlainTextPassword` to true for each node configuration that's mentioned in the configuration. See [Compiling DSC configurations in Azure Automation State Configuration](../automation-dsc-compile.md).
236
236
237
-
## <aname="failure-processing-extension"></a>Scenario: "Failure processing extension" error when onboarding from DSC extension
237
+
## <aname="failure-processing-extension"></a>Scenario: "Failure processing extension" error when onboarding from a DSC extension
238
238
239
239
### Issue
240
240
@@ -253,7 +253,7 @@ This error typically occurs when the node is assigned a node configuration name
253
253
* Make sure that you're assigning the node with a name that exactly matches the name in the service.
254
254
* You can choose to not include the node configuration name, which results in onboarding the node but not assigning a node configuration.
255
255
256
-
## <aname="cross-subscription"></a>Scenario: "One or more errors occurred" error when registering a node using PowerShell
256
+
## <aname="cross-subscription"></a>Scenario: "One or more errors occurred" error when registering a node by using PowerShell
257
257
258
258
### Issue
259
259
@@ -310,7 +310,7 @@ If the **/tmp** location is set to `noexec`, the current version of DSC fails to
310
310
311
311
Remove the `noexec` option from the **/tmp** location.
312
312
313
-
## <aname="compilation-node-name-overlap"></a>Scenario: Node configuration names that overlap can result in bad release
313
+
## <aname="compilation-node-name-overlap"></a>Scenario: Node configuration names that overlap can result in a bad release
0 commit comments