Skip to content

Files

Latest commit

 

History

History
310 lines (153 loc) · 4.64 KB

Get-HueRoom.md

File metadata and controls

310 lines (153 loc) · 4.64 KB

Get-HueRoom

Synopsis

Gets Hue Groups

Description

Gets Groups from one or more Hue Bridges

Related Links

Examples

EXAMPLE 1

Get-HueRoom

Parameters

Schedule

If set, will get the schedules defined on the Hue bridge

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Rule

If set, will get the rules defined on the Hue bridge

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Scene

If set, will get the scenes defined on the Hue bridge

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Sensor

If set, will get the sensors defined on the Hue bridge

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Group

If set, will get the groups (or rooms) defined on the Hue bridge

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Configuration

If set, will get the device configuration

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Capability

If set, will get the device capabilities

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Resource

If set, will get resources defined on the device

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Light

If set, will get the lights defined on the device

Type: [Switch]

Required: true

Position: named

PipelineInput:true (ByPropertyName)

Name

If provided, will filter returned items by name

Type: [String[]]

Required: false

Position: 1

PipelineInput:true (ByPropertyName)

RegularExpression

If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard

Type: [Switch]

Required: false

Position: named

PipelineInput:true (ByPropertyName)

ExactMatch

If set, will treat the Name parameter as a specific match

Type: [Switch]

Required: false

Position: named

PipelineInput:true (ByPropertyName)

ID

If provided, will filter returned items by ID

Type: [String[]]

Required: false

Position: named

PipelineInput:true (ByPropertyName)

Detailed

If set, will requery each returned resource to retreive additional information.

Type: [Switch]

Required: false

Position: named

PipelineInput:false

Outputs

Syntax

Get-HueRoom [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Schedule [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Rule [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Scene [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Sensor [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Group [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Configuration [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Capability [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Resource [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]
Get-HueRoom -Light [[-Name] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Detailed] [<CommonParameters>]