listUsersInDestinationRole command
Use the listUsersInDestinationRole command to list users in the destination roles 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 .
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 listUsersInDestinationRole command list the users in destination roles for a selected local bus. The roles we can specify depend on the type of destination.
Target object
None.
Required parameters
- -type destinationType
- We 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 Administer destination roles.
If you are specifying a destinationType that is either foreignDestination or alias, the foreign bus name specified must be the name of the foreign bus hosting the destination.
If we specify a destinationType of queue or topic, the foreign bus name is ignored. The authorization is granted against the destination in the local bus.
- Queue
- -bus busName
- The name of the local bus. We can use the listSIBuses command to list the names of existing buses.
- -role roleType
- We can specify one of the following role types, depending on the -type we 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.
Conditional parameters
None.
Optional parameters
- -foreignBus foreignBusName
- Specify the name of the foreign bus if we have specified a ForeignDestination or Alias destination type.
- -showUniqueNames TRUE | FALSE
- Whether to display unique names. This parameter has two possible values:
- TRUE
- Unique names are displayed.
- FALSE
- Security names are displayed.
The default is FALSE.
Example
The following example lists users in the Sender role on a queue type destination called Queue1, on a local bus called Bus1.
- AdminTask.listUsersInDestinationRole ('[-type queue -bus Bus1 -destination Queue1 -role Sender]')
Related concepts
Related tasks
Reference topic