Controller: /nodeworx/ip/sites¶
- Required Permissions
IPS
Action: defaultSitesStatus
¶
- Added in Version
4.8.0-393
- Description
Change the status of the Default Sites feature.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
1, 0 |
1 |
* indicates that it’s actually required, but probably already has a valid default value.
Action: disableDefaultSites
¶
- Added in Version
4.8.0-393
- Description
Disables default sites feature.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
Action: enableDefaultSites
¶
- Added in Version
4.8.0-393
- Description
Enables default sites feature.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No |
1 |
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually |
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: listIpDefaultSites
¶
- Added in Version
4.8.0-393
- Description
List the sites IPs redirect to when requested like http://ip.ad.dr.es/.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'ip' => '192.168.0.1',
'location' => '/var/www/html',
'domains' => '',
),
1 =>
array (
'ip' => '192.168.0.3',
'location' => '/var/www/html',
'domains' => 'example.com, secondary.com',
),
2 =>
array (
'ip' => '192.168.0.4',
'location' => '/var/www/html',
'domains' => '',
),
),
'reply_code' => 205,
)
Action: queryDefaultSitesStatus
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “defaultSitesStatus”.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'status' => '1',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, … |
Action: updateIpDefaultSites
¶
- Added in Version
4.8.0-393
- Description
Change the locations IPs redirect to when requested like http://ip.ad.dr.es/.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
192.168.0.1, 192.168.0.3, 192.168.0.4, 192.168.0.5 |
||
|
string |
No |
This is the web location that the browser will be redirected to if they navigate directly to the IP address in their browser, i.e. http://203.0.113.22/. If you chose a blank value, the request will display a “default” splash page. The files for the default splash page are at /var/www/html/. You can choose one of the domains on that IP address, or any other domain you prefer. - Leave blank for default |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.