Functions

This page provides a list of all TPL functions and is grouped by function type.

Global scope functions

• datatype — Returns a string indicating the type of the item.
• size — Returns the number of items in the collection.

Log functions

• log-debug — Log the given message with a debug level message.
• log-info — Log the given message with an info level message. The log messages that are output automatically include the name of the pattern performing the log action.
• log-warn — Log the given message with a warn level message. The log messages that are output automatically include the name of the pattern performing the log action.
• log-error — Log the given message with an error level message. The log messages that are output automatically include the name of the pattern performing the log action.
• log-critical — Log the given message with a critical level message. The log messages that are output automatically include the name of the pattern performing the log action.

Text functions

• text-lower — Returns the lower-cased version of the string argument.
• text-upper — Returns the upper-cased version of the string argument.
• text-toNumber — Converts its string argument into a number.
• text-replace — Returns a modified version of the string formed by replacing all occurrences of the string old with new.
• text-join — Returns a string containing all items in a list of strings joined with the specified separator.
• text-split — Returns a list consisting of portions of the string split according to the separator string, where specified.
• text-strip — Strips unwanted characters from the start and end of the given string.
• text-leftStrip — Equivalent to text.strip, but only strips from the left side of the string.
• text-rightStrip — Equivalent to text.strip, but only strips from the right side of the string.
• text-hash — Returns a hashed form of the string, generated with the MD5 hash algorithm.
• text-ordinal — Returns the ordinal value of the string argument.

Number functions

• number-toChar — Converts the integer number in the ASCII range to a character.
• number-toText — Converts the integer number to a text form.
• number-range — Generate a list containing 0 to number - 1.

Regex functions

• regex-extract — Returns the result of extracting the regular expression from the string, optionally with a substitution expression and a specified result if no match is found.
• regex-extractAll — Returns a list containing all the non-overlapping matches of the pattern in the string.
• regex-replace — Return a string with all non-overlapping matches of pattern replaced by replacement. If count is non-zero, then count number of replacements are made, unless fewer replacements are required in the string.
• regex-escape — Returns a string with regex special characters suitably escaped.

XPath functions

• xpath-openDocument — Returns the DOM object resulting from parsing the XML string.
• xpath-evaluate — Returns the result of evaluating the XPath expression against the XML string, or document returned from xpath.openDocument().
• xpath-closeDocument — Closes the DOM object resulting from xpath.openDocument.

Table functions

• table — Creates a new table.
• table-remove — Removes the specified key from the specified table.
• table-get — Returns the key from table if it exists, or if it does not exist, returns the specified default_val.
• table-keys — Returns a list of the keys in the table.
• table-values — Returns a list of the values in the table.
• table-items — Returns a list of two-element lists, where each sub-list is a pair of key,value.

Discovery functions

