Changes the properties of a managed host.
Syntax:
Set-QManagedHostProperties [-ManagedHostId] <String> [[-Keyword] [<String>]] [[-ResourceActivityEnabled] [<Boolean>]] [[-Granularity] [<Int32>]] [[-ScheduleType] [QAM.Common.Interfaces.ScheduleConfiguration+ScanScheduleTupe>]] [[-ScheduledDays] [<Int32>]] [[-ScheduledTime] [<TimeSpan>]] [[-ScanInterval] [<TimeSpan>]] [[-EnableRemoteFileSystemChangeWatching] [<Boolean>]] [[-PerformImmediateScanOnWatchError] [<Boolean>]] [[-OverrideScanScheduleOnStartup] [<Boolean>]] [[-SupressHostProcess] [<SwitchParameter>]] [-IsManagedResourceHost [<Boolean>]] [<CommonParameters>]
Parameter | Description |
---|---|
ManagedHostId | Specify the ID (GUID format) of the managed host whose properties are to be updated. |
Keyword | (Optional) Specify a keyword which can then be displayed and used to group your managed host on the Managed hosts view in the Manager. |
ResourceActivityEnabled |
(Optional) Set this flag to enable resource activity collection. For example: -ResourceActivityEnabled 1 |
Granularity |
(Optional) Specify how often (in minutes) you would like to synchronize and aggregate the data. That is, this is the amount of time the agent is to record new activity before sending results to the Data Governance server. The value entered will be changed to a valid aggregation interval, as follows:
NOTE: Identical activity generated during this time will be recorded as one activity. |
ScheduleType |
Specifies the time and frequency with which the agent scans the target computer. Valid values are:
This parameter is required for remotely scanned managed hosts. |
ScheduledDays |
If the ScheduleType is set to "DayOfWeek", specify the days you would like the agent to scan the managed host. The syntax is DayOne for Sunday, DayTwo for Monday, etc. For example, to set a scan schedule for Monday, Wednesday and Friday, you would specify ScheduledDays DayTwo,DayFour,DaySix. |
ScheduledTime |
If the ScheduleType is set to "DayOfWeek", specify the time of day when the scan is scheduled to start. The syntax is, hh:mm:ss. For example, to start a scan at 4 a.m., specify -ScheduledTime 4:00:00; for 6 p.m., specify -ScheduledTime 18:00:00. |
ScanInterval |
If the ScheduleType is set to "Interval", specify the interval (in hours) at which the agent will scan the managed host. For example, to scan every 4 hours, specify -ScanInterval 4. |
EnableRemoteFileSystemChangeWatching |
(Optional) Set this flag to enable change watching for remotely scanned managed hosts. For example: -EnableRemoteFileSystemChangeWatching 1 |
PerformImmediateScanOnWatchError |
(Optional) Set this flag to perform a full scan when the watcher encounters an error. For example: -PerformImmediateScanOnWatchError 1 |
OverrideScanScheduleOnStartup |
(Optional) Set this flag for a remote managed host when you want the agent to do a full scan when the agent is started or restarted. For example: -OverrideScanScheduleOnStartup 1 |
SupressHostProcess | (Optional) Specify this parameter to stop the cmdlet from processing the managed host. That is, you can change a managed host's properties without actually triggering the server to use them right away. |
SelectedDataRoots |
Specify the managed paths where the agent should start scanning. A managed path is the root of an NTFS directory tree to be scanned by an agent, or a point in your SharePoint farm hierarchy below which everything is scanned. The agent monitors the specified managed paths for changes to security settings to maintain the security index. In addition, if resource activity collection is enabled, the agent collects resource activity for these same managed paths. For local managed hosts, all NTFS drives are scanned and monitored by default; However, you can optionally specify the managed paths to be scanned by the agent. When paths are added to this list, only the specified paths are scanned and monitored. For remote managed hosts, you must specify the paths to be managed in order for scanning to occur. So if you do not specify any managed paths using the parameter, no scanning will occur for the target managed host. For SharePoint managed hosts, you must specify the paths to be managed in order for scanning to occur. When you select a point in your SharePoint hierarchy as a managed path, new items added below that point are automatically scanned. |
IsManagedResourceHost |
(Optional) Specify this parameter to change the flag that indicates whether the managed host can be used to host a managed resource (for example, file shares created through the IT Shop self-service request functionality). Valid values are:
|
Examples:
Example | Description |
---|---|
Set-QManagedHostProperties -ManagedHostId 97dbedb3-6b02-4dbf-afe2-70d6bf51185a -ResourceActivityEnabled 1 | Enables resource activity tracking on the specified managed host. |
Set-QManagedHostProperties -ManagedHostId d589359a-8c51-4de0-8dcf-6b463793b0bf -SelectedDataRoots "\\2K8R2DJSQL\C$\Test Data" |
Defines a single data root. |
Set-QManagedHostProperties -ManagedHostId 97dbedb3-6b02-4dbf-afe2-70d6bf51185a -IsManagedResourceHost $true |
Enables managed resources for the managed host. |