Class ConfigBackendResource

Configuration Backend commands (libdhcp_cb_cmds.so), operating on a database-backed config.

Index

Constructors

Methods

delGlobalParameter4 delGlobalParameter6 delOptionDef4 delOptionDef6 delOptionGlobal4 delOptionGlobal6 delOptionNetwork4 delOptionNetwork6 delOptionPdPool6 delOptionPool4 delOptionPool6 delOptionSubnet4 delOptionSubnet6 delRemoteNetwork4 delRemoteNetwork6 delRemoteSubnet4ById delRemoteSubnet4ByPrefix delRemoteSubnet6ById delRemoteSubnet6ByPrefix delServer4 delServer6 getAllGlobalParameters4 getAllGlobalParameters6 getAllOptionDefs4 getAllOptionDefs6 getAllOptionsGlobal4 getAllOptionsGlobal6 getAllServers4 getAllServers6 getGlobalParameter4 getGlobalParameter6 getOptionDef4 getOptionDef6 getOptionGlobal4 getOptionGlobal6 getRemoteNetwork4 getRemoteNetwork6 getRemoteSubnet4 getRemoteSubnet6 getServer4 getServer6 listRemoteNetworks4 listRemoteNetworks6 listRemoteSubnets4 listRemoteSubnets6 setGlobalParameter4 setGlobalParameter6 setOptionDef4 setOptionDef6 setOptionGlobal4 setOptionGlobal6 setOptionNetwork4 setOptionNetwork6 setOptionPdPool6 setOptionPool4 setOptionPool6 setOptionSubnet4 setOptionSubnet6 setRemoteNetwork4 setRemoteNetwork6 setRemoteSubnet4 setRemoteSubnet6 setServer4 setServer6

Constructors

constructor

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

Methods

delGlobalParameter4

