API methods allow configuration of the File Accesser options.
Edit Device
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/editDevice.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, System Administrator.
Table 1. editDevice parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
ID of the device. |
Long |
| alias |
|
Alias to assign to the device. |
String |
| description |
|
Description to assign to the device. |
String |
| siteId |
|
ID of site on which to place the device. |
Long |
| accessPoolId |
|
Access Pool ID that the device should point to. |
Long |
| driveFailureWarningCount |
|
Quantity of drives that must be down for the device to report a warning level. |
Integer |
| driveFailureErrorCount |
|
Quantity of drives that must be down for the device to report an error level. |
Integer |
| managementVaultId |
|
Management Vault ID that the device should point to. |
Long |
| advancedConfiguration |
|
key=value pairs for various advanced configuration options to set for the device. |
String |
| virtualIps |
|
Comma or white space separated list of virtual IPs for the device, for use in HA
configuration. |
String |
| seedNode |
|
Set to true if this device should be a seed node for other devices. |
Boolean |
| tagIds |
|
Tags that are currently associated with the device. |
List |
| tagIdMap |
|
Map of tag IDIDs to action, to add or remove the tag from the vault. |
Map |
Add or Remove device from File Server Pool
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/addOrRemoveDeviceFromFileServerPool.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, System Administrator
Table 2. addOrRemoveDeviceFromFileServerPool parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
The ID of the file server pool |
Long |
| deviceId |
required |
The ID of the File Accesser device |
Long |
| action |
|
"add" to add a device and "remove" to remove a device from the file server pool. |
String |
Create File Server Pool
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/createFileServerPool.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, System Administrator
Table 3. createFileServerPool parameters
| Parameter |
Value |
Description |
Data type |
| name |
required |
Unique name for the file server pool. |
String |
| deviceIds |
|
A list of File Accesser devices to assign to the file server pool. |
List |
Create File System
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/createFileSystem.adm
- Valid formats
- JSON, XML.
- Implementation notes
- On success, returns the Manager-generated ID of the created file system.
- Capable roles
- Super User, System Administrator
Table 4. createFileSystem parameters
| Parameter |
Value |
Description |
Data type |
| name |
required |
The name of the file system. |
String |
| templateId |
required |
The ID of the vault or mirror template to use to back up the file system. |
Long |
| templateType |
vaultTemplate |
The type of the template for which the ID is being provided. |
String |
| updateAccessTimes |
true (default) |
Set to true if inodes in this file system should get their access times updated on read
operations. |
Boolean |
| maxBytes |
|
The maximum size that is allowed for this file system. |
Long |
| redundancyType |
loadBalance (default) |
The type of redundancy action for a file system when more than one Accesser device is
specified. |
String |
| storageType |
vault (default) |
The type of stable storage for the file system |
String |
| sslEnabled |
false (default) |
If set to true, File Accesser devices use SSL to communicate with vaults. |
Boolean |
| settleTime |
Optional, default is empty |
The defined settle time in milliseconds. If the value is empty, the settled writes
functionality is disabled. |
Long |
| uidOverride |
default is empty |
A UID mapped to the user who can bypass the settled writes functionality. Empty value
prevents any user to bypass settled writes. |
Long |
| gidOverride |
default is empty |
A GID mapped to the user's GID who can bypass the settled writes functionality. Empty value
prevents all groups to bypass settled writes. |
Long |
Create Share
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/createShare.adm
- Valid formats
- JSON, XML.
- Implementation notes
- On success, returns the Manager generated ID of the created share.
- Capable roles
- Super User, System Administrator
Table 5. createShare parameters
| Parameter |
Value |
Description |
Data type |
| fileServerPoolId |
required |
The ID of the file server pool where the share is created. |
Long |
| name |
required |
The name of the share. |
String |
| fileSystemId |
required |
The ID of the file system the created share exposes |
Long |
| iNodeId |
|
The iNode of the share. |
Long |
| useRootINode |
true (false) |
If set to true, inodeId param is ignored and root inode of file system is used. |
Boolean |
| requireSecurePort |
false (default) |
The accessing client must use a secure port (a port less than 1024). |
Boolean |
| readOnly |
false (default) |
Set to true if this share should be read only. |
Boolean |
| userMapping |
noRootSquash (default) |
The type of user mapping. |
String |
| anonUid |
0 |
The anonymous uid. |
Long |
| anonGid |
0 |
The anonymous gid. |
Long |
Edit Share Access Control
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/editShareAccessControl.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, System Administrator
Table 6. editShareAccessControl parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
A share ID. |
Long |
| allowedMachineNames |
|
A comma-separated list of ALL authorized systems that should have access to the
share. |
String |
Edit Share Authorization
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/editShareAuthorization.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, Security Officer
Table 7. editShareAuthorization parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
A share ID. |
Long |
| shareAnonymousPermission |
required |
The share permission to assign to anonymous users. |
String |
| userPermissions |
required |
A map of account IDs to share permissions. |
Long |
Delete File Server Pool
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/deleteFileServerPool.adm
- Valid formats
- JSON, XML.
- Implementation notes
- It is imperative that the 'nodetool decommission' command is completed on all devices in the
pool before it is deleted. Deleting a file server pool is a permanent action.
- Capable roles
- Super User, System Administrator
Table 8. deleteFileServerPool parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
Manager generated ID of the object to delete. |
Long |
| password |
required |
Password of the user that is making the request. |
String |
Delete File System
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/deleteFileSystem.adm
- Valid formats
- JSON, XML.
- Implementation notes
- All data that is associated with the file system is lost.
- Capable roles
- Super User, System Administrator
Table 9. deleteFileSystem parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
Manager generated ID of the object to delete. |
Long |
| password |
required |
Password of the user that is making the request. |
String |
Delete Share
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/deleteShare.adm
- Valid formats
- JSON, XML.
- Implementation notes
- All data that is associated with the share is lost.
- Capable roles
- Super User, System Administrator
Table 10. deleteShare parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
Manager generated ID of the object to delete. |
Long |
| password |
required |
Password of the user that is making the request. |
String |
Edit File Server Pool
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/editFileServerPool.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, System Administrator
Table 11. editFileServerPool parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
The ID of the file server pool. |
Long |
| name |
|
Unique name for the file server pool. |
String |
| mcastAddr |
|
mcastAddr of each device in the file server pool. |
String |
| accessDeviceIps |
|
This set of access device IPs overrides the known set of access devices. |
String |
Edit File System
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/editFileSystem.adm
- Valid formats
- JSON, XML.
- Implementation notes
- Update the values that are associated with a file system.
- Capable roles
- Super User, System Administrator
Table 12. editFileSystem parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
The ID of the file system to be modified. |
Long |
| name |
|
The name of the file system |
String |
| updateAccessTimes |
|
Set to true if inodes in this file system should get their access times updated on read
operations. |
Boolean |
| maxBytes |
|
The maximum size that is allowed for this file system. |
Long |
| redundancyType |
|
The type of redundancy action for a file system when more than one Accesser device is
specified. |
String |
| storageType |
|
The type of stable storage for the file system |
String |
| sslEnabled |
|
If set to true, File Accesser devices use SSL to communicate with vaults. |
Boolean |
| uidOverride |
default is empty |
A UID mapped to the user who can bypass the settled writes functionality. Empty value
prevents any user to bypass settled writes. |
Long |
| gidOverride |
default is empty |
A GID mapped to the user's GID who can bypass the settled writes functionality. Empty value
prevents all groups to bypass settled writes. |
Long |
Edit Share
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/editShare.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, System Administrator
Table 13. editShare parameters
| Parameter |
Value |
Description |
Data type |
| id |
required |
The ID of the share. |
Long |
| name |
|
The name of the share. |
String |
| readOnly |
|
Set to true if this share should be read only. |
Boolean |
| requireSecurePort |
|
The accessing client must use a secure port (a port less than 1024). |
Boolean |
| userMapping |
|
The type of user mapping. |
String |
| anonUid |
|
The anonymous uid. |
Long |
| anonGid |
|
The anonymous gid. |
Long |
File System Directory List
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/fileSystemDirectoryView.adm
- Valid formats
- JSON, XML.
- Implementation notes
- Returns the directories within a directory on a file system.
- Capable roles
- Super User, System Administrator
Table 14. fileSystemDirectoryView parameters
| Parameter |
Value |
Description |
Data type |
| iNodeId |
|
The iNode of the directory whose subdirectories are listed. Leave blank for root
iNode. |
Long |
| fileSystemId |
required |
The ID of the file system to look in. |
Long |
IPMI Reboot Command Controller
- Full path
- https://manager_host_or_ip/manager/api/format/1.0/ipmiReboot.adm
- Valid formats
- JSON, XML.
- Capable roles
- Super User, System Administrator
Table 15. ipmiReboot parameters
| Parameter |
Value |
Description |
Data type |
| fileServerPoolId |
required |
The ID of a file server pool. |
Long |