addUserToForeignBusRole command
Use the addUserToForeignBusRole command to grant a user 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 Configuring Qshell to run WebSphere scripts using wsadmin scripting.
This command is valid only when used with WebSphere® Application Server Version 7.0 or later application servers. Do not use it with earlier versions.
- 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')
AdminConfig.save()
Purpose
Use the addUserToForeignBusRole command grant a user 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. You can use the listSIBuses command to list the names of existing buses.
- -foreignBus foreignBusName
- The name of the foreign bus.
- -role Sender
- You can specify the Sender role only for a foreign bus.
- -user userName
- The name of the user that you want to add to the Sender role for the foreign bus.
Conditional parameters
None.
Optional parameters
- -uniqueName uniqueName
- Specify the name that uniquely defines the user in the user registry. If an LDAP user registry is in use, the unique name is the distinguished name (DN) for the user. You can specify values for both -uniqueName and -user, but you must ensure that they identify the same user. The command does not check that the values match.
Examples
The following example adds a user called User1 to the Sender role for a foreign bus called ForeignBus1. The local bus is called Bus1.
AdminTask.addUserToForeignBusRole ('[-bus Bus1 -foreignBus ForeignBus1 -role Sender -user User1]')