System maintenance

Functionality related to some dynamically-generated reports and lists may be affected as testing continues throughout the week.

 
 



This documentation refers to a previously released version of BMC Discovery.
See the information on this topic for the latest version (11.2) or version 11.1.

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

Global scope functions

  • sizeReturns the number of items in the collection, where the collection is a list, or a set of nodes retrieved with a search expression.

Log functions

  • log.debugLog the given message with a debug level message. The log messages that are output automatically include the name of the pattern performing the log action.
  • log.infoLog 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.warnLog 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.errorLog 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.criticalLog 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.lowerReturns the lower-cased version of the string argument.
  • text.upperReturns the upper-cased version of the string argument.
  • text.toNumberConverts its string argument into a number.
  • text.replaceReturns a modified version of the string formed by replacing all occurrences of the string old with new.
  • text.joinReturns a string containing all items in a list of strings joined with the specified separator.
  • text.splitReturns a list consisting of portions of the string split according to the separator string, where specified.
  • text.stripStrips unwanted characters from the start and end of the given string.
  • text.leftStripEquivalent to text.strip, but only strips from the left side of the string.
  • text.rightStripEquivalent to text.strip, but only strips from the right side of the string.
  • text.hashReturns a hashed form of the string, generated with the MD5 hash algorithm.
  • text.ordinalReturns the ordinal value of the string argument.

Number functions

  • number.toCharConverts the integer number in the ASCII range to a character.
  • number.toTextConverts the integer number to a text form.
  • number.rangeGenerate a list containing 0 to number - 1.

Regex functions

  • regex.extractReturns 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.extractAllReturns a list containing all the non-overlapping matches of the pattern in the string.

XPath functions

  • xpath.evaluateReturns the result of evaluating the xpath expression against the XML string.
  • xpath.openDocumentReturns the DOM object resulting from parsing the XML string.
  • xpath.closeDocumentCloses the DOM object resulting from xpath.openDocument.

Table functions

  • tableCreates a new table.
  • table.removeRemoves the specified key from the specified table.

Discovery functions

  • Discovery action functions
    • discovery.fileGetRetrieves the specified file.
    • discovery.fileInfoRetrieves information about the specified file, but not the file content.
    • discovery.getNamesPerforms 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.listDirectoryRetrieves the directory listing of the directory specified by the path on the specified target.
    • discovery.listRegistryReturns a list of the registry entries of the registry key specified by the key_path.
    • discovery.registryKeyRetrieves a registry key from a Windows computer.
    • discovery.wmiQueryPerforms a WMI query on a Windows computer.
    • discovery.wbemQueryPerforms a WBEM query on the target and returns a list of DiscoveredWBEM DDD nodes.
    • discovery.wbemEnumInstancesPerforms a WBEM query on the target and returns a list of DiscoveredWBEMInstance DDD nodes.
    • discovery.runCommandReturns a DiscoveredCommandResult node containing the result of running the specified command.
    • discovery.snmpGetPerforms an SNMP query on the target and returns a DiscoveredSNMP node.
    • discovery.snmpGetTablePerforms an SNMP query that returns a table on the target.
    • discovery.restfulGetPerforms a GET request on the target using the RESTful protocol specified and returns a node containing information on the discovered system.
    • discovery.restfulPostPerforms a POST request on the target using the RESTful system and returns a node containing information on the discovered system.
    • discovery.vSphereFindObjectsQueries to search from the root folder the instances of an object type and returns the requested properties for each object found.
    • discovery.vSphereTraverseToObjectsQueries to traverse from the initial object to instances of an object type and get properties on those objects.
    • discovery.vSphereGetPropertiesQueries to retrieve properties from a given MOR and returns the requested properties for each object found.
    • discovery.vSphereGetPropertyTableQueries 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 data manipulation functions
    • discovery.processReturns the process node corresponding to the source node, which must be a ListeningPort or NetworkConnection node.
    • discovery.childrenReturns a list of the child processes for the given DiscoveredProcess node.
    • discovery.descendentsReturns a list consisting of the children of the given DiscoveredProcess node, and recursively all of the children's children.
    • discovery.parentReturns the parent process for the given DiscoveredProcess node.
    • discovery.allProcessesReturns a list of all processes corresponding to the directly discovered data source node.
    • discovery.accessReturns the Discovery Access node for the source DDD node, if given. If no node is given, it returns the DiscoveryAccess currently in use.

