Your Browser is not longer supported

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

{{viewport.spaceProperty.prod}}

getObject() - Read communication service object from the configuration

Function:

BcAdminCommunicationService.getObject()

Reads the communication service with the specified name from the configuration

Parameters:

props (Dictionary)

Dictionary containing the key-value pairs for the host and install-path properties of the communication service that is to be read. Optionally, the property install-path-gw can be specified in order to guarantee a unique assignment to the openUTM-LU62 Gateway.

Return:

(BcObject of type BcObjectType.RESOURCE_ADAPTER)

The read communication service or None if no communication service with the corresponding name exists.

Exceptions:

BcObjectException, BcParameterException, BcToolException

Note:

The property install-path-gw should be specified when reading a communication service because some of the properties of the communication service are stored under this path.

Example:

...
import BcAdminCommunicationService
...
getProps={"host": "bchost01", "install-path": 
"/opt/ibm/sna/bin"}
cs_obj=BcAdminCommunicationService.getObject(getProps)
...