Test-NBBranchingAvailable
Since
v4.4.10.0
SYNOPSIS
Tests if the Netbox Branching plugin is available on the connected server.
SYNTAX
Test-NBBranchingAvailable [-Quiet] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Checks if the netbox-branching plugin is installed and accessible on the connected Netbox instance by attempting to reach the branching API endpoint.
EXAMPLES
EXAMPLE 1
Test-NBBranchingAvailable
Returns $true if branching is available.
EXAMPLE 2
if (Test-NBBranchingAvailable -Quiet) { Enter-NBBranch -Name "feature" }
Check silently before using branching features.
PARAMETERS
-Quiet
Suppress warning messages and return only $true or $false.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.
INPUTS
OUTPUTS
[bool] Returns $true if the branching plugin is available, $false otherwise.
NOTES
AddedInVersion: v4.4.10.0