Skip to content

Commit 92c09d5

Browse files
committed
Updated text
1 parent 08c79e4 commit 92c09d5

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

azure-local/manage/disconnected-operations-on-demand-logs.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ To collect logs from the control plane, follow these steps:
5858
5959
For more information on the Send-DiagnosticData command, see [Fallback log collection](disconnected-operations-fallback.md).
6060
61-
1. Upload logs using the **standalone observability tool**.
61+
1. Upload logs by using the **standalone observability tool**.
6262
6363
After you save logs from both the appliance and host nodes to a shared location, upload them with the standalone observability tool:
6464
@@ -87,7 +87,7 @@ Here's what you need to do log collection in a connected disconnected operations
8787
Import-Module "<disconnected operations module folder path>\Azure.Local.DisconnectedOperations.psd1" -Force
8888
```
8989
90-
Here's an example output:
90+
Example output:
9191
9292
```console
9393
PS C:\Users\administrator.s46r2004\Documents> Import-Module "Q:\AzureLocalVHD\OperationsModule\Azure.Local.DisconnectedOperations.psd1" -Force
@@ -125,7 +125,7 @@ Here's what you need to do log collection in a connected disconnected operations
125125
$recoveryKeys
126126
```
127127
128-
Here's the example output:
128+
Example output:
129129
130130
```console
131131
PS C:\Users\administrator.s46r2004\Documents> $recoverykeySet = Get-ApplianceBitlockerRecoveryKeys
@@ -175,7 +175,7 @@ Before you trigger a log collection, create a share and credentials for a share.
175175
New-SMBShare -Name <share-name> -Path <path-to-share> -FullAccess Users -ChangeAccess 'Server Operators'
176176
```
177177
178-
1. Create PSCredentials to the share. Run this command:
178+
1. Create PSCredential's to the share. Replace the placeholder `<share-name>` and `<path-to-share>` with your own values and run this command:
179179
180180
```PowerShell
181181
$user = "<username>"
@@ -184,9 +184,9 @@ Before you trigger a log collection, create a share and credentials for a share.
184184
$shareCredential = New-Object System.Management.Automation.PSCredential ($user, $sec)
185185
```
186186
187-
1. Trigger log collection with the `Invoke-ApplianceLogCollectionAndSaveToShareFolder`.
187+
1. Trigger log collection with the `Invoke-ApplianceLogCollectionAndSaveToShareFolder` cmdlet. Replace the placeholder text `<File Share Path>` and `<Share Folder Password>` with your own values.
188188
189-
Here's an example:
189+
Example:
190190
191191
```azurecli
192192
$fromDate = (Get-Date).AddMinutes(-30)
@@ -195,9 +195,9 @@ Before you trigger a log collection, create a share and credentials for a share.
195195
-LogOutputShareFolderPath "<File Share Path>" -ShareFolderUsername "ShareFolderUser" -ShareFolderPassword (ConvertTo-SecureString "<Share Folder Password>" -AsPlainText -Force)
196196
```
197197
198-
1. Copy logs from your disconnected environment to the share folder.
198+
1. Copy logs from your disconnected environment to the share folder. Replace the placeholder text `<share folder path>` and `<share folder user name>` with your own values.
199199
200-
Here's an example:
200+
Example:
201201
202202
```azurecli
203203
$fromDate = (Get-Date).ToUniversalTime().AddHours(-1)
@@ -219,9 +219,9 @@ Before you trigger a log collection, create a share and credentials for a share.
219219
220220
1. Check the status of the log collection job.
221221
222-
Use the `Get-ApplianceLogCollectionJobStatus` or `Get-ApplianceLogCollectionHistory` cmdlet to retrieve the current log collection job status.
222+
Use the `Get-ApplianceLogCollectionJobStatus` or `Get-ApplianceLogCollectionHistory` cmdlet to get the current log collection job status.
223223
224-
Here's an example:
224+
Example:
225225
226226
```azurecli
227227
Get-ApplianceLogCollectionJobStatus -OperationId $OperationId
@@ -231,7 +231,7 @@ Before you trigger a log collection, create a share and credentials for a share.
231231
Get-ApplianceLogCollectionHistory -FromDate ((Get-Date).AddHours(-3))
232232
```
233233
234-
Here's an example output:
234+
Example output:
235235
236236
```console
237237
PS C:\Users\administrator.s46r2004\Documents> $operationId = Invoke-ApplianceLogCollectionAndSaveToShareFolder -FromDate $fromDate -ToDate $toDate -LogOutputShareFolderPath "\\<LogShareName>\$logShareName" -ShareFolderUsername "<Username>.masd.stbtest.microsoft.com\administrator" -ShareFolderPassword (ConvertTo-SecureString "<Password>" -AsPlainText -Force)
@@ -319,19 +319,19 @@ Before you trigger a log collection, create a share and credentials for a share.
319319
}
320320
```
321321
322-
1. Get the stamp ID
322+
1. Get the stamp ID.
323323
324324
```azurecli
325325
$stampId = (Get-ApplianceInstanceConfiguration).StampId
326326
```
327327
328328
## Log collection for control plane when connected to Azure with an accessible management endpoint
329329
330-
Before you can start log collection and get the Stamp ID, set up the observability configuration with Azure Local disconnected operations module.
330+
Before you can start log collection and get the Stamp ID, set up the observability configuration with the Azure Local disconnected operations module.
331331
332-
1. To check that the observability configuration is set up. Use the Get-`ApplianceObservabilityConfiguration` or `Get-Appliancehealthstate` cmdlet:
332+
1. Check that the observability configuration is set up. Use the Get-`ApplianceObservabilityConfiguration` or `Get-ApplianceHealthState` cmdlet:
333333
334-
Here's an example output:
334+
Example output:
335335
336336
```console
337337
PS C:\Users\administrator.s46r2004\Documents> Get-ApplianceHealthState
@@ -347,7 +347,7 @@ Before you can start log collection and get the Stamp ID, set up the observabili
347347
> [!NOTE]
348348
> If the observability configuration is set up, skip step 2 and proceed to step 3.
349349
350-
1. If the observability configuration isn't set up, run the following script:
350+
1. If the observability configuration isn't set up, run this script:
351351
352352
```azurecli
353353
$observabilityConfiguration = New-ApplianceObservabilityConfiguration `
@@ -388,7 +388,7 @@ Before you can start log collection and get the Stamp ID, set up the observabili
388388
False @{Services=22; Diagnostics=0; Identity=100; Networking=100} @{Services=System.Object[]; Diagnostics=System.Object[]; Identity=System.Object[]; Networking=System.Object[]}
389389
```
390390
391-
1. Trigger log collection. Run the `Invoke-applianceLogCollection` cmdlet.
391+
1. Trigger log collection. Run the `Invoke-ApplianceLogCollection` cmdlet.
392392
393393
```azurecli
394394
$fromDate = (Get-Date).AddMinutes(-30)
@@ -439,29 +439,29 @@ What Send-DiagnosticData does:
439439
- Date range
440440
- Log type
441441
442-
- Can bypass observability agents to collect logs only on the node where the command is run.
442+
- Bypasses observability agents to collect logs only on the node where the command is run.
443443
444-
- Allows saving logs locally using the `-SaveToPath` parameter.
444+
- Lets you save logs locally by using the `-SaveToPath` parameter.
445445
446446
- Supports secure credentialed access when saving to a network share.
447447
448448
## Security considerations
449449
450-
- In air-gapped environments, this is the only supported method to extract and provide diagnostic logs to Microsoft.
451-
- Logs are not automatically transmitted unless explicitly configured.
450+
- In air-gapped environments, this method is the only supported way to extract and give diagnostic logs to Microsoft.
451+
- Logs aren't automatically sent unless you explicitly set them to be sent.
452452
- Logs can be saved locally and reviewed before sharing.
453-
- Logs may contain sensitive operational metadata but do not include PII (Personally Identifiable Information) by default.
454-
- Microsoft does not retain access to logs unless they are explicitly shared by the customer.
453+
- Logs can contain sensitive operational metadata, but they don't include personal data by default.
454+
- Microsoft doesn't keep access to logs unless they're explicitly shared by the customer.
455455
456-
If your organization does not allow direct internet connectivity from the affected node, follow these steps:
456+
If your organization doesn't let the affected node connect directly to the internet, follow these steps:
457457
458-
1. Use the -SaveToPath option to store logs locally.
459-
2. Transfer the logs to a separate VM or system that is permitted to connect to the internet.
460-
3. Use that system to upload the logs to Microsoft via secure support channels.
458+
1. Use the `-SaveToPath` option to store logs locally.
459+
2. Move the logs to a separate VM or system that can connect to the internet.
460+
3. Use that system to upload the logs to Microsoft through secure support channels.
461461
462-
This approach ensures that diagnostic data can still be shared for support purposes without compromising the integrity of your air-gapped environment.
462+
This approach lets you share diagnostic data for support purposes without affecting the integrity of your air-gapped environment.
463463
464-
### Use Fallback log collection
464+
### Use fallback log collection
465465
466466
Use fallback log collection to collect and send logs when the disconnected operations with Azure Local VM is down, the management endpoint isn't accessible, and you can't invoke standard log collection.
467467
@@ -477,42 +477,42 @@ For more information, see [Use appliance fallback log collection](disconnected-o
477477
478478
- `Copy-DiagnosticData`: this cmdlet must be run on the Hyper-V host that is hosting your Azure Local disconnected VM.
479479
480-
- `Send-DiagnosticData`: this cmdlet must be run on a windows machine that has direct internet access to Azure and is not arc-enabled and does not use the appliance as its arc control plane.
480+
- `Send-DiagnosticData`: this cmdlet must be run on a windows machine that has direct internet access to Azure, isn't arc-enabled, and doesn't use the appliance as its arc control plane.
481481
482-
- `Invoke-ApplianceLogCollectionAndSaveToShareFolder`: you need to specify the account in the format: Domain\Username, if you omit the domain or use an incorrect username, the copy operation to the share will fail with an access-denied error.
482+
- `Invoke-ApplianceLogCollectionAndSaveToShareFolder`: you need to specify the account in the format: Domain\Username. If you omit the domain or use an incorrect username, the copy operation to the share fails with an access-denied error.
483483
484484
## When to use on-demand log collection
485485
486-
Use on-demand direct log collection when an on-premises device running Azure Local temporarily has connectivity to Azure.
486+
Use on-demand direct log collection when an on-premises device running Azure Local temporarily connects to Azure.
487487
488488
- Improper Execution of `Send-DiagnosticData`.
489489
- Log collection fails when customers attempt to run `Send-DiagnosticData` or `Copy-DiagnosticData` from:
490-
- Nodes that are not part of the Azure Local host infrastructure.
491-
- External machines (e.g., personal laptops) that don't host the required appliance VMs on the same Hyper-V host.
490+
- Nodes that aren't part of the Azure Local host infrastructure.
491+
- External machines (for example, personal laptops) that don't host the required appliance VMs on the same Hyper-V host.
492492
493493
- Misuse of the Observability Tool.
494494
- The Standalone Observability Tool must be:
495495
- Run on a Windows Server.
496-
- Configured with additional manual steps if executed in unsupported environments.
496+
- Configured with more manual steps if executed in unsupported environments.
497497
498498
### Indirect or fallback log collection (disconnected mode)
499499
500-
Use indirect log collection methods when direct upload is not possible:
500+
Use indirect log collection methods when direct upload isn't possible:
501501
502502
- Run the following commands on the seed node:
503503
- `Invoke-ApplianceLogCollectionAndSaveToShareFolder`
504504
- `Copy-DiagnosticData`
505505
506506
- Ensure that:
507507
- The share folder is accessible.
508-
- Troubleshooting instructions are provided for common failures (e.g., permission issues, missing dependencies).
508+
- Troubleshooting instructions are provided for common failures (for example, permission issues, missing dependencies).
509509
510510
### Uploading logs to Microsoft Support
511511
512512
To upload collected logs to Microsoft:
513513
514514
- Use the Send-DiagnosticData command from the Azure Local Disconnected Operations PowerShell module.
515-
- Important: This command must not be run on Azure Local host nodes, as those are managed by the ALDO control plane.
515+
- Important: This command must not be run on Azure Local host nodes, as those are managed by the Azure Local disconnected operations control plane.
516516
- Instead, run it from a Windows machine with Azure connectivity—ideally the customer’s laptop or desktop.
517517
518518
## Related content

0 commit comments

Comments
 (0)