ip_interfaces.save
- Nathaniel Halbrooks
- Kelli Higdon
Owned by Nathaniel Halbrooks
Description
Save networking settings.
Versioning Notes
This method is available in version 2.0 and later, when support for multiple interfaces was implemented.
Arguments
name | required | value type | default value |
|---|---|---|---|
ip_address | no | ip address | none |
gateway_address | no | ip address | none |
net_mask | no | ip address | none |
dns_addresses | no | array of ip addresses | none |
port_num | no | integer | none |
use_dhcp | no | boolean | yes |
Example Requests & Responses
Example One
Request
Save a network interface.
{
    'method' => 'ip_interfaces.save',
    'parameters' => {
       '1' => {
          'gateway_address' => '10.24.23.254',
          'dns_addresses' => [
                               '10.24.55.4'
                             ],
          'net_mask' => '255.255.248.0',
          'ip_address' => '10.24.18.34',
          'use_dhcp' => 1,
          'port_num' => 1,
        }
      },
      '2' => {
          'gateway_address' => '1.1.1.254',
          'dns_addresses' => [
                               '1.1.2.1',
                               '1.1.2.2'
                             ],
          'net_mask' => '255.255.248.0',
          'ip_address' => '1.1.4.34',
          'use_dhcp' => 0,
          'port_num' => 2,
        }
      } |
Response
{
          'result' => 'success'
 } |
Or
{
          'result' => 'error',
          'error' => 'An Error String',
          'error_key' => 'AN_ERROR_LANGUAGE_KEY',
 } |