Agent-Related Subcommands for the ssoadm Command

This sections lists the options available for each of the agent-related subcommands of the ssoadm command. The agent-related subcommands are presented as links in the following list:

• The ssoadm Command: add-agent-to-grp subcommand

• The ssoadm Command: agent-remove-props subcommand

• The ssoadm Command: create-agent subcommand

• The ssoadm Command: create-agent-grp subcommand

• The ssoadm Command: delete-agent-grps subcommand

• The ssoadm Command: delete-agents subcommand

• The ssoadm Command: list-agent-grp-members subcommand

• The ssoadm Command: list-agent-grps subcommand

• The ssoadm Command: list-agents subcommand

• The ssoadm Command: remove-agent-from-grp subcommand

• The ssoadm Command: show-agent subcommand

• The ssoadm Command: show-agent-grp subcommand

• The ssoadm Command: show-agent-membership subcommand

• The ssoadm Command: show-agent-types subcommand

• The ssoadm Command: update-agent subcommand

• The ssoadm Command: update-agent-grp subcommand

The ssoadm Command: add-agent-to-grp subcommand

ssoadm add-agent-to-grp--options [--global-options]
Add agents to a agent group.

Usage:
ssoadm
    --realm|-e
    --agentgroupname|-b
    --agentnames|-s
    --adminid|-u
    --password-file|-f

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.
    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentgroupname, -b
        Name of agent group.

    --agentnames, -s
        Names of agents.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

The ssoadm Command: agent-remove-props subcommand

ssoadm agent-remove-props --options [--global-options]
Remove agent's properties.

Usage:
ssoadm
    --realm|-e
    --agentname|-b
    --attributenames|-a
    --adminid|-u
    --password-file|-f

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentname, -b
        Name of agent.

    --attributenames, -a
        properties name(s).

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

The ssoadm Command: create-agent subcommand

ssoadm create-agent --options [--global-options]
Create a new agent configuration.

Usage:
ssoadm
    --realm|-e
    --agentname|-b
    --agenttype|-t
    --adminid|-u
    --password-file|-f
    [--attributevalues|-a]
    [--datafile|-D]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentname, -b
        Name of agent.

    --agenttype, -t
        Type of agent. e.g. J2EEAgent, WebAgent

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --attributevalues, -a
        properties e.g. homeaddress=here.

    --datafile, -D
        Name of file that contains properties.

The ssoadm Command: create-agent-grp subcommand

ssoadm create-agent-grp --options [--global-options]
Create a new agent group.

Usage:
ssoadm
    --realm|-e
    --agentgroupname|-b
    --agenttype|-t
    --adminid|-u
    --password-file|-f
    [--attributevalues|-a]
    [--datafile|-D]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentgroupname, -b
        Name of agent group.

    --agenttype, -t
        Type of agent group. e.g. J2EEAgent, WebAgent

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --attributevalues, -a
        properties e.g. homeaddress=here.

    --datafile, -D
        Name of file that contains properties.

The ssoadm Command: delete-agent-grps subcommand

ssoadm delete-agent-grps --options [--global-options]
Delete agent groups.

Usage:
ssoadm
    --realm|-e
    --agentgroupnames|-s
    --adminid|-u
    --password-file|-f

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentgroupnames, -s
        Names of agent group.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

The ssoadm Command: delete-agents subcommand

ssoadm delete-agents --options [--global-options]
Delete agent configurations.

Usage:
ssoadm
    --realm|-e
    --agentnames|-s
    --adminid|-u
    --password-file|-f

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentnames, -s
        Names of agent.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

The ssoadm Command: list-agent-grp-members subcommand

ssoadm list-agent-grp-members --options [--global-options]
List agents in agent group.

Usage:
ssoadm
    --realm|-e
    --agentgroupname|-b
    --adminid|-u
    --password-file|-f
    [--filter|-x]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentgroupname, -b
        Name of agent group.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --filter, -x
        Filter (Pattern).

