Chat now with support
Chat with Support

Identity Manager Data Governance Edition 8.0 - Technical Insight Guide

Introduction Data Governance Edition Network Communications Data Governance service Data Governance agents Resource activity collection in Data Governance Edition QAM module tables Configurable configuration file settings
Data Governance service configuration file settings Data Governance agent configuration file settings
Configurable registry settings PowerShell commands
Adding the PowerShell snap-ins Finding component IDs Data Governance Edition deployment Service account management Managed domain deployment Agent deployment Managed host deployment Account access management Resource access management Governed data management Classification management
About us

Get-QAgentMetrics

Retrieves agent activity and performance metrics.

Syntax:

Get-QAgentMetrics [-AgentId] <String> [<CommonParameters>]

Table 143: Parameters
Parameter Description
AgentId

Specify the ID (GUID format) of the agent whose metrics are to be retrieved.

NOTE: Run the Get-QManagedHosts cmdlet and locate the agents array in the managed host to retrieve its ID.
Examples:
Table 144: Examples
Example Description
(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 145: Details retrieved
Detail Description
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 146: Parameters
Parameter Description
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.

NOTE: 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.

NOTE: 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.

NOTE: 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 147: Examples
Example Description
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.

NOTE: The DataRoots is (DisplayPath|UnfriendlyPath)

Set-QAgentStateUpdated

Notifies the Data Governance server that an agent has been updated and the server should process it

Note: Only use this cmdlet if you have enabled encryption for the One Identity Manager database.

Syntax:

Set-QAgentStateUpdated [-AgentId] <String> [<CommonParameters>]

Table 148: Parameters
Parameter Description
AgentId

Specify the ID (GUID format) of the agent that was updated.

NOTE: Run the Get-QManagedHosts cmdlet and locate the agents array in the managed host to retrieve its ID.
Examples:
Table 149: Examples
Example Description
Set-QAgentStateUpdated -AgentId 37b27a56-3463-45a8-83ec-ff88d48c49a7 Tells the Data Governance server to update the agent state for the specified agent.

Upgrade-QAgents

Upgrades the agents in your Data Governance Edition deployment.

Syntax:

Upgrade-QAgents [-ManagedHostIds] <String[]> [-AgentIds] <String[]> [-UpgradeAllAgents] <SwitchParameter. [[-BatchSize] [<Int32>]] [[-OnErrorContinue[ [<SwitchParameter>]] [<CommonParameters>]

Table 150: Parameters
Parameter Description
ManagedHostIds

Specify the ID (GUID format) of the managed hosts to have their agents upgraded.

This parameter supports a single value, a list of comma-separated values, or an array.

NOTE: Do not specify this parameter with the -AgentIds or -UpgradeAllAgents parameter.

NOTE: Run the Get-QManagedHosts cmdlet without any parameters to retrieve a list of available managed hosts and their IDs.
AgentIds

Specify the ID (GUID format) of the agents to be upgraded.

This parameter supports a single value, a list of comma-separated values, or an array.

NOTE: Run the Get-QManagedHosts cmdlet and locate the agents array in the managed host to retrieve its ID.

NOTE: Do not specify this parameter with the -ManagedHostIds or -UpgradeAllAgents parameter.

NOTE: Upgrading an agent on an agent host will cause all agents on the same server to be upgraded.
UpdateAllAgents

Specify this parameter to upgrade all of the agents that are in an upgradable state.

NOTE: Do not specify this parameter with the -ManagedHostIds or -AgentIds parameter.
BatchSize

(Optional) Specify the batch size of the agents/managed hosts that are able to be updated simultaneously. Each host/agent in the batch must complete their upgrade (or fail) before the next batch of hosts/agents are processed. If this parameter is not specified, the default batch size of five is used.

NOTE: If a host/agent in the current batch fails, the upgrade process will be aborted for all queued machines unless the -OnErrorContinue flag is set.
OnErrorContinue (Optional) Specify this parameter to allow subsequent batches of hosts/agents to be processed for upgrade even if the upgrade of a host/agent in the previous batch failed.
Examples:
Table 151: Examples
Example Description
Upgrade-QAgents -UpgradeAllAgents -OnErrorContinue Upgrades all agents, in batches of five (default); processing upgrades even if an agent in the previous batch has failed.
Upgrade-QAgents -ManagedHostIds ("0f04f33e-6717-4cfc-8528-9e396137fd6e","0f04f33e-6717-4cfc-8528-9e396137fd6e") -BatchSize 7 -OnErrorContinue Updates all agents associated with the two specified managed hosts in batches of seven; processing upgrades even if an agent in the previous batch has failed.
Related Documents