Controller: /nodeworx/nfs

Required Permissions:

NFS

Action: fail

Added in Version:

4.7.0-339

Description:

Magic function - test for failure mechanism.

Action: isRunning

Added in Version:

4.7.0-339

Description:

Checks if the service is running or not.

Sample Output

array (
  'status' => 0,
  'payload' => false,
  'reply_code' => 205,
)

Action: isRunningOnNode

Added in Version:

4.7.0-339

Description:

Checks if the service is running on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

* indicates that it’s actually required, but probably already has a valid default value.

Action: listGeneralName

Added in Version:

4.7.0-339

Description:

Lists the “normal” name - ie “web server” instead of “httpd”.

Sample Output

array (
  'status' => 0,
  'payload' => '##LG_NFS_SERVER##',
  'reply_code' => 205,
)

Action: listPortNumbers

Added in Version:

4.7.0-339

Description:

Lists a string of the port numbers that this service uses, comma-seperated.

Sample Output

array (
  'status' => 0,
  'payload' => '2049',
  'reply_code' => 205,
)

Action: listPortNumbersArray

Added in Version:

4.7.0-339

Description:

Lists array of port numbers and ranges that this service uses.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 => 2049,
  ),
  'reply_code' => 205,
)

Action: listRequiredPermissions

Added in Version:

4.7.0-339

Description:

Lists an array of permissions required to control the service.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 => 'NFS',
  ),
  'reply_code' => 205,
)

Action: listServiceInfo

Added in Version:

4.7.0-339

Description:

Lists the service name, ports, page, and status.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'id' => 'nfs-server',
    'name' => '##LG_NFS_SERVER##',
    'ports' => '2049',
    'page' => '/nodeworx/nfs',
    'ctrl' => '/nodeworx/nfs',
    'is_running' => 0,
  ),
  'reply_code' => 205,
)

Action: listServiceName

Added in Version:

4.7.0-339

Description:

Lists the service name - ie “httpd” instead of “web server”.

Sample Output

array (
  'status' => 0,
  'payload' => 'nfs-server',
  'reply_code' => 205,
)

Action: listServicePage

Added in Version:

4.7.0-339

Description:

Lists the page that controls the service.

Sample Output

array (
  'status' => 0,
  'payload' => '/nodeworx/nfs',
  'reply_code' => 205,
)

Action: reroute

Added in Version:

4.7.0-339

Description:

Action to re-route from the current controller to a different one.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
controller	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, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, Ip, Ipv6, …

Action: restart

Added in Version:

4.7.0-339

Description:

Restart the service.

Action: restartOnNode

Added in Version:

4.7.0-339

Description:

Restarts the service on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

* indicates that it’s actually required, but probably already has a valid default value.

Action: start

Added in Version:

4.7.0-339

Description:

Start the service.

Action: startOnBoot

Added in Version:

4.7.0-339

Description:

Set the NFS start-on-boot status.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
nfs_startonboot	integer	No*	1, 0	0

* indicates that it’s actually required, but probably already has a valid default value.

Action: startOnNode

Added in Version:

4.7.0-339

Description:

Starts the service on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

* indicates that it’s actually required, but probably already has a valid default value.

Action: stop

Added in Version:

4.7.0-339

Description:

Stop the service.

Action: stopOnNode

Added in Version:

4.7.0-339

Description:

Stops the service on a specific node (Clustering only).

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
node_id	string	No*

* indicates that it’s actually required, but probably already has a valid default value.

Action: wait

Added in Version:

8.1.3-2998

Description:

Magic function - used to simulate a long-running process

Action: win

Added in Version:

4.7.0-339

Description:

Magic function - test for testing success mechanism.