This repository has been archived by the owner on Sep 8, 2024. It is now read-only.

Get‐OPNsenseCaptivePortal

Jump to bottom

fvanroie edited this page Dec 6, 2017 · 7 revisions

Synopsis

Retrieve CaptivePortal zones, templates or providers from OPNsense.

Syntax

Get-OPNsenseCaptivePortal [-Template] [-Uuid <String>] [<CommonParameters>]

Get-OPNsenseCaptivePortal [-Zone] [-Uuid <String>] [<CommonParameters>]

Get-OPNsenseCaptivePortal [-Provider] [<CommonParameters>]

Description

Use the Get-OPNsenseCaptivePortal cmdlet to retrieve zones, templates or providers from OPNsense. Specify either -Zone, -Template or -Provider to get a list of the objects. Optionally pass a UUID parameter the get the details of a specific zone or template.

Parameters

-Template <SwitchParameter>

Required?	false
Position?	named
Default Value?
Pipeline Input?	false

-Provider <SwitchParameter>

Required?	false
Position?	named
Default Value?
Pipeline Input?	false

-Zone <SwitchParameter>

Required?	false
Position?	named
Default Value?
Pipeline Input?	false

-Uuid <String>

Required?	false
Position?	named
Default Value?
Pipeline Input?	false

Examples

PS_OPNsense PowerShell Module - Copyright (c) 2018 fvanroie