Chapter 1 Desktop Subcommands

This chapter describes the folllowing subcommands:

• psadmin get-attribute

• psadmin set-attribute

• psadmin list-attributes

• psadmin list-dp

• psadmin merge-dp

• psadmin modify-dp

• psadmin add-dp

• psadmin remove-dp

psadmin get-attribute

Description

Gets the portal attribute for a base dn or from global or default levels.

Syntax

Long Format

psadmin get-attribute --component desktop -attribute-name attribute-name --adminuser uid --passwordfile password-filename [--dn dn] -portalid portal-ID [--output output-file] [--debug]

Short Format

psadmin get-attribute -m desktop -a attribute-name -u uid -f password-filename [-d dn] -p portal-ID [-o output-file]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

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

Specifies the desktop attribute name for which the value is to be retrieved. User friendly desktop attributes can be fetched from the list-attribute subcommand, 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:

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

[--output | -o] output-file

Specifies a file for output.

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.

psadmin list-attributes

Description

Lists the portal desktop attributes which are defined at any base dn or at global or default levels. This subcommand can be used when an administrator wants to see the entire list of desktop attributes.

Syntax

Long Format

psadmin list-attributes --component desktop --adminuser uid --passwordfile password-filename [--output output-file] [--verbose] [--debug]

Short Format

psadmin list-attributes -m desktop -u uid -f password-filename [-o output-file] [-v] [--debug]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--component | -m] desktop

Always desktop for this module.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

The following options are optional:

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

[--output | -o] output-file

Specifies a file for output.

[--verbose | -v]

Removes display profile verbosely.

psadmin list-dp

Description

Retrieves and displays display profile node objects.

Syntax

Long Format

psadmin list-dp --name name --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run] [--output output-file]

Short Format

psadmin list-dp -n name -u uid -f password-filename -d dn -p portal-ID [-v] [ -g] [-r] [-o output-file]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

Distinguished name of the target node. This is mutually exclusive to -g option.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portalId| -p] portal-ID

Specifies the portal ID; if this is not supplied, the default is used.

The following options are optional:

[--dry-run | -r]

Attempt to execute command without writing out to LDAP. Default is false.

[--global | -g]

Global display profile. Default is false. This is mutually exclusive to -d option.

[--name | -n] name

Name of the target display object. If omitted, the entire display profile is displayed.

[--output | -o] output-file

Specifies a file for output.

[--verbose | -v]

Lists display profile verbosely.

psadmin merge-dp

Description

Retrieves and displays the merged result of the given display profile node objects.

Syntax

Long Format

psadmin merge-dp --name name --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run] [--output output-file]

Short Format

psadmin merge-dp --n name -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r] [-o output-file]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

The distinguished name of the target node. This is mutually exclusive to -g option.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portalId | -p] portal-ID

Specifies the portal ID; if this is not supplied, the default is used.

The following options are optional:

[--dry-run | -r]

Attempt to execute command without writing out to LDAP. Default is false.

[--global | -g]

Global display profile. Default is false. This is mutually exclusive to -d option.

[--name | -n] name

Name of the target display object. If omitted, merges the entire display profile.

[--output | -o] output-file

Specifies a file for output.

[--verbose | -v]

Merges display profile verbosely.

psadmin modify-dp

Description

Changes the value for an existing display profile object.

Syntax

Long Format

psadmin modify-dp --parent parent --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run] [--combine] [--output output-file]

Short Format

psadmin modify-dp -P parent -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r] [-m] [-o output-file]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

Distinguished name of the target node. This is mutually exclusive to -g option.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portalId | -p] portal-ID

Specifies the portal ID, if this is not supplied, the default is be used.

The following options are optional:

[--combine | -m]

Combine with the existing display profile object. For example, use this option to add a channel specified in the existing XML file to a container's existing selected list. By default, this is false.

[--dry-run | -r]

Attempt to execute command without writing out to LDAP. Default is false.

[--global | -g]

Global display profile. Default is false. This is mutually exclusive to -d option.

[--output | -o] output-file

Specifies a file for output.

[--parent | -P] parent

Name of the parent display object. If omitted, assumes the node to be modified is under root.

[--verbose | -v]

Modifies display profile verbosely.

Operands

Specifies one or more files which contain XML fragments.

psadmin add-dp

Description

Adds a new display profile object to the display profile.

Syntax

Long Format

psadmin add-dp [--parent parent] --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run]

Short Format

psadmin add-dp [-P parent] -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

Distinguished name of the target node. This is mutually exclusive to -g option.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portalId | -p] portal-ID

Specifies the portal ID, if this is not supplied, the default is used.

The following options are optional:

[--dry-run | -r]

Attempt to execute command without writing out to LDAP. Default is false.

[--global | -g]

Global display profile. Default is false. This is mutually exclusive to -d option.

[--parent | -P] parent

Name of the parent display object. If not specified , the object gets added to the root.

[--verbose | -v]

Adds display profile verbosely

Operand

Specifies one or more files each of which contains XML fragment.

psadmin remove-dp

Description

Removes an existing display profile object from the display profile.

Syntax

Long Format

psadmin remove-dp --name name [--parent parent] --type type --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [ --verbose] [--global] [--dry-run]

Short Format

psadmin remove-dp -n name [-P parent] -t type -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

Distinguished name of the target node. This is mutually exclusive to -g option.

[--name | -n] name

Name of the target display object. This should be specified as none if type is root or if the entire display profile needs to be removed.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portalId | -p] portal-ID

Specifies the portal ID; if this is not supplied, the default is used.

[--type | -t] type

Type of the display object: root,channel,provider,property,available,selected .

The following options are optional:

[--dry-run | -r]

Attempt to execute command without writing out to LDAP. Default is false.

[--global | -g]

Global display profile. Default is false. This is mutually exclusive to -d option.

[--parent | -P] parent

Name of the parent display object. If not specified , the object gets removed from the root.

[--verbose | -v]

Removes display profile verbosely.