addGroupToBusConnectorRole command
Use the addGroupToBusConnectorRole command to add a group to the connector role for a local 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 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 addGroupToBusConnectorRole command to add a group to the bus connector role for a local bus. This command grants the group permission to connect to local destinations.
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.
- -group groupName
- The name of a group to add to the bus connector role for the local bus. We can type a specific group name, or use 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
- -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 Group1 to the bus connector role for a bus called Bus1.
AdminTask.addGroupToBusConnectorRole ('[-bus Bus1 -group Group1 -uniqueName SalesGroup]')
The following example adds the Server group to the bus connector role for a bus called Bus1.
AdminTask.addGroupToBusConnectorRole ('[-bus Bus1 -group Server]')
The following example adds the AllAuthenticated group to the bus connector role for a bus called Bus1.
AdminTask.addGroupToBusConnectorRole ('[-bus Bus1 -group AllAuthenticated]')
The following example adds the Everyone group to the bus connector role for a bus called Bus1.
AdminTask.addGroupToBusConnectorRole ('[-bus Bus1 -group Everyone]')
Related concepts
Messaging security Role-based authorization
Related tasks
Add users and groups in the bus connector role
listGroupsInBusConnectorRole command removeGroupFromBusConnectorRole command listUsersInBusConnectorRole command addUserToBusConnectorRole command removeUserFromBusConnectorRole command Reference topic