Get-InputSetting¶
SYNOPSIS¶
Gets the settings for specified input.
SYNTAX¶
GeneralSettings¶
StreamSettings¶
Get-InputSetting -Input <InputEvent> [-Stream] [-StreamNumber <Int32>] [-Name <String>] [-ValueInfo]
[<CommonParameters>]
DESCRIPTION¶
The Get-InputSetting cmdlet returns a PSCustomObject with all the settings available for the specified input.
The values returned by this cmdlet are the "display values" that would be seen in the Management Client. To see a mapping of the "display values" to the raw values used by the MIP SDK, the "-ValueInfo" switch may be used.
REQUIREMENTS
- Requires VMS connection and will attempt to connect automatically
EXAMPLES¶
Example 1¶
Get-VmsInput -Name 'Axis P3265-LVE (10.1.1.133) - Input 1' | Get-InputSetting -General
<# OUTPUT (all values)
InputRiseTrigger
----------------
closed
#>
Gets all the input settings for the input named 'Axis P3265-LVE (10.1.1.133) - Input 1'. The "-General" switch is required.
Example 2¶
$i = Get-VmsInput -Name 'Axis P3265-LVE (10.1.1.133) - Input 1'
Get-InputSetting -Input $i -Name 'InputRiseTrigger' -General
<# OUTPUT (all values)
InputRiseTrigger
----------------
open
#>
Another way of doing Example 1. Also, using the "-Name" parameter to specify the name of the setting.
Example 3¶
Get-VmsInput -Name 'Axis P3265-LVE (10.1.1.133) - Input 1' | Get-InputSetting -General -ValueInfo
<# OUTPUT (ValueInfo)
Setting Property Value
------- -------- -----
InputRiseTrigger Circuit closed closed
InputRiseTrigger Circuit open open
#>
Gets the mapping of display values to the raw values. Sometimes the raw value is different from the value that is displayed in the Management Client. When setting a value, the raw value has to be used.
PARAMETERS¶
-General¶
Specifies that the General settings should be returned. Inputs only have General settings so this switch is required.
Type: SwitchParameter
Parameter Sets: GeneralSettings
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Input¶
Specifies the Input to retrieve the settings of, as returned by Get-VmsInput.
Type: InputEvent
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name¶
Specifies the name of the property to be returned.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Stream¶
** Not Used **
Type: SwitchParameter
Parameter Sets: StreamSettings
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StreamNumber¶
** Not Used **
Type: Int32
Parameter Sets: StreamSettings
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ValueInfo¶
Specifies that the PSCustomObject should contain a "ValueInfo" collection for each setting, instead of the value of the setting. The "ValueInfo" collections can be used to discover the valid ranges or values for each setting.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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.