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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
|||
|
string |
Yes |
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. - CIDR Notation |
||
|
integer |
No* |
128 |
Netmask to use with IPs pulled from the pool. - CIDR Notation |
|
|
integer |
Yes |
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. - CIDR Notation |
||
|
string |
Yes |
eth0, lo |
||
|
string |
Yes |
|||
|
string |
No* |
random, sequential |
sequential |
The Distribution Policy controls how IPv6 Addresses are assigned from the pool. |
|
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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
IPv6 Address |
||
|
string |
Yes |
IPv6 Address |
||
|
string |
No |
Action: deletePool
¶
- Added in Version
5.0.14-579
- Description
Delete an unused IPv6 Pool.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
2001::/64, 2001::/24 |
Action: deleteReservation
¶
- Added in Version
5.0.14-579
- Description
Delete a reserved IP or range.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (integer) |
Yes |
Action: editPool
¶
- Added in Version
5.0.14-579
- Description
Edit an IPv6 Pool.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
2001::/64, 2001::/24 |
||
|
string |
No* |
##LG_IPV6_SUBPOOL_OF_X|Pool Test## |
||
|
integer |
No* |
128 |
Netmask to use with IPs pulled from the pool. - CIDR Notation |
|
|
string |
No* |
eth0, lo |
eth0 |
|
|
string |
No* |
2001::db8/24 |
||
|
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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
string |
No* |
2001::db8/24 |
IPv6 Address |
|
|
string |
No* |
2001::db8/24 |
IPv6 Address |
|
|
string |
No |
##LG_IPV6_RESERVED_GATEWAY|Pool Test## |
* indicates that it’s actually required, but probably already has a valid default value.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
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' => '2001::/64',
'nickname' => '##LG_IPV6_SUBPOOL_OF_X|Pool Test##',
'range_start' => '42540488161975842760550356425300246528',
'range_end' => '42540488161975842778997100499009798143',
'distribution_policy' => 'sequential',
'dedicated_reseller_id' => '0',
'device' => 'eth0',
'netmask_cidr' => '128',
'dedicated_siteworx_id' => '0',
'reseller_count' => '0',
'used_by' => NULL,
'parent_id' => '1',
),
1 =>
array (
'cidr_format' => '2001::/24',
'nickname' => 'Pool Test',
'range_start' => '42540488161975842760550356425300246528',
'range_end' => '42540508444385446412220780372551532543',
'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',
),
),
'reply_code' => 205,
)
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' => '2',
'range_start' => '2001::db8/24',
'range_end' => '2001::db8/24',
'note' => '##LG_IPV6_RESERVED_GATEWAY|Pool Test##',
),
),
'reply_code' => 205,
)
Action: queryEditPool
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “editPool”.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
2001::/64, 2001::/24 |
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'nickname' => '##LG_IPV6_SUBPOOL_OF_X|Pool Test##',
'ipv6_with_cidr' => '2001::/64',
'cidr' => '128',
'subpool_size' => '64',
'device' => 'eth0',
'gateway' => '2001::db8/24',
'distribution_policy' => 'sequential',
'reseller_id' => '0',
'pool' => '2001::/64',
),
'reply_code' => 205,
)
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' => '2001::db8/24',
'range_end' => '2001::db8/24',
'note' => '##LG_IPV6_RESERVED_GATEWAY|Pool Test##',
'id' => '2',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.