Chapter 21: Controller: /nodeworx/ip/sites Up Part II: NodeWorx API Spec Chapter 23: Controller: /nodeworx/lang 

22 Controller: /nodeworx/ipv6

Required Permissions "IPS"
Action: addPool
Added in version 5.0.14-579
Description Add a new IPv6 Pool.
Input Parameters
Name Type Notes Required?
nickname string Yes
ipv6_with_cidr string Description
CIDR Notation
Help Entry
Use Classless Inter Domain Routing (CIDR) notation to designate a block of IPs to use in the pool - for example, 2001:db8::/32. The CIDR is used to define the size of the pool to pull from, not the netmask of the resulting IPs.
Yes
cidr integer Description
CIDR Notation
Help Entry
Netmask to use with IPs pulled from the pool.
Example Default Value
128
No*
subpool_size integer Description
CIDR Notation
Help Entry
This value determines the size of smaller, dedicated Subpools that will be generated from the parent. Each Subpool will be dedicated to a single SiteWorx account, allowing easier management of IPv6 networking. To disable the feature, leave the Subpool Size the same as the CIDR of the Pool itself.
Yes
device string Example Values
eth0, lo
Yes
gateway string Yes
distribution_policy string Help Entry
The Distribution Policy controls how IPv6 Addresses are assigned from the pool.
Example Values
random, sequential
Example Default Value
sequential
No*
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: addReservation
Added in version 5.0.14-579
Description Add a reserved IP or range.
Input Parameters
Name Type Notes Required?
range_start string Description
IPv6 Address
Yes
range_end string Description
IPv6 Address
Yes
note string No
Action: deletePool
Added in version 5.0.14-579
Description Delete an unused IPv6 Pool.
Input Parameters
Name Type Notes Required?
pool struct (string) Example Values
dead::/64, dead::/24
Yes
Action: deleteReservation
Added in version 5.0.14-579
Description Delete a reserved IP or range.
Input Parameters
Name Type Notes Required?
id struct (integer) Yes
Action: editPool
Added in version 5.0.14-579
Description Edit an IPv6 Pool.
Input Parameters
Name Type Notes Required?
pool string Example Values
dead::/64, dead::/24
Yes
nickname string Example Default Value
##LG_IPV6_SUBPOOL_OF_X|Pool Test##
No*
cidr integer Description
CIDR Notation
Help Entry
Netmask to use with IPs pulled from the pool.
Example Default Value
128
No*
device string Example Values
eth0, lo
Example Default Value
eth0
No*
gateway string Example Default Value
dead::beef/24
No*
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editReservation
Added in version 5.0.14-579
Description Edit a reserved IP or range.
Input Parameters
Name Type Notes Required?
id integer Yes
range_start string Description
IPv6 Address
Example Default Value
dead::beef/24
No*
range_end string Description
IPv6 Address
Example Default Value
dead::beef/24
No*
note string Example Default Value
##LG_IPV6_RESERVED_GATEWAY|Pool Test##
No
* indicates that it’s actually required, but probably already has a valid default value
Action: listPools
Added in version 5.0.14-579
Description Lists information about configured IPv6 Pools.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’cidr_format’ => ’dead::/64’,
’nickname’ => ’##LG_IPV6_SUBPOOL_OF_X|Pool Test##’,
’range_start’ => ’295986882420777848964380943247191572480’,
’range_end’ => ’295986882420777848982827687320901124095’,
’distribution_policy’ => ’sequential’,
’dedicated_reseller_id’ => ’0’,
’device’ => ’eth0’,
’netmask_cidr’ => ’128’,
’dedicated_siteworx_id’ => ’0’,
’reseller_count’ => ’0’,
’used_by’ => NULL,
’parent_id’ => ’2’,
),
1 =>
array (
’cidr_format’ => ’dead::/24’,
’nickname’ => ’Pool Test’,
’range_start’ => ’295986882420777848964380943247191572480’,
’range_end’ => ’295986902703187452616051367194442858495’,
’distribution_policy’ => ’sequential’,
’dedicated_reseller_id’ => ’0’,
’device’ => ’eth0’,
’netmask_cidr’ => ’128’,
’dedicated_siteworx_id’ => ’0’,
’reseller_count’ => ’0’,
’used_by’ => NULL,
’parent_id’ => ’0’,
),
),
)
Action: listReserved
Added in version 5.0.14-579
Description Lists information reserved IPv6 addresses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’1’,
’range_start’ => ’::1’,
’range_end’ => ’::1’,
’note’ => ’##LG_IPV6_RESERVED_LOOPBACK##’,
),
1 =>
array (
’id’ => ’3’,
’range_start’ => ’dead::beef/24’,
’range_end’ => ’dead::beef/24’,
’note’ => ’##LG_IPV6_RESERVED_GATEWAY|Pool Test##’,
),
),
)
Action: queryEditPool
Added in version 5.1.0-838
Description Displays the information available to the action "editPool".
Input Parameters
Name Type Notes Required?
pool string Example Values
dead::/64, dead::/24
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’nickname’ => ’##LG_IPV6_SUBPOOL_OF_X|Pool Test##’,
’ipv6_with_cidr’ => ’dead::/64’,
’cidr’ => ’128’,
’subpool_size’ => ’64’,
’device’ => ’eth0’,
’gateway’ => ’dead::beef/24’,
’distribution_policy’ => ’sequential’,
’reseller_id’ => ’0’,
’pool’ => ’dead::/64’,
),
)
Action: queryEditReservation
Added in version 5.1.0-838
Description Displays the information available to the action "editReservation".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’range_start’ => ’dead::beef/24’,
’range_end’ => ’dead::beef/24’,
’note’ => ’##LG_IPV6_RESERVED_GATEWAY|Pool Test##’,
’id’ => ’3’,
),
)
 Chapter 21: Controller: /nodeworx/ip/sites Up Part II: NodeWorx API Spec Chapter 23: Controller: /nodeworx/lang 

(C) 2017 by InterWorx LLC