Binary functions

  • binary.toHexStringReturns the given binary value as a hex string, that is, two hex digits per byte.
  • binary.toIPv4Returns the given binary value as the text representation of an IPv4 address.
  • binary.toIPv4zReturns the given binary value as the text representation of an IPv4 address with a zone index.
  • binary.toIPv6Returns the given binary value as the text representation of a canonical IPv6 address.
  • binary.toIPv6zReturns the given binary value as the text representation of a canonical IPv6 address with zone index.
  • binary.toMACAddressReturns the given binary value as the text representation of a MAC address.
  • binary.toValueConverts the given binary value into the specified format.
  • binary.toWWNReturns the given binary value as the text representation of a WWN value.

JSON functions

  • json.encodeConverts value to a JSON encoded string. Where value is a string, table, or a list including nested structures.
  • json.decodeDecodes a JSON encoded string and returns a structure containing a string, table or list including nested structures. 

Model functions

  • model.addContainmentAdds the containees to the container by creating suitable relationships between the nodes.
  • model.setContainmentEquivalent to addContainment, except unconfirmed relationships are removed at the end of the pattern body
  • model.destroyDestroy the specified node or relationship in the model.
  • model.withdrawRemoves the named attribute from the node.
  • model.setRemovalGroupAdd the specified node or nodes to a named removal group.
  • model.anchorRemovalGroupSpecify an anchor node for a named removal group.
  • model.suppressRemovalGroupSuppress removal of the named removal group.
  • model.hostReturns the Host node corresponding to the given node.
  • model.hostsReturns a list of all the Host nodes corresponding to the given node.
  • model.findPackagesTraverses 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.addDisplayAttributeAdds a named attribute, or a list of named attributes to the additional attributes displayed in a node view.
  • model.removeDisplayAttributeRemoves a named attribute, or a list of named attributes from the additional attributes displayed in a node view.
  • model.kindReturns the node kind corresponding to the given node.

Related functions

  • related.detailContainerReturns the Software Component, Software Instance, or Business Application Instance node containing the given node.
  • related.hostReturns the Host node corresponding to the given node.
  • related.hostingNodeReturns a Host or Cluster node that is associated with the node that triggered the pattern.

Email functions

Time functions

  • time.currentReturns the current time in the internal TPL time format.
  • time.deltaCreates a time delta that can be added to or subtracted from a time. Uses the internal TPL time format. 
  • time.parseLocalThe time is converted according to the appliance's time zone and daylight saving setting.
  • time.parseUTCThe time is assumed to already be UTC, and is not adjusted for timezones or daylight saving time.
  • time.formatLocalFormats a time into a human-readable string.
  • time.formatUTCFormats a time into a human-readable string.
  • time.toTicksConverts a time or time delta into the DCE ticks format.
  • time.fromTicksConverts DCE ticks into a time.

Inference functions

  • inference.associateCreate associate inference relationship(s) from the specified node(s) to the inferred node.
  • inference.contributorCreate contributor inference relationship(s) from the specified node(s) to the inferred node, for attribute names specified in the contributes list.
  • inference.primaryCreate primary inference relationship(s) from the specified node(s) to the inferred node.
  • inference.relationCreate relation inference relationship(s) from the specified node(s) to the inferred relationship.
  • inference.withdrawalCreate withdrawal inference relationship(s) from the specified node(s) to the inferred node, indicating the withdrawal of the withdrawn attribute name.
  • inference.destructionWhen destroying a node, indicate that the source node was responsible for its destruction.

System functions

  • system.getOptionTakes the name of a BMC Discovery system option and returns the value.
Was this page helpful? Yes No Submitting... Thank you
  • No labels