Connection operations
Address attributes
Defines the address line attributes that the target will support
Signature: addressattrs(cinfo)
Return Value:
ACSuccess 0
ACUnknownError 1
ACOperationNotSupported 2
Remarks:
The agent.addAddressAttr callback should be used in this operation to define the address attributes for the target, refer to agent.addAddressAttr callback for full details. The callback can only be used in scripted agents that are defined with a .con file. The values specified for the address attributes, will be available to be used in other operations inside of the "settings" dictionary object.
Connect
Establishes a connection to the target system
Signature: connect(cinfo)
Parameters:
cinfo['adminid'] - The administrator account that should be used to connect to the target system
cinfo['adminpw'] - The password for the administrator account
cinfo['sysid'] - An optional system account that should be used during connection
cinfo['syspw'] - The password for the system account
cinfo['settings'] - Dictionary object containing the address attributes defined in the address attributes operation
Return Value:
ACSuccess 0
ACUnknownError 1
ACNotConnected 3
Remarks:
This function will be called before other operations to establish a connection for use in the subsequent operations.
Disconnect
Terminates the connection to the target system
Signature: disconnect(cinfo)
Return Value:
ACSuccess 0
ACUnknownError 1
Platform information
Defines additional operations the connector supports
Signature: platforminfo(cinfo)
Return Value:
ACSuccess 0
ACUnknownError 1
Remarks:
The agent.addSupportedOp callback can be used in this operation to define additional operations the connector will support. This functionality is primarily used in scenarios where the connector is wrapping a different connector. See the agent.addAddressAttr callback page for full details.
Server information
Returns the version of the target system. Also used to validate a connection to the target system when using the "Test Connect" button during target configuration
Signature: serverinfo(cinfo)
Return Value:
ACSuccess 0
ACUnknownError 1
Remarks:
The agent.serverInfo callback should be used to return the version information for the target system. See the agent.serverInfo callback page for full details.