Your Browser is not longer supported

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

{{viewport.spaceProperty.prod}}

getList() - Output list of all configured objects of an object type

Function:

BcAdminMain.getlist()

Reads the names of all the objects of a type from the current BeanConnect configuration and returns a dictionary with names and objects.

Parameters:

list_type (String)

Type of object of which a list of all objects defined in the current configuration is to be created. You can make the following specifications for list_type (see also Class: BcObjectType )

String

or the value of one of the following toString() methods

"communication-service"

BcObjectType.COMMUNICATION_SERVICE.toString()

"lu62gateway"

BcObjectType.LU62GATEWAY.toString()

"proxy"

BcObjectType.PROXY.toString()

"proxy-cluster"

BcObjectType.PROXY_CLUSTER.toString()

"todo"

BcObjectType.TODO.toString()

Return:

Dictionary with all the objects of the specified type and the associated names as key.

Exceptions:

BcParameterException, BcObjectException, BcToolException

Example:

...
import BcAdminMain
...
''' get list of all proxys configured '''
bcproxys=BcAdminMain.getList("proxy")
...

The list of proxies (list_type= "proxy") contains only individual (stand-alone) proxies, i.e. no proxies that belong to a proxy cluster. You can read the proxies that are present in a proxy cluster using the function getList() in the module BcAdminProxyCluster.