listGroupsInTopicRole command
Use the listGroupsInTopicRole command to list the groups in topic roles for a topic space on 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 listGroupsInTopicRole command to list the groups in topic roles for a selected topic in the topic hierarchy for a selected local bus. We can use this command to define the access control policy for a topic that does not yet exist.
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.
- -topicSpace topicSpaceName
- The name of the topic space.
- -topic topicName
- The name of the topic.
- -role roleType
- We can specify the Sender or Receiver roles for a topic.
Conditional parameters
None.
Optional parameters
- -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 value is FALSE.
Examples
The following example lists the groups in the Sender role for a topic called football, in the topic space called Sport, on a local bus called Bus1.
listGroupsInTopicRole { -bus Bus1 -topicSpace Sport -topic football -role Sender}
Related concepts
Messaging security Topic security Role-based authorization
Related tasks
Listing users and groups in topic roles
addGroupToTopicRole command removeGroupFromTopicRole command listUsersInTopicRole command addUserToTopicRole command removeUserFromTopicRole command Reference topic