psadmin deploy-portlet

Description

Deploys the portlet web application into the Portal Server. It deploys the portlet WAR file and inserts the provider into display profile.

Syntax

Long Format

psadmin deploy-portlet --adminuser uid --passwordfile password-filename --dn dn | --global [--rolesfile roles-file] [--continue false] [--instance instance-port] [--userinfofile user-info-file] --portal portal-ID portletwarfile [--locale]

Short Format

psadmin deploy-portlet -u uid -f password-filename -d dn [-r roles-file] [-c false] [-i instance-port] [-n user-info-file] -p portal-ID [-g] portletwarfile [-l]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the administrator's distinguished name.

[--dn | -d] dn

Specifies the distinguished name in the LDAP node to access the display profile document. The -d or -g option is required.

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

[--global | -g]

Specifies the global level node in LDAP to access the display profile document. The -d or -g option is required.

[--rolesfile | -r] roles-file

Specifies the file containing the Access Manager software and portlet application role mapping information.

[--userinfofile | -n] user-info-file

Specifies the file containing the user information mapping information.

[--continue | -c]

Returns with error if deployment fails on any single portal instance. Default is True. Deployment continues to other instances if it fails on one instance.

[--instance | -i]

Specifies the portal instance where the portlet is to be deployed. If it is not specified, deploys on all the instances of the portal.

---

Note –

If you are in the cluster environment, be sure to specify the portal instance id which is installed on the cluster using this option. However, if you are not in the cluster environment, it is recommended to use this option ONLY in a development environment, since using this option will cause inconsistency between Portal Server Instances.

---

Operands

portletwarfile

Specifies the path to the WAR file.

Example

Example 8–1 psadmin deploy-portlet

psadmin deploy-portlet -u admin-user -f password -g --rolesfile /tmp/rolesfile -p portal1 portlet.war

Where the content of the rolesfile is:

cn\=AsAdminRole,o\=DeveloperSample,dc\=x,dc\=y,dc\=com=portletAsAdminRole
cn\=DevRole,o\=DeveloperSample,dc\=x,dc\=y,dc\=com=portletDevRole

AsAdminRole and DevRole are the roles that are created through the Access Manager and the roles file creates a logical mapping to the AsAdminRole with portletAsAdminRole and DevRole with portletDevRole. The portletAsAdminRole and the portletDevRole can be used in the portlets.