Network Deployment (Distributed operating systems), v8.0 > Reference > Commands (wsadmin scripting)


addGroupToDestinationRole command

Use the addGroupToDestinationRole command to add a group to the destination roles for a local or foreign 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 changes to the master configuration; for example, by using the following command:


AdminConfig.save()

Use the addGroupToDestinationRole command to grant a group access to local bus destinations for the specified roles. The roles you 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 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. 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 you 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.

-group groupName

The name of the group to add to the destination role type for the local bus. We can specify a group name, or 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

-foreignBus foreignBusName

Specify the name of the foreign bus. If you are adding a group to a destination on a foreign destination or an alias, specify the name of the foreign bus that hosts the foreign destination or the alias.

-uniqueName uniqueName

This parameter is valid only when used with WAS v7.0 or later application servers. Do not use it with earlier versions. 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 ensure that they identify the same group. The command does not check that the values match.


Example

The following example adds a group with the group name Group1, and the unique name SalesGroup to the sender role on a queue type destination called Queue1, on a local bus called Bus1.

AdminTask.addGroupToDestinationRole ('[-type queue -bus Bus1
 -destination Queue1 -role Sender -group Group1 -uniqueName SalesGroup]')

The following example adds a group called Group2 to the receiver role on a queue type destination called Queue2, on a local bus called Bus1.

AdminTask.addGroupToDestinationRole ('[-type queue -bus Bus1
 -destination Queue2 -role Receiver -group Group2]')

Messaging security
Destination security
Role-based authorization
Temporary bus destinations
Bus destinations
Add users and groups to destination roles
Add users and groups to temporary destination prefix roles

+

Search Tips   |   Advanced Search