SystemdatasetApi.md

RMoore\Truenas\SystemdatasetApi

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

Method	HTTP request	Description
systemdatasetGet()	GET /systemdataset
systemdatasetPoolChoicesGet()	GET /systemdataset/pool_choices
systemdatasetPut()	PUT /systemdataset

systemdatasetGet()

systemdatasetGet()

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\SystemdatasetApi(
    // 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->systemdatasetGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemdatasetApi->systemdatasetGet: ', $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]

systemdatasetPoolChoicesGet()

systemdatasetPoolChoicesGet()

Retrieve pool choices which can be used for configuring system dataset.

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\SystemdatasetApi(
    // 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->systemdatasetPoolChoicesGet();
} catch (Exception $e) {
    echo 'Exception when calling SystemdatasetApi->systemdatasetPoolChoicesGet: ', $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]

systemdatasetPut()

systemdatasetPut($systemdataset_update0)

Update System Dataset Service Configuration. pool is the name of a valid pool configured in the system which will be used to host the system dataset. pool_exclude can be specified to make sure that we don't place the system dataset on that pool if pool is not provided.

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\SystemdatasetApi(
    // 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
);
$systemdataset_update0 = new \RMoore\Truenas\Model\SystemdatasetUpdate0(); // \RMoore\Truenas\Model\SystemdatasetUpdate0

try {
    $apiInstance->systemdatasetPut($systemdataset_update0);
} catch (Exception $e) {
    echo 'Exception when calling SystemdatasetApi->systemdatasetPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
systemdataset_update0	\RMoore\Truenas\Model\SystemdatasetUpdate0		[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]