FID YAML Assets

Property Name

Type

Required

Definition

name

string

Y

Flash name

display_name

string

N

It shows in IE Probe Flash UI. The default is the same with the name parameter.

description

string

N

The flash probe description

target_type

enum

N

There are 2 target types:

•Device(default)

•Interface

target_interface

string

N

If the target type is Interface, this parameter is available. It also references the feature variable as the value, such as $IntfName.

qualification

string

N

The qualification of the flash probe. It can use the GDR variable or feature variable as a condition, such as :$device.subTypeName=="Cisco Router" && $intf.name!="e0" && $intf.xxx=="xx"

It supports device GDR attribute and physical interface GDR attribute.

See Qualification Properties and Condition

conflict_mode

string

N

Override or Skip(default)

type

string

N

Primary(default), Secondary and External are supported.

trigger_type

string

N

This parameter is valid if the type parameter is Primary. It supports AlertBased (default)and TimerBased.

alert_source

string

N

This parameter is valid if the type parameter is External, such as 'ServiceNow'.

frequency_multiple

int

Y

Multiple of the period of the base frequency.

It is valid for target_type=Device&&type=Primary&&trigger_type=TimerBased

variables_defines

object

N

It may be used in rule or alert_message. It is valid for type=Primary|Secondary&&trigger_type=AlertBased.

variables_defines.parser

list

N

Parser path

variable_defines.parameters.{var1}

string

N

The parser parameter variable,and {var1} is the variable name.

variable_defines.variables

object

N

The variables to be used in rule or alert_message

variable_defines.variables.name

string

N

The variable of the parser full name

variable_defines.variables.alias

string

N

The alias actually used when referenced in rule and alert_Message, same as 'name' if alias has no value.

variable_defines.varaibles.monitor

object

N

It indicates that this variable needs to be monitored.

variable_defines.varaibles.monitor.display_name

string

N

Display the name which shows up on the map data view.

variable_defines.varaibles.monitor.unit

string

N

As a variable unit and shows up on the map data view.

variable_defines.compound_variable

object

N

The compound variable name, and defining multiple compound variables is supported.

variable_defines.compound_variable.expression

string

N

Define the compound variable expression such as $var > 0 and $var2 !=None.

rule

object

N

Define rule for the flash probe . It is valid for type=Primary|Secondary&&trigger_type=AlertBased

rule.loop_table_rows

bool

N

The default is true.

It will be set as true if the variable is the table.

rule.conditions

object

N

The rule condition

rule.conditions.operand1

string

N

rule.conditions.operator

object

N

The rule condition operator expression, such as Equal, Not Equal.

It supports dynamic GB rule as well.

rule.conditions.operand2

string

N

rule.conditions.boolean_expression

string

N

The rule bool expression

alert_message

string

N

The alert message, which supports variable input such as $status.

It is valid for type=Primary|Secondary&&trigger_type=AlertBased.

triggered_by

object

N

The triggered flash probe list  

It is valid for type=Secondary&&trigger_type=AlertBased.

triggered_by.name

string

N

The triggered flash probe name

triggered_by.target_type

string

N

Device#Device or SameLevel（default)

enable

bool

N

Whether to enable the flash probe being created or not

The default is true.

send_mail

object

N

Setting email content for flash probe.

send_mail.enable

bool

N

The default is true when there is the send_email tag and at least one valid email address is filled in.

emails

list

N

The email address list

trigger_event_template

string

N

The name of the event template to be triggered when sending an email .

Property Name

Type

Required

Definition

path

string

Y

The path to generate the Network Intent.

Only use the crossRelationHash variable here.

conflict_mode

string

N

Skip(default) or Override

Verify if the asset being created already existed.

create_default_NI

bool

N

Whether to create the Default Network Intent for the FIG.

 The default value is false.

The parameter is valid if the the Network Intent template does not exist or None

lock_after_created

bool

N

Lock the created Network Intent.

The default value is false.

cli_baseline_update_type

string

N

LatestFromDE(compared to the time of running FID) or LiveFromNextRun,