delGlobalParameter4(
args: RemoteGlobalParameterDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteGlobalParameterDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:559

delGlobalParameter6

delGlobalParameter6(
args: RemoteGlobalParameterDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteGlobalParameterDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:576

delOptionDef4

delOptionDef4(
args: RemoteOptionDefDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionDefDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:744

delOptionDef6

delOptionDef6(
args: RemoteOptionDefDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionDefDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:757

delOptionGlobal4

delOptionGlobal4(
args: RemoteOptionGlobalDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionGlobalDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:673

delOptionGlobal6

delOptionGlobal6(
args: RemoteOptionGlobalDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionGlobalDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:686

delOptionNetwork4

delOptionNetwork4(
args: RemoteOptionNetworkDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionNetworkDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:693

delOptionNetwork6

delOptionNetwork6(
args: RemoteOptionNetworkDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionNetworkDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:699

delOptionPdPool6

delOptionPdPool6(
args: RemoteOptionPdPoolDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionPdPoolDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:731

delOptionPool4

delOptionPool4(
args: RemoteOptionPoolDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionPoolDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:719

delOptionPool6

delOptionPool6(
args: RemoteOptionPoolDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionPoolDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:725

delOptionSubnet4

delOptionSubnet4(
args: RemoteOptionSubnetDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionSubnetDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:706

delOptionSubnet6

delOptionSubnet6(
args: RemoteOptionSubnetDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionSubnetDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:712

delRemoteNetwork4

delRemoteNetwork4(
args: RemoteNetworkDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteNetworkDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:615

delRemoteNetwork6

delRemoteNetwork6(
args: RemoteNetworkDelArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteNetworkDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:628

delRemoteSubnet4ById

delRemoteSubnet4ById(
args: RemoteSubnetDelByIdArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetDelByIdArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:638

delRemoteSubnet4ByPrefix

delRemoteSubnet4ByPrefix(
args: RemoteSubnetDelByPrefixArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetDelByPrefixArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:641

delRemoteSubnet6ById

delRemoteSubnet6ById(
args: RemoteSubnetDelByIdArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetDelByIdArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:654

delRemoteSubnet6ByPrefix

delRemoteSubnet6ByPrefix(
args: RemoteSubnetDelByPrefixArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetDelByPrefixArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:657

delServer4

delServer4(args: RemoteServerDelArgs, service?: string[]): Promise<JsonObject>
Parameters
- args: RemoteServerDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:589

delServer6

delServer6(args: RemoteServerDelArgs, service?: string[]): Promise<JsonObject>
Parameters
- args: RemoteServerDelArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:602

getAllGlobalParameters4

getAllGlobalParameters4(
args?: RemoteGlobalParameterGetAllArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteGlobalParameterGetAllArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:552

getAllGlobalParameters6

getAllGlobalParameters6(
args?: RemoteGlobalParameterGetAllArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteGlobalParameterGetAllArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:569

getAllOptionDefs4

getAllOptionDefs4(
args?: RemoteOptionDefGetAllArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteOptionDefGetAllArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:741

getAllOptionDefs6

getAllOptionDefs6(
args?: RemoteOptionDefGetAllArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteOptionDefGetAllArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:754

getAllOptionsGlobal4

getAllOptionsGlobal4(service?: string[]): Promise<JsonObject>
Parameters
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:670

getAllOptionsGlobal6

getAllOptionsGlobal6(service?: string[]): Promise<JsonObject>
Parameters
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:683

getAllServers4

getAllServers4(service?: string[]): Promise<JsonObject>
Parameters
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:586

getAllServers6

getAllServers6(service?: string[]): Promise<JsonObject>
Parameters
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:599

getGlobalParameter4

getGlobalParameter4(
args: RemoteGlobalParameterGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteGlobalParameterGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:549

getGlobalParameter6

getGlobalParameter6(
args: RemoteGlobalParameterGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteGlobalParameterGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:566

getOptionDef4

getOptionDef4(
args: RemoteOptionDefGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionDefGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:738

getOptionDef6

getOptionDef6(
args: RemoteOptionDefGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionDefGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:751

getOptionGlobal4

getOptionGlobal4(
args: RemoteOptionGlobalGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionGlobalGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:667

getOptionGlobal6

getOptionGlobal6(
args: RemoteOptionGlobalGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionGlobalGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:680

getRemoteNetwork4

getRemoteNetwork4(
args: RemoteNetworkGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteNetworkGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:609

getRemoteNetwork6

getRemoteNetwork6(
args: RemoteNetworkGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteNetworkGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:622

getRemoteSubnet4

getRemoteSubnet4(
args: RemoteSubnetGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:635

getRemoteSubnet6

getRemoteSubnet6(
args: RemoteSubnetGetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:651

getServer4

getServer4(args: RemoteServerGetArgs, service?: string[]): Promise<JsonObject>
Parameters
- args: RemoteServerGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:583

getServer6

getServer6(args: RemoteServerGetArgs, service?: string[]): Promise<JsonObject>
Parameters
- args: RemoteServerGetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:596

listRemoteNetworks4

listRemoteNetworks4(
args?: RemoteNetworkListArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteNetworkListArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:612

listRemoteNetworks6

listRemoteNetworks6(
args?: RemoteNetworkListArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteNetworkListArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:625

listRemoteSubnets4

listRemoteSubnets4(
args?: RemoteSubnetListArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteSubnetListArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:644

listRemoteSubnets6

listRemoteSubnets6(
args?: RemoteSubnetListArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- Optionalargs: RemoteSubnetListArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:660

setGlobalParameter4

setGlobalParameter4(
args: RemoteGlobalParameterSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteGlobalParameterSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:546

setGlobalParameter6

setGlobalParameter6(
args: RemoteGlobalParameterSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteGlobalParameterSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:563

setOptionDef4

setOptionDef4(
args: RemoteOptionDefSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionDefSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:735

setOptionDef6

setOptionDef6(
args: RemoteOptionDefSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionDefSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:748

setOptionGlobal4

setOptionGlobal4(
args: RemoteOptionGlobalSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionGlobalSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:664

setOptionGlobal6

setOptionGlobal6(
args: RemoteOptionGlobalSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionGlobalSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:677

setOptionNetwork4

setOptionNetwork4(
args: RemoteOptionNetworkSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionNetworkSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:690

setOptionNetwork6

setOptionNetwork6(
args: RemoteOptionNetworkSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionNetworkSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:696

setOptionPdPool6

setOptionPdPool6(
args: RemoteOptionPdPoolSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionPdPoolSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:728

setOptionPool4

setOptionPool4(
args: RemoteOptionPoolSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionPoolSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:716

setOptionPool6

setOptionPool6(
args: RemoteOptionPoolSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionPoolSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:722

setOptionSubnet4

setOptionSubnet4(
args: RemoteOptionSubnetSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionSubnetSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:703

setOptionSubnet6

setOptionSubnet6(
args: RemoteOptionSubnetSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteOptionSubnetSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:709

setRemoteNetwork4

setRemoteNetwork4(
args: RemoteNetworkSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteNetworkSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:606

setRemoteNetwork6

setRemoteNetwork6(
args: RemoteNetworkSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteNetworkSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:619

setRemoteSubnet4

setRemoteSubnet4(
args: RemoteSubnetSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:632

setRemoteSubnet6

setRemoteSubnet6(
args: RemoteSubnetSetArgs,
service?: string[],
): Promise<JsonObject>
Parameters
- args: RemoteSubnetSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:648

setServer4

setServer4(args: RemoteServerSetArgs, service?: string[]): Promise<JsonObject>
Parameters
- args: RemoteServerSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:580

setServer6

setServer6(args: RemoteServerSetArgs, service?: string[]): Promise<JsonObject>
Parameters
- args: RemoteServerSetArgs
- Optionalservice: string[]
Returns Promise<JsonObject>
- Defined in src/client.ts:593