Class LeaseResource

lease_cmds hook: unified lease manipulation across memfile/MySQL/PostgreSQL backends.

Constructors

constructor

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

Methods

bulkApplyLease6

bulkApplyLease6(
args: Lease6BulkApplyArgs,
service?: string[],
): Promise<Lease6BulkApplyResult>
Parameters
- args: Lease6BulkApplyArgs
- Optionalservice: string[]
Returns Promise<Lease6BulkApplyResult>
- Defined in src/client.ts:333

delLease4

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

delLease6

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

getAllLeases4

getAllLeases4(
args?: LeaseGetAllArgs,
service?: string[],
): Promise<LeaseGetAllResult<Lease4>>
Parameters
- Optionalargs: LeaseGetAllArgs
- Optionalservice: string[]
Returns Promise<LeaseGetAllResult<Lease4>>
- Defined in src/client.ts:285

getAllLeases6

getAllLeases6(
args?: LeaseGetAllArgs,
service?: string[],
): Promise<LeaseGetAllResult<Lease6>>
Parameters
- Optionalargs: LeaseGetAllArgs
- Optionalservice: string[]
Returns Promise<LeaseGetAllResult<Lease6>>
- Defined in src/client.ts:321

getLease4

getLease4(args: Lease4GetArgs, service?: string[]): Promise<Lease4>
Parameters
- args: Lease4GetArgs
- Optionalservice: string[]
Returns Promise<Lease4>
- Defined in src/client.ts:253

getLease4ByClientId

getLease4ByClientId(
args: Lease4GetByClientIdArgs,
service?: string[],
): Promise<LeaseGetAllResult<Lease4>>
Parameters
- args: Lease4GetByClientIdArgs
- Optionalservice: string[]
Returns Promise<LeaseGetAllResult<Lease4>>
- Defined in src/client.ts:265

getLease4ByHwAddress

getLease4ByHwAddress(
args: Lease4GetByHwAddressArgs,
service?: string[],
): Promise<LeaseGetAllResult<Lease4>>
Parameters
- args: Lease4GetByHwAddressArgs
- Optionalservice: string[]
Returns Promise<LeaseGetAllResult<Lease4>>
- Defined in src/client.ts:257

getLease4Page

getLease4Page(
args: LeaseGetPageArgs,
service?: string[],
): Promise<LeaseGetPageResult<Lease4>>
Parameters
- args: LeaseGetPageArgs
- Optionalservice: string[]
Returns Promise<LeaseGetPageResult<Lease4>>
- Defined in src/client.ts:289

getLease6

getLease6(args: Lease6GetArgs, service?: string[]): Promise<Lease6>
Parameters
- args: Lease6GetArgs
- Optionalservice: string[]
Returns Promise<Lease6>
- Defined in src/client.ts:301

getLease6ByDuid

getLease6ByDuid(
args: Lease6GetByDuidArgs,
service?: string[],
): Promise<LeaseGetAllResult<Lease6>>
Parameters
- args: Lease6GetByDuidArgs
- Optionalservice: string[]
Returns Promise<LeaseGetAllResult<Lease6>>
- Defined in src/client.ts:305

getLease6Page

getLease6Page(
args: LeaseGetPageArgs,
service?: string[],
): Promise<LeaseGetPageResult<Lease6>>
Parameters
- args: LeaseGetPageArgs
- Optionalservice: string[]
Returns Promise<LeaseGetPageResult<Lease6>>
- Defined in src/client.ts:325

resendLease4Ddns

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

resendLease6Ddns

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

setLease4

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

setLease6

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

updateLease4

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

updateLease6

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

wipeLease4

wipeLease4(args?: LeaseWipeArgs, service?: string[]): Promise<LeaseWipeResult>
Parameters
- Optionalargs: LeaseWipeArgs
- Optionalservice: string[]
Returns Promise<LeaseWipeResult>
- Defined in src/client.ts:281

wipeLease6

wipeLease6(args?: LeaseWipeArgs, service?: string[]): Promise<LeaseWipeResult>
Parameters
- Optionalargs: LeaseWipeArgs
- Optionalservice: string[]
Returns Promise<LeaseWipeResult>
- Defined in src/client.ts:317