Skip to content

Test-NBAPIConnected

Since

v1.7.2

SYNOPSIS

Tests whether the Netbox API connection is established.

SYNTAX

Test-NBAPIConnected [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Tests whether the Netbox API connection is established.

EXAMPLES

EXAMPLE 1

Test-NBAPIConnected

Returns $true if the API connection is established, $false otherwise.

PARAMETERS

-ProgressAction

{{ Fill ProgressAction Description }}

```yaml 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

System.Boolean

NOTES

AddedInVersion: v1.7.2

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/rest-api/overview/