Adding Suggestions to PowerShell Console

by Aug 19, 2013

Categories

Tags

Administration agent-based monitoring Agentless Monitoring alert responses alert thresholds alerting Alerts Amazon Aurora Amazon EC2 Amazon RDS Amazon RDS / Aurora Amazon RDS for SQL Server Amazon Redshift Amazon S3 Amazon Web Services (AWS) Analytics application monitoring Aqua Data Studio automation availability Azure Azure SQL Database azure sql managed instance Azure VM backup Backup and recovery backup and restore backup compression backup status Backup Strategy backups big data Blocking bug fixes business architecture business data objects business intelligence business process modeling business process models capacity planning change management cloud cloud database cloud database monitoring cloud infrastructure cloud migration cloud providers Cloud Readiness Cloud Services cloud storage cloud virtual machine cloud VM clusters code completion collaboration compliance compliance audit compliance audits compliance manager compliance reporting conference configuration connect to database cpu Cross Platform custom counters Custom Views customer survey customer testimonials Dark Theme dashboards data analysis Data Analytics data architect data architecture data breaches Data Collector data governance data lakes data lineage data management data model data modeler data modeling data models data privacy data protection data security data security measures data sources data visualization data warehouse database database administration database administrator database automation database backup database backups database capacity database changes database community database connection database design database developer database developers database development database diversity Database Engine Tuning Advisor database fragmentation database GUI database IDE database indexes database inventory management database locks database management database migration database monitoring database navigation database optimization database performance Database Permissions database platforms database profiling database queries database recovery database replication database restore database schema database security database support database synchronization database tools database transactions database tuning database-as-a-service databases DB Change Manager DB Optimizer DB PowerStudio DB2 DBA DBaaS DBArtisan dBase DBMS DDL Debugging defragmentation Demo diagnostic manager diagnostics dimensional modeling disaster recovery Download drills embedded database Encryption End-user Experience entity-relationship model ER/Studio ER/Studio Data Architect ER/Studio Enterprise Team Edition events execution plans free tools galera cluster GDPR Getting Started Git GitHub Google Cloud Hadoop Healthcare high availability HIPAA Hive hybrid clouds Hyper-V IDERA IDERA ACE Index Analyzer index optimization infrastructure as a service (IaaS) infrastructure monitoring installation Integrated Development Environment interbase Inventory Manager IT infrastructure Java JD Edwards JSON licensing load test load testing logical data model macOS macros managed cloud database managed cloud databases MariaDB memory memorystorage memoryusage metadata metric baselines metric thresholds Microsoft Azure Microsoft Azure SQL Database Microsoft PowerShell Microsoft SQL Server Microsoft Windows MongoDB monitoring Monitoring Tools Monyog multiple platforms MySQL news newsletter NoSQL Notifications odbc optimization Oracle PeopleSoft performance Performance Dashboards performance metrics performance monitoring performance schema performance tuning personally identifiable information physical data model Platform platform as a service (PaaS) PostgreSQL Precise Precise for Databases Precise for Oracle Precise for SQL Server Precise Management Database (PMDB) product updates Project Migration public clouds Query Analyzer query builder query monitor query optimization query performance Query Store query tool query tuning query-level waits Rapid SQL rdbms real time monitoring Real User Monitoring recovery regulations relational databases Releases Reporting Reports repository Restore reverse engineering Roadmap sample SAP Scalability Security Policy Security Practices server monitoring Server performance server-level waits Service Level Agreement SkySQL slow query SNMP snowflake source control SQL SQL Admin Toolset SQL CM SQL code SQL coding SQL Compliance Manager SQL Defrag Manager sql development SQL Diagnostic Manager SQL Diagnostic Manager for MySQL SQL Diagnostic Manager for SQL Server SQL Diagnostic Manager Pro SQL DM SQL Doctor SQL Enterprise Job Manager SQl IM SQL Inventory Manager SQL Management Suite SQL Monitoring SQL Performance SQL Quality SQL query SQL Query Tuner SQL Safe Backup SQL script SQL Secure SQL Security Suite SQL Server sql server alert SQL Server Migration SQL Server Performance SQL Server Recommendations SQL Server Security SQL statement history SQL tuning SQL Virtual Database sqlmemory sqlserver SQLyog Storage Storage Performance structured data Subversion Support tempdb tempdb data temporal data Tips and Tricks troubleshooting universal data models universal mapping unstructured data Uptime Infrastructure Monitor user experience user permissions Virtual Machine (VM) web services webinar What-if analysis WindowsPowerShell

Suggestions are little pieces of text that can appear next to a PowerShell error message to better explain what went wrong. Suggestions only work in the PowerShell console. They do not work in the ISE editor. There are only three suggestions hard-coded into PowerShell, but you can add more.

When you run this code in a PowerShell console, you now also get suggestions when you try and access a non-available computer using Get-WmiObject:

$PSType = [PSObject].Assembly.GetType('System.Management.Automation.HostUtilities', $true)
$suggestions = $PSType.GetField('suggestions', 'Static,NonPublic,GetField').GetValue($null) 

$NewSuggestion = 
@{
    Id = 4
    Category = 'Network Problem'
    MatchType = 'Dynamic'
    Rule = 
    {
        ($lastError -and
        ($lastError.FullyQualifiedErrorId -eq 'GetWMICOMException,Microsoft.PowerShell.Commands.GetWmiObjectCommand') -and
        ($lastError.Exception.Message -like '*RPC*'))
    }
    Suggestion = 
    {
        'The remote computer does not answer. It either does not exist, or a firewall may block access. Also make sure you did not mistype the computer name.'
    }
    Enabled = $true
}


$null = $suggestions.Add($NewSuggestion)

This is what the result would look like:

PS> Get-WmiObject -Class Win32_BIOS -ComputerName DoesNotExist
Get-WmiObject : The RPC server is unavailable. (Exception from HRESULT: 0x800706BA)
At line:1 char:1
+ Get-WmiObject -Class Win32_BIOS -ComputerName DoesNotExist
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidOperation: (:) [Get-WmiObject], COMException
+ FullyQualifiedErrorId : GetWMICOMException,Microsoft.PowerShell.Commands.GetW miObjectCommand
Suggestion [4,InvalidOperation]: The remote computer does not answer. It either does not exist, or a firewall may block access. Also make sure you did not mistype the computer name.

$NewSuggestion actually is a hash table. Rule holds a script block that gets evaluated, and if it returns $true, then PowerShell displays the suggestion. Since PowerShell needs to evaluate all rules on all suggestions, it is obvious that your rules should evaluate quickly, or else it would slow down PowerShell.

The particular rule in this example looks like this:

 Rule = 
    {
        ($lastError -and
        ($lastError.FullyQualifiedErrorId -eq 'GetWMICOMException,Microsoft.PowerShell.Commands.GetWmiObjectCommand') -and
        ($lastError.Exception.Message -like '*RPC*'))
    }

It basically checks whether there was an error record and whether the error ID was related to Get-WmiObject. With this rule alone, the suggestion would appear with any error produced by Get-WmiObject. To make it more specific, the rule also checks whether the error message contains the word “RPC” which indicates that a remote computer was unavailable.

ReTweet this Tip!