|
| 1 | +--- |
| 2 | +external help file: Logic.Monitor-help.xml |
| 3 | +Module Name: Logic.Monitor |
| 4 | +online version: |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Invoke-LMDiagnosticSource |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Triggers a diagnostic source execution for a host. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +### Id-diagnosticId (Default) |
| 16 | +``` |
| 17 | +Invoke-LMDiagnosticSource -Id <Int32> -DiagnosticId <Int32> [-AlertId <String>] |
| 18 | + [-ProgressAction <ActionPreference>] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +### Id-diagnosticName |
| 22 | +``` |
| 23 | +Invoke-LMDiagnosticSource -Id <Int32> -DiagnosticName <String> [-AlertId <String>] |
| 24 | + [-ProgressAction <ActionPreference>] [<CommonParameters>] |
| 25 | +``` |
| 26 | + |
| 27 | +### Name-diagnosticName |
| 28 | +``` |
| 29 | +Invoke-LMDiagnosticSource -Name <String> -DiagnosticName <String> [-AlertId <String>] |
| 30 | + [-ProgressAction <ActionPreference>] [<CommonParameters>] |
| 31 | +``` |
| 32 | + |
| 33 | +### Name-diagnosticId |
| 34 | +``` |
| 35 | +Invoke-LMDiagnosticSource -Name <String> -DiagnosticId <Int32> [-AlertId <String>] |
| 36 | + [-ProgressAction <ActionPreference>] [<CommonParameters>] |
| 37 | +``` |
| 38 | + |
| 39 | +### DisplayName-diagnosticName |
| 40 | +``` |
| 41 | +Invoke-LMDiagnosticSource -DisplayName <String> -DiagnosticName <String> [-AlertId <String>] |
| 42 | + [-ProgressAction <ActionPreference>] [<CommonParameters>] |
| 43 | +``` |
| 44 | + |
| 45 | +### DisplayName-diagnosticId |
| 46 | +``` |
| 47 | +Invoke-LMDiagnosticSource -DisplayName <String> -DiagnosticId <Int32> [-AlertId <String>] |
| 48 | + [-ProgressAction <ActionPreference>] [<CommonParameters>] |
| 49 | +``` |
| 50 | + |
| 51 | +## DESCRIPTION |
| 52 | +The Invoke-LMDiagnosticSource function manually triggers a diagnostic source execution for a |
| 53 | +LogicMonitor host. |
| 54 | +The host can be identified by ID, name, or display name, and the diagnostic |
| 55 | +source can be identified by ID or name. |
| 56 | + |
| 57 | +## EXAMPLES |
| 58 | + |
| 59 | +### EXAMPLE 1 |
| 60 | +``` |
| 61 | +Invoke-LMDiagnosticSource -Id 123 -DiagnosticId 456 |
| 62 | +``` |
| 63 | + |
| 64 | +Triggers diagnostic source ID 456 on host ID 123. |
| 65 | + |
| 66 | +### EXAMPLE 2 |
| 67 | +``` |
| 68 | +Invoke-LMDiagnosticSource -HostName "server01" -DiagnosticName "Disk Troubleshooter" -AlertId "A123456" |
| 69 | +``` |
| 70 | + |
| 71 | +Looks up host and diagnostic source by name, then triggers a diagnostic execution associated with alert A123456. |
| 72 | + |
| 73 | +## PARAMETERS |
| 74 | + |
| 75 | +### -Id |
| 76 | +The host ID to run the diagnostic source against. |
| 77 | +Alias: HostId. |
| 78 | + |
| 79 | +```yaml |
| 80 | +Type: Int32 |
| 81 | +Parameter Sets: Id-diagnosticId, Id-diagnosticName |
| 82 | +Aliases: HostId, DeviceId |
| 83 | + |
| 84 | +Required: True |
| 85 | +Position: Named |
| 86 | +Default value: 0 |
| 87 | +Accept pipeline input: True (ByPropertyName) |
| 88 | +Accept wildcard characters: False |
| 89 | +``` |
| 90 | +
|
| 91 | +### -Name |
| 92 | +The host name to run the diagnostic source against. |
| 93 | +Alias: HostName. |
| 94 | +
|
| 95 | +```yaml |
| 96 | +Type: String |
| 97 | +Parameter Sets: Name-diagnosticName, Name-diagnosticId |
| 98 | +Aliases: HostName, DeviceName |
| 99 | + |
| 100 | +Required: True |
| 101 | +Position: Named |
| 102 | +Default value: None |
| 103 | +Accept pipeline input: False |
| 104 | +Accept wildcard characters: False |
| 105 | +``` |
| 106 | +
|
| 107 | +### -DisplayName |
| 108 | +The host display name to run the diagnostic source against. |
| 109 | +
|
| 110 | +```yaml |
| 111 | +Type: String |
| 112 | +Parameter Sets: DisplayName-diagnosticName, DisplayName-diagnosticId |
| 113 | +Aliases: HostDisplayName, DeviceDisplayName |
| 114 | + |
| 115 | +Required: True |
| 116 | +Position: Named |
| 117 | +Default value: None |
| 118 | +Accept pipeline input: False |
| 119 | +Accept wildcard characters: False |
| 120 | +``` |
| 121 | +
|
| 122 | +### -DiagnosticId |
| 123 | +The diagnostic source ID to execute. |
| 124 | +
|
| 125 | +```yaml |
| 126 | +Type: Int32 |
| 127 | +Parameter Sets: Id-diagnosticId, Name-diagnosticId, DisplayName-diagnosticId |
| 128 | +Aliases: |
| 129 | + |
| 130 | +Required: True |
| 131 | +Position: Named |
| 132 | +Default value: 0 |
| 133 | +Accept pipeline input: False |
| 134 | +Accept wildcard characters: False |
| 135 | +``` |
| 136 | +
|
| 137 | +### -DiagnosticName |
| 138 | +The diagnostic source name to execute. |
| 139 | +
|
| 140 | +```yaml |
| 141 | +Type: String |
| 142 | +Parameter Sets: Id-diagnosticName, Name-diagnosticName, DisplayName-diagnosticName |
| 143 | +Aliases: |
| 144 | + |
| 145 | +Required: True |
| 146 | +Position: Named |
| 147 | +Default value: None |
| 148 | +Accept pipeline input: False |
| 149 | +Accept wildcard characters: False |
| 150 | +``` |
| 151 | +
|
| 152 | +### -AlertId |
| 153 | +Optional alert ID associated with this diagnostic execution. |
| 154 | +
|
| 155 | +```yaml |
| 156 | +Type: String |
| 157 | +Parameter Sets: (All) |
| 158 | +Aliases: |
| 159 | + |
| 160 | +Required: False |
| 161 | +Position: Named |
| 162 | +Default value: None |
| 163 | +Accept pipeline input: False |
| 164 | +Accept wildcard characters: False |
| 165 | +``` |
| 166 | +
|
| 167 | +### -ProgressAction |
| 168 | +{{ Fill ProgressAction Description }} |
| 169 | +
|
| 170 | +```yaml |
| 171 | +Type: ActionPreference |
| 172 | +Parameter Sets: (All) |
| 173 | +Aliases: proga |
| 174 | + |
| 175 | +Required: False |
| 176 | +Position: Named |
| 177 | +Default value: None |
| 178 | +Accept pipeline input: False |
| 179 | +Accept wildcard characters: False |
| 180 | +``` |
| 181 | +
|
| 182 | +### CommonParameters |
| 183 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 184 | +
|
| 185 | +## INPUTS |
| 186 | +
|
| 187 | +### None. You cannot pipe objects to this command. |
| 188 | +## OUTPUTS |
| 189 | +
|
| 190 | +### Returns LogicMonitor.DiagnosticSourceExecution object. |
| 191 | +## NOTES |
| 192 | +You must run Connect-LMAccount before running this command. |
| 193 | +
|
| 194 | +## RELATED LINKS |
0 commit comments