Get-RelationshipObject
Get-RelationshipObject
Gets monitoring relationship objects.
Syntax
Parameter Set: FromMonitoringObjectProviderPath
Get-RelationshipObject [[-Path] <String[]> ] [ <CommonParameters>]
Parameter Set: FromId
Get-RelationshipObject [-Id] <Guid> [[-Path] <String[]> ] [ <CommonParameters>]
Parameter Set: FromMonitoringObject
Get-RelationshipObject [-MonitoringObject] <MonitoringObject> [ <CommonParameters>]
Detailed Description
Gets monitoring relationship objects.
Parameters
-Id<Guid>
Specifies the GUID of the relationship object to retrieve.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-MonitoringObject<MonitoringObject>
Specifies the monitoring object for which to retrieve the associated relationship object.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Path<String[]>
Specifies the paths to monitoring objects for which to retrieve associated relationship objects. To enter multiple values, separate them by using a comma.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Notes
- For more information, type "Get-Help Get-RelationshipObject -detailed". For technical information, type "Get-Help Get-RelationshipObject -full".
When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".
Examples
-------------- EXAMPLE 1 --------------
This command uses Get-RelationshipObject to retrieve relationship objects for monitoring objects in the current path. It displays information about all of the relationship objects.
C:\PS>get-relationshipobject
-------------- EXAMPLE 2 --------------
This command uses Get-RelationshipObject to retrieve relationship objects for monitoring objects in the current path. It passes the results along the pipeline to Format-Table which selects two of the properties of the relationship objects and displays them in a tabular format.
C:\PS>get-relationshipObject |
format-table sourcemonitoringobject,targetmonitoringobject