Agent deployment
The following commands are available to you to manage your agent deployment. For full parameter details and examples, click a command hyperlink in the table or see the command help, using the Get-Help command.
Get-QAgentEvents
Retrieves saved events for the specified agent from the One Identity Manager database.
Agent events include information such as errors and warnings from the agent that are stored in the One Identity Manager database. Use this command to retrieve stored agent messages to the console or a text file to quickly identify issues.
Syntax:
Get-QAgentEvents [-AgentId] <String> [<CommonParameters>]
Table 150: Parameters
| AgentId |
Specify the ID (GUID format) of the agent whose stored messages are to be retrieved.
Run the Get-QManagedHosts cmdlet and locate the agents array in the managed host to retrieve its ID. |
Examples:
Table 151: Examples
|
C:\PS>@{#cdata-section=Add-PSSnapin Quest.DataGovernance
$hosts = Get-QManagedHosts
$agents = $hosts[0].Agents
$agentId = $agents[0].Id
Get-QAgentEvents -AgentId $agentId; xmlns:dev=http://schemas.microsoft.com/maml/dev/2004/10}
First run the Get-QManagedHosts command and access the agents collection for the selected managed host. Locate the agent ID, call Get-QAgentEvents, and pass the agent ID to the method. |
Returns all stored messages for the specified Data Governance agent. |
Details retrieved:
Table 152: Details retrieved
| Date/Time |
The date and time the critical agent error occurred. |
| Description |
The event message logged for the critical agent error. |
Get-QAgentMetrics
Retrieves agent activity and performance metrics.
Syntax:
Get-QAgentMetrics [-AgentId] <String> [<CommonParameters>]
Table 153: Parameters
| AgentId |
Specify the ID (GUID format) of the agent whose metrics are to be retrieved.
Run the Get-QManagedHosts cmdlet and locate the agents array in the managed host to retrieve its ID. |
Examples:
Table 154: Examples
| (Get-QAgentMetrics -AgentId 19048a06-845a-4628-94fc-dabf60345ea9).Metrics |
Returns agent activity and performance information for the specified Data Governance agent. Expands the Metrics array to display the individual metrics. |
Details retrieved:
Table 155: Details retrieved
| Agent |
Value (GUID) assigned to the agent. |
| MetricsSetName |
The name associated with a set of metrics:
- AgentCore
- Resource Activity
- Scan
- SharePoint Security Indexer
- SharePoint Security Indexer - Store Security Info
|
| Start |
For metrics that span a length of time, the date and time when the metrics collection started. |
| End |
For metrics that span a length of time, the date and time when the metrics collection ended.
If no end time is specified by the agent, the date/time maximum value (for example, 23:59:59:9999999 UTC, December 31, 9999) |
| Metrics |
Metrics is an array that can be expanded to show the metrics returned from the agent. The following details are displayed for each metric:
- Value
- ValueAsObject
- ValueAsString
- Name
|
Set-QAgentConfiguration
Sets or modifies the managed paths to be scanned by the specified agent.
Note: When you set the managed paths using this cmdlet, existing managed paths will be overwritten.
Note: This cmdlet is does not support setting managed paths for Cloud managed hosts.
Syntax:
Set-QAgentConfiguration [-DataRoots [<String[]>]] [-AgentId] <String> [-ManagedHostId] <String> [-AppendRoots [<SwitchParameter>]] [<CommonParameters>]
Table 156: Parameters
| DataRoots |
(Optional) Specify this parameter to specify or change the managed paths to be scanned by the agent. Enter an array of strings that contain the paths to the roots to be scanned by the agent.
For SharePoint managed host, enter the DisplayPath|UnfriendlyPath (see example). |
| AgentId |
Specify the ID (GUID format) of the agent you want to set (or change) roots for.
Run the Get-QManagedHosts cmdlet and locate the agents array in the managed host to retrieve its ID. |
| ManagedHostId |
Specify the ID (GUID format) of the managed host you want to set (or change) managed paths for.
Run the Get-QManagedHosts cmdlet without any parameters to retrieve a list of available managed hosts and their IDs. |
| AppendRoots |
(Optional) Specify this parameter to append any specified managed paths (DataRoots) to the given agent configuration. If not specified, the data roots provided overwrite previously defined managed paths. |
Examples:
Table 157: Examples
| Set-QAgentConfiguration -AgentId 49536bfa-d149-4410-a484-aca06dbef09e -ManagedHostId fef62b17-146b-4eb3-9567-7707b6a88785 -DataRoots \\2K8R2DJSQL\C$\Test Data |
Sets the managed paths to be scanned for the specified agent. |
| Set-QAgentConfiguration -AgentId 67e1c215-6603-42f5-b5a1-42a05837ae12 -ManagedHostId 8212e02a-7b3f-4010-bb33-68160abc41fc -DataRoots "SharePoint_ConfigVmset6/SharePoint - 80/My Wiki/My Wiki/Documents|sp://titan/0ee296d6-dea5-4f4d-950f-27c06458cad1/57947f70-c2b0-4d76-a8b3-ac54fa5bb4ab/15c4fc23-b986-4937-890c-d38715d3114/My%20Wiki/Documents" |
Specifies the managed paths to be scanned for a SharePoint managed host.
TIP: The DataRoots is (DisplayPath|UnfriendlyPath). |
