Sun Java System SAML v2 Plug-in for Federation Services User's Guide

The saml2setup Command-line Reference

saml2setup is the command-line installer for the SAML v2 Plug-in for Federation Services. By default, it:

The saml2setup syntax is:

saml2setup install [-p]  -s  installation-configuration-properties-file
saml2setup uninstall -s installation-configuration-properties-file
saml2setup configure -s installation-configuration-properties-file
saml2setup unconfigure -s installation-configuration-properties-file
saml2setup update -s installation-configuration-properties-file
saml2setup -V
saml2setup -?

Note –

saml2setup takes as input an installation configuration properties file. See Creating an Installation Configuration Properties File for more information.


-p

Specifies that the SAML v2 Plug-in for Federation Services packages will be installed only. The plug-in will not be configured and the modified WAR will not be generated. 

-s or --silent

Specifies the name of the installation configuration properties file used as input to the script. See Creating an Installation Configuration Properties File

-V

Displays version information. 

-?

Displays help information. 

The subcommands of saml2setup are:

install

Installs the SAML v2 Plug-in for Federation Services packages, configures the plug-in, and generates a WAR. 


Note –

The function of this subcommand will change when run using the -p option.


uninstall

Removes the SAML v2 Plug-in for Federation Services and its packages. 

configure

Configures the plug-in and generates a WAR only. 

unconfigure

Removes a configured SAML v2 Plug-in for Federation Services and WAR but leaves the packages, allowing for future reconfiguration using the configure subcommand.

update

Updates a previously configured staging directory with new files from a patch installation directory and then regenerates a WAR file for deployment. 


Note –

Use the update option after you install a new SAML v2 plug-in patch or Access Manager 7.x patch, so you can avoid the unconfigure and configure routine, which will remove your existing metadata.