Chapter 19: Controller: /nodeworx/index Up Part II: NodeWorx API Spec Chapter 21: Controller: /nodeworx/ip/sites 

20 Controller: /nodeworx/ip

Required Permissions "IPS"
Action: activate
Added in version 5.0.14-579
Description Activate an IP.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: add
Added in version 4.7.0-339
Description Add an ip address range.
Input Parameters
Name Type Notes Required?
ip_start string Description
IPv6 or IPv4
Yes
ip_end string Description
IPv6 or IPv4
Yes
netmask string Yes
device string Example Values
eth0, lo
Yes
type string Example Values
static, shared
Yes
reseller integer Example Values
1, 0
Yes
vip integer Example Values
1, 0
Yes
Action: delete
Added in version 5.0.14-579
Description Deletes an IP from the system.
Input Parameters
Name Type Notes Required?
ip string Help Entry
####
Example Values
10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
confirm_action struct (integer) Example Values
1
No*
* 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 Notes Required?
ip string Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
netmask string Example Default Value
255.255.0.0
No*
device string Example Values
eth0, lo
Example Default Value
eth0
No*
external_ip string No
is_static integer Example Values
0, 1
Example Default Value
0
No*
is_reseller integer Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: forceRemoveVipStatus
Added in version 5.1.51-1304
Description Remove VIP Status (internal use).
Input Parameters
Name Type Notes Required?
ip string Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: import
Added in version 5.0.14-579
Description Imports a system IP to InterWorx.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.200, fe80::fcb5:65ff:fe2a:a05
Yes
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’ => ’10.1.15.200’,
’ext_ipaddr’ => ’10.1.15.200’,
’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.0.0’,
),
1 =>
array (
’ipaddr’ => ’2001:db8::d:1101’,
’ext_ipaddr’ => ’2001:db8::d:1101’,
’device’ => ’eth0’,
’type’ => ’shared’,
’reseller’ => 1,
’vip’ => 1,
’sys_aware’ => 1,
’iworx_aware’ => 1,
’iworx_managed’ => 0,
’resellers’ => ’’,
’domains’ => ’’,
’assigned_to_reseller’ => false,
’ssl_domain’ => false,
’is_internal’ => false,
’siteworx_count’ => 0,
’version’ => ’6’,
’netmask’ => ’64’,
),
2 =>
array (
’ipaddr’ => ’2001:db8::d:1102’,
’ext_ipaddr’ => ’2001:db8::d:1102’,
’device’ => ’eth0’,
’type’ => ’quorum’,
’reseller’ => 1,
’vip’ => 0,
’sys_aware’ => 1,
’iworx_aware’ => 1,
’iworx_managed’ => 0,
’resellers’ => ’’,
’domains’ => ’’,
’assigned_to_reseller’ => false,
’ssl_domain’ => false,
’is_internal’ => false,
’siteworx_count’ => 0,
’version’ => ’6’,
’netmask’ => ’64’,
),
),
)
Action: queryDomains
Added in version 5.0.14-579
Description Show domains on an IP address.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
ip string Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ip_copy’ => ’10.1.15.100’,
’netmask’ => ’255.255.0.0’,
’device’ => ’eth0’,
’external_ip’ => ’’,
’is_static’ => ’0’,
’is_reseller’ => ’0’,
’is_vip’ => ’1’,
’is_locked’ => ’0’,
’ip’ => ’10.1.15.100’,
),
)
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’ => ’<span class=\’iw-qh\’><span class=\’quickhelp\’ data-qh=\’Checks to see if the Linux kernel has been compiled with IPv6 support\’>?</span></span>’,
’value’ => ’##LG_YES##’,
),
1 =>
array (
’section’ => ’##LG_IPV6_STATUS##’,
’option’ => ’##LG_IPV6_ENABLED##’,
’qh’ => ’<span class=\’iw-qh\’><span class=\’quickhelp\’ data-qh=\’IPv6 may be disabled in InterWorx. This indicator shows the status as far as InterWorx is concerned.\’>?</span></span>’,
’value’ => ’##LG_YES##’,
),
2 =>
array (
’section’ => ’##LG_IPV6_STATUS##’,
’option’ => ’##LG_IPV6_CLUSTERING##’,
’qh’ => ’<span class=\’iw-qh\’><span class=\’quickhelp\’ data-qh=\’This indicator shows whether the system is running the correct versions of ipvsadm and the Linux kernel to load-balance IPv6 traffic\’>?</span></span>’,
’value’ => ’##LG_YES##’,
),
),
)
Action: queryResellers
Added in version 5.0.14-579
Description Shows resellers that have access to an IP address.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: querySiteworxAccounts
Added in version 5.0.14-579
Description Show siteworx accounts that have access to an IP address.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: syncIpData
Added in version 5.0.14-579
Description Syncronizes IP data from the CM to the Node.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
 Chapter 19: Controller: /nodeworx/index Up Part II: NodeWorx API Spec Chapter 21: Controller: /nodeworx/ip/sites 

(C) 2017 by InterWorx LLC