cPanel API 1 Functions - NVData::set - Knowledgebase

Description

This function sets the value of an environment variable. The system stores the value in the /home/$user/.cpanel/nvdatadirectory.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — None.
cPanel API 2 — NVData::set — This function creates a non-volatile datastore.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_nv_location = $cpanel->api1('NVData', 'set', array('location', 'Houston', '0') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $set_nv_location = $cpliveapi->api1('NVData', 'set', ['location', 'Houston', '0'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="NVData::set( $FORM('name', 'value', 'nocache') )">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
name	string	Required An environment variable.	A valid environment variable name.	location
value	string	Required The environment variable's value.	Any valid string.	Houston
nocache	boolean	Required Whether to cache the value. The cache improves system performance.	1 — Do not save the value in the cache. 0 — Save the value in the cache.	0

Returns

This function does not return output.

Knowledgebase

Categories

Categories