Class StatResource

stat_cmds hook: lease/packet statistic inspection and management.

Index

Constructors

Methods

getAllStatistics getStatistic removeAllStatistics removeStatistic resetAllStatistics resetStatistic setAllStatisticsSampleAge setAllStatisticsSampleCount setStatisticSampleAge setStatisticSampleCount

Constructors

constructor

new StatResource(request: Requester): StatResource
Parameters
- request: Requester
Returns StatResource
- Defined in src/client.ts:499

Methods

getAllStatistics

getAllStatistics(service?: string[]): Promise<StatisticGetResult>
Parameters
- Optionalservice: string[]
Returns Promise<StatisticGetResult>
- Defined in src/client.ts:505

getStatistic

getStatistic(
args: StatisticGetArgs,
service?: string[],
): Promise<StatisticGetResult>
Parameters
- args: StatisticGetArgs
- Optionalservice: string[]
Returns Promise<StatisticGetResult>
- Defined in src/client.ts:501

removeAllStatistics

removeAllStatistics(service?: string[]): Promise<void>
Parameters
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:521

removeStatistic

removeStatistic(args: StatisticRemoveArgs, service?: string[]): Promise<void>
Parameters
- args: StatisticRemoveArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:517

resetAllStatistics

resetAllStatistics(service?: string[]): Promise<void>
Parameters
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:513

resetStatistic

resetStatistic(args: StatisticResetArgs, service?: string[]): Promise<void>
Parameters
- args: StatisticResetArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:509

setAllStatisticsSampleAge

setAllStatisticsSampleAge(
args: { duration: number },
service?: string[],
): Promise<void>
Parameters
- args: { duration: number }
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:529

setAllStatisticsSampleCount

setAllStatisticsSampleCount(
args: { "max-samples": number },
service?: string[],
): Promise<void>
Parameters
- args: { "max-samples": number }
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:537

setStatisticSampleAge

setStatisticSampleAge(
args: StatisticSampleAgeSetArgs,
service?: string[],
): Promise<void>
Parameters
- args: StatisticSampleAgeSetArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:525

setStatisticSampleCount

setStatisticSampleCount(
args: StatisticSampleCountSetArgs,
service?: string[],
): Promise<void>
Parameters
- args: StatisticSampleCountSetArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:533