Get-HomebridgeStatus

SYNOPSIS

Gets Homebridge status information.

SYNTAX

Named (Default)

Get-HomebridgeStatus -Type <string> [-InstanceName <string>]

ExplicitNoAuthentication

Get-HomebridgeStatus -Url <string> -NoAuthentication -Type <string>

ExplicitCredential

Get-HomebridgeStatus -Url <string> -Credential <pscredential> -Type <string>

DESCRIPTION

This function returns the complete status object for the selected type and does not change the instance.

EXAMPLES

EXAMPLE 1

Get-HomebridgeStatus -InstanceName home -Type HomebridgeVersion

Returns installed and available Homebridge version information from the saved connection.

EXAMPLE 2

Get-HomebridgeStatus -InstanceName home -Type ChildBridge

Returns the active child bridges and their current status.

PARAMETERS

-Credential

Explicit credentials.

Type: System.Management.Automation.PSCredential
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitCredential
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InstanceName

The saved connection name.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Named
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-NoAuthentication

Indicates that the server does not require authentication.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitNoAuthentication
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Type

Selects the status resource that the command returns. RaspberryPiThrottling is available only when Homebridge runs on a Raspberry Pi.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Url

An explicit Homebridge URL.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitNoAuthentication
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ExplicitCredential
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None.

You cannot pipe objects to this function.

OUTPUTS

PSHomebridge.Status.*.

This function returns the complete status object.

NOTES

https://pshomebridge.xyz/command-reference/commands/Get-HomebridgeStatus/

https://github.com/angrycuban13/PSHomebridge/blob/main/PSHomebridge/Source/Public/Get-HomebridgeStatus.ps1