Chapter 19 WSRP Producer psadmin Subcommands

This supplement contains the following:

• psadmin create-producer

• psadmin delete-producer

• psadmin list-producers

• psadmin list-attributes

• psadmin get-attribute

• psadmin set-attribute

• psadmin list-consumer-registrations

• psadmin create-consumer-registration

• psadmin delete-consumer-registration

psadmin create-producer

Description

Create a Producer in a portal.

Syntax

Long Format

psadmin create-producer --portal portal-ID --adminuser uid --passwordfile password-filename --dn orgnaization-DN --producer producer-name

Short Format

psadmin create-producer -p portal-ID -u uid -f password-filename -d orgnaization-DN -N producer-name

Options

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] organization-DN

Specifies the distinguished name for the organization where the Producer is to be created.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

[--producer | -N] producer-name

Specifies the name of the Producer to be created.

psadmin delete-producer

Description

Delete a Producer in a portal.

Syntax

Long Format

psadmin delete-producer --adminuser uid --passwordfile password-filename --portal portal-ID --producer producer-name

Short Format

psadmin delete-producer -u uid -f password-filename -p portal-ID -N producer-name

Options

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

[--producer | -N] producer-name

Specifies the name of the Producer to be deleted.

psadmin list-producers

Description

List all Producers for a portal.

Syntax

Long Format

psadmin list-producers --adminuser uid --passwordfile password-filename [--dn organization-DN] --portal portal-ID [--output output-filename]

Short Format

psadmin list-producers -u uid -f password-filename [-d organization-DN] -p portal-ID [-o output-filename]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

The following options are optional:

[--dn | -d] organization-DN

Specifies the distinguished name for the organization from where the producers are to be listed. If none is specified, all the producers that belong to the portal are listed.

[--output | -o] output-filename

Specifies the file to output the result of the command.

psadmin list-attributes

Description

List the attributes for a Producer.

Syntax

Long Format

psadmin list-attributes --component producer --adminuser uid --passwordfile password-filename --portal portal-ID [--consumerregistration] [--output output-filename]

Short Format

psadmin list-attributes -m producer -u uid -f password-filename -p portal-ID [-S] [-o output-filename]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--component | -m] producer

Specifies the name of the component. The value should be producer.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

The following options are optional:

[--consumerregistration | -S]

Specifies that this is for a consumer registration.

[--output | -o] output-filename

Specifies the file to output the result of the command.

psadmin get-attribute

Description

Display the value of an attribute for a Producer.

Syntax

Long Format

psadmin get-attribute --component producer --portal portal-ID --attribute-name attribute-name --adminuser uid --passwordfile password-filename [--producer producer-name] [--registrationhandle handle]

Short Format

psadmin get-attribute -m producer -p portal-ID -a attribute-name -u uid -f password-filename [-N producer-name] [-H handle]

Options

The following options are required:

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

Specifies the name of the Producer attribute for which the value is to be retrieved.

Attributes can be:

• AllDisabled (true or false, global attribute)

• Enabled (true or false )

• WSDL_URL (read-only)

• RegistrationRequired (true or false)

• InBandRegistrationSupported (true or false)

• RegistrationValidatorClassName

• PublishedPortlets

• UnpublishedPortlets (read-only)

• RegistrationPropertyDescription

Attributes for Consumer Registrations can be:

• Enabled (true or false )

• ConsumerName

• ConsumerAgent

• MethodGetSupported

• ConsumerModes

• ConsumerWindowStates

• ConsumerUserScopes

• CustomUserProfileData

• RegistrationProperties

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--component | -m] producer

Specifies the name of the component. The value should be producer.

[--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:

[--producer | -N] producer-name

Specifies the name of the Producer being targeted.

[--registrationhandle | -H] handle

Specifies the registration handle.

psadmin set-attribute

Description

Set the value of an attribute for a Producer.

Syntax

Long Format

psadmin set-attribute --component producer --portal portal-ID --attribute-name attribute-name --adminuser uid --passwordfile password-filename [--producer producer-name] [--registrationhandle handle] [--add] [--remove] values

Short Format

psadmin set-attribute -m producer -p portal-ID -a attribute-name -u uid -f password-filename [-N producer-name] [-H handle] [-A] [-E] values

Options

[--component | -m] producer

Specifies the name of the component. The value should be producer.

[--portalid | -p] portal-ID

Specifies the portal ID.

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

Specifies the name of the Producer attribute for which the value is to be retrieved.

Attributes can be:

• AllDisabled (true or false, global attribute)

• Enabled (true or false)

• WSDL_URL (read-only)

• RegistrationRequired (true or false)

• InBandRegistrationSupported (true or false)

• RegistrationValidatorClassName

• PublishedPortlets

• UnpublishedPortlets (read-only)

• RegistrationPropertyDescription

Attributes for Consumer Registrations can be:

• Enabled (true or false)

• ConsumerName

• ConsumerAgent

• MethodGetSupported

• ConsumerModes

• ConsumerWindowStates

• ConsumerUserScopes

• CustomUserProfileData

• RegistrationProperties

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

The following options are optional:

[--add | -A] [--remove | -E] values

Specifies values to add or remove.

[--producer | -N] producer-name

Specifies the name of the Producer being targeted.

[--registrationhandle | -H] handle

Specifies the registration handle.

psadmin list-consumer-registrations

Description

List the Consumers that are currently registered with a Producer.

Syntax

Long Format

psadmin list-consumer-registrations --portal portal-ID --producer producer-name --adminuser uid --passwordfile password-filename [--output output-filename]

Short Format

psadmin list-consumer-registrations -p portal-ID -N producer-name -u uid -f password-filename [-o output-filename]

Options

The following options are required:

[--producer | -N] producer-name

Specifies the name of the Producer being targeted.

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

The following option is optional:

[--output | -o] output-filename

Specifies the file to output the result of the command.

psadmin create-consumer-registration

Description

Create a new Consumer registration at a Producer.

Syntax

Long Format

psadmin create-consumer-registration --portal portal-ID --producer producer-name --registrationdatafile file --adminuser uid --passwordfile password-filename

Short Format

psadmin create-consumer-registration -p portal-ID -N producer-name -x file -u uid -f password-filename

Options

The following options are required

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.

[--producer | -N] producer-name

Specifies the name of the Producer being targeted.

[--registrationdatafile | -x] file

Specifies the properties file that lists the options to set on the new consumer registration.

psadmin delete-consumer-registration

Description

Delete a Consumer registration from a Producer.

Syntax

Long Format

psadmin delete-consumer-registration --producer producer-name --adminuser uid --passwordfile password-filename --portal portal-ID --registrationhandle handle

Short Format

psadmin delete-consumer-registration -N producer-name -u uid -f password-filename -p portal-ID -H handle

Options

The following options are required

[--producer | -N] producer-name

Specifies the name of the Producer being targeted.

[--registrationhandle | -H] handle

Specifies the registration handle that is to be deleted.

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--passwordfile | -f] password-filename

Specifies the administrator's password in the password file.

[--portal | -p] portal-ID

Specifies the portal ID.