modifySIBus command
Use the modifySIBus command to modify the properties of a service integration 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 Configuring Qshell to run WebSphere scripts using wsadmin scripting.
- For a list of the available service integration bus commands in Jython and a brief
description of each command, enter the following command at the wsadmin prompt:
print AdminTask.help('SIBAdminCommands')
- For overview help on a given command, enter the following command at the wsadmin
prompt:
print AdminTask.help('command_name')
AdminConfig.save()
Purpose
This command modifies the properties of a service integration bus.
Target object
A bus.
Required parameters
- -bus busname
- The name by which the service integration bus is known. You can use the listSIBuses command to list the names of existing buses.
Conditional parameters
None.
Optional parameters
- -description text
- An optional description for the bus, for administrative purposes.
- -secure TRUE | FALSE
- This parameter is deprecated for this version.
- -mediationsAuthAlias name
- The name of the authentication alias used to authorize mediations to access the bus.
- -securityGroupCacheTimeout timeout_value
- The length of time, in minutes, that a security group will be cached for. timeout_value can
be in the range 0 through 99999.
The default value is 120.
Increasing the timeout decreases the load on the user registry and improves performance but makes the system less responsive to changes in a user's group membership. To tune the group cache to the optimum setting, you need to balance the need for responsiveness with the registry load. For example, if the system must respond quickly to changes in a user's group membership, specify a timeout of 15 minutes. If the system needs to respond less frequently, for example to respond to overnight changes, specify a timeout of 1440 minutes (24 hours). With a setting of 0, entries in the cache do not timeout, and so remain until the server is next restarted.
A change to this value is effective immediately and only affects the group cache of the bus for which the configuration was changed.
- -protocol protocol
- The transport chain used for communication between messaging engines in this bus.
- -discardOnDelete TRUE | FALSE
- Set this option to TRUE if messages on a deleted message point can be discarded. Set this option to FALSE if messages on a deleted message point should be retained at a system exception destination.
- -busSecurity TRUE | FALSE
- Set this option to TRUE to enforce the authorization policy for the bus, which also requires administrative security to be enabled. Set this option to FALSE if you always want to disable bus security. If administrative security is disabled the bus is not secured.
- -permittedChains ALL | SSL_ENABLED | LISTED
- Set one of three options to enforce a transport policy for the
bus.
- ALL
- Allow the use of all defined transport channel chains.
- SSL_ENABLED
- Restrict the use of defined transport channel chains to those protected by SSL.
- LISTED
- Restrict the use of defined transport channel chains to the list of protected transports.
- -bootstrapPolicy SIBSERVICE_ENABLED | MEMBERS_AND_NOMINATED | MEMBERS_ONLY
- Set one of three options to enforce a bus members policy for the
bus.
- SIBSERVICE_ENABLED
- Any server in the cell that has the SIB service enabled can service bootstrap requests.
- MEMBERS_AND_NOMINATED
- Only bus members or a nominated bootstrap server can service bootstrap requests.
- MEMBERS_ONLY
- Only bus members can service bootstrap requests.
- -useServerIdForMediations TRUE | FALSE
- Set this option to TRUE if you want to run mediations using a single server identity for the bus. This option enables you to run mediations across multiple security domains without the need to specify a mediation authentication alias for each domain. You can use a server identity to run mediations on the global domain. Set this option to FALSE if you want to run mediations using a mediations authentication alias.
- -auditAllowed TRUE | FALSE
- Set this option to be TRUE to enable security auditing for the bus. Set this option to be FALSE to disable security auditing for the bus. The default value is TRUE. You must have Audit Administrator privileges to use this parameter.
Example
AdminTask.modifySIBus('[-bus bus1 -description [A new description of the bus]]')
'bus1(cells/cell01/buses/bus1|sib-bus.xml)'