• Discovery-action-functions
  • discovery-fileGet — Retrieves the specified file.
  • discovery-fileInfo — Retrieves information about the specified file, but not the file content.
  • discovery-getNames — Performs a DNS lookup on the IP address and returns a list of FQDN strings. Finds the DiscoveryAccess from the target node and attaches the list of FQDNs to it.
  • discovery-lookupAddresses — Performs a DNS lookup on the supplied DNS resolvable name and returns a list of IP addresses. Finds the DiscoveryAccess from the target node and attaches the list of IP addresses to it.
  • discovery-listDirectory — Retrieves the directory listing of the directory specified by the path on the specified target.
  • discovery-listRegistry — Returns a list of the registry entries of the registry key specified by the key_path.
  • discovery-registryKey — Retrieves a registry key from a Windows computer.
  • discovery-wmiQuery — Performs a WMI query on a Windows computer.
  • discovery-wbemQuery — Performs a WBEM query on the target and returns a list of DiscoveredWBEM DDD nodes.
  • discovery-wbemEnumInstances — Performs a WBEM query on the target and returns a list of DiscoveredWBEMInstance DDD nodes.
  • discovery-runCommand — Returns a DiscoveredCommandResult node containing the result of running the specified command.
  • discovery-runPowerShell — Returns a DiscoveredCommandResult node containing the result of running the specified PowerShell script.
  • Future-runCommand — Returns a DiscoveredCommandResult node containing the result of running the specified command. Enables command paths to be restricted.
  • discovery-snmpGet — Performs an SNMP query on the target and returns a DiscoveredSNMP node.
  • discovery-snmpGetTable — Performs an SNMP query that returns a table on the target.
  • discovery-vSphereFindObjects — Queries to search from the root folder the instances of an object type and returns the requested properties for each object found.
  • discovery-vSphereTraverseToObjects — Queries to traverse from the initial object to instances of an object type and get properties on those objects.
  • discovery-vSphereGetProperties — Queries to retrieve properties from a given MOR and returns the requested properties for each object found.
  • discovery-vSphereGetPropertyTable — Queries to retrieve a table of values from a given MOR and is intended to be used to retrieve nested properties from lists and arrays. The query returns multiple NodeState objects, one for each DataObject in the list or array.
  • discovery-scan — Adds an open scan for the given target and returns a count of the number of endpoints included in the open scan.
  • Discovery-cloud-provider-requests — A set of discovery functions which query the cloud provider API, for information about the target discovered using the specified DiscoveryAccess and optional parameters. They each return a list depending on the request made.
• Discovery-restful-functions
  • discovery-restfulGet — This function performs a GET request on the target using the specified RESTful protocol and returns a node containing information about the discovered system.
  • discovery-restfulPost — Performs a POST request on the target using the RESTful system and returns a node containing information on the discovered system.
  • discovery-restfulDelete — Performs a delete request on the target using the RESTful protocol specified and returns a node containing information on the discovered system.
  • discovery-restfulPatch — Performs a patch request on the target using the RESTful protocol specified and returns a node containing information on the discovered system.
  • discovery-restfulPut — Performs a put request on the target using the RESTful protocol specified and returns a node containing information on the discovered system.
  • discovery-dataSource — Specifies a data source to use in a pattern. Data sources are a specialized type of credential providing a mechanism to access the target.
  • discovery-sqlQuery — Performs an SQL query on a relational database, returning a list of SQLResultRow nodes.
  • discovery-getCertificate — Retrieves a TLS certificate from the specified discovery target.
• Discovery-data-manipulation-functions
  • discovery-process — Returns the process node corresponding to the source node, which must be a ListeningPort or NetworkConnection node.
  • discovery-children — Returns a list of the child processes for the given DiscoveredProcess node.
  • discovery-descendents — Returns a list consisting of the children of the given DiscoveredProcess node, and recursively all of the children's children.
  • discovery-parent — Returns the parent process for the given DiscoveredProcess node.
  • discovery-allProcesses — Returns a list of all processes corresponding to the directly discovered data source node.
  • discovery-access — Returns the Discovery Access node for the source DDD node, if given. If no node is given, it returns the DiscoveryAccess currently in use.
  • discovery-startTime — Returns the start time of the scan which discovered the source DDD node. If no source DDD node is given, it returns the start time of the DiscoveryAccess currently in use.

Binary functions

• binary-toHexString — Returns the given binary value as a hex string, that is, two hex digits per byte.
• binary-toIPv4 — Returns the given binary value as the text representation of an IPv4 address.
• binary-toIPv4z — Returns the given binary value as the text representation of an IPv4 address with a zone index.
• binary-toIPv6 — Returns the given binary value as the text representation of a canonical IPv6 address.
• binary-toIPv6z — Returns the given binary value as the text representation of a canonical IPv6 address with zone index.
• binary-toMACAddress — Returns the given binary value as the text representation of a MAC address.
• binary-toValue — Converts the given binary value into the specified format.
• binary-toWWN — Returns the given binary value as the text representation of a WWN value.

JSON functions

