< Back
Set-MonTarget
Post
NAME Set-MonTarget
SYNOPSIS
Register a monitoring target.
SYNTAX
Set-MonTarget [-Name] <String[]> [-Tag] <String[]> [[-Capability] <String[]>] [<CommonParameters>]
DESCRIPTION
Register a monitoring target.
This is used for updating and maintaining a target system.
PARAMETERS
-Name <String[]>
What to target the monitoring subject by.
A unique label used to identify the resource.
For computer management, this could be a DNS name.
For monitoring SQL instances a connection string or instance name.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Tag <String[]>
What tag to assign to the target.
Tags are monitoring groups. Checks are assigned to tags.
For example, all checks assigned the tag 'DC' are applied to targets also tagged as 'DC'.
At the same time, a target could also have the tag 'Server' and thus be subject to checks assigned to that tag.
Assignments of tags are cummulative - applying new tags adds them to the object.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Capability <String[]>
Capabilities are used to determine what kind of connections can be established to this target.
For example, adding a WinRM capability would tell the system the target can accept PowerShell Remoting and CIM
over WinRM connections.
Add supported capabilities by using the Register-MonConnection.
Assignments of capabilities are cummulative - applying new capabilities adds them to the object.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-MonTarget -Name 'server1.contoso.com' -Tag 'server', 'dc', 'server2019' -Capability WinRM, ldap
Configures the server 'server1.contoso.com' as server, server2019 and dc.
It also configures it to accept WinRM and ldap connections.
RELATED LINKS
SYNOPSIS
Register a monitoring target.
SYNTAX
Set-MonTarget [-Name] <String[]> [-Tag] <String[]> [[-Capability] <String[]>] [<CommonParameters>]
DESCRIPTION
Register a monitoring target.
This is used for updating and maintaining a target system.
PARAMETERS
-Name <String[]>
What to target the monitoring subject by.
A unique label used to identify the resource.
For computer management, this could be a DNS name.
For monitoring SQL instances a connection string or instance name.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Tag <String[]>
What tag to assign to the target.
Tags are monitoring groups. Checks are assigned to tags.
For example, all checks assigned the tag 'DC' are applied to targets also tagged as 'DC'.
At the same time, a target could also have the tag 'Server' and thus be subject to checks assigned to that tag.
Assignments of tags are cummulative - applying new tags adds them to the object.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Capability <String[]>
Capabilities are used to determine what kind of connections can be established to this target.
For example, adding a WinRM capability would tell the system the target can accept PowerShell Remoting and CIM
over WinRM connections.
Add supported capabilities by using the Register-MonConnection.
Assignments of capabilities are cummulative - applying new capabilities adds them to the object.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-MonTarget -Name 'server1.contoso.com' -Tag 'server', 'dc', 'server2019' -Capability WinRM, ldap
Configures the server 'server1.contoso.com' as server, server2019 and dc.
It also configures it to accept WinRM and ldap connections.
RELATED LINKS