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.

We strongly recommend that you use UAPI instead of cPanel API 2.


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=set&names=mymind&mymind=you



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set "mymind" NVDatastore to "you"
$cloud_nine = $cpanel->api2(
    'NVData', 'set', 
    array(
        'names'  => 'mymind',
        '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', 'set',
    { 
        'names'  => 'mymind',
        'mymind' => 'you'
    }
);

 




cpapi2 --user=username NVData set names=mymind mymind=you



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



   

Parameters

ParameterTypeDescriptionPossible valuesExample
namesstring

Required

A list of one or more NVData file names.

A valid NVData file name.mymind

datastore name

 

string

Required

The NVData file's contents.

You must use the name of each NVData file that you specified in the names value as a parameter name.


A valid string.you

Returns

Return TypeDescriptionPossible valuesExample
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