Chapter 25 Subcommands for Managing Communities

This chapter describes the subcommands used for managing the Sun Java System Portal Server software communities through command-line. This chapter lists the following subcommands:

• list—communities

• list—community-templates

• list—community-dps

• create—community

• enable—community

• disable-community

• undelete-community

• delete-community

• destroy-community

• get-community

• get-community-dp

• modify-community

• list-community-users

• list-community-pending-users

• add-community-users

• remove-community-users

• approve-community-users

• deny-community-users

• ban-community-users

• unban-community-users

• add-community-owners

• remove-community-owners

list—communities

This subcommand list all the communities.

Syntax

Long Format

psadmin list-communities --adminuser uid [--passwordfile password-filename] --portal portal-ID [--search search-pattern] [--verbose]

Short Format

psadmin list-communities -u uid [-f password-filename] -p portal-ID [-s search-pattern] -v

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--search | -s search-pattern

Specifies a pattern for searching communities. To search for communities, you can use the wildcard character *. For example, to search through all community names that begin with the letter C, the search pattern can be specified as C*.

--verbose | -v

Specifies community properties in output.

list—community-templates

This subcommand lists all available community templates in the specified portal. You need a community template ID for creating a community.

Syntax

Long Format

psadmin list-community-templates --adminuser uid [--passwordfile password-filename] --portal portal-ID

Short Format

psadmin list-community-templates -u uid [-f password-filename] -p portal-ID

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

list—community-dps

This subcommand lists all community display profile names. The community display profile name (such as owner or member) is required to get the community display profile XML fragment.

Syntax

Long Format

psadmin list—community-dps --adminuser uid [--passwordfile password-filename] --portal portal-ID

Short Format

psadmin list—community-dps -u uid [-f password-filename] -p portal-ID

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

create—community

This subcommand creates a community.

Syntax

Long Format

psadmin create—community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--description community-description] --owner user-DN [--category community-category] --template community-template [--unlisted true|false] [--membershiprestricted true|false] [--secured true|false]

Short Format

psadmin create—community -u uid [-f password-filename] -p portal-ID -N community-name [-D community-description] -O user-DN -G search-category -T community-template [-U true|false] [-R true|false] [-S true|false]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies a name for the community.

--owner | -O user-DN

Specifies the distinguished name of the owner of the community.

--template | -T community-template

Specifies a community template.

The following option is optional:

--category | -G search-category

Specifies the search category.

--description | -D community-description

Specifies a description of the community.

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--unlisted | -U true|false

Specifies whether or not a community is unlisted. If a community is unlisted, the user will not be able to find it from their desktop. Values can be true or false.

--membershiprestricted | -R true|false

Specifies whether or not the community membership is restricted. Values can be true or false.

--secured | -S true|flase

Specifies whether or not a community is secured. Secured communities are completely private and membership is by invitation only. The user cannot send a request to join a secured community. Values can be true or false.

enable—community

This subcommand enables the specified community.

Syntax

Long Format

psadmin enable—community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin enable—community -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to enable.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

disable-community

This subcommand disables the specified community.

Syntax

Long Format

psadmin disable-community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin disable-community -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to disable.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

undelete-community

This subcommand undeletes the specified community.

Syntax

Long Format

psadmin undelete-community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin undelete-community -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to undelete.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

delete-community

This subcommand marks the specified community as deleted and only the administrator can see the community.

Syntax

Long Format

psadmin undelete-community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin undelete-community -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to delete.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

destroy-community

This subcommand removes the specified community permanently.

Syntax

Long Format

psadmin destroy-community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin destroy-community -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to remove permanently.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

get-community

This subcommand fetches the description, owner, and category for the specified community.

Syntax

Long Format

psadmin get-community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin get-community -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to fetch data.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

get-community-dp

This subcommand fetches the community display profile XML fragment for the specified display profile name (such as owner or member).

Syntax

Long Format

psadmin get-community-dp --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name --dp dp-name

Short Format

psadmin get-community-dp -u uid [-f password-filename] -p portal-ID -N community-name -P dp-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to fetch community display profile data.

--dp | -P community-name

Specifies the display profile name (such as owner or member).

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

modify-community

This subcommand modifies the description and category of the specified community.

Syntax

Long Format

psadmin modify-community --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--newdescription community-description] [--newcategory community-category] [--newunlisted Community-Unlisted] [--newmembershiprestricted Community-MembershipRestricted] [--newsecured Community-Secured]

Short Format

psadmin modify-community -u uid [-f password-filename] -p portal-ID -N community-name [-D community-description] [-G community-category] [-U Community-Unlisted] [-R Community-MembershipRestricted [-S Community-Secured]]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to modify.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--newdescription | -D new-description

