Description

This function creates a non-volatile datastore.

 The system creates the datastore in the /home/user/.cpanel/nvdata directory, where user represents the account name.

Examples 


https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=NVData&cpanel_jsonapi_func=setall&mymind=you

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set "mymind" NVDatastore to "you"
$cloud_nine = $cpanel->api2(
    'NVData', 'setall', 
    array(
        'mymind' => 'you',
    ) 
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set "mymind" NVDatastore to "you"
my $cloud_nine = $cpliveapi->api2(
    'NVData', 'setall',
    { 
        'mymind' => 'you',
    }
);

 

cpapi2 --user=username NVData setall names=mymind

 {
  "cpanelresult": {
    "apiversion": 2,
    "func": "setall",
    "data": [
      {
        "set": "mymind"
      },
    ],
    "event": {
      "result": 1
    },
    "module": "NVData"
  }
}

   

Parameters

ParameterTypeDescriptionPossible valuesExample

datastore name

 

string

Required

The NVData file's value.

The NVData file to create is the parameter name.

A valid string.you

Returns

The function creates the datastore in the /home/user/.cpanel/nvdata directory.

Return TypeDescriptionPossible valuesExample
setstringThe datastore's name.A valid string.mymind
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1