cPanel API 1 Functions - NVData::set

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 deprecatedDo not use this function. Instead, we strongly recommend that you use the following newer functions:

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.

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....