RMoore\Truenas\SystemGeneralApi

All URIs are relative to https://truenas.local/api/v2.0.

Method	HTTP request	Description
systemGeneralCountryChoicesGet()	GET /system/general/country_choices
systemGeneralGet()	GET /system/general
systemGeneralKbdmapChoicesGet()	GET /system/general/kbdmap_choices
systemGeneralLanguageChoicesGet()	GET /system/general/language_choices
systemGeneralLocalUrlGet()	GET /system/general/local_url
systemGeneralPut()	PUT /system/general
systemGeneralTimezoneChoicesGet()	GET /system/general/timezone_choices
systemGeneralUiAddressChoicesGet()	GET /system/general/ui_address_choices
systemGeneralUiCertificateChoicesGet()	GET /system/general/ui_certificate_choices
systemGeneralUiHttpsprotocolsChoicesGet()	GET /system/general/ui_httpsprotocols_choices
systemGeneralUiRestartGet()	GET /system/general/ui_restart
systemGeneralUiRestartPost()	POST /system/general/ui_restart
systemGeneralUiV6addressChoicesGet()	GET /system/general/ui_v6address_choices

`systemGeneralCountryChoicesGet()`

systemGeneralCountryChoicesGet()

Returns country choices.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralCountryChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralCountryChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralGet()`

systemGeneralGet()

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralKbdmapChoicesGet()`

systemGeneralKbdmapChoicesGet()

Returns kbdmap choices.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralKbdmapChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralKbdmapChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralLanguageChoicesGet()`

systemGeneralLanguageChoicesGet()

Returns language choices.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralLanguageChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralLanguageChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralLocalUrlGet()`

systemGeneralLocalUrlGet()

Returns configured local url in the format of protocol://host:port

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralLocalUrlGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralLocalUrlGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralPut()`

systemGeneralPut($system_general_update0)

Update System General Service Configuration. ui_certificate is used to enable HTTPS access to the system. If ui_certificate is not configured on boot, it is automatically created by the system. ui_httpsredirect when set, makes sure that all HTTP requests are converted to HTTPS requests to better enhance security. ui_address and ui_v6address are a list of valid ipv4/ipv6 addresses respectively which the system will listen on. syslogserver and sysloglevel are deprecated fields as of 11.3 and will be permanently moved to system.advanced.update for 12.0

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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
);
$system_general_update0 = new \RMoore\Truenas\Model\SystemGeneralUpdate0(); // \RMoore\Truenas\Model\SystemGeneralUpdate0

try {
    $apiInstance->systemGeneralPut($system_general_update0);
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
system_general_update0	\RMoore\Truenas\Model\SystemGeneralUpdate0		[optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`systemGeneralTimezoneChoicesGet()`

systemGeneralTimezoneChoicesGet()

Returns time zone choices.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralTimezoneChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralTimezoneChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralUiAddressChoicesGet()`

systemGeneralUiAddressChoicesGet()

Returns UI ipv4 address choices.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralUiAddressChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralUiAddressChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralUiCertificateChoicesGet()`

systemGeneralUiCertificateChoicesGet()

Return choices of certificates which can be used for ui_certificate.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralUiCertificateChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralUiCertificateChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralUiHttpsprotocolsChoicesGet()`

systemGeneralUiHttpsprotocolsChoicesGet()

Returns available HTTPS protocols.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralUiHttpsprotocolsChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralUiHttpsprotocolsChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`systemGeneralUiRestartGet()`

systemGeneralUiRestartGet($body)

Restart HTTP server to use latest UI settings. HTTP server will be restarted after delay seconds.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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 = 56; // int

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

Parameters

Name	Type	Description	Notes
body	int		[optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`systemGeneralUiRestartPost()`

systemGeneralUiRestartPost($body)

Restart HTTP server to use latest UI settings. HTTP server will be restarted after delay seconds.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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 = 56; // int

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

Parameters

Name	Type	Description	Notes
body	int		[optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`systemGeneralUiV6addressChoicesGet()`

systemGeneralUiV6addressChoicesGet()

Returns UI ipv6 address choices.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\SystemGeneralApi(
    // 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->systemGeneralUiV6addressChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemGeneralApi->systemGeneralUiV6addressChoicesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Files

SystemGeneralApi.md

Latest commit

History

SystemGeneralApi.md

File metadata and controls

RMoore\Truenas\SystemGeneralApi

systemGeneralCountryChoicesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralKbdmapChoicesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralLanguageChoicesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralLocalUrlGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralPut()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralTimezoneChoicesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralUiAddressChoicesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralUiCertificateChoicesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralUiHttpsprotocolsChoicesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralUiRestartGet()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralUiRestartPost()

Example

Parameters

Return type

Authorization

HTTP request headers

systemGeneralUiV6addressChoicesGet()

`systemGeneralCountryChoicesGet()`

`systemGeneralGet()`

`systemGeneralKbdmapChoicesGet()`

`systemGeneralLanguageChoicesGet()`

`systemGeneralLocalUrlGet()`

`systemGeneralPut()`

`systemGeneralTimezoneChoicesGet()`

`systemGeneralUiAddressChoicesGet()`

`systemGeneralUiCertificateChoicesGet()`

`systemGeneralUiHttpsprotocolsChoicesGet()`

`systemGeneralUiRestartGet()`

`systemGeneralUiRestartPost()`

`systemGeneralUiV6addressChoicesGet()`