netbrain.sysapi.AAM Namespace Reference

Classes
class	PathTemplate

Functions
def	get_segment_path_title (segmengt_path)
def	get_branch_list_on_segment_path (segmengt_path)
def	get_hops_list_on_branch (branch)
def	get_failed_reason_on_branch (branch)
def	get_branch_status (branch)
def	is_this_branch_failed (branch)
def	get_failed_hop_on_branch (branch)
def	get_pathapp_ids (aams, golden=False)
def	GetAllAAM ()
	get all aams in current domain More...
def	GetAAM (aamName)
	get aam with specified name in current domain More...
def	GetPathAppIds (path_template_name, aam_name)
	get pathapplication id list in current domain with specified path name More...
def	GetPathOverViews (paIds)
	get path overviews in current domain with specified path application ids More...
def	ExportAAM (golden=False)
	Export AAM results in current domain. More...
def	AddPathToAAM (path_template, aam_name="Untitled Application")
	Insert or update a new path to aam please make sure aam_name has been created. More...

Variables
	str_stack = traceback.format_exc();

Function Documentation

AddPathToAAM()

def netbrain.sysapi.AAM.AddPathToAAM	(		path_template,
			aam_name = "Untitled Application"
	)

Insert or update a new path to aam please make sure aam_name has been created.

Parameters

aam_name	the name of aam
path_template	path templates should added/updated to this aam.

Returns

True if success else false

ExportAAM()

def netbrain.sysapi.AAM.ExportAAM

(

golden = False

)

Export AAM results in current domain.

Parameters

golden

(bool), export golden path or latest path

Returns

aam results, see document: https://confluence.netbraintech.com/confluence/display/SDU/8.01+Export+AAM+Result+Python+API

get_branch_list_on_segment_path()

def netbrain.sysapi.AAM.get_branch_list_on_segment_path

(

segmengt_path

)

get_branch_status()

def netbrain.sysapi.AAM.get_branch_status

(

branch

)

get_failed_hop_on_branch()

def netbrain.sysapi.AAM.get_failed_hop_on_branch

(

branch

)

get_failed_reason_on_branch()

def netbrain.sysapi.AAM.get_failed_reason_on_branch

(

branch

)

get_hops_list_on_branch()

def netbrain.sysapi.AAM.get_hops_list_on_branch

(

branch

)

get_pathapp_ids()

def netbrain.sysapi.AAM.get_pathapp_ids	(		aams,
			golden = False
	)

get_segment_path_title()

def netbrain.sysapi.AAM.get_segment_path_title

(

segmengt_path

)

GetAAM()

def netbrain.sysapi.AAM.GetAAM

(

aamName

)

get aam with specified name in current domain

Parameters

aamName

(string), name of one aam

Returns

aam

Return values

{	"aam_name": "Untitled Application", "golden_paId": "", "latest_paId": "bd3ace71-7eee-4569-b537-f43d8146d2aa", "path_template_name": "222" }

GetAllAAM()

def netbrain.sysapi.AAM.GetAllAAM

(

)

get all aams in current domain

Returns

list of aams

Return values

[	{ "aam_name": "Untitled Application", "golden_paId": "", "latest_paId": "bd3ace71-7eee-4569-b537-f43d8146d2aa", "path_template_name": "222" } ]

GetPathAppIds()

def netbrain.sysapi.AAM.GetPathAppIds	(		path_template_name,
			aam_name
	)

get pathapplication id list in current domain with specified path name

Parameters

path_template_name	(string), name of path
aam_name	(string), name of aam

Returns

id list of pathapplication

Return values

['xxxx','cccccccc']

GetPathOverViews()

def netbrain.sysapi.AAM.GetPathOverViews

(

paIds

)

get path overviews in current domain with specified path application ids

Parameters

paIds

(list of string), path application ids

Returns

path overviews https://confluence.netbraintech.com/confluence/display/SDU/8.01+Export+AAM+Result+Python+API

is_this_branch_failed()

def netbrain.sysapi.AAM.is_this_branch_failed

(

branch

)

Variable Documentation

str_stack

netbrain.sysapi.AAM.str_stack = traceback.format_exc();