pfSense-pkg-saml2-auth

Documentation

Table of Contents

Packages

Saml2

Namespaces

Saml2

Constants

REFRESH_CACHE_CMD  = '/usr/local/pkg/Saml2/manage.php refreshcache'

Functions

backup()  : void
Performs a backup of the SAML2 configuration
restore()  : void
Restores the SAML2 configuration from the latest backup
refreshcache()  : void
Refreshes the package releases cache
setupschedule()  : void
Sets up cron schedules for the package
removeschedule()  : void
Removes cron schedules for the package
update()  : void
Updates the pfSense-pkg-saml2-auth package to the latest version
revert()  : void
Reverts the pfSense-pkg-saml2-auth package to the specified version
run_tests()  : void
Runs all (or select) TestCase classes in \RESTAPI\Tests. This is only intended to test development of this package and should not be used on live installs.
version()  : void
Prints the installed version of the pfSense-pkg-saml2-auth package
help()  : void
Displays the help page for the CLI tool
main()  : void
Main function that parses command line arguments and calls the appropriate function

Constants

REFRESH_CACHE_CMD

public mixed REFRESH_CACHE_CMD = '/usr/local/pkg/Saml2/manage.php refreshcache'

Functions

backup()

Performs a backup of the SAML2 configuration

backup() : void

restore()

Restores the SAML2 configuration from the latest backup

restore() : void

refreshcache()

Refreshes the package releases cache

refreshcache() : void

setupschedule()

Sets up cron schedules for the package

setupschedule() : void

removeschedule()

Removes cron schedules for the package

removeschedule() : void

update()

Updates the pfSense-pkg-saml2-auth package to the latest version

update() : void

revert()

Reverts the pfSense-pkg-saml2-auth package to the specified version

revert(string $version) : void
Parameters
$version : string

run_tests()

Runs all (or select) TestCase classes in \RESTAPI\Tests. This is only intended to test development of this package and should not be used on live installs.

run_tests([mixed $contains = '' ]) : void
Parameters
$contains : mixed = ''

string|null Only run tests that contain this sub-string in the test name.

Tags
note

Tests will attempt to create, modify and delete configurations and files as well as restart services; which can be disruptive to live systems.

version()

Prints the installed version of the pfSense-pkg-saml2-auth package

version() : void

help()

Displays the help page for the CLI tool

help() : void

main()

Main function that parses command line arguments and calls the appropriate function

main(array<string|int, mixed> $argv) : void
Parameters
$argv : array<string|int, mixed>

Command line arguments

Search results