Fortinet black logo

Integration API Guide

Description of Device Attributes

Description of Device Attributes

The following tables are available for device attributes.

Device Attribute

Type

Description

unmanaged

boolean

Identifies if the device is managed or unmanaged.
discoverMethod

string

The discovery method of the device.

accessMethodIds

string

The ids for the access method.

discoverTime

unsignedLong

The date and time the device was discovered.
name

string

The device name.
accessIP

string

The IP address.
vendor

string

The vendor name.
model

string

The model name.
version

string

The version.

buildNumber

string

The build number.

osSerialNum

string

The operating system's serial number.

osEdition

string

The edition of the operating system.

hwVendor

string

The hardware vendor.

assetCategory

string

The category that the asset belongs to.

assetWeight

unsignedByte

The weight (priority) given to the asset.

description

string

Any additional details/information.

sysUptime

unsignedInt

The system uptime.

bios

See bios table.

bios

Type

Description

name

string

The bios name.
vendor

string

The vendor from where the bios came from.
serialNumber

string

The bios serial number.
version

string

The bios version.

Patch

Type

Description

Name

string

The name of the patch.
Description

string

Information about the patch.
installedBy

string

The person who installed the patch.
installedOn

unsignedInt

The date and time the patch was installed.

Processor

Type

Description

name string The processor name.
cpuUtil unsignedByte The CPU utilization of the processor.
manufacturer string The name of the processor manufacturer.
addrWidth unsignedByte The width of the DMA address space (in bytes).
dataWidth unsignedByte The maximum space available for data (in bytes)
currClockSpeed unsignedShort The current clock speed of the processor.
maxClockSpeed unsignedShort The maximum clock speed of the processor.

Storage

Type

Description

type string The storage type.
description string Information about the storage.
size string The storage size.
used string The amount of storage used.
memUtil unsignedByte The amount of storage utilized for memory.
diskUtil unsignedByte The amount of disk utilization from storage.

networkInterface

Type

Description

type string The network interface type.
name string Name of the network interface.
alias string The network alias name.
description string Information/details about the network interface.
ipv4Addr string The IPv4 address.
ipv4Mask unsignedByte The IPv4 subnet mask.
macAddr string The media access control address (MAC address).

speed

string

The Ethernet transmission speed.

snmpIndex

unsignedByte

The unique value of the interface.

isTrunk

boolean

Whether the network interface uses trunking or not.

adminStatus

string

The configured status of the interface (port).

operStatus string The working/running status of the interface.

InstalledSoftware

Type

Description

custId unsignedByte

The customer id.

count unsignedByte

The number of installed software.

runningSoftware

Type

Description

name

string

The name of the application.

groupName

string

The name of the application group that the application belongs to.

processName

string

The application's process name.

param

string

The application parameters.

procOwner

The process owner of the application.

path

string

The location of the application.

uptime

unsignedInt

The uptime of the running application.

swService

Type

Description

name string The service name.
displayName string The display name of the service.
description string Description of the service.
processId unsignedShort The service process Id.
path string The location of the service.
state string The current service state.
status string The status of the service.
startMode string The start up mode of the service.

monitorTypes

Type

Description

refId unsignedInt The reference Id.

eventPullingTypes

Type

Description

id string The id of the pulling event type.

errorMsgs

Type

Description

accessMethod string The access method error message.
error string The error message.
severity string The severity of the error.
impact string The impact of the error.
resolution string The resolution required to fix the error.

Description of Device Attributes

The following tables are available for device attributes.

Device Attribute

Type

Description

unmanaged

boolean

Identifies if the device is managed or unmanaged.
discoverMethod

string

The discovery method of the device.

accessMethodIds

string

The ids for the access method.

discoverTime

unsignedLong

The date and time the device was discovered.
name

string

The device name.
accessIP

string

The IP address.
vendor

string

The vendor name.
model

string

The model name.
version

string

The version.

buildNumber

string

The build number.

osSerialNum

string

The operating system's serial number.

osEdition

string

The edition of the operating system.

hwVendor

string

The hardware vendor.

assetCategory

string

The category that the asset belongs to.

assetWeight

unsignedByte

The weight (priority) given to the asset.

description

string

Any additional details/information.

sysUptime

unsignedInt

The system uptime.

bios

See bios table.

bios

Type

Description

name

string

The bios name.
vendor

string

The vendor from where the bios came from.
serialNumber

string

The bios serial number.
version

string

The bios version.

Patch

Type

Description

Name

string

The name of the patch.
Description

string

Information about the patch.
installedBy

string

The person who installed the patch.
installedOn

unsignedInt

The date and time the patch was installed.

Processor

Type

Description

name string The processor name.
cpuUtil unsignedByte The CPU utilization of the processor.
manufacturer string The name of the processor manufacturer.
addrWidth unsignedByte The width of the DMA address space (in bytes).
dataWidth unsignedByte The maximum space available for data (in bytes)
currClockSpeed unsignedShort The current clock speed of the processor.
maxClockSpeed unsignedShort The maximum clock speed of the processor.

Storage

Type

Description

type string The storage type.
description string Information about the storage.
size string The storage size.
used string The amount of storage used.
memUtil unsignedByte The amount of storage utilized for memory.
diskUtil unsignedByte The amount of disk utilization from storage.

networkInterface

Type

Description

type string The network interface type.
name string Name of the network interface.
alias string The network alias name.
description string Information/details about the network interface.
ipv4Addr string The IPv4 address.
ipv4Mask unsignedByte The IPv4 subnet mask.
macAddr string The media access control address (MAC address).

speed

string

The Ethernet transmission speed.

snmpIndex

unsignedByte

The unique value of the interface.

isTrunk

boolean

Whether the network interface uses trunking or not.

adminStatus

string

The configured status of the interface (port).

operStatus string The working/running status of the interface.

InstalledSoftware

Type

Description

custId unsignedByte

The customer id.

count unsignedByte

The number of installed software.

runningSoftware

Type

Description

name

string

The name of the application.

groupName

string

The name of the application group that the application belongs to.

processName

string

The application's process name.

param

string

The application parameters.

procOwner

The process owner of the application.

path

string

The location of the application.

uptime

unsignedInt

The uptime of the running application.

swService

Type

Description

name string The service name.
displayName string The display name of the service.
description string Description of the service.
processId unsignedShort The service process Id.
path string The location of the service.
state string The current service state.
status string The status of the service.
startMode string The start up mode of the service.

monitorTypes

Type

Description

refId unsignedInt The reference Id.

eventPullingTypes

Type

Description

id string The id of the pulling event type.

errorMsgs

Type

Description

accessMethod string The access method error message.
error string The error message.
severity string The severity of the error.
impact string The impact of the error.
resolution string The resolution required to fix the error.