• json-encode — Converts value to a JSON encoded string. Where value is a string, table, or a list including nested structures.
• json-decode — Decodes a JSON encoded string and returns a structure containing a number, boolean, null, string, table or list including nested structures.
• jmespath-evaluate — Returns the https://jmespath.org/ evaluation for the expression given a source table or list.

List functions

• list — Builds an empty list.
• list-append — Appends an item to a specified list.
• list-sorted — Returns a sorted copy of items list, leaving the items unchanged. If reverse is true, sorts in reverse order.

Model functions

• model-addContainment — Adds the containees to the container by creating suitable relationships between the nodes.
• model-setContainment — Equivalent to addContainment, except unconfirmed relationships are removed at the end of the pattern body
• model-destroy — Destroy the specified node or relationship in the model.
• model-withdraw — Removes the named attribute from the node.
• model-setRemovalGroup — Add the specified node or nodes to a named removal group.
• model-anchorRemovalGroup — Specify an anchor node for a named removal group.
• model-suppressRemovalGroup — Suppress removal of the named removal group.
• model-host — Returns the Host node corresponding to the given node.
• model-hosts — Returns a list of all the Host nodes corresponding to the given node.
• model-findPackages — Traverses from the node, which must be a Host or a directly discovered data node, and returns a set of all Package nodes that have names matching the provided list of regular expressions.
• model-addDisplayAttribute — Adds a named attribute, or a list of named attributes to the additional attributes displayed in a node view.
• model-removeDisplayAttribute — Removes a named attribute, or a list of named attributes from the additional attributes displayed in a node view.
• model-kind — Returns the node kind corresponding to the given node.
• model-confirm — Sends a confirmed event for the node.
• model-findCandidate — Finds a candidate node of a kind that matches table data.
• model-findCandidates — Finds ranked candidates.
• model-publish — Takes a node of kind ModelDefinition and publishes it, creating a BusinessService, TechnicalService or BusinessApplicationInstance node. If the model is already published, updates the existing published node.
• model-unpublish — Takes a node of kind ModelDefinition that has been published, and unpublishes it by destroying the published BusinessService, TechnicalService or BusinessApplicationInstance node.

Related functions

• related-detailContainer — Returns the Software Component, Software Instance, or Business Application Instance node containing the given node.
• related-host — Returns the Host node corresponding to the given node.
• related-hostingNode — Returns a Host or Cluster node that is associated with the node that triggered the pattern.

Email functions

• mail-send — Sends an email.

Time functions

• time-current — Returns an internal datetime object representing the current UTC time.
• time-delta — Creates a time delta that can be added to or subtracted from a time represented by an internal datetime object.
• time-parseLocal — Converts a string representing a local time into an internal UTC datetime object. If no time zone is present in the string it will use the time zone of the appliance.
• time-parseUTC — Takes a UTC time string and converts it into an internal datetime object. It is not adjusted for time zones or daylight saving time.
• time-formatLocal — Formats an internal datetime object into a human-readable string.
• time-formatUTC — Formats an internal datetime object into a human-readable string.
• time-toTicks — Converts an internal datatime object (UTC) to ticks.
• time-fromTicks — Converts ticks to an internal datetime object (UTC).
• time-deltaFromTicks — Converts ticks into a time delta.

Inference functions

• inference-associate — Create associate inference relationship(s) from the specified node(s) to the inferred node.
• inference-contributor — Create contributor inference relationship(s) from the specified node(s) to the inferred node, for attribute names specified in the contributes list.
• inference-primary — Create or replace primary inference relationship(s) from the specified node(s) to the inferred node.
• inference-relation — Create relation inference relationship(s) from the specified node(s) to the inferred relationship.
• inference-withdrawal — Create withdrawal inference relationship(s) from the specified node(s) to the inferred node, indicating the withdrawal of the withdrawn attribute name.
• inference-destruction — When destroying a node, indicate that the source node was responsible for its destruction.

System functions

• system-getOption — Takes the name of a BMC Discovery system option and returns the value.
• system-cmdbSync — Adds the given root node or list of root nodes to the CMDB synchronization queue for all sync connections where continuous synchronization is enabled.