isc::yang::TranslatorPool Class Reference

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

#include <translator_pool.h>

Inheritance diagram for isc::yang::TranslatorPool:

Public Member Functions
	TranslatorPool (sysrepo::S_Session session, const std::string &model)
	Constructor. More...
virtual	~TranslatorPool ()
	Destructor. More...
isc::data::ElementPtr	getPool (const std::string &xpath)
	Get and translate a pool from YANG to JSON. More...
void	setPool (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set (address) 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...

Static Public Member Functions
static void	getAddresses (const std::string &prefix, std::string &start_address, std::string &end_address)
	Get start and end addresses from prefix. More...
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 Member Functions
isc::data::ElementPtr	getPoolIetf6 (const std::string &xpath)
	getPool for ietf-dhcpv6-server. More...
isc::data::ElementPtr	getPoolKea (const std::string &xpath)
	getPool for kea-dhcp[46]-server. More...
void	setPoolIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPool for ietf-dhcpv6-server. More...
void	setPoolKea (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPool for kea-dhcp[46]-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
Protected Attributes inherited from isc::yang::TranslatorBasic
std::string	model_
	The model. More...
sysrepo::S_Session	session_
	The sysrepo session. More...

Detailed Description

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

Currently supports on kea-dhcp[46]-server and partially ietf-dhcpv6-server.

JSON syntax for both kea-dhcp4 and kea-dhcp6 is:

{
    "pool": "<pool prefix or start - end addresses>",
    "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 is for ietf-dhcpv6-server is with pool-id as the key:

+--rw pool-id               uint32
+--rw pool-prefix           inet:ipv6-prefix
+--rw start-address         inet:ipv6-address-no-zone
+--rw end-address           inet:ipv6-address-no-zone
+--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-address-count     threshold
+--rw option-set-id
   /server/server-config/option-sets/option-set/option-set-id

YANG syntax for kea-dhcp[46] is with start-address and end-address as the keys:

+--rw prefix?                  inet:ipv[46]-prefix
+--rw start-address            inet:ipv[46]-address
+--rw end-address              inet:ipv[46]-address
+--rw option-data*
+--rw client-class?            string
+--rw require-client-classes*  string
+--rw user-context?            string

An example in JSON and YANG formats for the IETF model:

[
    {
        "pool": "2001:db8::/112"
    }
]

/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']/address-pools (container)
/ietf-dhcpv6-server:server/server-config/network-ranges/
   network-range[network-range-id='111']/address-pools/
   address-pool[pool-id='0'] (list instance)
/ietf-dhcpv6-server:server/server-config/network-ranges/
   network-range[network-range-id='111']/address-pools/
   address-pool[pool-id='0']/pool-id = 0
/ietf-dhcpv6-server:server/server-config/network-ranges/
   network-range[network-range-id='111']/address-pools/
   address-pool[pool-id='0']/pool-prefix = 2001:db8::1:0/112
/ietf-dhcpv6-server:server/server-config/network-ranges/
   network-range[network-range-id='111']/address-pools/
   address-pool[pool-id='0']/start-address = 2001:db8::1:0
/ietf-dhcpv6-server:server/server-config/network-ranges/
   network-range[network-range-id='111']/address-pools/
   address-pool[pool-id='0']/end-address = 2001:db8::1:ffff
/ietf-dhcpv6-server:server/server-config/network-ranges/
   network-range[network-range-id='111']/address-pools/
   address-pool[pool-id='0']/max-address-count = disabled

An example in JSON and YANG formats for the Kea model:

[
    {
        "pool": "2001:db8::1 - 2001:db8::100"
    }
]

/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']/
   pool[start-address='2001:db8::1'][end-address='2001:db8::100']
   (list instance)
/kea-dhcp6-server:config/subnet6[id='111']/
   pool[start-address='2001:db8::1'][end-address='2001:db8::100']/
   start-address = 2001:db8::1
/kea-dhcp6-server:config/subnet6[id='111']/
   pool[start-address='2001:db8::1'][end-address='2001:db8::100']/
   end-address = 2001:db8::100

Definition at line 124 of file translator_pool.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters

session	Sysrepo session.
model	Model name.

Definition at line 27 of file translator_pool.cc.

isc::yang::TranslatorPool::~TranslatorPool ( )

virtual

Destructor.

Definition at line 33 of file translator_pool.cc.

Member Function Documentation

void isc::yang::TranslatorPool::getAddresses ( const std::string &  prefix, std::string &  start_address, std::string &  end_address  )

static

Get start and end addresses from prefix.

Parameters

prefix	The prefix string.
start_address	The reference to the start_address.
end_address	The reference to the end_address.

Exceptions

BadValue

when the prefix is not correctly formed.

Definition at line 248 of file translator_pool.cc.

References isc::asiolink::firstAddrInPrefix(), isc_throw, isc::asiolink::lastAddrInPrefix(), and isc::asiolink::IOAddress::toText().

Referenced by setPoolKea(), and isc::yang::TranslatorPools::setPoolsByAddresses().

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorPool::getPool

(

const std::string &

xpath

)

Get and translate a pool from YANG to JSON.

Parameters

xpath

The xpath of the pool.

Returns

JSON representation of the pool.

Exceptions

SysrepoError

when sysrepo raises an error.

Definition at line 37 of file translator_pool.cc.

References getPoolIetf6(), getPoolKea(), isc_throw, isc::yang::TranslatorBasic::model_, and isc::Exception::what().

Referenced by isc::yang::TranslatorPools::getPoolsIetf(), and isc::yang::TranslatorPools::getPoolsKea().

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorPool::getPoolIetf6 ( const std::string &  xpath )

protected

getPool for ietf-dhcpv6-server.

Parameters

xpath

The xpath of the pool.

Returns

JSON representation of the pool.

Exceptions

BadValue

on pool without prefix.

no require-client-classes nor user-context.

Definition at line 55 of file translator_pool.cc.

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

Referenced by getPool().

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorPool::getPoolKea ( const std::string &  xpath )

protected

getPool for kea-dhcp[46]-server.

Parameters

xpath

The xpath of the pool.

Returns

JSON representation of the pool.

Exceptions

BadValue

on a pool without prefix and start or end address.

Definition at line 93 of file translator_pool.cc.

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

Referenced by getPool().

Here is the call graph for this function:

void isc::yang::TranslatorPool::setPool	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem
	)

Translate and set (address) pool from JSON to YANG.

Parameters

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

Definition at line 130 of file translator_pool.cc.

References isc_throw, isc::yang::TranslatorBasic::model_, setPoolIetf6(), setPoolKea(), and isc::Exception::what().

Referenced by isc::yang::TranslatorPools::setPoolsByAddresses(), and isc::yang::TranslatorPools::setPoolsById().

Here is the call graph for this function:

void isc::yang::TranslatorPool::setPoolIetf6 ( const std::string &  xpath, isc::data::ConstElementPtr  elem  )

protected

setPool for ietf-dhcpv6-server.

Parameters

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

Exceptions

BadValue

on pool without prefix and with a range which is not a prefix.

Definition at line 149 of file translator_pool.cc.

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

Referenced by setPool().

Here is the call graph for this function:

void isc::yang::TranslatorPool::setPoolKea ( const std::string &  xpath, isc::data::ConstElementPtr  elem  )

protected

setPool for kea-dhcp[46]-server.

Parameters

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

Exceptions

BadValue

on a pool without a well formed prefix.

Definition at line 202 of file translator_pool.cc.

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

Referenced by setPool().

Here is the call graph for this function:

---

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

• translator_pool.h
• translator_pool.cc