psadmin set-attribute

Description

Sets the portal desktop attribute to the supplied value or values for a base dn or at global or default levels.

Syntax

Long Format

psadmin set-attribute --component desktop --attribute-name attribute-name --adminuser uid --passwordfile password-filename [-add add_values] [--remove remove_values] [--inherit ] [--dn dn] --portalid portal-ID set_values --debug

Short Format

psadmin set-attribute -m desktop -a attribute-name -u uid -f password-filename [-d dn] -p portal-ID [ -A add_values] [-E remove_values][--inherit] set_values --debug

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--attribute-name | -a] attribute-name

Argument which specifies the name of the desktop attribute for which the value is to be added, removed, replaced, or inherited. User friendly desktop attributes can be fetched from list-attribute command, with component name as desktop.

[--component | -m] desktop

Always desktop for this module.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portalId | -p] portal-ID

Specifies the portal ID.

The following options are optional:

[--add | -A] add_values

Applies to multi value attribute. Specifies a comma separated list of values to be set for an attribute. Mutually exclusive to --inherit option and set_values operand. The list of value is enclosed in "; for example, "val1","val2","val3".

--debug

Used for debugging purpose only. By default, this is set to false. Set this flag to true to see exceptions that caused the error.

[--dn | -d] dn

Specifies the distinguished name for whom desktop attribute is to be set.

--inherit

Allows the specified attribute at the given dn, to inherit its value from the parent dn.

The dn is mandatory to use this option.

[--remove | -E] remove_values

Applies to multi value attribute. Specifies a comma separated list of values to be removed for an attribute. Mutually exclusive to --inherit option and set_values operand. The list of value is enclosed in "; for example, "val1","val2","val3".

Operands

The following operand is supported:

set_values

Specifies the value to be set.

Limitations

You cannot do the following:

• Use --add or --remove option with the --inherit option.

• Use --add, --remove, or --inherit options with set_values operand.

• Use the --inherit option without supplying the --dn option.