Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name (dn) or the user identification name (uid).

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--component | -m] component-name

Specifies the component name. Valid names are: producer, consumer, desktop, mobilemail, mobilecalendar, mobileaddressbook, gateway, netlet, proxylet, netfile, and subscriptions.

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

Specifies the attribute name. For list of the attribute names for a component, please run the command psadmin list-attributes --component component-name.

The following options are optional:

[--portal | -p] portal-name

Specifies the portal name. The --portal option is required when a portal-centric component attribute is being accessed. The following components are portal-centric and you must provide the --portal option for list, get, and set operations while using the following components: desktop, producer, consumer, and subscriptions. For all other components, do not use the -portal option since they are common to all portals.

[--producer] producer-ID

Specifies the producer id. This is the ID or the name of a producer when the component is producer and it is the ID of a configured producer when the component is consumer. This option is valid only if the component is producer or consumer.

[--registrationhandle] handle

Specifies the registration handle of a producer's consumer registration. The attribute of a producer's consumer registration is returned (not the attribute of a producer itself). This option is valid only if the component is producer.

[--dn | -d]

Specifies the dn of the node. This must be an organization DN when the component is consumer.

[--gateway-profile] gateway-profile-name

Specifies the gateway profile name. This is used only when the component is gateway.

[--debug]

Specifies if debug mode is turned on.

[--output | -O] output-filename

Specifies if the output mode is used.