Machine Syntax Reference


Actions

Arguments in square brackets are optional.

Action Name Description
bookmark(int, [overwrite:bool]) Bookmarks an entity.
clearBookmark()  Removes the entity’s bookmark.
delete([parents: int], [children int]) Deletes the selected entities from the graph.
deleteBranch() Deletes entities and their children.
exportImage(String path, [suffix:bool], [dateFormat:String]) Exports the graph as a PNG file to the given location. Default date format: Default is yyyyMMdd-HHmmssSSS. 
log(String msg, [status:String], [showEntities: bool]) Prints the given text in the machine run window.
run(String transformID, [slider:int],[ignoreSeenEntities:bool], [(transformSetting) key:String]) Runs a transform.
saveAs(String Path, [suffix:bool], [dateFormat:String]) Saves the current graph to a file. Default date format: Default is yyyyMMdd-HHmmssSSS. 
setLayout(String Layout , [scope:String] )

Sets the current layout mode and performs a layout of the graph. 

  • Available layouts: Block, Organic, Circular, Hierarchical, Interactive Organic
  • Available Scopes: global, local
status(String msg) Updates the status in the Machine Run Window.
userFilter(String Title, [description:String], [icon:String ], [heading:String ], [proceedButtonText:String],[removePromptText:String], [removePromptChecked:Boolean],[selectEntities:Boolean], [showIncomingLinks:Boolean],[showOutgoingLinks:Boolean]) Shows a user filter to allow the user to make a manual selection.

Filters

Arguments in square brackets are optional.

Filter Name

Description

value(String Value, [Like:String], [ignoreCase:boolean], [equalTo:boolean]) Filters entities based on their value.
type(String Value, [scope:String])

Filters entites based on their type.

  • Available Scopes: global, local
age(int Value, [equalTo:int], [moreThan:int], [lessThan:int], [invert:Boolean], [scope:String])

Filters entities based on their age on the graph as measured in seconds since their first appearance.

  • Available Scopes: global, local
bookmarked([int], [invert:Boolean], [scope:String])

Matches entities based on their bookmark.

  • Available Scopes: global, local
degree(int Value, [equalTo:int], [moreThan:int], [lessThan:int], [invert:Boolean], [scope:String])

Filters entities based on the number of links. 

  • Available Scopes: global, local
incoming(int Value, [equalTo:int], [moreThan:int], [lessThan:int], [invert:Boolean], [scope:String])

Filters entities based on the number of incoming links. 

  • Available Scopes: global, local
outgoing(int Value, [equalTo:int], [moreThan:int], [lessThan:int], [invert:Boolean], [scope:String]) 

Filters entities based on the number of outgoing links.

  • Available Scopes: global, local
property(String title, [equalTo:int],[like:String], [ignoreCase:Boolean, [invert:Boolean], [scope:String])

Filters entities based on the value of a property.

  • Available Scopes: global, local

 

Run a Machine from the Commandline

  maltego --machine “<name> <entity type>=<entity value>”

Options:

  • -f  Full screen
  • -q  Exit Maltego after machine completion
  • -i#  Run perpetual machine # for iterations
Continue to the MDS Reference page.



© Copyright 2017, Paterva PTY Limited