Skip to content

Get-PlatformItem

SYNOPSIS

Obtiene un objeto VideoOS.Platform.Item que representa un elemento de configuración.

SYNTAX

ByFQID

Get-PlatformItem [[-Fqid] <FQID>] [<CommonParameters>]

BySearch

Get-PlatformItem [[-SearchText] <String>] [[-MaxResultCount] <Int32>] [[-TimeoutSeconds] <Int32>]
 [<CommonParameters>]

ByKind

Get-PlatformItem [[-Kind] <Guid>] [<CommonParameters>]

ListAvailable

Get-PlatformItem [-ListAvailable] [[-Hierarchy] <ItemHierarchy>] [-IncludeFolders] [<CommonParameters>]

ById

Get-PlatformItem [[-Id] <Guid>] [<CommonParameters>]

DESCRIPTION

El elemento es un objeto genérico que representa un elemento de configuración en el VMS. Un elemento puede representar una cámara, hardware, servidor o evento genérico.

Este cmdlet es especialmente útil para convertir un FQID de Get-ItemState en un elemento, con el fin de obtener el nombre del dispositivo más rápido de lo posible mediante comandos de la Configuración de API como Get-ConfigurationItem.

REQUIREMENTS

  • Requires VMS connection and will attempt to connect automatically

EXAMPLES

EXAMPLE 1

Get-ItemState | ForEach-Object { $name = ($_.FQID | Get-PlatformItem).Name; "$name - $($_.State)" }

Recupere el nombre del artículo y escriba el nombre y el estado del artículo

EXAMPLE 2

Get-PlatformItem -ListAvailable

Recuperar todos los elementos de configuración del VMS que no se consideran objetos principales

EXAMPLE 3

$kind = (Get-Kind -List | Where-Object DisplayName -eq Transact).Kind; Get-PlatformItem -Kind $kind

Recupere todas las fuentes Transact configuradas en el VMS. Primero obtenemos el GUID asociado con 'Kind.Transact' y luego pasamos ese GUID al parámetro Get-PlatformItem -Kind. A continuación, puede inspeccionar la colección de propiedades asociada con los elementos devueltos.

PARAMETERS

-Fqid

VideoOS.Platform.FQID of a Milestone configuration Item

Type: FQID
Parameter Sets: ByFQID
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Hierarchy

Filtre los resultados según la jerarquía del sistema, las jerarquías definidas por el usuario, como los grupos de cámaras, o ambos.

Valores posibles: UserDefined, SystemDefined, Both

Type: ItemHierarchy
Parameter Sets: ListAvailable
Aliases:

Required: False
Position: 1
Default value: SystemDefined
Accept pipeline input: False
Accept wildcard characters: False

-Id

Especifica el identificador Guid de un artículo.

Úselo solo cuando tenga una identificación pero no sepa el tipo de dispositivo.

Type: Guid
Parameter Sets: ById
Aliases: ObjectId

Required: False
Position: 1
Default value: 00000000-0000-0000-0000-000000000000
Accept pipeline input: False
Accept wildcard characters: False

-IncludeFolders

Solo los objetos secundarios sin elementos secundarios propios se incluyen de forma predeterminada.

Ejemplo: cámaras y eventos definidos por el usuario.

Type: SwitchParameter
Parameter Sets: ListAvailable
Aliases:

Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Kind

Especifica la constante GUID para el tipo de objeto que desea devolver

Type: Guid
Parameter Sets: ByKind
Aliases:

Required: False
Position: 1
Default value: 00000000-0000-0000-0000-000000000000
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ListAvailable

Enumerar todos los elementos de la configuración

Type: SwitchParameter
Parameter Sets: ListAvailable
Aliases:

Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxResultCount

Especifica el número máximo de resultados permitidos. Cuando una búsqueda devuelve más que esto, se considera un error. Predeterminado = 1

Type: Int32
Parameter Sets: BySearch
Aliases:

Required: False
Position: 2
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-SearchText

Especifica el nombre o la cadena para buscar

Type: String
Parameter Sets: BySearch
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TimeoutSeconds

Especifica el tiempo de espera en segundos antes de que finalice una búsqueda. Predeterminado = 60 segundos

Type: Int32
Parameter Sets: BySearch
Aliases:

Required: False
Position: 3
Default value: 60
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.Platform.FQID

VideoOS.Platform.FQID de un elemento de configuración de Milestone

System.String

Especifica el nombre o la cadena para buscar

System.Guid

Especifica la constante GUID para el tipo de objeto que desea devolver

OUTPUTS

VideoOS.Platform.Item

NOTES

Online Help