Your Browser is not longer supported

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

{{viewport.spaceProperty.prod}}

getCheckResults() - Show results of check actions

Function:

BcAdminAction.getCheckResults()

Returns a dictionary that contains the results of all check proxy container subactions of the specified type.

Parameters:

bc_object (BcObject of Type BcObjectType.ACTION)

The result of a perform() call.

action_type

Type of check, possible specifications are:

BcDef.ACTION_CHECK_ADM
BcDef.ACTION_CHECK_AVAIL
object_type

Object type for which the check actions are to be read; the following specifications are possible:

BcObjectType.COMMUNICATION_SERVICE.toString() 
BcObjectType.LU62GATEWAY.toString() 
BcObjectType.PROXY.toString() (Default) 
BcObjectType.RESOURCE_ADAPTER.toString() 

Return:

Dictionary with key-value pairs consisting of the proxy name and check result (value=result) of all check proxy container subactions.
Examples of the return
{"BCCnt1": "Available", "BcCnt2": "Not available"}
{"BCCnt1": "Administrable", "BcCnt2": "Not administrable"}

Exceptions:

BcObjectException, BcToolException

Note:

This function returns a selection of the results of the function getResults(), namely information about the administrability (specification BcDef.ACTION_CHECK_ADM) or the status (specification BcDef.ACTION_CHECK_AVAIL) of the components of the specified type. The return information contains key-value pairs with:

  • key: Name of the component (object_name)

  • value: Result of the subaction (result)

where object_name and result are the properties of the subaction as described in getResult(). If the specified action was the return value of a check call for a proxy then the dictionary contains only one element. If it was the return value of a check call for a proxy cluster then it contains one element for each proxy in the cluster.

Example:

...
import BcAdminAction
import BcAdminProxy
...
proxy_obj=BcAdminProxy.getObject("BCProxy")
bcaction=BcAdminProxy.perform(proxy_obj,action="check-avail")
checkProxy=BcAdminAction.getCheckResults(bcaction,\
BcDef.ACTION_CHECK_AVAIL)
...