This chapter describes the folllowing subcommands:
Gets the portal attribute for a base dn or from global or default levels.
psadmin get-attribute --component desktop -attribute-name attribute-name --adminuser uid --passwordfile password-filename [--dn dn] -portalid portal-ID [--output output-file] [--debug]
psadmin get-attribute -m desktop -a attribute-name -u uid -f password-filename [-d dn] -p portal-ID [-o output-file]
The following options are required:
Specifies the administrator's distinguished 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.
Always desktop for this module.
Specifies the administrator's password in the password file.
Specifies the portal ID.
The following options are optional:
Used for debugging purpose only. By default, this is set to false. Set this flag to true to see exceptions that caused the error.
Specifies the distinguished name for whom desktop attribute is to be retrieved.
Specifies a file for output.
Sets the portal desktop attribute to the supplied value or values for a base dn or at global or default levels.
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
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
The following options are required:
Specifies the administrator's distinguished 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.
Always desktop for this module.
Specifies the administrator's password in the password file.
Specifies the portal ID.
The following options are optional:
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".
Used for debugging purpose only. By default, this is set to false. Set this flag to true to see exceptions that caused the error.
Specifies the distinguished name for whom desktop attribute is to be set.
Allows the specified attribute at the given dn, to inherit its value from the parent dn.
The dn is mandatory to use this option.
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".
The following operand is supported:
Specifies the value to be set.
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.
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.
psadmin list-attributes --component desktop --adminuser uid --passwordfile password-filename [--output output-file] [--verbose] [--debug]
psadmin list-attributes -m desktop -u uid -f password-filename [-o output-file] [-v] [--debug]
The following options are required:
Specifies the administrator's distinguished name.
Always desktop for this module.
Specifies the administrator's password in the password file.
The following options are optional:
Used for debugging purpose only. By default, this is set to false. Set this flag to true to see exceptions that caused the error.
Specifies a file for output.
Removes display profile verbosely.
Retrieves and displays display profile node objects.
psadmin list-dp --name name --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run] [--output output-file]
psadmin list-dp -n name -u uid -f password-filename -d dn -p portal-ID [-v] [ -g] [-r] [-o output-file]
The following options are required:
Specifies the administrator's distinguished name.
Distinguished name of the target node. This is mutually exclusive to -g option.
Specifies the administrator's password in the password file.
Specifies the portal ID; if this is not supplied, the default is used.
The following options are optional:
Attempt to execute command without writing out to LDAP. Default is false.
Global display profile. Default is false. This is mutually exclusive to -d option.
Name of the target display object. If omitted, the entire display profile is displayed.
Specifies a file for output.
Lists display profile verbosely.
Retrieves and displays the merged result of the given display profile node objects.
psadmin merge-dp --name name --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run] [--output output-file]
psadmin merge-dp --n name -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r] [-o output-file]
The following options are required:
Specifies the administrator's distinguished name.
The distinguished name of the target node. This is mutually exclusive to -g option.
Specifies the administrator's password in the password file.
Specifies the portal ID; if this is not supplied, the default is used.
The following options are optional:
Attempt to execute command without writing out to LDAP. Default is false.
Global display profile. Default is false. This is mutually exclusive to -d option.
Name of the target display object. If omitted, merges the entire display profile.
Specifies a file for output.
Merges display profile verbosely.
Changes the value for an existing display profile object.
psadmin modify-dp --parent parent --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run] [--combine] [--output output-file]
psadmin modify-dp -P parent -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r] [-m] [-o output-file]
The following options are required:
Specifies the administrator's distinguished name.
Distinguished name of the target node. This is mutually exclusive to -g option.
Specifies the administrator's password in the password file.
Specifies the portal ID, if this is not supplied, the default is be used.
The following options are optional:
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.
Attempt to execute command without writing out to LDAP. Default is false.
Global display profile. Default is false. This is mutually exclusive to -d option.
Specifies a file for output.
Name of the parent display object. If omitted, assumes the node to be modified is under root.
Modifies display profile verbosely.
Specifies one or more files which contain XML fragments.
Adds a new display profile object to the display profile.
psadmin add-dp [--parent parent] --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [--verbose] [--global] [--dry-run]
psadmin add-dp [-P parent] -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r]
The following options are required:
Specifies the administrator's distinguished name.
Distinguished name of the target node. This is mutually exclusive to -g option.
Specifies the administrator's password in the password file.
Specifies the portal ID, if this is not supplied, the default is used.
The following options are optional:
Attempt to execute command without writing out to LDAP. Default is false.
Global display profile. Default is false. This is mutually exclusive to -d option.
Name of the parent display object. If not specified , the object gets added to the root.
Adds display profile verbosely
Specifies one or more files each of which contains XML fragment.
Removes an existing display profile object from the display profile.
psadmin remove-dp --name name [--parent parent] --type type --adminuser uid --passwordfile password-filename --dn dn --portalid portal-ID [ --verbose] [--global] [--dry-run]
psadmin remove-dp -n name [-P parent] -t type -u uid -f password-filename -d dn -p portal-ID [-v] [-g] [-r]
The following options are required:
Specifies the administrator's distinguished name.
Distinguished name of the target node. This is mutually exclusive to -g option.
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.
Specifies the administrator's password in the password file.
Specifies the portal ID; if this is not supplied, the default is used.
Type of the display object: root,channel,provider,property,available,selected .
The following options are optional:
Attempt to execute command without writing out to LDAP. Default is false.
Global display profile. Default is false. This is mutually exclusive to -d option.
Name of the parent display object. If not specified , the object gets removed from the root.
Removes display profile verbosely.