Storage Appliance API v40-1-0 Copyright (C) Nexenta Systems, Inc. All rights reserved. 1 API Overview 2 Block Diagram 3 Terms and Conventions 4 Object Model 5 Data Types 5.1 Primitive Data Types 5.2 Receiving an Array 5.3 Receiving a Dictionary 5.4 Receiving Complex Data Types 5.5 Passing an Array 5.6 Passing a Dictionary 6 Virtual Base Object 6.1 get_prop - Get the property value 6.2 get_props - Get { propname => value } dictionary of all properties ... 6.3 set_prop - Set the value of property 6.4 set_props - Set the properties according to dictionary 6.5 trylock_self - Make an attempt to lock the object. Unlike com.nexenta.nms.Container::trylock ... 6.6 unlock_self - Unlock object. Unlike com.nexenta.nms.Container::unlock it unlocks object self, not ... 7 Virtual Container 7.1 destroy - Destroy a child object. 7.2 get_child_prop - Get the value of a property for a child object. ... 7.3 get_child_props - Get the list of properties and values that match the ... 7.4 get_names - Get the list of names of all child objects that ... 7.5 get_names_by_prop - Get the list of all child objects that have a ... 7.6 object_exists - Verify that an object exists. 7.7 set_child_prop - Update a property of a child object with a new ... 7.8 trylock - Try to lock a child object. 7.9 unlock - Unlock a child object. 8 Appliance Backup 8.1 get_saved_configurations - Returns the list of saved appliance configurations 8.2 get_state - Returns current state of a save/restore process 8.3 restore_app_configuration - Restores appliance configuration 8.4 save_app_configuration - Save appliance configuration 9 AutoScrub (volume scrubbing) Service 10 AutoSnap (snapshot) Service 11 AutoTier (data replication) Service 12 Fault Management 12.1 clear - Clear specific fault ID 12.2 clear_all - Clear all faults generated by the specified fault trigger ... 12.3 event - Create and send an event for the specified trigger ... 12.4 fault - Generate a fault notification 12.5 get_faults - Get the list of faults generated by the specified fault ... 13 Folder (Filesystem) 13.1 add_group_acl - Add the group's permissions to access a given folder and ... 13.2 add_user_acl - Add the user's permissions to access a given folder and ... 13.3 clone - Create a clone of a snapshot. Clone is a writable ... 13.4 create - Create "paths" to folders 13.5 create_snapshot - Snapshot a given folder and possibly its sub-folders 13.6 create_with_props - Create a "path" of folders. This API method enables you ... 13.7 del_group_acl - Remove the group's permissions from the folder's ACL 13.8 del_user_acl - Remove the user's permissions from the folder's ACL 13.9 get_acl - Get folder's ACL for the entities that match the pattern ... 13.10 get_acl_by_index - Retrieve the complete folder's ACL, and possibly check for duplicate ... 13.11 get_aclinfo - Get the ACL related static information: the groups of permissions ... 13.12 get_all_names - Get an array of all child object names that match ... 13.13 get_groupspace - Get the groupspace parameters 13.14 get_groupspace_types - Get the list of available groupspace types. 13.15 get_prop_valid_values - Get the valid range and/or enumeration for a given folder's ... 13.16 get_subfolder_names - Get the sub-folder names 13.17 get_userspace - Get the userspace parameters 13.18 get_userspace_types - Get the available userspace types 13.19 get_version_info - Get the folder's ZFS version 13.20 has_zfs_prop - Determine whether a zfs property exists or not 13.21 inherit_prop - Restore a system-default inheritance of a ZFS property. The method ... 13.22 promote - Promotes a cloned dataset to no longer be dependent on ... 13.23 reset_acl - Reset the folder's ACLs to the system default (POSIX, built-in) ... 13.24 set_group_acl - Set the group's permissions to access a given folder and ... 13.25 set_group_owner - Change the group ownership for a given folder. 13.26 set_user_acl - Set the user's permissions to access a given folder and ... 13.27 set_user_owner - Change the user ownership of a folder 13.28 upgrade - Upgrade folder's ZFS version 13.29 upgrade_folders - Upgrade folder's ZFS version recursively 14 Folder and Snapshot Indexing Facility (Search Engine) 14.1 create - Create indexer for the specified folder. Once created, the indexer ... 14.2 search - Search the folder and its snapshot(s). 15 General Appliance Management 15.1 add_swap - Add a zvol as an additional swap area. 15.2 configure_ugen_device - Configure a generic USB device. 15.3 create_checkpoint - Create a checkpoint from a system snapshot. 15.4 dbus_auth_iptable_is_set - Determine whether the deny/allow access rule is present in the ... 15.5 dbus_auth_iptable_list - Get all iptable access rules. The NexentaStor appliance provides a ... 15.6 dbus_auth_iptable_set - Deny/Allow access to the NexentaStor appliance from the specified IP ... 15.7 dbus_auth_iptable_unset - Remove Deny/Allow access rule from the appliance's iptable. This method ... 15.8 dbus_auth_keys_add - Add a new key to the key authorization table on ... 15.9 dbus_auth_keys_list - Get all authorization keys and their IDs. NexentaStor Storage Appliance ... 15.10 dbus_auth_keys_remove - Remove an authentication key. 15.11 delete_swap - Remove zvol swap area, and undo the result of the ... 15.12 get_cpu_info - Get the detailed per-CPU information. 15.13 get_dumpdir - Get the location of the 15.14 get_etchosts_rec - Get the record from the appliance's local host table for ... 15.15 get_fqdn - Get a fully qualified domain name (FQDN) of the appliance. ... 15.16 get_general_diagnostics - Get the general diagnostics, collect all log information in a ... 15.17 get_host_by_addr - Resolve a hostname by IP address. 15.18 get_kbd_layouts - Get the list of all supported keyboard layouts. 15.19 get_license_info_ - Get the license information. 15.20 get_memstat - Get the RAM utilization information. 15.21 get_saved_configurations - Get the list of all saved configurations. 15.22 get_saved_user_configurations - Returns the list of saved appliance configurations. This method is ... 15.23 get_serial_names - Get the list of all available serial ports. 15.24 get_subtimezones - Get the list of time zones for the specified country ... 15.25 get_timezone_continent - Get the time zone code for the specified time zone. ... 15.26 get_timezone_continents - Get the list of continents for the available time zones. ... 15.27 get_timezone_country_code - Get the time zone code for the specified country. ... 15.28 get_timezones - Get the list of all available time zones for the ... 15.29 get_upgrade_info - Get the information about upgrades on this NexentaStor appliance ... 15.30 get_uptime - Get the appliance's uptime, including the following information: the current ... 15.31 group_configuration_sync_set - Synchronize group configuration by enabling or disabling the synchronization. ... 15.32 is_rebooting - Verify that NexentaStor appliance is rebooting 15.33 list_appliances - Get the list of all SSH-bound as well as dynamically ... 15.34 list_conf_ugen_hid_devs - Get the configuration of all USB devices. 15.35 list_swap - Get the summary information about total swap space usage, existing ... 15.36 list_unconf_hid_devs - Get the list of unconfigured USB devices. 15.37 ns_getent - Get the list of local and LDAP users, groups, and ... 15.38 ns_group_del - Delete a group 15.39 ns_group_exists - Verify that a group exists. 15.40 ns_group_get - Get the group properties, such as group ID, group members, ... 15.41 ns_group_idmap_get - Get the identity mapping for a Unix group. 15.42 ns_group_set - Modify the existing local group or create a new group. ... 15.43 ns_netgroup - Get the list of hosts (computers) included in a netgroup ... 15.44 ns_user_del - Delete a specified user 15.45 ns_user_exists - Verify, if a user exists 15.46 ns_user_get - Get the properties for a specified local or LDAP user. ... 15.47 ns_user_idmap_get - Get an identity mapping for a Unix user. 15.48 ns_user_set - Modify an existing local user or add a new local ... 15.49 ping_tcp - Ping host using TCP 15.50 poweroff - Get the descriptions of the saved appliance's configurations 15.51 reboot - Reboot the appliance 15.52 reset_ugen_configuration - Reset the current USB devices configuration 15.53 restore_configuration - Restore an appliance's configuration from the most recent copy stored ... 15.54 restore_volume_services - Restore the volume services 15.55 save_configuration - Save appliance's configuration at a pre-defined location. The location in ... 15.56 save_user_configuration - Save appliance's configuration at a pre-defined location. The location in ... 15.57 set_dumpdir - Set a datapath for the directory that stores system crash ... 15.58 set_etchosts_rec - Add, replace or delete a record from the appliance's local ... 15.59 set_license_key - Update license key 15.60 ssh_bind - Bind a given (user, appliance) to the specified remote host ... 15.61 ssh_bind_add - Create the ssh-binding on the remote NexentaStor appliance 15.62 ssh_bind_delete - Delete the ssh-binding on the remote NexentaStor appliance 15.63 ssh_bind_v2 - Extension for the ssh_bind method, which enables you to use ... 15.64 ssh_bind_vip - Bind a standalone NexentaStor appliance to a cluster group virtual ... 15.65 ssh_check_binding - Verify whether the specified appliance is SSH-bound to the specified ... 15.66 ssh_list_bindings - Get all existing SSH bound hosts 15.67 ssh_unbind - SSH-unbind a given (user, appliance) from the specified remote host. ... 15.68 ssh_unbind_v2 - Extension for the ssh_unbind method,