Fortinet black logo

fortindr-cloud-get-telemetry-packetstats

fortindr-cloud-get-telemetry-packetstats

Get packetstats telemetry data grouped by time.

Base Command

fortindr-cloud-get-telemetry-packetstats <input>

Input

Argument Name

Description

Required

sensor_id

Scopes the returned metrics to the interfaces of the specified sensor ID.

Optional

start_date

Scopes the returned metrics to dates after the given start_date. If empty returns most current packet stats.

Optional

end_date

Scopes the returned metrics to dates before the given end_date. If empty returns most current packet stats.

Optional

interval

Aggregation interval. 1 hr is not specified by default.

Optional

group_by

Option to group by the following fields: interface_name, sensor_id, account_code. Possible values are: interface_name, sensor_id, account_code.

Optional

account_code

Account code to filter by.

Optional

Context Output

Path prefix:

FortiNDRCloud.Telemetry.Packetstats

Path

Type

Description

.account_code

string

Account code the data was filtered by

.timestamp

date

Timestamp of the grouped data.

.interface_name

string

Interface the packet data was recorded from.

.rx_bits_per_second

number

Receive throughput bits per secondbitspersecond.

.rx_bytes

number

Receive data size bytesbytes.

.rx_errors

number

Number of receive errors.

.rx_packets

number

Number of receive packets.

.sensor_id

string

Sensor ID packet data was recorded from.

.tx_bytes

number

Transmit data size bytesbytes

.tx_errors

number

Number of transmit errors.

.tx_packets

number

Number of transmit packets.

Command example

!fortindr-cloud-get-telemetry-packetstats start_date=2022-08-22T23:00:00.000Z end_date=2022-08-23T01:00:00.000Z

fortindr-cloud-get-telemetry-packetstats

Get packetstats telemetry data grouped by time.

Base Command

fortindr-cloud-get-telemetry-packetstats <input>

Input

Argument Name

Description

Required

sensor_id

Scopes the returned metrics to the interfaces of the specified sensor ID.

Optional

start_date

Scopes the returned metrics to dates after the given start_date. If empty returns most current packet stats.

Optional

end_date

Scopes the returned metrics to dates before the given end_date. If empty returns most current packet stats.

Optional

interval

Aggregation interval. 1 hr is not specified by default.

Optional

group_by

Option to group by the following fields: interface_name, sensor_id, account_code. Possible values are: interface_name, sensor_id, account_code.

Optional

account_code

Account code to filter by.

Optional

Context Output

Path prefix:

FortiNDRCloud.Telemetry.Packetstats

Path

Type

Description

.account_code

string

Account code the data was filtered by

.timestamp

date

Timestamp of the grouped data.

.interface_name

string

Interface the packet data was recorded from.

.rx_bits_per_second

number

Receive throughput bits per secondbitspersecond.

.rx_bytes

number

Receive data size bytesbytes.

.rx_errors

number

Number of receive errors.

.rx_packets

number

Number of receive packets.

.sensor_id

string

Sensor ID packet data was recorded from.

.tx_bytes

number

Transmit data size bytesbytes

.tx_errors

number

Number of transmit errors.

.tx_packets

number

Number of transmit packets.

Command example

!fortindr-cloud-get-telemetry-packetstats start_date=2022-08-22T23:00:00.000Z end_date=2022-08-23T01:00:00.000Z