Split-VmsConfigItemPath¶
SYNOPSIS¶
Returns the specified part of the Milestone Configuration API path.
SYNTAX¶
Id (Default)¶
ParentItemType¶
ItemType¶
DESCRIPTION¶
The Split-VmsConfigItemPath cmdlet returns the specified part of the provided Milestone Configuration API path. These
paths usually look like "Hardware[7abcfcdc-7d6f-4a1a-b7a3-f77607806169]" or "CameraGroup[81258601-71ef-41e7-bd59-41946e16fc5a]/CameraGroupFolder"
where "Hardware" and "CameraGroupFolder" are the ItemType values, and in the case of the second example, "CameraGroup"
is the ParentItemType.
REQUIREMENTS
- None specified
EXAMPLES¶
Example 1¶
Returns the Id of a given Hardware device based on the Path property of the hardware object.
Example 2¶
Returns the ItemType value "Hardware".
PARAMETERS¶
-Id¶
Specifies that the value returned from the configuration item path should be the Id, if present.
Type: SwitchParameter
Parameter Sets: Id
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ItemType¶
Specifies that the value returned from the configuration item path should be the ItemType.
Type: SwitchParameter
Parameter Sets: ItemType
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ParentItemType¶
Specifies that the value returned from the configuration item path should be the ParentItemType, if present. This applies typically only to "Folder" items as the ParentItemType isn't described in the configuration item path for a normal "item".
Type: SwitchParameter
Parameter Sets: ParentItemType
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path¶
Specifies the Milestone XProtect Configuration API path from which the specified part should be returned.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.