Child pages
  • cPanel API 1 Functions - FrontPage::addfp

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function adds Microsoft® FrontPage® Extensions to the domain.

Note
titleNotes:
  • In cPanel & WHM version 11.44, if you uninstalled FrontPage extensions, or if FrontPage was never installed on the server, the server will ignore all FrontPage settings.
  • In cPanel & WHM version 11.46 and later, FrontPage extensions are no longer supported. These functions will only return 'not installed' or an error message.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$add_frontpage = $cpanel->api1('FrontPage', 'addfp', array('example.com','example.com') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $add_frontpage = $cpliveapi->api1('FrontPage', 'addfp', ['example.com','example.com'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="FrontPage::addfp( $FORM('ftpdomain','psuedodomain') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username FrontPage addfp ftpdomain=example.com pseudodomain=example.com

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (plaintext)
Code Block
languagexml
collapsetrue
Saving .htaccess file: /home/example/public_html/.htaccess
Using Upgrade Mode
Saving .htaccess file: /home/example/public_html/_private/.htaccess
Saving .htaccess file: /home/example/public_html/secondary.com/.htaccess
Saving .htaccess file: /home/example/public_html/secondary.com/_private/.htaccess
Saving .htaccess file: /home/example/public_html/tertiary.com/.htaccess
Starting install, port: 80.
Created: 01 Feb 2014 02:43:18 -0000
Version: 5.0.2.4803
Server extensions already installed on port 80.
Reverting to upgrade.
Starting upgrade, port: 80.
Created: 01 Feb 2014 02:43:18 -0000
Version: 5.0.2.4803
Port 80: Upgrade completed.
Upgraded Version: 5.0.2.4803.
Merging .htaccess file: /home/example/public_html/.htaccess
Merging .htaccess file: /home/example/public_html/_private/.htaccess
Merging .htaccess file: /home/example/public_html/secondary.com/.htaccess
Merging .htaccess file: /home/example/public_html/secondary.com/_private/.htaccess
Merging .htaccess file: /home/example/public_html/tertiary.com/.htaccess
Setting Password
Frontpage passthough auth enabled in /home/example/public_html!
Frontpage was installed on the following domains: example.com

   

Parameters

ParameterTypeDescriptionPossible valuesExample
ftpdomain

string

Required

The domain name.

A valid domain name.example.com
psuedodomainstring

Required

The domain name.

A valid domain name.example.com

Returns

This function returns a set of FrontPage status information.

In cPanel & WHM version 11.46 and later, this function returns 'not installed' or an error message.