Controller: Ip

API Controller /nodeworx/ip
Required Permissions ["IPS"]
Action Description
add Add an ip address range.
listIpv4Addresses List ipv4 addresses on the system.

Action: add

Add an ip address range.

Input Parameters

Name Type Notes Required?
ip_start string Yes
ip_end string Yes
netmask string
Example Default Value
255.255.255.0
 No*
device string
Example Values
eth0, lo, sit0
 Yes
type string
Example Values
shared, static
 Yes
reseller integer
Example Values
1, 0
 Yes
vip integer
Example Values
1, 0
 Yes
* indicates that it's actually required, but probably already has a valid default value

Action: listIpv4Addresses (Added in version 4.8.0-393)

List ipv4 addresses on the system.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'ipaddr' => '208.69.122.234',
      'ext_ipaddr' => '208.69.122.234',
      'device' => 'eth0',
      'type' => 'static',
      'reseller' => 'yes',
      'vip' => 'no',
      'sys_aware' => 'yes',
      'iworx_aware' => 'yes',
      'resellers' => 'Jon Reseller',
      'domains' => '',
      'assigned_to_reseller' => '1',
      'ssl_domain' => NULL,
      'is_internal' => false,
      'siteworx_count' => 0,
      'type_changeable' => true,
      'reseller_changeable' => false,
      'sys_aware_changeable' => false,
      'line_disabled' => false,
    ),
    1 => 
    array (
      'ipaddr' => '4.3.2.1',
      'ext_ipaddr' => '4.3.2.1',
      'device' => 'eth0:0',
      'type' => 'static',
      'reseller' => 'yes',
      'vip' => 'yes',
      'sys_aware' => 'yes',
      'iworx_aware' => 'yes',
      'resellers' => 'Jon Reseller',
      'domains' => '',
      'assigned_to_reseller' => '1',
      'ssl_domain' => NULL,
      'is_internal' => false,
      'siteworx_count' => 0,
      'type_changeable' => true,
      'reseller_changeable' => false,
      'sys_aware_changeable' => true,
      'line_disabled' => false,
    ),
    2 => 
    array (
      'ipaddr' => '123.123.123.123',
      'ext_ipaddr' => '123.123.123.123',
      'device' => 'eth0:1',
      'type' => 'shared',
      'reseller' => 'yes',
      'vip' => 'yes',
      'sys_aware' => 'yes',
      'iworx_aware' => 'yes',
      'resellers' => '',
      'domains' => 'example.com,mydomain.com,secondary.com',
      'assigned_to_reseller' => '',
      'ssl_domain' => NULL,
      'is_internal' => false,
      'siteworx_count' => 2,
      'type_changeable' => false,
      'reseller_changeable' => true,
      'sys_aware_changeable' => false,
      'line_disabled' => false,
    ),
  ),
)