Function reference

This reference describes each function that is available in the custom server extensions API. The functions are listed in alphabetical order.

addProcessToPool function
Add a runtime process to a process pool.
binToDot function
Convert a binary representation of an IP address to dot notation.
bitsMaskToDottedDecimalMask function
Convert network bits mask notation to dotted decimal notation.
calcNetworkAddress function
Calculate the network address given an IP address and netmask.
canonicalMac function
Remove separators or radix notation from a MAC address and return the hexadecimal MAC address.
classlessNotation function
Calculate the classless notation of an IP network.
cloneModelObject function
Create a copy of a Common Data Model ModelObject.
dotToBin function
Convert an IPv4 address from dot notation to binary form.
executeCommand function
Run a command on the target.
executeCommandWithTimeout function
Run a command on the target with a timeout that specifies how long the command is permitted to run.
getApiMinorVersion function
Return the minor version of the API.
getApiVersion function
Return the major version of the API.
getAppTarget function
Return a tuple containing information about the application target.
getArray function
Get an array in Python for use with certain Java™ and TADDM functions.
getComputerSystem function
Return an object to which the OS handle is connected with the attributes populated.
getCsTarget function
Return a tuple containing information about the target.
getFile function
Capture a file from a remote target and return the file contents and metadata.
getFileWithLengthLimit function
Capture a file, up to the specified maximum length, from a remote target and return the file contents and metadata.
getLocalDNSLookup function
Perform a name lookup on the TADDM server.
getNewOsHandle function
Create a new OS handle to the specified target.
getOperatingSystem function
Return an object representing the operating system to which the OS handle is connected.
getPidConnectionMap function
Return a Python dictionary containing the process IDs and TCP connections of the process IDs
getPidPortList function
Return a Python dictionary containing the process IDs and the ports the process is using either for listening or connecting.
getPidToRuntimeProcessMap function
Return a Python dictionary containing the process IDs and runtime process information.
getProcessByPid function
Return the Common Data Model RuntimeProcess object associated with a given process ID.
getRemoteDNSLookup function
Perform a lookup of a name extracted from a remote configuration which may not resolve on the TADDM server.
getServerProcesses function
Return a Python dictionary of Python lists containing the process IDs and bind addresses of the listen ports.
getSimpleCapabilitiesFactory function
Return SimpleCapabilitiesFactory for a given IP address.
getTADDMVersion function
Return the TADDM version number.
init function
Initialize the custom server extension API.
ipInSubnet function
Determine if an IP address is a member of a given subnet and not the broadcast address.
listDirectory function
Return a Python list containing the contents of a directory on a remote target.
networkToList function
Return all IP addresses that are members of the CDM representation of the IpNetwork parameter.
newModelObject function
Create a Common Data Model (CDM) object.
queryRegistry function
Return a registry key as XML.
setExtendedAttributes function
Set the values of the extended attributes.
splitArgs function
Split a command line into its components and return them as a Python sequence.
unixSlashes function
Converts Windows path separator characters to UNIX path separator characters.
validateFqdn function
Check a full qualified domain name to ensure it conforms to the rules outlined in RFC 1035.
validateIp function
Validate an IP address in dot notation.
windowsSlashes function
Converts UNIX path separator characters to Windows path separator characters.

Parent topic: Custom server extensions API