Note
You are viewing the documentation for a development version of Interworx (7.11). To see documentation for the current generally available release of Interworx, click here: 7.13.
Controller: /nodeworx/ip¶
- Required Permissions
IPS
Action: activate
¶
- Added in Version
5.0.14-579
- Description
Activate an IP.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
Action: add
¶
- Added in Version
4.7.0-339
- Description
Add an ip address range.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
IPv6 or IPv4 |
||
|
string |
Yes |
IPv6 or IPv4 |
||
|
string |
Yes |
|||
|
string |
Yes |
eth0, lo |
||
|
string |
Yes |
static, shared |
||
|
integer |
Yes |
1, 0 |
||
|
integer |
Yes |
1, 0 |
Action: delete
¶
- Added in Version
5.0.14-579
- Description
Deletes an IP from the system.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.3, 192.168.0.4, 192.168.0.5 |
||
|
struct (integer) |
No* |
1 |
* indicates that it’s actually required, but probably already has a valid default value.
Action: edit
¶
- Added in Version
5.0.14-579
- Description
Edit an IP Address.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
||
|
string |
No |
|||
|
integer |
No* |
0, 1 |
0 |
* 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: forceRemoveVipStatus
¶
- Added in Version
5.1.51-1304
- Description
Remove VIP Status (internal use).
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
Action: import
¶
- Added in Version
5.0.14-579
- Description
Imports a system IP to InterWorx.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
192.168.0.1 |
Action: listIpAddresses
¶
- Added in Version
5.0.14-579
- Description
List ipv4 addresses on the system.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'ipaddr' => '192.168.0.1',
'ext_ipaddr' => '192.168.0.1',
'device' => 'eth0',
'type' => NULL,
'reseller' => 0,
'vip' => 0,
'sys_aware' => 1,
'iworx_aware' => 0,
'iworx_managed' => 0,
'resellers' => '',
'domains' => '',
'assigned_to_reseller' => NULL,
'ssl_domain' => NULL,
'is_internal' => NULL,
'siteworx_count' => NULL,
'version' => '4',
'netmask' => '255.255.240.0',
),
1 =>
array (
'ipaddr' => '192.168.0.2',
'ext_ipaddr' => '192.168.0.2',
'device' => 'eth0:0',
'type' => 'shared',
'reseller' => 1,
'vip' => 1,
'sys_aware' => 1,
'iworx_aware' => 1,
'iworx_managed' => 0,
'resellers' => 'Reseller Nickname',
'domains' => 'example.com,pointer.com,secondary.com',
'assigned_to_reseller' => true,
'ssl_domain' => 'example.com',
'is_internal' => true,
'siteworx_count' => 1,
'version' => '4',
'netmask' => '255.255.240.0',
),
2 =>
array (
'ipaddr' => '192.168.0.3',
'ext_ipaddr' => '192.168.0.3',
'device' => 'eth0:iw0',
'type' => 'shared',
'reseller' => 0,
'vip' => 1,
'sys_aware' => 1,
'iworx_aware' => 1,
'iworx_managed' => 0,
'resellers' => '',
'domains' => '',
'assigned_to_reseller' => false,
'ssl_domain' =>
array (
),
'is_internal' => true,
'siteworx_count' => 0,
'version' => '4',
'netmask' => '255.255.255.0',
),
),
'reply_code' => 205,
)
Action: queryDomains
¶
- Added in Version
5.0.14-579
- Description
Show domains on an IP address.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
Action: queryEdit
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “edit”.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'ip_copy' => '192.168.0.2',
'netmask' => '255.255.240.0',
'device' => 'eth0',
'external_ip' => '',
'is_static' => '0',
'is_reseller' => '1',
'is_vip' => '1',
'is_locked' => '0',
'ip' => '192.168.0.2',
),
'reply_code' => 205,
)
Action: queryIPv6Status
¶
- Added in Version
5.0.14-579
- Description
Shows the current IPv6 status.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'section' => '##LG_IPV6_STATUS##',
'option' => '##LG_IPV6_CAPABLE##',
'qh' => '<i class="mdi mdi-help-circle iw-quickhelp" data-iw-qh-key="Checks to see if the Linux kernel has been compiled with IPv6 support"></i>',
'value' => '##LG_YES##',
),
1 =>
array (
'section' => '##LG_IPV6_STATUS##',
'option' => '##LG_IPV6_ENABLED##',
'qh' => '<i class="mdi mdi-help-circle iw-quickhelp" data-iw-qh-key="IPv6 may be disabled in InterWorx. This indicator shows the status as far as InterWorx is concerned."></i>',
'value' => '##LG_YES##',
),
2 =>
array (
'section' => '##LG_IPV6_STATUS##',
'option' => '##LG_IPV6_CLUSTERING##',
'qh' => '<i class="mdi mdi-help-circle iw-quickhelp" data-iw-qh-key="This indicator shows whether the system is running the correct versions of ipvsadm and the Linux kernel to load-balance IPv6 traffic"></i>',
'value' => '##LG_NO##',
),
),
'reply_code' => 205,
)
Action: queryResellers
¶
- Added in Version
5.0.14-579
- Description
Shows resellers that have access to an IP address.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
Action: querySiteworxAccounts
¶
- Added in Version
5.0.14-579
- Description
Show siteworx accounts that have access to an IP address.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Action: syncIpData
¶
- Added in Version
5.0.14-579
- Description
Syncronizes IP data from the CM to the Node.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
192.168.0.2, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.