Add an NFS share to remote storage.

This function adds an NFS mount to the system’s remote storage.

Important:

This function requires a high-availability license.

SecurityBasicAuth

Request

query Parameters

host required	string The hostname or IP address of the remote NFS service. Example: host=nfs.example.com
remote_path required	string <path> The path on the remote NFS service to mount locally. Example: remote_path=/the/remote/path
comment	string A free-form note about this NFS mount. Example: comment=This is my favorite NFS mount.
option	Array of strings The NFS mount options. See `man 5 nfs` and `man 8 mount` for details. Example: option=nfsvers=4.2&option=noac

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/PRIVATE_add_nfs_storage

Request samples

whmapi1 --output=jsonpretty \
  PRIVATE_add_nfs_storage \
  host='nfs.example.com' \
  remote_path='/the/remote/path'

Response samples

application/json

{"data": {"local_path": "/opt/cpanel/remote-storage-1234"
},
"metadata": {"command": "PRIVATE_add_nfs_storage",
"reason": "OK",
"result": 1,
"version": 1
}
}