Class ControlResource

General control commands, supported by every Kea daemon (dhcp4, dhcp6, d2, ca).

Constructors

constructor

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

Methods

addInterface

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

disableDhcp

disableDhcp(args?: DhcpDisableArgs, service?: string[]): Promise<void>
Parameters
- Optionalargs: DhcpDisableArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:220

enableDhcp

enableDhcp(args?: DhcpEnableArgs, service?: string[]): Promise<void>
Parameters
- Optionalargs: DhcpEnableArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:224

getBuildReport

getBuildReport(service?: string[]): Promise<BuildReport>
Parameters
- Optionalservice: string[]
Returns Promise<BuildReport>
- Defined in src/client.ts:152

getConfig

getConfig(service?: string[]): Promise<ConfigGetResult>
Parameters
- Optionalservice: string[]
Returns Promise<ConfigGetResult>
- Defined in src/client.ts:156

getConfigHash

getConfigHash(service?: string[]): Promise<ConfigHashGetResult>
Parameters
- Optionalservice: string[]
Returns Promise<ConfigHashGetResult>
- Defined in src/client.ts:160

getServerTag

getServerTag(service?: string[]): Promise<ServerTagGetResult>
Parameters
- Optionalservice: string[]
Returns Promise<ServerTagGetResult>
- Defined in src/client.ts:200

getStatus

getStatus(service?: string[]): Promise<StatusGetResult>
Parameters
- Optionalservice: string[]
Returns Promise<StatusGetResult>
- Defined in src/client.ts:188

getVersion

getVersion(service?: string[]): Promise<VersionGetResult>
Parameters
- Optionalservice: string[]
Returns Promise<VersionGetResult>
- Defined in src/client.ts:192

listCommands

listCommands(service?: string[]): Promise<ListCommandsResult>
Parameters
- Optionalservice: string[]
Returns Promise<ListCommandsResult>
- Defined in src/client.ts:180

listInterfaces

listInterfaces(service?: string[]): Promise<InterfaceListResult>
Parameters
- Optionalservice: string[]
Returns Promise<InterfaceListResult>
- Defined in src/client.ts:212

pullConfigBackend

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

reclaimLeases

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

redetectInterfaces

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

reloadConfig

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

setConfig

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

shutdown

shutdown(args?: ShutdownArgs, service?: string[]): Promise<void>
Parameters
- Optionalargs: ShutdownArgs
- Optionalservice: string[]
Returns Promise<void>
- Defined in src/client.ts:184

startLfc

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

testConfig

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

testSubnet4o6Select

testSubnet4o6Select(
args: Subnet4o6SelectTestArgs,
service?: string[],
): Promise<SelectTestResult>
Parameters
- args: Subnet4o6SelectTestArgs
- Optionalservice: string[]
Returns Promise<SelectTestResult>
- Defined in src/client.ts:236

testSubnet4Select

testSubnet4Select(
args: Subnet4SelectTestArgs,
service?: string[],
): Promise<SelectTestResult>
Parameters
- args: Subnet4SelectTestArgs
- Optionalservice: string[]
Returns Promise<SelectTestResult>
- Defined in src/client.ts:232

testSubnet6Select

testSubnet6Select(
args: Subnet6SelectTestArgs,
service?: string[],
): Promise<SelectTestResult>
Parameters
- args: Subnet6SelectTestArgs
- Optionalservice: string[]
Returns Promise<SelectTestResult>
- Defined in src/client.ts:240

writeConfig

writeConfig(
args?: ConfigWriteArgs,
service?: string[],
): Promise<ConfigWriteResult>
Parameters
- Optionalargs: ConfigWriteArgs
- Optionalservice: string[]
Returns Promise<ConfigWriteResult>
- Defined in src/client.ts:176