Subnet (aka network range) translation between YANG and JSON. More...

#include <translator_subnet.h>

Inheritance diagram for isc::yang::TranslatorSubnet:

Public Member Functions
	TranslatorSubnet (sysrepo::S_Session session, const std::string &model)
	Constructor. More...

virtual	~TranslatorSubnet ()
	Destructor. More...

isc::data::ElementPtr	getSubnet (const std::string &xpath)
	Get and translate a subnet from YANG to JSON. More...

void	setSubnet (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set subnet from JSON to YANG. More...

Public Member Functions inherited from isc::yang::TranslatorPools
	TranslatorPools (sysrepo::S_Session session, const std::string &model)
	Constructor. More...

virtual	~TranslatorPools ()
	Destructor. More...

isc::data::ElementPtr	getPools (const std::string &xpath)
	Get and translate pools from YANG to JSON. More...

void	setPools (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set (address) pools from JSON to YANG. More...

Public Member Functions inherited from isc::yang::TranslatorPool
	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...

Public Member Functions inherited from isc::yang::TranslatorPdPools
	TranslatorPdPools (sysrepo::S_Session session, const std::string &model)
	Constructor. More...

virtual	~TranslatorPdPools ()
	Destructor. More...

isc::data::ElementPtr	getPdPools (const std::string &xpath)
	Get and translate pd-pools from YANG to JSON. More...

void	setPdPools (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set pd-pools from JSON to YANG. More...

Public Member Functions inherited from isc::yang::TranslatorPdPool
	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::TranslatorHosts
	TranslatorHosts (sysrepo::S_Session session, const std::string &model)
	Constructor. More...

virtual	~TranslatorHosts ()
	Destructor. More...

isc::data::ElementPtr	getHosts (const std::string &xpath)
	Get and translate host reservations from YANG to JSON. More...

void	setHosts (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set (address) host reservations from JSON to YANG. More...

Public Member Functions inherited from isc::yang::TranslatorHost
	TranslatorHost (sysrepo::S_Session session, const std::string &model)
	Constructor. More...

virtual	~TranslatorHost ()
	Destructor. More...

isc::data::ElementPtr	getHost (const std::string &xpath)
	Get and translate a host reservation from YANG to JSON. More...

void	setHost (const std::string &xpath, isc::data::ConstElementPtr elem)
	Translate and set host reservation from JSON to YANG. More...

Protected Member Functions
isc::data::ElementPtr	getSubnetIetf6 (const std::string &xpath)
	getSubnet for ietf-dhcpv6-server. More...

isc::data::ElementPtr	getSubnetKea (const std::string &xpath)
	getSubnet for kea-dhcp[46]-server. More...

void	setSubnetIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem)
	setSubnet for ietf-dhcpv6-server. More...

void	setSubnetKea (const std::string &xpath, isc::data::ConstElementPtr elem)
	setSubnet for kea-dhcp[46]-server. More...

Protected Member Functions inherited from isc::yang::TranslatorPools
isc::data::ElementPtr	getPoolsIetf (const std::string &xpath)
	getPools for ietf-dhcpv6-server. More...

isc::data::ElementPtr	getPoolsKea (const std::string &xpath)
	getPools for kea-dhcp[46]-server. More...

void	setPoolsByAddresses (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPools using address pair. More...

void	setPoolsById (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPools using pool-id. More...

Protected Member Functions inherited from isc::yang::TranslatorPool
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...

Protected Member Functions inherited from isc::yang::TranslatorPdPools
isc::data::ElementPtr	getPdPoolsCommon (const std::string &xpath)
	getPdPools common part. More...

void	setPdPoolsId (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPdPools using pool-id. More...

void	setPdPoolsPrefix (const std::string &xpath, isc::data::ConstElementPtr elem)
	setPdPools using prefix. More...

Protected Member Functions inherited from isc::yang::TranslatorPdPool
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::TranslatorHosts
void	setHostsKea (const std::string &xpath, isc::data::ConstElementPtr elem)
	setHosts for kea-dhcp[46]. More...

Protected Member Functions inherited from isc::yang::TranslatorHost
isc::data::ElementPtr	getHostKea (const std::string &xpath)
	getHost for kea-dhcp[46]-server models. More...

void	setHostKea (const std::string &xpath, isc::data::ConstElementPtr elem)
	setHost for kea-dhcp[46]-server models. More...

Additional Inherited Members
Static Public Member Functions inherited from isc::yang::TranslatorPool
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 Attributes inherited from isc::yang::TranslatorBasic
std::string	model_
	The model. More...

sysrepo::S_Session	session_
	The sysrepo session. More...

Detailed Description

Subnet (aka network range) translation between YANG and JSON.

JSON syntax for kea-dhcp4 is:

{
    "valid-lifetime": <valid lifetime>,
    "min-valid-lifetime": <minimum valid lifetime>,
    "max-valid-lifetime": <maximum valid lifetime>,
    "renew-timer": <renew timer>,
    "rebind-timer": <rebind timer>,
    "calculate-tee-times": <calculate T1/T2 times>,
    "t1-percent": <T1 percent>,
    "t2-percent": <T2 percent>,
    "option-data": [ <list of option data> ],
    "pools": [ <list of pools> ],
    "subnet": "<subnet prefix>",
    "interface": "<interface>",
    "id": <id>,
    "client-class": "<guard class name>",
    "require-client-classes": [ <list of required class names> ],
    "reservations": [ <list of host reservations> ],
    "reservation-mode": <host reservation mode>,
    "relay": <relay ip address(es)>,
    "match-client-id": <match client id flag>,
    "next-server": "<next server>",
    "server-hostname": "<server hostname>",
    "boot-file-name": "<boot file name>",
    "4o6-interface": "<dhcpv4-over-dhcpv6 interface>",
    "4o6-interface-id": "<dhcpv4-over-dhcpv6 interface id>",
    "4o6-subnet": "<dhcpv4-over-dhcpv6 subnet>",
    "authoritative": <authoritative flag>,
    "user-context": { <json map> },
    "comment": "<comment>"
}

JSON syntax for kea-dhcp6 is:

{
    "preferred-lifetime": <preferred lifetime>,
    "min-preferred-lifetime": <minimum preferred lifetime>,
    "max-preferred-lifetime": <maximum preferred lifetime>,
    "valid-lifetime": <valid lifetime>,
    "min-valid-lifetime": <minimum valid lifetime>,
    "max-valid-lifetime": <maximum valid lifetime>,
    "renew-timer": <renew timer>,
    "rebind-timer": <rebind timer>,
    "calculate-tee-times": <calculate T1/T2 times>,
    "t1-percent": <T1 percent>,
    "t2-percent": <T2 percent>,
    "option-data": [ <list of option data> ],
    "pools": [ <list of pools> ],
    "pd-pools": [ <list of prefix delegation pools> ],
    "subnet": "<subnet prefix>",
    "interface": "<interface>",
    "interface-id": "<interface id>",
    "id": <id>,
    "rapid-commit": <rapid commit flag>,
    "client-class": "<guard class name>",
    "require-client-classes": [ <list of required class names> ],
    "reservations": [ <list of host reservations> ],
    "reservation-mode": <host reservation mode>,
    "relay": <relay ip address(es)>,
    "user-context": { <json map> },
    "comment": "<comment>"
}

YANG syntax for ietf-dhcpv6-server is with network-range-id as the key:

+--rw network-range-id      uint32
+--rw network-description   string
+--rw network-prefix        inet:ipv4-prefix
+--rw option-set-id?
   /server/server-config/option-sets/option-set/option-set-id
+--rw address-pool*         [pool-id]
+--rw pd-pool*              [pool-id]
+--rw host-reservations     host-reservation* [cli-id]

YANG syntax for kea-dhcp[46]-server is with id as the key:

+--rw valid-lifetime?           uint32
+--rw min-valid-lifetime?       uint32
+--rw max-valid-lifetime?       uint32
+--rw renew-timer?              uint32
+--rw rebind-timer?             uint32
+--rw calculate-tee-times?      boolean
+--rw t1-percent?               decimal64
+--rw t2-percent?               decimal64
+--rw option-data*
+--rw pool*
+--rw subnet                    inet:ip-prefix
+--rw interface?                string
+--rw id                        uint32
+--rw client-class?             string
+--rw require-client-classes*   string
+--rw host*
+--rw reservation-mode?         enumeration
+--rw relay                     ip-addresses*
+--rw user-context?             string
(DHCPv4 only)
+--rw match-client-id?          boolean
+--rw next-server?              inet:ipv4-address
+--rw server-hostname?          string
+--rw boot-file-name?           string
+--rw subnet-4o6-interface?     string
+--rw subnet-4o6-interface-id?  string
+--rw subnet-4o6-subnet?        inet:ipv6-prefix
+--rw authoritative?            boolean
(DHCPv6 only)
+--rw preferred-lifetime?       uint32
+--rw min-preferred-lifetime?   uint32
+--rw max-preferred-lifetime?   uint32
+--rw pd-pool*
+--rw interface-id?             string
+--rw rapid-commit?             boolean

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

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

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

[
    {
        "subnet": "10.0.1.0/24",
        "id": 123,
        "pools":
            [
                {
                    "pool": "10.0.1.0/28",
                },
                {
                    "pool": "10.0.1.200 - 10.0.1.222"
                }
            ]
    }
]

/kea-dhcp4-server:config (container)
/kea-dhcp4-server:config/subnet4[id='123'] (list instance)
/kea-dhcp4-server:config/subnet4[id='123']/id = 123
/kea-dhcp4-server:config/subnet4[id='123']/
   pool[start-address='10.0.1.0'][end-address='10.0.1.15'] (list instance)
/kea-dhcp4-server:config/subnet4[id='123']/
   pool[start-address='10.0.1.0'][end-address='10.0.1.15']/
   start-address = 10.0.1.0
/kea-dhcp4-server:config/subnet4[id='123']/
   pool[start-address='10.0.1.0'][end-address='10.0.1.15']/
   end-address = 10.0.1.15
/kea-dhcp4-server:config/subnet4[id='123']/
   pool[start-address='10.0.1.0'][end-address='10.0.1.15']/
   prefix = 10.0.1.0/28
/kea-dhcp4-server:config/subnet4[id='123']/
   pool[start-address='10.0.1.200'][end-address='10.0.1.222']
   (list instance)
/kea-dhcp4-server:config/subnet4[id='123']/
   pool[start-address='10.0.1.200'][end-address='10.0.1.222']/
   start-address = 10.0.1.200
/kea-dhcp4-server:config/subnet4[id='123']/
   pool[start-address='10.0.1.200'][end-address='10.0.1.222']/
   end-address = 10.0.1.222
/kea-dhcp4-server:config/subnet4[id='123']/subnet = 10.0.1.0/24

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

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

Definition at line 254 of file translator_subnet.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters

session	Sysrepo session.
model	Model name.

Definition at line 23 of file translator_subnet.cc.

isc::yang::TranslatorSubnet::~TranslatorSubnet ( )

virtual

Destructor.

Definition at line 35 of file translator_subnet.cc.

Member Function Documentation

ElementPtr isc::yang::TranslatorSubnet::getSubnet ( const std::string & xpath )

Get and translate a subnet from YANG to JSON.

Parameters

xpath The xpath of the subnet.

Returns: JSON representation of the subnet.

Exceptions

SysrepoError	when sysrepo raises an error.
BadValue	on a subnet without prefix or id.

Definition at line 39 of file translator_subnet.cc.

References getSubnetIetf6(), getSubnetKea(), isc_throw, isc::yang::TranslatorBasic::model_, and isc::Exception::what().

Referenced by isc::yang::TranslatorSubnets::getSubnetsCommon().

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorSubnet::getSubnetIetf6 ( const std::string & xpath )

protected

getSubnet for ietf-dhcpv6-server.

Parameters

xpath The xpath of the subnet.

Returns: JSON representation of the subnet.

Todo:: timers

Todo:: : option-data

Set empty list too.

Todo:: : reservations missing a lot of things

Adding description if exists.

missing a lot of things

Definition at line 57 of file translator_subnet.cc.

References isc::yang::TranslatorBasic::getItem(), isc::yang::TranslatorPdPools::getPdPools(), isc::yang::TranslatorPools::getPools(), isc_throw, isc::yang::TranslatorBasic::model_, and isc::yang::AdaptorPool::toSubnet().

Referenced by getSubnet().

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorSubnet::getSubnetKea ( const std::string & xpath )

protected

getSubnet for kea-dhcp[46]-server.

Parameters

xpath The xpath of the subnet.

Returns: JSON representation of the subnet.

Definition at line 95 of file translator_subnet.cc.

References isc::yang::TranslatorHosts::getHosts(), isc::yang::TranslatorBasic::getItem(), isc::yang::TranslatorBasic::getItems(), isc::yang::TranslatorOptionDataList::getOptionDataList(), isc::yang::TranslatorPdPools::getPdPools(), isc::yang::TranslatorPools::getPools(), isc_throw, and isc::yang::TranslatorBasic::model_.

Referenced by getSubnet().

Here is the call graph for this function:

void isc::yang::TranslatorSubnet::setSubnet	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem
	)

Translate and set subnet from JSON to YANG.

Parameters

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

Exceptions

BadValue on a subnet without prefix.

Definition at line 248 of file translator_subnet.cc.

References isc_throw, isc::yang::TranslatorBasic::model_, setSubnetIetf6(), setSubnetKea(), and isc::Exception::what().

Referenced by isc::yang::TranslatorSubnets::setSubnetsIetf6(), and isc::yang::TranslatorSubnets::setSubnetsKea().

Here is the call graph for this function:

void isc::yang::TranslatorSubnet::setSubnetIetf6	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem
	)

protected

setSubnet for ietf-dhcpv6-server.

Parameters

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

Skip id as it is the key.

Todo:: option-data

Todo:: reservations

Definition at line 267 of file translator_subnet.cc.

References isc::yang::AdaptorPool::fromSubnet(), isc_throw, isc::yang::TranslatorBasic::model_, isc::yang::TranslatorBasic::setItem(), isc::yang::TranslatorPdPools::setPdPools(), and isc::yang::TranslatorPools::setPools().

Referenced by setSubnet().

Here is the call graph for this function:

void isc::yang::TranslatorSubnet::setSubnetKea	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem
	)

protected

setSubnet for kea-dhcp[46]-server.

Parameters

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

Skip id as it is the key.

Definition at line 295 of file translator_subnet.cc.

References isc::yang::Adaptor::getContext(), isc_throw, isc::yang::TranslatorBasic::model_, isc::yang::TranslatorHosts::setHosts(), isc::yang::TranslatorBasic::setItem(), isc::yang::TranslatorOptionDataList::setOptionDataList(), isc::yang::TranslatorPdPools::setPdPools(), and isc::yang::TranslatorPools::setPools().

Referenced by setSubnet().

Here is the call graph for this function:

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation