Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

perform() - Start administrative actions

Function:

BcAdminRA.perform()


Starts the specified action for the resource adapter.

Parameters:

bc_object (BcObject of type BcObjectType.RESOURCE_ADAPTER).


Resource adapter for which the action is to be started.

action (String)

Action that is to be started for the specified resource adapter. Possible values are (see BcDef.ACTION_xxx)


check-avail

Checks the resource adapter's execution status.


update-ra-xml

Enters the saved changes in the configuration of the resource adapter.

params (kw) (Dictionary)


Dictionary with the key-value pairs for the parameters that are to be passed to the specified action.
If action="update-ra-xml" then the following key-value pair must be specified in the dictionary params:
key="rar-file-path"
value= Name of the resource adapter rar file in which the changes to the configuration are to be entered.

Return:

For action="update-ra-xml":
True (boolean) if update has been initiated, otherwise BcToolException.
For action="check-avail":
bcaction (BcObject of type BcObjectType.ACTION) containing all the information about the started action and all its subactions. To obtain more detailed information, you can call a function of the BcAdminAction module with this object as parameter.

Exceptions:

BcObjectException, BcParameterException, BcToolException

Example:

...
import BcAdminRA
import BcAdminProxy
...
proxy_obj=BcAdminProxy.getObject("BCProxy")
ra_obj=BcAdminRA.getObject("test-RA", proxy_obj)
bcaction=BcAdminRA.perform(ra_obj,"check-avail")
...