The default value is LatestFromDE.

ni_template

string

N

The relative path of the Network Intent Template file.

The NI will be generated from the Network Intent Template when create_default_NI=false.

ni_inputs

object

N

Devices included in the Network Intent.

ni_inputs.devices.R1

string

N

Satisfy R1 condition.

ni_inputs.devices.R1.device_condition

string

N

FIG Device to NI Device Mapping condition.

ni_inputs.devices.R1.parameter

string

N

Property Name

Type

Required

Definition

description

string

N

The triggered automation description

automation

object

Y

Include the NI definition.

Supports to reference current YAML created NI.

automation.network_intents

list

Y

References the NI path.

Supports multiple NIs.

auto_append_created_NI.auto_append_created_NI

bool

N

Whether to automatically add the created NI by this FID

The default is true.

triggered_by_flash_probes

list object

Y

The triggered Flash Probe list.

triggered_by_flash_probes.name

string

Y

The Flash probe name

triggered_by_flash_probes.qualification

string

N

The qualification can use the GDR variable or feature variable as a condition, such as :$device.subTypeName=="Cisco Router" && $intf.name!="e0" && $intf.xxx=="xx"

It supports device GDR attribute and physical interface GDR attribute.

triggered_by_flash_probes.note_on_decision_tree

string

N

A note displayed on decision tree

triggered_by_flash_probes.playbook_tags

list

N

The playbook tags for decision tree, such as [BGP,]

triggered_by_flash_probes.trigger_rule

object

Y

The Trigger rule definition

triggered_by_flash_probes.trigger_rule.run_type

string

Y

Once or Continuously

triggered_by_flash_probes.trigger_rule.frequency

object

Y

The run frequency for Continuously

triggered_by_flash_probes.trigger_rule.frequency.interval

int

Y

The unit is minute.

triggered_by_flash_probes.trigger_rule.frequency.times

int

Y

Repeat run times.

triggered_by_flash_probes.trigger_rule.suppression

object

N

The unit is minute.

triggered_by_flash_probes.trigger_rule.suppression.enable

bool

N

triggered_by_flash_probes.trigger_rule.suppression.wont_run_twice_within

string

N

conflict_mode

string

N

To verify if the triggered automation has a conflict.  

Override or Skip (default)

enable

bool

N

Boolean value:

true (default) or false

send_mail

object

N

Setting email content.

send_mail.enable

bool

N

The default is true when there is the send_email tag and at least one valid email address is filled in.

emails

list

N

The email address list

trigger_event_template

string

N

The name of the event template to be triggered when an email is sent.

Property Name

Type

Required

Definition

automation

object

Y

Recommend automation object .

It includes NI, DVT, Qapp, Runbook Template, and CLI Command.

description

string

N

automation.network_intents

list

N

Add the NI path.

It  supports multiple NI

automation.runbook_templates

list

N

Add the Runbook Template path.

It supports multiple Runbook Template.

automation.commands

list

N

Add the CLI command.

It supports multiple CLI commands.

automation.auto_append_created_NI

bool

N

Whether to automatically add the created NI by this FID

The default is false.

automation.auto_append_created_RBT

bool

N

Whether to automatically add the created RBT by this FID

The default is false.

automation.auto_append_feature_commands

bool

N

Append the feature CLI command.

The default is false.

recommended_by_flash_probes

list

N

The triggered Flash Probe list.

recommended_by_flash_probes.name

string

N

The Flash probe name can contain variables.

recommended_by_flash_probes.alert_type

string

N

NetBrain or External

recommended_by_flash_probes.qulification

string

N

The qualification

It can use the GDR variable or feature variable as a condition, such as :$device.subTypeName=="Cisco Router" && $intf.name!="e0" && $intf.xxx=="xx"

It supports device GDR attribute and physical interface GDR attribute.

recommended_by_flash_probes.note_on_decision_tree

string

N

A note displayed on decision tree

recommended_by_flash_probes.playbooks

list

N

The playbook tags are for decision tree, such as [BGP,].

