Skip to content

Get-Metadata

SYNOPSIS

Reads a specific value from a PowerShell metdata file (e.g. a module manifest)

SYNTAX

GetAll (Default)

Get-Metadata -Hardware <Hardware> [<CommonParameters>]

ByChannel

Get-Metadata -Hardware <Hardware> [[-Channel] <Int32>] [<CommonParameters>]

ByName

Get-Metadata -Hardware <Hardware> [[-Name] <String>] [<CommonParameters>]

ById

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

DESCRIPTION

By default Get-Metadata gets the ModuleVersion, but it can read any key in the metadata file

REQUIREMENTS

  • Requires VMS connection and will attempt to connect automatically

EXAMPLES

EXAMPLE 1

Get-Metadata .\Configuration.psd1

Returns the module version number (as a string)

EXAMPLE 2

Get-Metadata .\Configuration.psd1 ReleaseNotes

Returns the release notes!

PARAMETERS

-Channel

{{ Fill Channel Description }}

Type: Int32
Parameter Sets: ByChannel
Aliases:

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

-Hardware

{{ Fill Hardware Description }}

Type: Hardware
Parameter Sets: GetAll, ByChannel, ByName
Aliases:

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

-Id

{{ Fill Id Description }}

Type: Guid
Parameter Sets: ById
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

{{ Fill Name Description }}

Type: String
Parameter Sets: ByName
Aliases:

Required: False
Position: 2
Default value: None
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.ConfigurationItems.Hardware

OUTPUTS

VideoOS.Platform.ConfigurationItems.Metadata

NOTES