Get-ConfigurationItem¶
SYNOPSIS¶
Obtiene un objeto ConfigurationItem
SYNTAX¶
Get-ConfigurationItem [-ConfigurationItem <ConfigurationItem>] [-ItemType <String>] [-Id <Guid>]
[[-Path] <String>] [-ChildItems] [-Parent] [-ParentItem] [-Recurse] [-Sort] [<CommonParameters>]
DESCRIPTION¶
Utiliza la Configuración de API para acceder a los elementos de configuración. Útil para navegar por la configuración del VMS sin la necesidad de comprender los tipos de objetos individuales como cámaras, servidores y usuarios.
Cada ConfigurationItem puede tener elementos secundarios, métodos que se pueden invocar o propiedades que se pueden leer y/o modificar. Utilice Set-ConfigurationItem para guardar los cambios realizados en un objeto ConfigurationItem.
REQUIREMENTS
- Requires VMS connection and will attempt to connect automatically
EXAMPLES¶
EXAMPLE 1¶
$managementServer = Get-ConfigurationItem -Path '/'
$nameProperty = $managementServer.Properties | Where-Object Key -eq 'Name'
$nameProperty.Value = 'New Name'
$managementServer | Set-ConfigurationItem
Cambia la propiedad Name del Management Server
PARAMETERS¶
-ChildItems¶
Obtenga todos los elementos secundarios para el ConfigurationItem, Path o ItemType y el par de ID dados
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ConfigurationItem¶
Especifica un elemento de configuración de origen para recuperar un elemento de configuración secundario o principal
Type: ConfigurationItem
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Id¶
Especifica un identificador de Guid que se utilizará para construir una ruta en forma de ItemType [Id]
Type: Guid
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 00000000-0000-0000-0000-000000000000
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ItemType¶
Especifica un tipo de elemento, como Camera, Hardware, RecordingServer, que se utilizará para construir una ruta en forma de ItemType [Id]
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Parent¶
Obtenga el padre inmediato de un ConfigurationItem, Path o ItemType y un par de ID determinados
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ParentItem¶
Obtener el primer padre de un ConfigurationItem, una ruta o un ItemType e ID determinados donde ItemCategory es "Item"
Esto se usa principalmente cuando se navega desde un dispositivo de cámara al dispositivo de hardware principal, o de hardware al servidor de grabación
El interruptor -Parent proporcionará el padre inmediato, que podría ser una carpeta en lugar de un dispositivo reconocible real
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Path¶
Especifica la cadena de ruta de la API de configuración para un elemento dado, si ya se conoce.
Por lo general, tienen la forma de Camera [GUID] pero siempre puede comenzar a rastrear la configuración desde la parte superior comenzando en "/", que especifica el servidor de administración en sí.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Recurse¶
Devuelve el ConfigurationItem deseado y todos los elementos secundarios de forma recursiva.
Nota: Esto puede llevar mucho tiempo para devolver un resultado dependiendo de la ruta proporcionada y el tamaño del VMS.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Sort¶
{{ Fill Sort Description }}
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
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.
INPUTS¶
VideoOS.ConfigurationApi.ClientService.ConfigurationItem¶
Especifica un elemento de configuración de origen para recuperar un elemento de configuración secundario o principal
System.String¶
Especifica un tipo de elemento, como Camera, Hardware, RecordingServer, que se utilizará para construir una ruta en forma de ItemType [Id]
System.Guid¶
Especifica un identificador de Guid que se utilizará para construir una ruta en forma de ItemType [Id ]
System.String¶
Especifica la cadena de ruta de la API de configuración para un elemento dado, si ya se conoce.
Por lo general, tienen la forma de Camera [GUID] pero siempre puede comenzar a rastrear la configuración desde la parte superior comenzando en "/", que especifica el servidor de administración en sí.