The ssoadm Command: list-agent-grps subcommand

ssoadm list-agent-grps --options [--global-options]
List agent groups.

Usage:
ssoadm
    --realm|-e
    --adminid|-u
    --password-file|-f
    [--filter|-x]
    [--agenttype|-t]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --filter, -x
        Filter (Pattern).

    --agenttype, -t
        Type of agent. e.g. J2EEAgent, WebAgent

The ssoadm Command: list-agents subcommand

ssoadm list-agents --options [--global-options]
List agent configurations.

Usage:
ssoadm
    --realm|-e
    --adminid|-u
    --password-file|-f
    [--filter|-x]
    [--agenttype|-t]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --filter, -x
        Filter (Pattern).

    --agenttype, -t
        Type of agent. e.g. J2EEAgent, WebAgent

The ssoadm Command: remove-agent-from-grp subcommand

ssoadm remove-agent-from-grp --options [--global-options]
Remove agents from a agent group.

Usage:
ssoadm--realm|-e
    --agentgroupname|-b
    --agentnames|-s
    --adminid|-u
    --password-file|-f

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentgroupname, -b
        Name of agent group.

    --agentnames, -s
        Names of agents.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

The ssoadm Command: show-agent subcommand

ssoadm show-agent --options [--global-options]
Show agent profile.

Usage:
ssoadm
    --realm|-e
    --agentname|-b
    --adminid|-u
    --password-file|-f
    [--outfile|-o]
    [--inherit|-i]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentname, -b
        Name of agent.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --outfile, -o
        Filename where configuration is written to.

    --inherit, -i
        Set this to inherit properties from parent group.

The ssoadm Command: show-agent-grp subcommand

ssoadm show-agent-grp --options [--global-options]
Show agent group profile.

Usage:
ssoadm
    --realm|-e
    --agentgroupname|-b
    --adminid|-u
    --password-file|-f
    [--outfile|-o]

Global Options:
    --locale, -l
    Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentgroupname, -b
        Name of agent group.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --outfile, -o
        Filename where configuration is written to.

The ssoadm Command: show-agent-membership subcommand

ssoadm show-agent-membership --options [--global-options]
List agent?s membership.

Usage:
ssoadm
    --realm|-e
    --agentname|-b
    --adminid|-u
    --password-file|-f

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentname, -b
        Name of agent.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

The ssoadm Command: show-agent-types subcommand

ssoadm show-agent-types --options [--global-options]
Show agent types.

Usage:
ssoadm
    --adminid|-u
    --password-file|-f

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

The ssoadm Command: update-agent subcommand

ssoadm update-agent --options [--global-options] 
Update agent configuration.
Usage:
ssoadm
    --realm|-e
    --agentname|-b
    --adminid|-u
    --password-file|-f
    [--set|-s]
    [--attributevalues|-a]
    [--datafile|-D]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentname, -b
        Name of agent.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --set, -s
        Set this flag to overwrite properties values.

    --attributevalues, -a
        properties e.g. homeaddress=here.

    --datafile, -D
        Name of file that contains properties.

The ssoadm Command: update-agent-grp subcommand

ssoadm update-agent-grp --options [--global-options]
Update agent group configuration.
Usage:

ssoadm
    --realm|-e
    --agentgroupname|-b
    --adminid|-u
    --password-file|-f
    [--set|-s]
    [--attributevalues|-a]
    [--datafile|-D]

Global Options:
    --locale, -l
        Name of the locale to display the results.

    --debug, -d
        Run in debug mode. Results sent to the debug file.

    --verbose, -v
        Run in verbose mode. Results sent to standard output.

Options:
    --realm, -e
        Name of realm.

    --agentgroupname, -b
        Name of agent group.

    --adminid, -u
        Administrator ID of running the command.

    --password-file, -f
        File name that contains password of administrator.

    --set, -s
        Set this flag to overwrite properties values.

    --attributevalues, -a
        properties e.g. homeaddress=here.

    --datafile, -D
        Name of file that contains properties.