EtherAssist PowerShell module
The EtherAssist PowerShell module lets approved users call EtherAssist from scripts, consoles, and automation jobs.
Before you begin
- Install the EtherAssist module only on trusted workstations or automation hosts.
- Configure API keys through approved secret handling and never commit them to source control.
- Use read-only examples first, then add write actions only after review.
- Test scripts with sample data before running against production tenants.
Install
Install-Module -Name EtherAssist -Repository PSGallery
Import-Module EtherAssist
Configure API access
Create an API key in EtherAssist, then configure the module:
Set-EAApiConfig -ApiKey "" -ApiUrl "https://api.etherassist.ai"
Get-EAApiConfig
For longer jobs, configure retry and timeout behaviour:
Set-EAApiAdvancedConfig -DefaultTimeout 60 -MaxRetries 5 -EnableLogging
Get-EAApiAdvancedConfig
Do not commit API keys, tokens, or generated configuration files to source control.
Core cmdlets
| Cmdlet | Purpose |
|---|---|
Send-EARequest | Ask EtherAssist a question. |
Send-EACompletion | Send a completion-style request. |
Send-EAReflectiveRequest | Request a deeper reflective review. |
Invoke-EAQuery | Start an interactive console session. |
Send-EAWebSearch | Run an approved web-search style request. |
New-EAKnowledgeArticle | Generate a knowledge article draft. |
Get-EATitle | Generate a concise title from text. |
Get-EATextSummary | Summarise longer text. |
Get-EAAzureBillSummary | Summarise Azure billing-style input. |
Get-EALogAnalysis | Analyse log text with -LogContent. |
Get-EAErrorCodeDescription | Explain an error code. |
Get-EAAppDescription | Describe an application. |
Get-EAAppInstallerArgs | Suggest installer arguments. |
Get-EAMsixAnalysis | Analyse MSIX manifest content. |
Get-EAEntraThreatAnalysis | Analyse Entra threat data with -LogData. |
Get-EAPcapAnalysis | Analyse packet-capture content supplied as base64. |
Convert-EABatchToPs | Convert batch script content to PowerShell. |
Convert-EAVbsToPs | Convert VBScript content to PowerShell. |
Ask a question
Send-EARequest -Question "Create a short Intune device sync troubleshooting checklist."
Useful output switches include:
-OutputAsJson-OutputAsObject-MuteQuestion-MuteDateTime-MuteAnswer
Analyse text
$log = Get-Content -Path ".\application.log" -Raw
Get-EALogAnalysis -LogContent $log
Get-EAErrorCodeDescription -ErrorCode "0x80070643"
Review security data
Get-EAEntraThreatAnalysis -LogData $entraThreatLogs
Use these cmdlets only with data you are authorised to process. Redact secrets and personal data where possible.
Safe automation pattern
- Start with read-only data collection.
- Validate input files and parameters.
- Avoid hard-coded secrets.
- Handle API failures and throttling.
- Log enough detail for support, but do not log tokens or sensitive payloads.
- Test against sample data before production use.
Update
Update-Module -Name EtherAssist
For a clean reinstall:
Uninstall-Module -Name EtherAssist -AllVersions
Install-Module -Name EtherAssist -Repository PSGallery -Force
Related articles
Tips
- Keep names, prompts, and configuration values specific to the task you are performing.
- Check role, subscription, region, and tenant policy when a feature is not visible.
Troubleshooting
| Issue | What to check |
|---|---|
| Module command is not found | Confirm the module is installed, imported, and available in the current PowerShell session. |
| API request fails | Check API key configuration, network access, and retry settings. |
| Output is hard to audit | Use JSON/object output and avoid logging secrets or raw sensitive content. |