Variables¶

The following variables are accessible from templates:

Functions¶

The following functions are accessible from templates:

find(pattern, nodes=True, systems=False, full_match=False)¶

Find nodes and/or systems matching the given search pattern.

Parameters:	pattern – Regular expression node path pattern nodes – Returns nodes if True systems – Returns systems if True full_match – Require full regexp match instead of default sub-string match
Return type:	generator object returning Node objects

Example usage:

#for $node in $find("webshop/frontend")
  $node.name has address $node.host
#end for

find_config(pattern, all_configs=False, full_match=False)¶

Find configs matching given pattern.

A double-backslash combination in the pattern signifies “anything”, i.e. //foo will find all foo configs in the entire system and bar//baz will find all baz configs under the bar system.

Parameters:	pattern – Regular expression config path pattern. all_configs – Returns also inherited configs if True full_match – Require full regexp match instead of default sub-string match
Return type:	generator object returning (node, config) pairs

Example usage:

# find all "http-server" configs under the entire "webshop" system:
#for $node, $conf in $find_config("webshop//http-server", all_configs=True)
  $node.name has $conf.name at port $conf.settings.server_port
#end for

get_node(pattern)¶

Return exactly one node that matches the pattern. An error is raise if zero or more than one nodes match the pattern.

Parameters:	pattern – Regular expression node path pattern.
Return type:	Node object

get_system(pattern)¶

Return exactly one system that matches the pattern. An error is raise if zero or more than one systems match the pattern.

Parameters:	pattern – Regular expression system path pattern.
Return type:	System object

get_config(pattern)¶

Return exactly one config that matches the pattern. An error is raise if zero or more than one configs match the pattern.

Parameters:	pattern – Regular expression system/node/config path pattern.
Return type:	Config object

edge(bucket_name, dest_node, dest_config, **kwargs)¶

Add a directed graph edge as a dict object into a bucket. This can be used to, for example, automatically collect information about network connections between nodes.

Parameters:	bucket_name (string) – Bucket name dest_node (poni.core.Node) – Edge destination node dest_config (poni.core.Config) – Edge destination config kwargs – Extra information to store in the dict object

Example usage:

#for $db_node, $db_config in $find_config("webshop//pg84")
  $edge("tcp", $db_node, $db_config, protocol="sql", port=$db_config.settings.db_server_port)#slurp
#end for

bucket(bucket_name)¶

Return a bucket object for accessing dynamically collected data during the template rendering process.

Parameters:	bucket_name (string) – Bucket name
Return type:	list object

NOTE: Accessing buckets from templates should be done only after all other templates are rendered so that all dynamic data is collected. This can be achieved by giving the extra report=True argument to the poni.core.PlugIn add_file() call.

Example usage:

#for $item in $bucket("tcp")
Node $item.source_node.name config $item.source_config.name connects to:
  $item.dest_node:$item.port for some $item.protocol action...
#end for

Registering the template to be processed after all regular templates:

class PlugIn(config.PlugIn):
    def add_actions(self):
        self.add_file("node-report.txt", dest_path="/tmp/", report=True)