Specifies a new description for the specified community.

--newcategory | -G new-category

Specifies the new search category for the specified community.

--newunlisted | -U Community-Unlisted

Specifies whether or not the community is unlisted. If a community is unlisted, the user will not be able to find it from their desktop. Values can be true or false.

--newmembershiprestricted | -R Community-MembershipRestricted

Specifies whether or not the community membership is restricted. Values can be true or false.

--newsecured | -S Community-Secured

Specifies new community secured attribute. Values can be true or false.

list-community-users

This subcommand lists the members of the specified community.

Syntax

Long Format

psadmin list-community-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin list-community-users -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to fetch data.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

list-community-pending-users

This subcommand lists the users awaiting membership approval to a community.

Syntax

Long Format

psadmin list-community-pending-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name

Short Format

psadmin list-community-pending-users -u uid [-f password-filename] -p portal-ID -N community-name

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community to fetch data.

The following option is optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

add-community-users

This subcommand adds users to a specified community.

Syntax

Long Format

psadmin add-community-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin add-community-users -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the user to add.

--users | -Y userDN-list

Specifies a pattern to search for distinguished name of users to add. The search pattern is a regular expression for directory node search.

--search | -s search-pattern

Specifies a pattern for searching distinguished name of users.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.

remove-community-users

This subcommand deletes users from a specified community.

Syntax

Long Format

psadmin remove-community-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin remove-community-users -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the community user to remove.

--users | -Y userDN-list

Specifies a list of distinguished name of users.

--search | -s search-pattern

Specifies a pattern to search for distinguished name of users to remove. The search pattern is a regular expression for directory node search.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.

approve-community-users

This subcommand approves community membership requests from users.

Syntax

Long Format

psadmin approve-community-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin approve-community-users -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the user to approve.

--users | -Y userDN-list

Specifies the distinguished name of a list of users.

--search | -s search-pattern

Specifies a pattern to search for distinguished name of users. The search pattern is a regular expression for directory node search.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.

deny-community-users

This subcommand denies membership requests from users to a specified community.

Syntax

Long Format

psadmin deny-community-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin deny-community-users -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the user to deny approval.

--users | -Y userDN-list

Specifies the distinguished name of a list of users.

--search | -s search-pattern

Specifies a pattern to search for distinguished name of users. The search pattern is a regular expression for directory node search.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.

ban-community-users

This subcommand bans users from a specified community. Banned users cannot see the content of the community.

Syntax

Long Format

psadmin ban-community-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin ban-community-users -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the user to ban.

--users | -Y userDN-list

Specifies the distinguished name of a list of users.

--search | -s search-pattern

Specifies a pattern to search for distinguished name of users. The search pattern is a regular expression for directory node search.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.

unban-community-users

This subcommand removes the ban on users from joining a specified community.

Syntax

Long Format

psadmin unban-community-users --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin unban-community-users -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the user to unban.

--users | -Y userDN-list

Specifies the distinguished name of a list of users.

--search | -s search-pattern

Specifies a pattern to search for distinguished name of users. The search pattern is a regular expression for directory node search.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.

add-community-owners

This subcommand adds owners to a specified community.

Syntax

Long Format

psadmin add-community-owners --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin add-community-owners -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the user to add as an owner.

--users | -Y userDN-list

Specifies the distinguished name of a list of users.

--search | -s search-pattern

Specifies a pattern to search for distinguished name of users. The search pattern is a regular expression for directory node search.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.

remove-community-owners

This subcommand removes the specified community owners. If you remove the owner role from a user, the user is still a member.

Syntax

Long Format

psadmin remove-community-owners --adminuser uid [--passwordfile password-filename] --portal portal-ID --name community-name [--user user-DN] [--users userDN-list] [--search search-pattern] [--dryrun]

Short Format

psadmin remove-community-owners -u uid [-f password-filename] -p portal-ID -N community-name [-y user-DN] [-Y userDN-list] [-s search-pattern] [-n]

Options

The following options are required:

--adminuser | -u uid

Specifies the distinguished name of administrator.

--portal | -p portal-ID

Specifies the portal ID.

--name | -N community-name

Specifies the name of the community.

The following options are optional:

--passwordfile | -f password-filename

Specifies the administrator password in a temporary password file. The password file is used to fetch and present password for authentication.

--user | -y userDN

Specifies the distinguished name of the user to remove as an owner.

--users | -Y userDN-list

Specifies the distinguished name of a list of users.

--search | -s search-pattern

Specifies a pattern to search for distinguished name of users. The search pattern is a regular expression for directory node search.

--dryrun | -n

Performs a dry run, typically, for testing the search pattern.