listGroupsInDestinationRole command

Use the listGroupsInDestinationRole command to list the groups in the destination roles for a local bus. To run the command, use the AdminTask object of the wsadmin scripting client. Command-line help is provided for service integration bus commands:

After using the command, save the changes to the master configuration; for example, by using the following command:

AdminConfig.save()

 

Purpose

Use the listGroupsInDestinationRole command to list all the groups 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 we are specifying a destinationType that is either foreignDestination or alias, the foreign bus name that you specify must be the name of the foreign bus hosting the destination.

If you specify a destinationType of queue or topic, the foreign bus name is ignored. The authorization is granted against the destination in the local bus.

-bus busName

The name of the local bus. 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 you have specified.

Sender

This role type is authorized to send messages to destinations on the local bus.

Receiver

This role type is authorized to receive messages from destinations on the local bus.

Browser

This role type is authorized to browse messages on destinations on the local bus.

 

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.

 

Example

The following example lists groups in the Sender role for a queue type destination called Queue1, on a local bus called Bus1.

AdminTask.listGroupsInDestinationRole ('[-type queue -bus Bus1 -destination Queue1 -role Sender]')

The following example lists groups in the Receiver role for a queue type destination called Queue2, on a local bus called Bus1.

AdminTask.listGroupsInDestinationRole ('[-type queue -bus BusName -destination Queue2 -role Receiver]')
   



Last updated Nov 10, 2010 8:23:07 PM CST