isc::yang::TranslatorPdPool Class Reference

Prefix delegation pool translation between YANG and JSON. More...

#include <translator_pd_pool.h>

Inheritance diagram for isc::yang::TranslatorPdPool:

Public Member Functions
	TranslatorPdPool (sysrepo::S_Session session, const std::string &model)
	Constructor. More...
virtual	~TranslatorPdPool ()
	Destructor. More...
isc::data::ElementPtr	getPdPool (const std::string &xpath)
	Get and translate a pd-pool from YANG to JSON. More...
void	setPdPool (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set pd-pool from JSON to YANG. More...
Public Member Functions inherited from isc::yang::TranslatorOptionDataList
	TranslatorOptionDataList (sysrepo::S_Session session, const std::string &model)
	Constructor. More...
virtual	~TranslatorOptionDataList ()
	Destructor. More...
isc::data::ConstElementPtr	getOptionDataList (const std::string &xpath)
	Get and translate option data list from YANG to JSON. More...
void	setOptionDataList (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set option data list from JSON to YANG. More...
Public Member Functions inherited from isc::yang::TranslatorOptionData
	TranslatorOptionData (sysrepo::S_Session session, const std::string &model)
	Constructor. More...
virtual	~TranslatorOptionData ()
	Destructor. More...
isc::data::ElementPtr	getOptionData (const std::string &xpath)
	Get and translate an option data from YANG to JSON. More...
void	setOptionData (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set option data from JSON to YANG. More...
Public Member Functions inherited from isc::yang::TranslatorBasic
	TranslatorBasic (sysrepo::S_Session session, const std::string &model)
	Constructor. More...
virtual	~TranslatorBasic ()
	Destructor. More...
void	delItem (const std::string &xpath)
	Delete basic value from YANG. More...
isc::data::ElementPtr	getItem (const std::string &xpath)
	Get and translate basic value from YANG to JSON. More...
isc::data::ElementPtr	getItems (const std::string &xpath)
	Get and translate a list of basic values from YANG to JSON. More...
sysrepo::S_Iter_Value	getIter (const std::string &xpath)
	List iterator methods keeping the session private. More...
std::string	getNext (sysrepo::S_Iter_Value iter)
	Get xpath of the next YANG list item. More...
void	setItem (const std::string &xpath, isc::data::ConstElementPtr elem, sr_type_t type)
	Translate and set basic value from JSON to YANG. More...

Protected Member Functions
isc::data::ElementPtr	getPdPoolIetf6 (const std::string &xpath)
	getPdPool for ietf-dhcpv6-server. More...
isc::data::ElementPtr	getPdPoolKea (const std::string &xpath)
	getPdPool for kea-dhcp6-server. More...
void	setPdPoolIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPdPool for ietf-dhcpv6-server. More...
void	setPdPoolKea (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPdPool for kea-dhcp6-server. More...
Protected Member Functions inherited from isc::yang::TranslatorOptionDataList
isc::data::ConstElementPtr	getOptionDataListKea (const std::string &xpath)
	getOptionDataList for kea-dhcp[46]. More...
void	setOptionDataListKea (const std::string &xpath, isc::data::ConstElementPtr elem)
	setOptionDataList for kea-dhcp[46]. More...
Protected Member Functions inherited from isc::yang::TranslatorOptionData
isc::data::ElementPtr	getOptionDataKea (const std::string &xpath)
	getOptionData JSON for kea-dhcp[46]. More...
void	setOptionDataKea (const std::string &xpath, isc::data::ConstElementPtr elem)
	setOptionData for kea-dhcp[46]. More...

Additional Inherited Members
Static Public Member Functions inherited from isc::yang::TranslatorBasic
static isc::data::ElementPtr	value (sysrepo::S_Val s_val)
	Translate basic value from YANG to JSON. More...
static sysrepo::S_Val	value (isc::data::ConstElementPtr elem, sr_type_t type)
	Translate basic value from JSON to YANG. More...
Protected Attributes inherited from isc::yang::TranslatorBasic
std::string	model_
	The model. More...
sysrepo::S_Session	session_
	The sysrepo session. More...

Detailed Description

Prefix delegation pool translation between YANG and JSON.

JSON syntax for kea-dhcp6-server is:

{
    "prefix": <prefix base>,
    "prefix-len": <prefix length>,
    "delegated-len": <delegated length>,
    "excluded-prefix": <excluded prefix>,
    "excluded-prefix-len": <excluded prefix length>,
    "option-data": [ <list of option data> ],
    "client-class": "<guard class name>",
    "require-client-classes": [ <list of required class names> ],
    "user-context": { <json map> },
    "comment": "<comment>"
}

YANG syntax for ietf-dhcpv6-server is with pool-id as the key.

+--rw pool-id                     uint32
+--rw prefix                      inet:ipv6-prefix
+--rw prefix-length               uint8
+--rw valid-lifetime              yang:timeticks
+--rw renew-time                  yang:timeticks
+--rw rebind-time                 yang:timeticks
+--rw preferred-lifetime          yang:timeticks
+--rw rapid-commit?               boolean
+--rw client-class?               string
+--rw max-pd-space-utilization?   threshold
+--rw option-set-id?
   /server/server-config/option-sets/option-set/option-set-id

YANG syntax for kea-dhcp6-server is with prefix as the key.

+--rw prefix?                  inet:ipv6-prefix
+--rw delegated-len?           uint8
+--rw excluded-prefix?         inet:ipv6-prefix
+--rw option-data*
+--rw client-class?            string
+--rw require-client-classes*  string
+--rw user-context?            string

An example in JSON and YANG formats:

[
    {
        "prefix": "2001:db8:0:1000::",
        "prefix-len": 56,
        "delegated-len": 64
    }
]

/ietf-dhcpv6-server:server (container)
/ietf-dhcpv6-server:server/server-config (container)
/ietf-dhcpv6-server:server/server-config/network-ranges (container)
/ietf-dhcpv6-server:server/server-config/network-ranges
   network-range[network-range-id='111'] (list instance)
/ietf-dhcpv6-server:server/server-config/network-ranges
   network-range[network-range-id='111']/network-range-id = 111
/ietf-dhcpv6-server:server/server-config/network-ranges
   network-range[network-range-id='111']/network-prefix = 2001:db8::/48
/ietf-dhcpv6-server:server/server-config/network-ranges
   network-range[network-range-id='111']/pd-pools (container)
/ietf-dhcpv6-server:server/server-config/network-ranges
   network-range[network-range-id='111']/pd-pools/
   pd-pool[pool-id='0'] (list instance)
/ietf-dhcpv6-server:server/server-config/network-ranges/
   pd-pool[pool-id='0']/pool-id = 0
   network-range[network-range-id='111']/pd-pools/
   pd-pool[pool-id='0']/prefix = 2001:db8:0:1000::/56
/ietf-dhcpv6-server:server/server-config/network-ranges
   network-range[network-range-id='111']/pd-pools/
   pd-pool[pool-id='0']/prefix-length = 56
/ietf-dhcpv6-server:server/server-config/network-ranges
   network-range[network-range-id='111']/pd-pools/
   pd-pool[pool-id='0']/max-pd-space-utilization = disabled

/kea-dhcp6-server:config (container)
/kea-dhcp6-server:config/subnet6[id='111'] (list instance)
/kea-dhcp6-server:config/subnet6[id='111']/id = 111
/kea-dhcp6-server:config/subnet6[id='111']/subnet = 2001:db8::/48
/kea-dhcp6-server:config/subnet6[id='111']/
   pd-pool[prefix='2001:db8:0:1000::/56' (list instance)
/kea-dhcp6-server:config/subnet6[id='111']/
   pd-pool[prefix='2001:db8:0:1000::/56'/prefix = 2001:db8:0:1000::/56
/kea-dhcp6-server:config/subnet6[id='111']/
   pd-pool[prefix='2001:db8:0:1000::/56'/delegated-len = 64

A translator class for converting a pd-pool between YANG and JSON.

Currently supported models:

• kea-dhcp6-server
• ietf-dhcpv6-server (partial support)

Definition at line 116 of file translator_pd_pool.h.

Constructor & Destructor Documentation

isc::yang::TranslatorPdPool::TranslatorPdPool	(	sysrepo::S_Session	session,
		const std::string &	model
	)

Constructor.

Parameters

session	Sysrepo session.
model	Model name.

Definition at line 24 of file translator_pd_pool.cc.

isc::yang::TranslatorPdPool::~TranslatorPdPool ( )

virtual

Destructor.

Definition at line 30 of file translator_pd_pool.cc.

Member Function Documentation

ElementPtr isc::yang::TranslatorPdPool::getPdPool

(

const std::string &

xpath

)

Get and translate a pd-pool from YANG to JSON.

Parameters

xpath

The xpath of the pd-pool.

Returns

JSON representation of the pd-pool.

Exceptions

SysrepoError	when sysrepo raises an error.
BadValue	on pd-pool without well formed prefix.

Definition at line 34 of file translator_pd_pool.cc.

References getPdPoolIetf6(), getPdPoolKea(), isc_throw, isc::yang::TranslatorBasic::model_, and isc::Exception::what().

Referenced by isc::yang::TranslatorPdPools::getPdPoolsCommon().

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorPdPool::getPdPoolIetf6 ( const std::string &  xpath )

protected

getPdPool for ietf-dhcpv6-server.

Parameters

xpath

The xpath of the pd-pool.

Returns

JSON representation of the pd-pool.

Exceptions

SysrepoError

when sysrepo raises an error.

Definition at line 51 of file translator_pd_pool.cc.

References isc::yang::TranslatorBasic::getItem(), and isc_throw.

Referenced by getPdPool().

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorPdPool::getPdPoolKea ( const std::string &  xpath )

protected

getPdPool for kea-dhcp6-server.

Parameters

xpath

The xpath of the pd-pool.

Returns

JSON representation of the pd-pool.

Exceptions

SysrepoError

when sysrepo raises an error.

Definition at line 104 of file translator_pd_pool.cc.

References isc::yang::TranslatorBasic::getItem(), isc::yang::TranslatorBasic::getItems(), isc::yang::TranslatorOptionDataList::getOptionDataList(), and isc_throw.

Referenced by getPdPool().

Here is the call graph for this function:

void isc::yang::TranslatorPdPool::setPdPool	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem
	)

Translate and set pd-pool from JSON to YANG.

Parameters

xpath	The xpath of the pd-pool.
elem	The JSON element.

Definition at line 183 of file translator_pd_pool.cc.

References isc_throw, isc::yang::TranslatorBasic::model_, setPdPoolIetf6(), setPdPoolKea(), and isc::Exception::what().

Referenced by isc::yang::TranslatorPdPools::setPdPoolsId(), and isc::yang::TranslatorPdPools::setPdPoolsPrefix().

Here is the call graph for this function:

void isc::yang::TranslatorPdPool::setPdPoolIetf6 ( const std::string &  xpath, isc::data::ConstElementPtr  elem  )

protected

setPdPool for ietf-dhcpv6-server.

Parameters

xpath	The xpath of the pd-pool.
elem	The JSON element.

Exceptions

BadValue

on pd-pool without prefix or prefix length.

Definition at line 201 of file translator_pd_pool.cc.

References isc_throw, and isc::yang::TranslatorBasic::setItem().

Referenced by setPdPool().

Here is the call graph for this function:

void isc::yang::TranslatorPdPool::setPdPoolKea ( const std::string &  xpath, isc::data::ConstElementPtr  elem  )

protected

setPdPool for kea-dhcp6-server.

Parameters

xpath	The xpath of the pd-pool.
elem	The JSON element.

Definition at line 243 of file translator_pd_pool.cc.

References isc::yang::Adaptor::getContext(), isc::yang::TranslatorBasic::setItem(), and isc::yang::TranslatorOptionDataList::setOptionDataList().

Referenced by setPdPool().

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• translator_pd_pool.h
• translator_pd_pool.cc