addGroupToDestinationRole command

Use the addGroupToDestinationRole command to add a group to the destination roles for a local or foreign bus.

To run the command, use the AdminTask object of the wsadmin scripting client.

The wsadmin scripting client is run from Qshell. For more information, see Configuring Qshell to run WebSphere Application Server scripts using wsadmin scripting .

Command-line help is provided for service integration bus commands:
  • For a list of the available service integration bus security commands in Jython and a brief description of each command, enter the following command at the wsadmin prompt:

    print AdminTask.help('SIBAdminBusSecurityCommands')

  • For overview help on a given command, enter the following command at the wsadmin prompt:

    print AdminTask.help('command_name')

After using the command, save your changes to the master configuration; for example, by using the following command:


AdminConfig.save()

Purpose

Use the addGroupToDestinationRole command to grant a group access to local bus destinations for the specified roles. The roles you can specify depend on the type of destination.

Target object

None.

Required parameters

-type destinationType
You can specify one of the following destination types:
  • Queue
  • Port
  • TopicSpace
  • ForeignDestination
  • Alias

The allowed roles for a destination depend on the type of the destination as defined in Administering destination roles.

If you are specifying a destinationType that is either foreignDestination or alias, the foreign bus name that you specify must be the name of the foreign bus hosting the destination.

If you specify a destinationType of queue or topic, the foreign bus name is ignored. The authorization is granted against the destination in the local bus.

-bus busName
The name of the local bus. You can use the listSIBuses command to list the names of existing buses.
-role roleType
You can specify one of the following role types, depending on the -type you have specified.
Sender
This role type applies to alias, foreignDestination, port, queue, and topicSpace destination types.
Receiver
This role type applies to alias, port, queue, and topicSpace destination types.
Browser
This role type applies to alias, port, and queue destination types.
-group groupName
The name of the group that you want to add to the destination role type for the local bus. You can specify a group name, or one of the following specialized group names:
Server
This group contains application servers.
AllAuthenticated
This group contains authenticated users only.
Everyone
This group contains all users. Each user is anonymous.

Conditional parameters

None.

Optional parameters

-foreignBus foreignBusName
Specify the name of the foreign bus. If you are adding a group to a destination on a foreign destination or an alias, you must specify the name of the foreign bus that hosts the foreign destination or the alias.
-uniqueName uniqueName
This parameter is valid only when used with WebSphere® Application Server Version 7.0 or later application servers. Do not use it with earlier versions. Specify the name that uniquely defines the group in the user registry. If an LDAP user registry is in use, the unique name is the distinguished name (DN) for the group. You can specify values for both -uniqueName and -group, but you must ensure that they identify the same group. The command does not check that the values match.

Example

The following example adds a group with the group name Group1, and the unique name SalesGroup to the sender role on a queue type destination called Queue1, on a local bus called Bus1.

AdminTask.addGroupToDestinationRole ('[-type queue -bus Bus1 
 -destination Queue1 -role Sender -group Group1 -uniqueName SalesGroup]')

The following example adds a group called Group2 to the receiver role on a queue type destination called Queue2, on a local bus called Bus1.

AdminTask.addGroupToDestinationRole ('[-type queue -bus Bus1 
 -destination Queue2 -role Receiver -group Group2]')



Related concepts
Messaging security
Destination security
Role-based authorization
Temporary bus destinations
Bus destinations
Related tasks
Adding users and groups to destination roles
Adding users and groups to temporary destination prefix roles
Reference topic Reference topic    

Terms of Use | Feedback

Last updatedLast updated: Sep 19, 2011 7:16:32 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=matt&product=was-express-iseries&topic=rjr_add_gp_dest_role
File name: rjr_add_gp_dest_role.html