Report Object
The following report objects are supported, and they can be divided into these categories:
Device Category
Here are report objects supported in the device category.
Device Object
If you select Device as the report object, the device properties will be listed in the Report Field Tree:
| Field Name | Field Type | Description |
|---|---|---|
| Hostname | Device | Device's hostname |
| Management IP | String | Device's management IP |
| Management Interface | String | The interface configured on the device's management IP |
| Vendor | String | Device's vendor name |
| Model | String | Device model |
| Sub Type | Picklist | Device type |
| Software Version | String | Compatible system version |
| Serial Number | String | The serial number for the device |
| Site Name | Site | The site to which the device belongs |
| Location | String | Device's location |
| Contact | String | The device's point of contact |
| System Memory Size | String | The memory size of the device |
| Asset Tag | String | The asset tag assigned to the device |
| Hierarchy Layer | String | Device's hierarchy layer, used in May Layout |
| Description | String | Device's description |
| First Discovery Time | Time | The first time when the device was added to the NetBrain system through Discovery |
| Last Discovery Time | Time | The most recent time when the device was added to the NetBrain system through Discovery |
| Cluster Enabling | Boolean | Whether Cluster has been enabled on the device |
| ISIS Enabling | Boolean | Whether ISIS has been enabled on the device |
| NAT Enabling | Boolean | Whether NAT has been enabled on the device |
| OMP Enabling | Boolean | Whether OMP has been enabled on the device |
| OTV Enabling | Boolean | Whether OTV has been enabled on the device |
| VxLAN Enabling | Boolean | Whether VxLAN has been enabled on the device |
| IPv6 Enabling | Boolean | Whether IPv6 has been enabled on the device |
| Transparent Enabling | Boolean | Whether the transparent model has been enabled on the device |
| BPE Enabling | Boolean | Whether BPE has been enabled on the device |
| MC-LAG Enabling | Boolean | Whether MC-LAG has been enabled on the device |
| OSPF Enabling | Boolean | Whether OSPF has been enabled on the device |
| EIGRP Enabling | Boolean | Whether EIGRP has been enabled on the device |
| QoS Enabling | Boolean | Whether QoS has been enabled on the device |
| HA Enabling | Boolean | Whether the HA mode has been enabled on the device |
| Multicasting Enabling | Boolean | Whether Multicasting has been enabled on the device |
| BGP Enabling | Boolean | Whether BGP has been enabled on the device |
| IPSec VPN Enabling | Boolean | Whether IPSec VPN has been enabled on the device |
| VPLS Enabling | Boolean | Whether VPLS has been enabled on the device |
Device Interface Object
If you select Device Interface as the report object, the interface properties will be listed in the Report Field Tree:
| Field Name | Field Type | Description |
|---|---|---|
| Hostname | Device | Device's hostname |
| Interface Name | String | Interface's name |
| Interface Description | String | Description of the configured interface |
| IPv4 Address | String | The IPv4 address configured on the interface |
| IPv6 Address | String | The IPv6 address configured on the interface |
| IPv6 Link Local Address | String | Interface's IPv6 link local address |
| Bandwidth | Number | Bandwidth set on the interface |
| Speed | String | Interface's speed |
| Duplex | String | Interface's duplex |
| Live Status | String | Interface status |
| MAC Address | String | Interface's MAC address |
| Slot# | String | The slot number for the interface |
| Module Type | String | The module type for the interface |
| Routing Protocol | String | The routing protocol used in the interface |
| Tunnel Mode | String | The tunnel mode set in the interface |
| Multicasting Mode | String | The PIM mode configured in the interface |
| MPLS VRF | String | The VRF name configured in the interface |
| Inbound ACL | String | The inbound ACL defined in the interface |
| Outbound ACL | String | The outbound ACL defined in the interface |
| Switchport Mode | String | The switchport mode defined in the interface |
| VLAN | String | The VLAN in which the interface was added |
| Native VLAN | String | Interface's native VLAN |
| Trunk Encapsulation | String | The encapsulation protocol of trunk in the interface |
| L2 Overlay Enabling | Boolean | Whether the interface is used in the L2 overlay protocol |
| Failover Enabling | Boolean | Whether the interface is used in Failover |
| VPLS PE Interface | Boolean | Whether the interface is the PE interface in VPLS |
| Interface of Bridge Port Extension | Boolean | Whether used in the Bridge Port Extention device's interface |
| Transparent Enabling | Boolean | Whether the interface is used in the transparent mode |
| NAT Enabling | Boolean | Whether the interface is used in NAT |
| BGP Forwarding MPLS Interface | Boolean | Whether the interface forwards the BGP route to MPLS |
| QinQ Config | Boolean | Whether Q-in-Q is configured in the interface |
Device Module Object
If you select Device Module as the report object, the module properties will be listed in the Report Field Tree:
| Field Name | Field Type | Description |
|---|---|---|
| Hostname | Device | Device’s hostname |
| Slot# | String | Device’s slot number |
| Module Type | String | Module’s type |
| Ports | String | Number of ports in the Module |
| Module Serial Number | String | Module’s serial number |
| HW Ver | String | Module’s hardware version |
| FW Ver | String | Module’s firmware version |
| SW Ver | String | Module’s software version |
| Description | String | Module’s description |
Device Change Analysis Object
If you select Device Change Analysis as the report object, the changes in the change analysis will be listed in the Report Field Tree:| Field Name | Field Type | Description |
|---|---|---|
| Hostname | Device | Device’s hostname |
| Data Type | Picklist | The data type examined in Change Analysis, such as configuration file, route table, etc. |
| Change Time | Time | The time when changes are detected |
Device Group Member Object
If you select Device Group Member as the report object, the device group member properties will be listed in the Report Field Tree:
| Field Name | Field Type | Description |
|---|---|---|
| Device Group Name | String | Name of the device group |
| Device Name | String | Device's hostname |
| Interface Name | String | Name of the Interface |
| Type | Picklist | Type of this device group member, such as static or dynamic. |
Device Group Property Object
If you select Device Group Property as the report object, the device group properties will be listed in the Report Field Tree:
| Field Name | Field Type | Description |
|---|---|---|
| Device Group Name | String | Name of this device group |
| Path | String | Path of this device group specifying the location of this device group in the tree. For example, Shared Device Groups/Cisco_ACI |
| Description | String | Description of this device group |
| Group Map | String | Name of the device group map |
| Type | Picklist | Type of this device group, such as shared device group, system device group, etc. |
Intent Category
The following report objects are supported in the intent category.
Intent Property Object
If you select Intent Property as the report object, the intent properties will be listed in the Report Field Tree:| Field Name | Field Type | Description |
|---|---|---|
| Intent Name | Intent | Intent’s name |
| Intent Type | Picklist | Intent type, such as comment intent, map intent, etc. |
| Intent Map | String | The map associated with the intent |
| Intent Tag | String | Intent’s tag |
| Creator | String | Intent creator |
| Creation Time | Time | The time when the intent is created |
| Modifier | String | The user who modified the intent most recently |
| Modify Time | Time | The time when the intent is modified most recently |
Intent Device Object
If you select Intent Device as the report object, the information for devices defined in the intent will be listed in the Report Field Tree:| Field Name | Field Type | Description |
|---|---|---|
| Intent Name | Intent | Intent name |
| Device Name | Device | Device(s) defined in the intent |
| Device Description | String | The description of devices defined in the intent |
| Commands | String | Commands for devices defined in the intent |
Intent Result Object
If you select Intent Result as the report object, the intent result info will be listed in the Report Field Tree:| Field Name | Field Type | Description |
|---|---|---|
| Intent Name | Intent | Intent name |
| Intent Result Summary | String | Result summary of the intent |
| Execution Time | Time | Execution time of the intent |
| Total Alert Count | Number | The total number of alert status codes after intent execution, including intent alert status code and device status code |
| Source | Picklist | How the intent is executed |
| Intent Status Code Count | Number | The total number of intent alert status codes and intent success status codes after intent execution |
| Intent Alert Status Code Count | Number | The number of intent alert status codes after intent execution |
| Intent Success Status Code Count | Number | The number of intent success status codes after intent execution |
| Intent Status Code Summary | String | The first intent status code after intent execution |
Intent Device Result Object
If you select Intent Device Result as the report object, the result info of the devices defined in the intent will be listed in the Report Field Tree:| Field Name | Field Type | Description |
|---|---|---|
| Intent Name | Intent | Intent name |
| Intent Result Summary | String | Result summary of the intent |
| Execution Time | Time | Execution time of the intent |
| Device Name | Device | Devices defined in the intent |
| Device Status Code Count | Number | The total number of device alert status codes and device success status codes during intent execution |
| Device Alert Status Code Count | Number | The number of device alert status codes during intent execution |
| Device Success Status Code Count | Number | The number of device success status codes during intent execution |
| Device Status Code Summary | String | The first device status code after intent execution |
Application Category
The following report objects are supported in the application category.
Application Path Property Object
If you select Application Path Property as the report object, the application info will be listed in the Report Field Tree:| Field Name | Field Type | Description |
|---|---|---|
| Application Name | String | Application name |
| Path Name | Path | Path in the application |
| Application Name | String | Application's description |
| Path Type | Picklist | Path type: multicast, unicast |
| Source | String | Path source |
| Source Port | Number | Path source port |
| Source Device | String | Path source device |
| Destination | String | Path destination |
| Destination Port | Number | Path destination port |
| Destination Device | String | The destination device name |
| Group | String | The multicasting group name, if the path is multicasting |
| Protocol | String | Path protocol, such as IPv4, TCP, etc. |
| Reference Map | String | The map associated with the path |
| Has Golden Path | Boolean | Whether the golden path is set in the path |
Application Path Last Result Object
If you select Application Path Last Result as the report object, the most recent execution results will be available:
| Field Name | Field Type | Description |
|---|---|---|
| Application Name | String | Application name |
| Path Name | Path | Path in the application |
| Application Name | String | Application's description |
| Path Type | Picklist | Path type: multicast, unicast |
| Source | String | Path source |
| Source Port | Number | Path source port |
| Source Device | String | Path source device |
| Destination | String | Path destination |
| Destination Port | Number | Path destination port |
| Destination Device | String | The destination device name |
| Group | String | The multicasting group name, if the path is multicasting |
| Protocol | String | Path protocol, such as IPv4, TCP, etc. |
| Reference Map | String | The map associated with the path |
| Has Golden Path | Boolean | Whether the golden path is set in the path |
| Path Result | Picklist | Path calculation result |
| Compare with Golden | Boolean | Whether there is any change when comparing the path result to the golden path |
| Compare with Last | Boolean | Whether there is any change when comparing the path result to the one from the last time |
| Last Verified Time | Number | The most recent time when the path is calculated |
| Task Name | String | The task initiating the path calculation |
| Task Type | Picklist | The task initiating the path calculation |
Application Path Historical Result Object
If you select Application Path Historical Result as the report object, all historical calculation results in the application will be available:
| Field Name | Field Type | Description |
|---|---|---|
| Application Name | String | Application name |
| Path Name | Path | Path in the application |
| Verified Time | Time | The time when the path is calculated |
| Result Category | String | The reason for the failure will be displayed if the path is not successfully calculated |
| Path Result | Picklist | Path calculation result |
Application Path Intent Result Object
If you select Application Path Intent Result as the report object, the most recent execution results of the path intent will be available:
| Field Name | Field Type | Description |
|---|---|---|
| Application Name | String | Application name |
| Path Name | Path | Path in the application |
| Intent Name | Intent | Path intent name |
| Intent Result Summary | String | The first intent status code after the execution of the path intent |
Change Management Category
The following report objects are supported in the change management category.Change Management Task Object
If you select Change Management Task as the report object, the info of the change management task will be listed in the Report Field Tree:
| Field Name | Field Type | Description |
|---|---|---|
| Change Management Task Name | Change Task | Change Management Task Name |
| Status | Picklist | Status of the change management task |
| Creator | String | Creator of the change management task |
| Approver | String | Approver of the change management task |
| Executor | String | Executor of the change management task |
| Creation Time | Time | Creation time of the change management task |
| Submit Time for Approval | Time | The time when the change management task is submitted for approval |
| Approval Time | Time | The time when the change management task is approved |
| Rejection Time | Time | The time when the change management task is rejected |
| Schedule Time | Time | The scheduled time to run the change management task |
| Execution Time | Time | The time when the change management task is executed |
| Archive Time | Time | The time when the change management task is complete |
Change Management Planned Device Object
If you select Change Management Planned Device as the report object, the info on devices planned for implement in the change will be available:
| Field Name | Field Type | Description |
|---|---|---|
| Change Management Task Name | Change Task | Change management task name |
| Change Management Task Node Name | String | The name of the Define Change node in the change management task runbook |
| Device Name | Device | The devices planned for implement in the change management task |
Change Management Implemented Device Object
If you select Change Management Implemented Device as the report object, the info on devices implemented in the change will be available:
| Field Name | Field Type | Description |
|---|---|---|
| Change Management Task Name | Change Task | Change management task name |
| Change Management Task Node Name | String | The name of the Execution node in the change management task runbook |
| Device Name | Device | The devices implemented in the change management task |
| Device Executed Status | Picklist | The executed status of each device |
Site Category
The following report objects are supported in the site category.Site Object
If you select Site as the report object, the site info field will be listed in the Report Field Tree:
| Field Name | Field Type | Description |
|---|---|---|
| Site Name | Site | Site name |
| Type | Picklist | Site type: leaf site, container site |
| Region | String | Site region |
| Location | String | Site location |
| Employee Number | String | The number of employees in the site |
| Device Count | Number | The number of devices in the site |
| Contact Name | String | The contact name for the site |
| Phone Number | String | The contact phone number for the site |
| String | The contact email for the site | |
| Description | String | Site description |
| Site Map | String | Site map associated with the site |
Site Member Object
If you select Site Member as the report object, the device info in the site will be available:
| Field Name | Field Type | Description |
|---|---|---|
| Site Name | Site | Site name |
| Device Name | Device | Devices in the site |