recommended_by_devices

list

N

The recommend target devices

recommended_by_devices.qualification

string

N

The qualification can use the GDR variable or feature variable as a condition, such as :$device.subTypeName=="Cisco Router" && $intf.name!="e0" && $intf.xxx=="xx"

It supports device GDR attribute and physical interface GDR attribute.

recommended_by_devices.note_on_decision_tree

string

N

A note displayed on decision tree

recommended_by_devices.playbooks

list

N

The playbook tags are for decision tree, such as [BGP,].

recommended_by_hypotheses

string

N

Create the hypotheses property.

recommended_by_hypotheses.qualification

object

N

recommended_by_hypotheses.note_on_decision_tree

string

N

recommended_by_hypotheses.playbooks

list

N

conflict_mode

string

N

Verify if the recommended automation has a conflict.

Support values: Override or  Skip(default)

enable

bool

N

Boolean value:

true(default) or false

Property Name

Type

Required

Definition

path

string

Y

The Data View Template full path

node_type

enum

N

In current version, node_type only supports Legacy.

In the future, we will consider more node type:

•Fabric Node.

•EPG

•Bridge Domain

•VRF

•L2Out

•L3Out

•Contract

•Cluster Virtual Standard Switch

•Virtual Standard Switch

•Vmware Distributed Virtual Switch

etc.

drill_down_actions

object

N

In current version, we only support :

•Execute CLI Commands.

•Runbook Template.

drill_down_actions.commands

list - string

N

Show commands.

drill_down_actions.runbook_templates

list - string

N

The Runbook template full path.

filter_criteria

object

N

Filter Criteria, see https://www.netbraintech.com/docs/ie80/help/index.html?advanced-search.htm#dynamic-search

filter_criteria.device_types

list - string

N

Device Type name list:

•Cisco IOS Switch

•Cisco Router

For all device types, please see Device Type Name

filter_criteria.feature_names

string

N

Match with GDR property: "_nb_features"

device_positions

object

N

device_positions.parser

string

N

The parser path

device_positions.variable

string

N

The variable name

device_positions.index

enum

N

The data view position: 0, 1, 2 or 3, ...19.

interface_positions

object

N

interface_positions.interface_type

enum

N

•IPv4 Interface

•Interface

•IPv6 Interface

•IPsec VPN Interface

•GRE VPN Interface

interface_positions.positions

object

N

interface_positions.positions.parser

string

N

The parser path

interface_positions.positions.variable

string

N

The variable name

interface_positions.positions.index

enum

N

The data view position: 0, 1, 2 or 3, ...23.

Property Name

Type

Required

Definition

parser

string

Y

The parser path

variable

string

Y

The variable name

enable_dynamic

bool

N

Boolean value:

true(default) or false

Property Name

Type

Required

Definition

command

string

Y

Show the  command.

frequency_type

enum

N

High, Medium or Low(default)

description

string

N

Describe the scheduled command.

playbook_tags

list-string

N

The Playbook tags

enable

bool

N

Boolean value:

true(default) or false

conflict_mode

enum

N

Override or Skip(default)

Property Name

Type

Required

Definition

name

string

Y

The schedule task name

auto_append_created_DVT

bool

N

Boolean value:

true or false(default)

dataview_templates

list

N

The list of Data View Templates

parsers

list

N

The list of parsers

frequency

object

Y

frequency.type        

enum

Y

It supports values: Hourly, Daily, and Weekly.

frequency.time

string

Y

An example: 20:58:25

frequency.day_of_week

enum

Y

It is valid when the type is 'Weekly'.

It supports values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday.

frequency.timezone

enum

Y

See time zone: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones

Property Name

Type

Required

Definition

path

string

Y

The Runbook Template full path

auto_append_feature_commands

bool

N

Whether to automatically append the commands of feature to RunbookTemplate Nodes; only applies to the commands that do not include the line pattern variables.

It supports value:

true(default) or false

conflict_mode

enum

N

It supports value:

Override or Skip(default)