Agent Configuration

The following subcommands execute operations for the supported agent profile types defined in the OpenSSO Centralized Agent Configuration service.

add-agent-to-grp

Add agents to an agent group.

Syntax

ssoadm add-agent-to-grp --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentgroupname, -b

The name of the agent group.

--agentnames, -s

The names of the agent.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

agent-remove-props

Remove an agent's properties.

Syntax

ssoadm agent-remove-props --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentname, -b

The name of the agent.

--attributenames, -a

The names of the properties.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

create-agent

Create a new agent configuration.

Syntax

ssoadm create-agent --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentname, -b

The name of the agent.

--agenttype, -t

The type of agent. For example, J2EEAgent or WebAgent.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--attributevalues, -a]

The properties. 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-agent-grp

Create a new agent group.

Syntax

ssoadm create-agent-grp --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentgroupname, -b

The name of the agent's group.

--agenttype, -t

The type of agent. For example, J2EEAgent or WebAgent.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--attributevalues, -a]

The properties. 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.

delete-agent-grps

Delete existing agent groups.

Syntax

ssoadm delete-agent-grps --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentgroupnames, -s

The names of the agent group.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

delete-agents

Delete existing agent configurations.

Syntax

ssoadm delete-agents --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentnames, -s

The names of the agent.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

list-agent-grp-members

List the agents in an agent group.

Syntax

ssoadm list-agent-grp-members --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentgroupname, -b

The name of the agent group.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--filter, -x]

Filter by a pattern.

list-agent-grps

List the agent groups.

Syntax

ssoadm list-agent-grps --options [--global-options]

Options

--realm, -e

The name of the realm.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--filter, -x]

Filter by a pattern.

[--agenttype, -t]

The type of agent. For example, J2EEAgent or WebAgent.

list-agents

List the agent configurations.

Syntax

ssoadm list-agents --options [--global-options]

Options

--realm, -e

The name of the realm.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--filter, -x]

Filter by a pattern.

[--agenttype, -t]

The type of agent. For example, J2EEAgent or WebAgent.

remove-agent-from-grp

Remove agents from an agent group.

Syntax

ssoadm remove-agent-from-grp --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentgroupname, -b

The name of the agent group.

--agentnames, -s

The names of the agent.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

show-agent

Show the agent profile.

Syntax

ssoadm show-agent --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentname, -b

The name of the agent.

--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.

[--inherit, -i]

Set this option to inherit properties from the parent group.

show-agent-grp

Show the agent group profile.

Syntax

ssoadm show-agent-grp --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentgroupname, -b

The name of the agent group.

--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.

show-agent-membership

List the agent's membership.

Syntax

ssoadm show-agent-membership --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentname, -b

The name of the agent.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

show-agent-types

Show the agent types.

Syntax

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

Options

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

update-agent

Update the agent's configuration.

Syntax

ssoadm update-agent --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentname, -b

The name of the agent.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--set, -s]

Set this flag to overwrite a property's values.

[--attributevalues, -a]

The properties. 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.

update-agent-grp

Update the agent group's configuration.

Syntax

ssoadm update-agent-grp --options [--global-options]

Options

--realm, -e

The name of the realm.

--agentgroupname, -b

The name of the agent group.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--set, -s]

Set this flag to overwrite a property's values.

[--attributevalues, -a]

The properties. 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.