Skip to content

Latest commit

 

History

History
414 lines (296 loc) · 11.7 KB

DhcpApi.md

File metadata and controls

414 lines (296 loc) · 11.7 KB
Raw

Swagger\Client\DhcpApi

All URIs are relative to /control

Method HTTP request Description
checkActiveDhcp POST /dhcp/find_active_dhcp Searches for an active DHCP server on the network
dhcpAddStaticLease POST /dhcp/add_static_lease Adds a static lease
dhcpInterfaces GET /dhcp/interfaces Gets the available interfaces
dhcpRemoveStaticLease POST /dhcp/remove_static_lease Removes a static lease
dhcpReset POST /dhcp/reset Reset DHCP configuration
dhcpResetLeases POST /dhcp/reset_leases Reset DHCP leases
dhcpSetConfig POST /dhcp/set_config Updates the current DHCP server configuration
dhcpStatus GET /dhcp/status Gets the current DHCP settings and status

checkActiveDhcp

\Swagger\Client\Model\DhcpSearchResult checkActiveDhcp()

Searches for an active DHCP server on the network

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->checkActiveDhcp();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->checkActiveDhcp: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\DhcpSearchResult

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dhcpAddStaticLease

dhcpAddStaticLease($body)

Adds a static lease

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\DhcpStaticLease(); // \Swagger\Client\Model\DhcpStaticLease | 

try {
    $apiInstance->dhcpAddStaticLease($body);
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->dhcpAddStaticLease: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\DhcpStaticLease

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dhcpInterfaces

\Swagger\Client\Model\NetInterfaces dhcpInterfaces()

Gets the available interfaces

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->dhcpInterfaces();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->dhcpInterfaces: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\NetInterfaces

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dhcpRemoveStaticLease

dhcpRemoveStaticLease($body)

Removes a static lease

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\DhcpStaticLease(); // \Swagger\Client\Model\DhcpStaticLease | 

try {
    $apiInstance->dhcpRemoveStaticLease($body);
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->dhcpRemoveStaticLease: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\DhcpStaticLease

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dhcpReset

dhcpReset()

Reset DHCP configuration

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $apiInstance->dhcpReset();
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->dhcpReset: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dhcpResetLeases

dhcpResetLeases()

Reset DHCP leases

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $apiInstance->dhcpResetLeases();
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->dhcpResetLeases: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dhcpSetConfig

dhcpSetConfig($body)

Updates the current DHCP server configuration

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\DhcpConfig(); // \Swagger\Client\Model\DhcpConfig | 

try {
    $apiInstance->dhcpSetConfig($body);
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->dhcpSetConfig: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\DhcpConfig [optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dhcpStatus

\Swagger\Client\Model\DhcpStatus dhcpStatus()

Gets the current DHCP settings and status

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DhcpApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->dhcpStatus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DhcpApi->dhcpStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\DhcpStatus

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]