addGroupToForeignBusRole command
Use the addGroupToForeignBusRole command to grant a group permission to access a foreign bus from a local bus, in the sender role.
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 Configure Qshell to run WebSphere scripts .
This command is valid only when used with WAS v7 or later application servers. Do not use it with earlier versions.
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 the changes to the master configuration using the following command:
AdminConfig.save()
Purpose
Use the addGroupToForeignBusRole command to grant a group permission to send messages from a local bus to a foreign bus.
Target object
None.
Required parameters
- -bus busName
- The name of the local bus. We can use the listSIBuses command to list the names of existing buses.
- -foreignBus foreignBusName
- The name of the foreign bus.
- -role Sender
- We can only specify the Sender role for a foreign bus.
- -group groupName
- The name of the group to add to the sender role for the foreign bus. We can specify a group name, or one of the following specialized group names:
- Server
- This group contains application servers.
- All Authenticated
- This group contains authenticated users only.
- Everyone
- This group contains all users. Each user is anonymous.
Conditional parameters
None.
Optional parameters
- -uniqueName uniqueName
- 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. We 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.
Examples
The following example adds a group with the group name Group1, and the unique name SalesGroup to the sender role for a foreign bus called ForeignBus1. The local bus is called Bus1.
AdminTask.addGroupToForeignBusRole ('[-bus Bus1 -ForeignBus ForeignBus1 -role Sender -group Group1 -uniqueName SalesGroup]')
Related concepts
Messaging security Role-based authorization Foreign buses
Related tasks
Add users and groups to foreign bus roles
listGroupsInForeignBusRole command removeGroupFromForeignBusRole command listUsersInForeignBusRole command addUserToForeignBusRole command removeUserFromForeignBusRole command Reference topic