Server Configuration

The following subcommands execute operations for configuring and managing OpenSSO Enterprise servers and sites within your enterprise.

add-site-members

Add members to a site.

Syntax

ssoadm add-site-members --options [--global-options]

Options

--sitename, -s

The name of the site. For example, mysite.

--servernames, -e

The server name. For example, http://www.example.com:8080/opensso.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

add-site-sec-urls

Add site secondary URLs.

Syntax

ssoadm add-site-sec-urls --options [--global-options]

Options

--sitename, -s

The name of the site. For example, mysite.

--secondaryurls, -a

The secondary URLs.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

clone-server

Clone a server instance.

Syntax

ssoadm clone-server --options [--global-options]

Options

--servername, -a

The server name.

--cloneservername, -o

The clone server name.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

create-server

Create a server instance.

Syntax

ssoadm create-server --options [--global-options]

Options

--servername, -a

The server name. For example, http://www.example.com:8080/opensso.

--serverconfigxml, -X

The server configuration XML filename.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--attributevalues, -a]

The attribute values. For example, homeaddress=here.

[--datafile, -D]

Name of file that contains attributes and corresponding values as in attribute-name=attribute-value. Enter one attribute and value per line.

create-site

Create a site.

Syntax

ssoadm create-site --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--siteurl, -i

The site's primary URL. For example, http://www.example.com:8080.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--secondaryurls, -a]

The secondary URLs.

delete-server

Delete a server instance.

Syntax

ssoadm delete-server --options [--global-options]

Options

--servername, -s

The server name. For example, http://www.example.com:8080/opensso.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

delete-site

Delete a site.

Syntax

ssoadm delete-site --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

export-server

Export a server instance.

Syntax

ssoadm export-server --options [--global-options]

Options

--servername, -s

The server name. For example, http://www.example.com:8080/opensso.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--outfile, -o]

The filename where configuration is written.

get-svrcfg-xml

Get the server configuration XML from the centralized data store.

Syntax

ssoadm get-svrcfg-xml --options [--global-options]

Options

--servername, -s

The server name.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--outfile, -o]

The filename where serverconfig.XML is written.

import-server

Import a server instance.

Syntax

ssoadm import-server --options [--global-options]

Options

--servername, -s

The server name.

--xmlfile, -X

The XML file that contains the configuration.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

list-server-cfg

List the server configuration.

Syntax

ssoadm list-server-cfg --options [--global-options]

Options

--servername, -s

The server name.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--withdefaults, -w]

Set this flag to get the default configuration.

list-servers

List all the server instances.

Syntax

ssoadm list-servers --options [--global-options]

Options

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

list-sites

List all the sites.

Syntax

ssoadm list-sites --options [--global-options]

Options

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

remove-server-cfg

Remove the server configuration.

Syntax

ssoadm remove-server-cfg --options [--global-options]

Options

--servername, -s

The server name. For example, http://www.example.com:8080/opensso.

--propertynames, -a

The names of the properties to be removed.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

remove-site-members

Remove members from a site.

Syntax

ssoadm remove-site-members --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--servernames, -e

The server name. For example, http://www.example.com:8080/opensso.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

remove-site-sec-urls

Remove the site secondary URLs.

Syntax

ssoadm remove-site-sec-urls --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--secondaryurls, -a

The secondary URLs.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

set-site-pri-url

Set the primary URL of a site.

Syntax

ssoadm set-site-pri-url --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--siteurl, -i

The site's primary URL. For example, http://www.example.com:8080.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

set-site-sec-urls

Set the site secondary URLs.

Syntax

ssoadm set-site-sec-urls --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--secondaryurls, -a

The secondary URLs.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

set-svrcfg-xml

Set the server configuration XML to the centralized data store.

Syntax

ssoadm set-svrcfg-xml --options [--global-options]

Options

--servername, -s

The server name.

--xmlfile, -X

The XML file that contains the configuration.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--outfile, -o]

The filename where serverconfig XML is written.

show-site

Show the site profile.

Syntax

ssoadm show-site --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

show-site-members

Display the members of a site.

Syntax

ssoadm show-site-members --options [--global-options]

Options

--sitename, -s

The site name. For example, mysite.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

update-server-cfg

Update the server configuration.

Syntax

ssoadm update-server-cfg --options [--global-options]

Options

--servername, -s

The server name.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--attributevalues, -a]

The attribute values. For example, homeaddress=here.

[--datafile, -D]

Name of file that contains attributes and corresponding values as in attribute-name=attribute-value. Enter one attribute and value per line.