Professional Documents
Culture Documents
OneFS
Version 7.0.1
CONTENTS
Chapter 1
Chapter 2
15
Create a session............................................................................................16
Send a request using a session cookie..........................................................16
Get information about the current session.....................................................16
Log out of a session......................................................................................16
Chapter 3
Authentication resources
19
CONTENTS
Chapter 4
NFS resources
49
Chapter 5
SMB resources
63
Chapter 6
Quota resources
75
Chapter 7
Snapshot resources
87
CONTENTS
Chapter 8
Zones resources
97
CONTENTS
CHAPTER 1
Introduction to the Platform API
The Isilon OneFS Platform API provides access to cluster configuration, management, and
monitoring functionality through an HTTP-based interface that conforms to the principles
of Representation State Transfer (REST) architecture. Through this interface, cluster
administrators can develop clients and software to automate the management and
monitoring of their EMC Isilon storage systems.
The Platform API represents system configuration and status information through objects
and collections of objects. These objects and collections are exposed as resources,
which are represented by Uniform Resource Identifiers (URIs). Resources are manipulated
using standard HTTP methods (GET, POST, PUT, and DELETE). The representations of
objects and collections are exchanged between client software and the cluster as
JavaScript Object Notation (JSON) formatted documents.
You must have a solid understanding of HTTP/1.1, RFC2616 and experience
writing HTTP-based client software before you can implement the Platform API.
The following table provides definitions for terms that are relevant to understanding the
Platform API.
Object
Collection
Resource
u
u
API architecture
The Platform API URIs and HTTP methods are organized into patterns that provide support
for manipulating objects and collections.
Much of cluster administration involves reading, creating, modifying, and deleting
configuration information. Typically, configuration information is arranged into groups of
related settings and properties called objects; similar objects are further organized into
collections.
A system object represents global system configuration information and is not part of a
collection. A user object represents configurations that are defined by users; these
objects are typically organized into a collection.
HTTP methods
You can perform operations by applying HTTP methods to resource URIs.
The Platform API only implements the HTTP methods defined by RFC 2616, with the
following distinctions:
u
The POST method is generally used to create resources.
u
The PUT and POST methods do not return full resource entity bodies upon success.
The POST method returns a document indicating the success of the request and the
location of the created resource.
Interaction patterns
You can interact with the system configuration by applying HTTP methods to resource
URIs according to a set of usage patterns.
When making multiple changes to the Platform API, it is recommended that users
send all requests to a single node to avoid potential configuration collisions.
Request:
GET /<resource-version>/<namespace>/<object-id>
Response:
Content-Type: application/json
{
"<object>": {
"<property>": <value>,
...
}
}
Response:
{Standard JSON success or error response}
Request:
GET /<resource-version>/<namespace>/<collection-name>
Response:
Content-Type: application/json
{
"<collection>": [
"<property>": <value>
...
]
}
Request:
GET /<resource-version>/<namespace>/<collection-name>/<object-id>
Response:
Content-Type: application/json
{
"<collection>": [
"<property>": <value>
...
]
Interaction patterns
Request:
POST /<resource-version>/<namespace>/<collection-name>
Content-Type: application/json
{
"<property>": <value>,
...
}
Response:
Location:/<resource-version>/<namespace>/<collection-name>/<newobject-id>
Content-Type: application/json
{Standard JSON success or error response}
Request:
PUT /<resource-version>/<namespace>/<collection-name>/<object-id>
Content-Type: application/json
{
"parameter_name": <value>
...
}
Response:
{Standard JSON success or error response}
Request:
DELETE /<resource-version>/<namespace>/<collection-name>/<object-id>
Response:
{Standard JSON success or error response}
10
Filter a collection
You can apply a filter to a collection and retrieve objects from the collection that matches
some common criteria.
Pattern: GET /<resource-version>/<namespace>/<collection-name>?
<parameter_name> =<match-pattern>&...
Request:
GET /<resource-version>/<namespace>/<collection-name>?
<parameter_name>=<match-pattern>&...
Response:
Content-Type: application/json
{
"count": <integer>,
"<collection-name>": [
{
"<parameter-name>":
<matched-value>,
...
},
...
]
}
You can retrieve a list of all of the resources by appending list and all options to the
describe query parameter.
For example, to return a list of all resource paths for snapshots, send the following
request:
GET /platform/1/snapshot/snapshots?describe&list&all
HTTP_RESULT 200
{
"directory": [
"/1/snapshot/snapshots/<SID>",
"/1/snapshot/snapshots/<SID>/locks",
"/1/snapshot/snapshots/<SID>/locks/<LID>"
]
}
You can obtain the JSON schemas that are included in the self-documentation by sending
a GET request to any resource URI with the query parameters describe and json appended
to the end of the URI.
For example, to obtain the JSON-formatted schemas for the quotas resource, send the
following request:
GET /platform/1/quota/quotas?describe&json
Platform API self-documentation
11
If you include any values for either the describe or json parameters, the values are
ignored.
The JSON-formatted schema documents conform to RFC draft-zyp-jsonschema-03.
Access Control
You can access the Platform API resources through the HTTPS protocol on TCP port 8080.
All Platform API resources are provided under a top-level /platform URI path that is
available on all nodes in the cluster.
Resources are accessed through the following pattern:
https://<cluster-ip-or-host-name>:8080/<resource-uri>.
Access to Platform API resources requires user authentication and authorization. The
Platform API uses role-based access control; users can only access resources for which
they have privileges.
Users can authenticate to the Platform API either through HTTP Basic Authentication (as
defined by RFC 2617) or with a session, which is obtained through the Platform API
session resource.
HTTP Basic Authentication requires more system processing resources and is slower than
authenticating with a session cookie. For multiple requests over a period of time, it is
recommended that you create a session cookie.
If the server validates the username and password, the server responds with a SetCookie header. Otherwise, the server responds with an error document.
3. Obtain the isisessid value from the Set-Cookie header.
4. Include the Cookie: <isisessid> header in all future Platform API requests to that
node.
13
14
CHAPTER 2
Platform API session resource
You can set a session cookie for extended authentication on a single node.
Object parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
username
string
password
string
services
array
timeout_absolute integer Provides the number of seconds before the session expires.
timeout_inactive
u
u
u
u
Create a session....................................................................................................16
Send a request using a session cookie..................................................................16
Get information about the current session.............................................................16
Log out of a session..............................................................................................16
15
Create a session
You can create a session and extend your authentication to a node for multiple requests
over a period of time.
Request:
POST /session/1/session
{
"username": "<string>",
"password": "<string>",
"services": ["<string>"]
Response:
If the server validates the credentials, the JSON document used to create the session is
returned.
"username": <string>
"services": [<string>, ...]
"timeout_absolute": <int>,
"timeout_inactive": <int>
If the server does not validate the credentials, the server responds with an error message.
16
(the default setting is 900 seconds) or after an absolute period of time (the default
setting is 14400 seconds).
Request:
DELETE /session/1/session?isisessid
Response:
If the server validates the credentials, the session value is no longer valid for future
requests.
If the server does not validate the credentials, the server responds with an error message.
17
18
CHAPTER 3
Authentication resources
Authentication resources
19
Authentication resources
GET /platform/1/auth/id
GET /platform/1/auth/id?describe
Query parameters
There are no parameters for this resource.
Object properties
20
Property
Type
Description
additional_id
persona on page
45
gid
persona on page
45
group_sid
persona on page
45
ifs_restricted
Boolean
local_address
string
on_disk_user_id
persona on page
45
privilege
privilege on page
45
protocol
integer
remote_address
string
uid
persona on page
45
user_sid
persona on page
45
zid
integer
Authentication resources
Property
Type
Description
zone_id
string
GET /platform/1/auth/groups
DELETE /platform/1/auth/groups
Get a group
GET /platform/1/auth/groups/
<group-id>
Create a group
POST /platform/1/auth/groups
Modify a group
PUT /platform/1/auth/groups/
<group-id>
Delete a group
DELETE /platform/1/auth/groups/
<group-id>
GET /platform/1/auth/groups?
describe
Query parameters
cached
If true, only return cached objects.
domain
Filter groups by domain.
filter
Filter groups by name prefix.
provider
Filter groups by provider.
query_member_of
Enumerate all groups that a group is a member of.
resolve_names
Resolve names of a persona.
zone
Filter groups by zone.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from the previous request (cannot be used with other
parameters).
21
Authentication resources
Object properties
Property Type
Type
total
string
resume
string
groups
groups on page 46
GET /platform/1/auth/groups/
<group-id>/members
POST /platform/1/auth/groups/
<group-id>/members
DELETE /platform/1/auth/groups/
<group-id>/members/<persona-id>
GET /platform/1/auth/groups/
<group-id>/members?describe
Query parameters
provider
Filter groups by the provider.
resolve_names
Resolve the name of a persona.
zone
Filter groups by zone.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from the previous request (cannot be used with other
parameters).
Object properties
22
Property
Type
Description
resume
string
id
string
Authentication resources
Property
Type
Description
Properties for users or groups that have this role.
GET /platform/1/auth/users
GET /platform/1/auth/users/<userid>
Modify a user
PUT /platform/1/auth/users/<userid>
Create a user
POST /platform/1/auth/users
DELETE /platform/1/auth/users
Delete a user
DELETE /platform/1/auth/users/
<user-id>
GET /platform/1/auth/users?
describe
Query parameters
cached
If true, only return cached objects.
domain
Filter users by domain.
filter
Filter users by name prefix.
provider
Filter users by provider.
query_member_of
Enumerate all users that a group is a member of.
resolve_names
Resolve names of personas.
zone
Filter users by zone.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from the previous request (cannot be used with other
parameters).
23
Authentication resources
Object properties
Property Type
Description
total
integer
resume
string
users
users on page 46
GET /platform/1/auth/users/<userid>/member_of
POST /platform/1/auth/users/
<user-id>/member_of
DELETE /platform/1/auth/users/
<user-id>/member_of/<persona-id>
GET /platform/1/auth/users/<userid>/member_of?describe
Query parameters
provider
Filters groups by provider.
resolve_names
Resolves the names of personas.
zone
Filters groups by zone.
resume
Continues returning results from the previous call (cannot be used with other
options).
Object properties
Property
Type
Description
resume
string
24
Authentication resources
GET /platform/1/auth/netgroups/
<netgroup>
GET /platform/1/auth/netgroups/
<netgroup>?describe
Query parameters
provider
Filter users by provider.
recursive
Perform recursive searches.
ignore_errors
Ignore netgroup errors.
zone
Filter users by zone.
Object properties
Property
Type
Description
domainname
string
hostname
string
netgroup
string
username
string
GET /platform/1/auth/mapping/
users/rules
PUT /platform/1/auth/mapping/
users/rules
GET /platform/1/auth/mapping/
users/rules?describe
Query parameters
zone
The zone that the rules apply to.
Auth netgroups resource
25
Authentication resources
Object properties
Property
Type
Description
options
options on page 48
user1
domain on page 48
user2
domain on page 48
GET /platform/1/auth/mapping/
users/lookup
GET /platform/1/auth/mapping/
users/lookup?describe
Query parameters
user
The user to lookup.
zone
The name of the zone that is serving the request.
uid
The system generated user ID.
gid
The system generated group ID.
primary_gid
The primary group ID.
Object properties
Property
Type
Description
mapping
user on page 46
26
GET /platform/1/auth/providers/
summary
Authentication resources
Operation
-
GET /platform/1/auth/providers/
summary?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
id
active_server string Provides the server that the provider serves authentication
requests with. Null if no server is set or is not applicable for that
provider.
forest
site
string Provides the Active Directory site name. Null if not applicable.
name
status
type
GET /platform/1/auth/providers/
ads/<provider-id>
GET /platform/1/auth/providers/
ads
Join a domain
POST /platform/1/auth/providers/
ads
PUT /platform/1/auth/providers/
ads/<provider-id>
Leave a domain
DELETE /platform/1/auth/
providers/ads/<provider-id>
GET /platform/1/auth/providers/
ads/<domain>?describe
Query parameters
scope
Auth ADS providers resource
27
Authentication resources
If this parameter is specified as effective, or if it is not specified, all fields are shown.
If the parameter is specified as user, only fields with non-default values are shown. If
the parameter is specified as default, the default values are returned.
Object properties
28
Property
Type
allocate_gids
allocate_uids
assume_default_domain
authentication
check_online_interval
integer
controller_time
integer
create_home_directory
domain_offline_alerts
forest
string
home_directory_template
string
hostname
string
id
string
ignore_all_trusts
ignored_trusted_domains
include_trusted_domains
ldap_sign_and_seal
login_shell
string
lookup_domains
string
lookup_groups
lookup_normalize_groups
lookup_normalize_users
Description
Authentication resources
Property
Type
Description
lookup_users
machine_account
string
machine_password_lifespan integer
name
string
netbios_domain
string
nss_enumeration
primary_domain
string
sfu_support
string
site
string
status
string
store_sfu_mappings
system
GET /platform/1/auth/providers/
ads/<id>/domains
GET /platform/1/auth/providers/
ads/<id>/domains/<ads-domain>
GET /platform/1/auth/providers/
ads/<id>/domains?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
dc_address
Description
29
Authentication resources
Property
Type
Description
dc_name
dc_site
domain
guid
id
site
status
trust_type
string Specifies the type of trust with the domain. Options consist of
primary, unknown, external, and forest.
GET /platform/1/auth/providers/ads/
<domain-id>/controllers
GET /platform/1/auth/providers/ads/
View the detailed JSON schema for
authentication providers ADS controllers <domain-id>/controllers?describe
Query parameters
Parameters
There are no parameters for this resource.
Object properties
30
Property
Type
Description
dc_address
string
dc_name
string
id
string
Authentication resources
GET /platform/1/auth/providers/
ads/<object>/search
GET /platform/1/auth/providers/
ads/<object>/search?describe
Query parameters
domain
The domain to search in.
user
The username for the domain, if untrusted.
password
The password for the domain, if untrusted.
filter
The filter to use when performing a search. The filter must be in the form of an LDAP
query.
description
An optional description to search for.
search_users
If true, search for users.
search_groups
If true, search for groups.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from the previous request (cannot be used with other
parameters).
Object properties
Property
Type
Type
resume
string
description
string
display_name string
id
persona on page
45
31
Authentication resources
GET /platform/1/auth/providers/
file/<provider-id>
GET /platform/1/auth/providers/
file
POST /platform/1/auth/providers/
file
PUT /platform/1/auth/providers/
file/<provider-id>
DELETE /platform/1/auth/
providers/file/<provider-id>
GET /platform/1/auth/providers/
file?describe
Query parameters
scope
If specified as effective, or unspecified, all fields are shown. If specified as user, only
fields with non-default values are shown. If specified as default, the default values
are returned.
Object properties
32
Property
Type
authentication
cache_entry_expiry
integer
create_home_directory
enabled
enumerate_groups
enumerate_users
findable_groups
string
findable_users
string
group_domain
string
group_file
string
Description
Authentication resources
Property
Type
Description
home_diretory_template string
id
string
listable_groups
string
listable_users
string
login_shell
string
modifiable_groups
string
modifiable_users
string
name
string
netgroup_file
string
normalize_groups
normalize_users
ntlm_support
string
password_file
string
provider_domain
string
restrict_findable
restrict_listable
restrict_modifiable
status
string
system
unfindable_groups
string
unfindable_users
string
unlistable_groups
string
unlistable_users
string
33
Authentication resources
Property
Type
Description
unmodifiable_groups
string
unmodifiable_users
string
user_domain
string
GET /platform/1/auth/providers/
ldap/<provider-id>
GET /platform/1/auth/providers/
ldap
POST /platform/1/auth/providers/
ldap
PUT /platform/1/auth/providers/
ldap/<provider-id>
DELETE /platform/1/auth/
providers/ldap/<provider-id>
GET /platform/1/auth/providers/
ldap/<provider-id>?describe
Query parameters
scope
If specified as effective, or unspecified, all fields are shown. If specified as user, only
fields with non-default values are shown. If specified as default, the default values
are returned.
Object properties
34
Property
Type
authentication
balance_servers
base_dn
string
bind_dn
string
Description
Authentication resources
Property
Type
Description
bind_mechanism
string
bind_password
string
bind_timeout
integer
cache_entry_expiry
integer
certificate_authority_file
string
check_online_interval
integer
cn_attribute
string
create_home_directory
crypt_password_attribute
string
email_attribute
string
enabled
enumerate_groups
enumerate_users
findable_groups
string
findable_users
string
gecos_attribute
string
gid_attribute
string
group_base_dn
string
group_domain
string
group_filter
string
group_members_attribute
string
group_search_scope
string
home_directory_template
string
35
Authentication resources
36
Property
Type
Description
homedir_attribute
string
id
string
ignore_tls_errors
string
listable_groups
string
listable_users
string
login_shell
string
name
string
name_attribute
string
netgroup_base_dn
string
netgroup_filter
string
netgroup_members_attribute
string
netgroup_search_scope
string
netgroup_triple_attribute
string
normalize_groups
normalize_users
nt_password_attribute
string
ntlm_support
string
provider_domain
string
require_secure_connection
restrict_findable
restrict_listable
search_scope
string
Authentication resources
Property
Type
Description
search_timeout
integer
server_uris
string
shell_attribute
string
status
string
system
uid_attribute
string
unfindable_groups
string
unfindable_users
string
unique_group_members_attribute string
unlistable_groups
string
unlistable_users
string
user_base_dn
string
user_domain
string
user_filter
string
user_search_scope
string
GET /platform/1/auth/providers/
local/<file-id>
GET /platform/1/auth/providers/
local
POST /platform/1/auth/providers/
local
PUT /platform/1/auth/providers/
local/<file-id>
37
Authentication resources
Operation
-
DELETE /platform/1/auth/
providers/local/<file-id>
GET /platform/1/auth/providers/
local?describe
Query parameters
scope
If this parameter is specified as effective, or if it is not specified, all export fields are
shown. If this parameter is specified as user, only fields with non-default values are
shown. If this parameter is specified as default, the original values are returned.
Object properties
38
Property
Type
Description
authentication
create_home_directory
home_directory_template string
id
string
lockout_duration
integer
lockout_threshold
integer
lockout_window
integer
login_shell
string
machine_name
string
max_password_age
integer
min_password_age
integer
min_password_length
integer
name
string
password_prompt_time
integer
status
string
system
Authentication resources
GET /platform/1/auth/providers/
nis/<nis-name>
GET /platform/1/auth/providers/
nis
POST /platform/1/auth/providers/
nis
PUT /platform/1/auth/providers/
nis/<nis-name>
DELETE /platform/1/auth/
providers/nis/<nis-name>
GET /platform/1/auth/providers/
nis?describe
Query parameters
scope
If this parameter is specified as effective, or if it is not specified, all export fields are
shown. If this parameter is specified as user, only fields with non-default values are
shown. If this parameter is specified as default, the original values are returned.
Object properties
Property
Type
authentication
balance_servers
cache_entry_expiry
integer
check_online_interval
integer
create_home_directory
integer
enabled
enumerate_groups
enumerate_users
findable_groups
string
Description
39
Authentication resources
Property
Type
Description
findable_users
string
group_domain
string
home_directory_template string
40
hostname_lookup
id
string
listable_groups
string
listable_users
string
login_shell
string
name
string
nis_domain
string
normalize_groups
normalize_users
ntlm_support
string
provider_domain
string
request_timeout
integer
restrict_findable
restrict_listable
retry_time
integer
servers
string
check_online_interval
integer
status
string
system
string
unfindable_groups
string
unfindable_users
string
Authentication resources
Property
Type
Description
unlistable_groups
string
unlistable_users
string
user_domain
string
ypmatch_using_tcp
GET /platform/1/auth/roles/<roleid>
GET /platform/1/auth/roles
Create a role
POST /platform/1/auth/roles
Modify a role
PUT /platform/1/auth/roles/<roleid>
Delete a role
DELETE /platform/1/auth/roles/
<role-id>
GET /platform/1/auth/roles?
describe
Query parameters
resolve_names
Filters users by zone.
resume
Continue returning results from the previous call (cannot be used with other options).
Object properties
Property Type
Description
resume
string
roles
roles on page 48
41
Authentication resources
GET /platform/1/auth/roles/
<member-id>/members
POST /platform/1/auth/roles/
<member-id>/members
DELETE /platform/1/auth/roles/
<member-id>/members/<persona-id>
GET /platform/1/auth/roles/
<member-id>/members?describe
Query parameters
resolve_names
Resolves the names of personas.
Object properties
Property
Type
Description
Properties for users or groups that have this role.
GET /platform/1/auth/roles/<id>/
privileges
POST /platform/1/auth/roles/<id>/
privileges
DELETE /platform/1/auth/roles/
<id>/privileges/<privilege-id>
GET /platform/1/auth/roles/<id>/
privileges?describe
Query parameters
resume
Continue returning results from the previous call (cannot be used with other options).
42
Authentication resources
Object properties
Property
Type
Description
resume
string
GET /platform/1/auth/settings/
global
PUT /platform/1/auth/settings/
global
GET /platform/1/auth/settings/
global?describe
Query parameters
scope
If this parameter is specified as effective, or if it is not specified, all export fields are
shown. If this parameter is specified as user, only fields with non-default values are
shown. If this parameter is specified as default, the original values are returned.
Object properties
Property
Type
Description
alloc_retries
integer
cache_cred_lifetime
integer
cache_id_lifetime
integer
gid_range_enabled
gid_range_max
integer
gid_range_min
integer
gid_range_next
integer
group_uid
integer
load_providers
array
43
Authentication resources
Property
Type
Description
min_mapped_rid
integer
null_gid
integer
null_uid
integer
on_disk_identity
string
rpc_block_time
integer
rpc_max_requests
integer
rpc_timeout
integer
send_ntlmv2
space_replacement
string
system_gid_threshold integer
system_uid_threshold integer
uid_range_enabled
uid_range_max
integer
uid_range_min
integer
uid_range_next
integer
unknown_gid
integer
unknown_uid
integer
workgroup
string
Query parameters
There are no parameters for this resource.
44
GET /platform/1/auth/shells
GET /platform/1/auth/shells?
describe
Authentication resources
Object properties
Property
Type
Description
shells
string
GET /platform/1/auth/wellknowns
GET /platform/1/auth/wellknowns?
describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Type
persona
persona on page 45
Persona properties
Object properties for personas.
Property Type
Description
id
name
string Provides the persona name, which must be combined with a type.
type
string Provides the type of persona, which must be combined with a name.
Privilege properties
Object properties for privileges.
Property
Type
Description
id
string
name
string
read-only
Boolean
45
Authentication resources
Groups properties
Object properties for groups.
Property
Type
Description
dn
string
dns_domain
string
domain
string
generated_gid
boolean
gid
persona on page
45
id
string
member_of
persona on page
45
name
string
provider
string
sam_account_name string
sid
persona on page
45
type
string
Users properties
Object properties for users.
46
Property
Type
Description
dn
string
dns_domain
string
domain
string
string
enabled
Boolean
expired
Boolean
expiry
integer
gecos
string
Authentication resources
Property
Type
Description
generated_gid
Boolean
generated_uid
Boolean
gid
persona on
page 45
home_directory
string
id
string
locked
Boolean
max_password_age
integer
member_of
persona on
page 45
name
string
password_expired
Boolean
password_expires
Boolean
password_last_set
integer
primary_group_sid
persona on
page 45
prompt_password_change
Boolean
provider
string
sam_account_name
string
shell
string
sid
persona on
page 45
type
string
uid
persona on
page 45
upn
string
Users properties
47
Authentication resources
Property
Type
Description
user_can_change_password Boolean
Domain properties
Object properties for domains.
Property
Type
Description
domain
integer
user
string
Option properties
Object properties for options.
Create rules for specified users. For example, &= for join a group, ++ for append a group,
-- for remove a group.
Property
Type
Description
break
Boolean
group
Boolean
groups
domain on page
48
user
domain on page
48
Roles properties
Object properties for roles.
48
Property
Type
Description
id
string
name
string
members
persona on page 45
privileges
privilege on page 45
CHAPTER 4
NFS resources
These resources allow users to retrieve, create, modify, or delete NFS export
configurations and settings.
u
u
u
u
u
u
u
u
u
u
u
u
u
u
NFS resources
49
NFS resources
GET /platform/1/protocols/nfs/exportssummary
GET /platform/1/protocols/nfs/exportssummary?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
count
integer
GET /platform/1/protocols/nfs/exports/
<export-id>
GET /platform/1/protocols/nfs/exports
POST /platform/1/protocols/nfs/exports
PUT /platform/1/protocols/nfs/exports
DELETE /platform/1/protocols/nfs/
exports/<export-id>
GET /platform/1/protocols/nfs/exports?
describe
GET /platform/1/protocols/nfs/exports/
<export-id>?describe
Query parameters
sort
Order results by this field. The default sort value is id.
dir
The sort order direction are ascending (ASC) or descending (DESC). The default
setting is ascending.
check
Check for conflicts when listing exports.
scope
50
NFS resources
Description
total
integer
resume
string
exports
exports on page 58
GET /platform/1/protocols/nfs/nlm/locks
GET /platform/1/protocols/nfs/nlm/locks?
describe
Query parameters
sort
Order results by this field.
dir
Direction for the sort order is ascending (ASC) or descending (DESC). The default
setting is ascending.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from previous request (cannot be used with other
parameters).
51
NFS resources
Object properties
Property Type
Description
total
integer
resume
string
locks
locks on page 61
GET /platform/1/protocols/nfs/nlm/
waiters
GET /platform/1/protocols/nfs/nlm/
waiters?describe
Query parameters
sort
Order results by this field.
dir
Direction for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from previous request (cannot be used with other
parameters).
Object properties
52
Property Type
Description
total
integer
resume
string
waiters
waiters on page 61
NFS resources
GET /platform/1/protocols/nfs/nlm/sessions
DELETE /platform/1/protocols/nfs/nlm/
sessions/<session-id>
GET /platform/1/protocols/nfs/nlm/
sessions?describe
GET /platform/1/protocols/nfs/nlm/
sessions/<session-id>?describe
Query parameters
sort
Order results by this field.
dir
Direction for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from previous request (cannot be used with other
parameters).
Object properties
Property Type
Description
total
integer
resume
string
GET /platform/1/protocols/nfs/settings/
export
PUT /platform/1/protocols/nfs/settings/
export
53
NFS resources
Operation
-
GET /platform/1/protocols/nfs/settings/
export?describe
Query parameters
scope
When specified as effective, or not specified, all fields are returned. When specified
as user, only fields with non-default values are shown. When specified as default, the
original values are returned.
Object properties
54
Property
Type
Description
all_dirs
Boolean
block_size
integer
can_set_time
Boolean
True if the client may set file times using the NFS
set attribute request. When set to false, the
server ignores the setting and behaves as if the
value is set to true. This value is used to advise
the client of optimal settings for the server, but is
not enforced.
commit_asynchronous
Boolean
directory_transfer_size
integer
encoding
string
map_lookup_uid
Boolean
map_retry
Boolean
map_all
map on
page 62
NFS resources
Property
Type
Description
map_full
Boolean
map_root
map on
page 62
max_file_size
integer
read_only
Boolean
readdirplus
Boolean
readdirplus_prefetch
integer
return_32bit_file_ids
Boolean
read_transfer_max_size integer
read_transfer_multiple
integer
read_transfer_size
integer
security_flavors
array
setattr_asynchronous
Boolean
symlinks
Boolean
time_delta
integer
write_datasync_action
string
write_datasync_reply
string
55
NFS resources
Property
Type
Description
write_filesync_action
string
write_filesync_reply
string
write_unstable_action
string
write_unstable_reply
string
write_transfer_max_size integer
write_transfer_multiple
integer
write_transfer_size
integer
GET /platform/1/protocols/nfs/settings/
global
PUT /platform/1/protocols/nfs/settings/
global
GET /platform/1/protocols/nfs/settings/
global?describe
Query parameters
scope
When specified as effective, or not specified, all fields are returned. When specified
as user, only fields with non-default values are shown. When specified as default, the
original values are returned.
Object properties
56
Property
Type
service
Boolean Enables the NFS service. When set to false, disables the NFS
service.
Description
NFS resources
Property
Type
Description
nfsv2_enabled
nfsv3_enabled
nfsv4_enabled
nfsv4_domain
string
lock_protection integer
rpc_minthreads integer
rpc_maxthreads integer
GET /platform/1/protocols/nfs/check
GET /platform/1/protocols/nfs/check?
describe
Query parameters
There are no parameters for this resource.
Object properties
Property Type
id
Description
string Provides the system ID given to the export. In a POST request, this
value is the ID that refers to the item in the collection item resource
path.
57
NFS resources
Operation
-
POST /platform/1/protocols/nfs/
reload
GET /platform/1/protocols/nfs/
reload?describe
Query parameters
There are no parameters for this resource.
Object properties
There are no properties for this resource.
58
Property
Type
Description
id
integer
description
string
paths
string
force
string
clients
string
root_clients
array
read_only_clients
array
read_write_clients
array
unresolved_clients
array
conflicting_paths
string
all_dirs
Boolean
block_size
integer
NFS resources
Property
Type
Description
can_set_time
Boolean
True if the client may set file times using the NFS
set attribute request. When set to false, the
server ignores the setting and behaves as if the
value is set to true. This value is used to advise
the client of optimal settings for the server, but
is not enforced.
commit_asynchronous
Boolean
directory_transfer_size
integer
encoding
string
map_lookup_uid
Boolean
map_retry
Boolean
map_all
map on
page 62
map_full
Boolean
map_root
map on
page 62
max_file_size
integer
read_only
Boolean
readdirplus
Boolean
readdirplus_prefetch
integer
return_32bit_file_ids
Boolean
read_transfer_max_size integer
59
NFS resources
Property
Type
Description
used to advise the client of optimal settings for
the server, but is not enforced.
60
read_transfer_multiple
integer
read_transfer_size
integer
security_flavors
array
setattr_asynchronous
Boolean
symlinks
Boolean
time_delta
integer
write_datasync_action
string
write_datasync_reply
string
write_filesync_action
string
write_filesync_reply
string
write_unstable_action
string
write_unstable_reply
string
write_transfer_max_size integer
write_transfer_multiple
integer
write_transfer_size
integer
NFS resources
Property
Type
Description
of optimal settings for the server, but is not
enforced.
Type
Description
id
string
client
string
client_id
string
lock_type string
range
path
string
created
integer Provides the UNIX Epoch time the lock was created.
lin
string
Type
Description
id
string
client
string
client_id
string
lock_type string
range
path
string
created
integer Provides the UNIX Epoch time the lock was created.
lin
string
61
NFS resources
Type
Description
id
string
client
string
client_id
string
lock_type string
range
path
string
created
integer Provides the UNIX Epoch time the lock was created.
lin
string
62
Description
groups
string Provides the name of the group that non-root clients are mapped to.
user
string Provides the name of the user that non-root clients are mapped to.
CHAPTER 5
SMB resources
These resources allow users to retrieve, create, modify, or delete SMB share
configurations and settings.
u
u
u
u
u
u
u
u
u
u
u
u
SMB resources
63
SMB resources
GET /platform/1/protocols/smb/sharessummary
GET /platform/1/protocols/smb/sharessummary?describe
Query parameters
There are no query parameters for this resource.
Object properties
Property
Type
Description
count
integer
GET /platform/1/protocols/smb/shares/
<share-name>
GET /platform/1/protocols/smb/shares
POST /platform/1/protocols/smb/shares
PUT /platform/1/protocols/smb/shares/
<share-name>
DELETE /platform/1/protocols/smb/shares/
<share-name>
GET /platform/1/protocols/smb/shares?
describe
GET /platform/1/protocols/smb/shares/
<share-name>?describe
Query parameters
sort
Order results by this field. The default value is id.
dir
Directions for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
zone
An optionally named zone to use for user and group resolution.
64
SMB resources
scope
If this parameter is specified as effective, or if it is unspecified, all export fields are
shown. If this parameter is specified as user, only fields with non-default values are
shown. If this parameter is specified as default, the original values are returned.
resolve_names
When this parameter is set to true, the group and user names are resolved.
limit
Return no more than this many results at one time. (See resume.)
resume
Continue returning results from previous request (cannot be used with other
parameters).
Object properties
Property Type
Description
total
integer
resume
string
share
share on page 70
GET /platform/1/protocols/smb/openfiles
DELETE /platform/1/protocols/smb/
openfiles/<file-id>
GET /platform/1/protocols/smb/openfiles?
describe
GET /platform/1/protocols/smb/openfiles/
<file-id>?describe
Query parameters
sort
Order results by this field. The default value is id.
dir
Directions for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
limit
Return no more than this many results at one time (see resume).
resume
SMB open files resource
65
SMB resources
Continue returning results from previous request (cannot be used with other
parameters).
Object properties
Property
Type
Description
total
integer
resume
string
GET /platform/1/protocols/smb/sessions
DELETE /platform/1/protocols/smb/sessions/
<computer>/<user>
DELETE /platform/1/protocols/smb/sessions/
<computer>
GET /platform/1/protocols/smb/sessions?
describe
GET /platform/1/protocols/smb/sessions/
<computer>/<user>?describe
GET /platform/1/protocols/smb/sessions/
<computer>?describe
Query parameters
sort
Order results by this field. The default sort value is id.
dir
Directions for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from previous request (cannot be used with other
parameters).
66
SMB resources
Object properties
Property Type
Description
total
integer
resume
string
GET /platform/1/protocols/smb/settings/
share
PUT /platform/1/protocols/smb/settings/
share
GET /platform/1/protocols/smb/settings/
share?describe
Query parameters
scope
If this parameter is specified as effective, or if it is not specified, all export fields are
shown. If this parameter is specified as user, only fields with non-default values are
shown. If this parameter is specified as default, the original values are returned.
Object properties
Property
Type
allow_execute_always
strict_locking
hide_dot_files
impersonate_guest
string
strict_flush
mangle_byte_start
integer
Description
67
SMB resources
Property
Type
Description
directory_create_mask
integer
directory_create_mode
integer
file_create_mask
integer
file_create_mode
integer
create_permissions
string
mangle_map
array
impersonate_user
string
change_notify
string
oplocks
allow_delete_readonly
ntfs_acl_support
access_based_enumeration
68
array
SMB resources
GET /platform/1/protocols/smb/settings/
global
PUT /platform/1/protocols/smb/settings/
global
GET /platform/1/protocols/smb/settings/
global?describe
Query parameters
scope
When specified as effective, or when not specified, all the fields are returned. When
specified as user, only the fields with non-default values are returned. When
specified as default, the original values are returned.
Object properties and structure
Property
Type
service
Description
string
audit_logon
string
dot_snap_visible_child
dot_snap_visible_root
string
69
SMB resources
Property
Type
Description
ignore_eas
onefs_cpu_multiplier
integer
onefs_num_workers
integer
string
srv_cpu_multiplier
integer
srv_num_workers
integer
support_netbios
support_smb2
Share properties
Object properties for an SMB share.
70
Property
Type
Description
run_as_root
run as root on
page 72
allow_execute_always
Boolean
strict_locking
Boolean
hide_dot_files
Boolean
impersonate_guest
string
strict_flush
Boolean
SMB resources
Property
Type
Description
mangle_byte_start
integer
directory_create_mask
integer
directory_create_mode
integer
file_create_mask
integer
file_create_mode
integer
create_permissions
string
Determines how
permissions are set for new
files and directories in the
SMB share.
mangle_map
array
impersonate_user
string
change_notify
string
oplocks
Boolean
allow_delete_readonly
Boolean
ntfs_acl_support
Boolean
access_based_enumeration
Boolean
Share properties
71
SMB resources
Property
Type
Description
access_based_enumeration_root_only Boolean
host_acl
array
inheritable_path_acl
string
id
string
description
string
path
string
name
string
csc_policy
string
browsable
Boolean
permissions
permissions on
page 73
72
Description
id
name
string
type
string
SMB resources
Permissions properties
Object properties for permissions.
Property
Type
Description
permission
string
permission_type string
trustee
trustee on page
73
Trustee properties
Object properties for trustees.
Property Type
Description
id
name
string
type
string
Type
id
integer Provides the system ID given to the file. In a POST request, this
value is the ID used to refer to the item in the collection item
resource path.
file
string
user
string
locks
integer Provides the number of locks the user holds on the file.
permissions string
Description
Sessions properties
Object properties for an SMB session.
Property
Type
Description
id
integer
computer
string
user
string
Permissions properties
73
SMB resources
Property
Type
Description
client_type
string
openfiles
integer
active_time integer
idle_time
integer
74
CHAPTER 6
Quota resources
Quota resources
75
Quota resources
GET /platform/1/quota/license
GET /platform/1/quota/license?
describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
duration
expiration integer Provides the UNIX Epoch time when the license expires.
status
array
name
string
GET /platform/1/quota/quotassummary
GET /platform/1/quota/quotassummary?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
count
Description
76
Quota resources
Property
Type
Description
directory_quotas_count
group_quotas_count
linked_quotas_count
user_quotas_count
Quotas resource
This resource applies the standard collection pattern to file system quotas.
Operation
-
GET /platform/1/quota/quotas/<quota-id>
GET /platform/1/quota/quotas
Create a quota
POST /platform/1/quota/quotas
Modify a quota
PUT /platform/1/quota/quotas/<quota-id>
Delete a quota
DELETE /platform/1/quota/quotas/<quotaid>
DELETE /platform/1/quota/quotas
GET /platform/1/quota/quotas?describe
GET /platform/1/quota/quotas/<quota-id>?
describe
Query Parameters
path
Only applies to quotas matching this path (see recurse_path_*).
type
Only applies to quotas matching this type.
persona
Only applies to user or group quotas that match this persona. This parameter must be
used with the corresponding type argument).
include_snapshots
Only applies to quotas with the setting for include_snapshots.
enforced
Only applies to quotas with this enforcement (non-accounting).
exceeded
Only list quotas which have exceeded one or more of their thresholds.
recurse_path_parents
If used with the path argument, this parameter applies to all quotas at that path or at
any parent directory.
Quotas resource
77
Quota resources
recurse_path_children
If used with the path argument, this parameter applies to all quotas at that path or at
any descendent subdirectory.
report_id
Uses the named report as a source rather than the live quotas. See the quota reports
resource for a list of valid reports.
zone
An optionally named zone for user and group resolution.
resolve_names
If true, resolves group and user names in personas.
limit
Return no more than this many results at once (see resume).
resume
Continue returning results from a previous request (cannot be used with other
parameters).
Object Properties and Structure
Property
Type
Description
total
integer
resume
integer
container Boolean
quotas
quotas on page
84
78
GET /platform/1/quota/quotas/<quota-id>/
notifications/<notification-id>
GET /platform/1/quota/quotas/<quota-id>/
notifications
POST /platform/1/quota/quotas/<quota-id>/
notifications
PUT /platform/1/quota/quotas/<quota-id>/
notifications
PUT /platform/1/quota/quotas/<quota-id>/
notifications/<notification-id>
DELETE /platform/1/quota/quotas/<quota-id>/
notifications/<notification-id>
Quota resources
Operation
-
GET /platform/1/quota/quotas/<quota-id>/
notifications?describe
GET /platform/1/quota/quotas/<quota-id>/
notifications/<notification-id>?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
id
string
action_alert
string
action_email_address string
action_email_owner
string
email_template
string
condition
array
holdoff
GET /platform/quota/reports/<reportid>?contents
GET /platform/quota/reports
POST /platform/quota/reports/<reportid>?contents
79
Quota resources
Operation
-
DELETE /platform/quota/reports/<reportid>
GET /platform/quota/reports?describe
GET /platform/quota/reports/<reportid>?describe
Query parameters
type
Only applies to reports matching this type.
generated
Applies to reports that match the source type (scheduled, manual, or all).
dir
Directions for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from a previous request (cannot be used with other
parameters).
Object properties
80
Property
Type
total
id
string
Description
generated string
type
string
resume
string
time
integer Provides the UNIX Epoch time that the report was generated.
Quota resources
GET /platform/1/quota/reports/<report-id>/
about
GET /platform/1/quota/reports/<report-id>/
about?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
id
string
generated string
type
string
time
integer Provides the UNIX Epoch time the report was taken.
GET /platform/1/quota/settings/
reports
PUT /platform/1/quota/settings/
reports
Query parameters
There are no parameters for this resource.
81
Quota resources
Object properties
Property
Type
Description
id
string
live_dir
string
live_retain
schedule
string
scheduled_dir
string
string
threshold
GET /platform/1/quota/settings/
notifications/<notification-id>
or GET /platform/1/quota/quotas/<reportid>/notifications
POST /platform/1/quota/settings/
notifications/<notification-id>
or POST /platform/1/quota/quotas/<reportid>/notifications/<notification-id>
PUT /platform/1/quota/settings/
notifications/<notification-id>
or PUT /platform/1/quota/quotas/<reportid>/notifications/<notification-id>
DELETE /platform/1/quota/settings/
notifications
or DELETE /platform/1/quota/quotas/<reportid>/notifications
82
Quota resources
Operation
-
DELETE /platform/1/quota/settings/
notifications/<notification-id>
or DELETE /platform/1/quota/quotas/<reportid>/notifications/<notification-id>
GET /platform/1/quota/settings/
notifications?describe
GET /platform/1/quota/settings/
notifications/<notification-id>?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
id
string
action_alert
string
action_email_address string
action_email_owner
string
email_template
string
condition
array
holdoff
schedule
string
threshold
GET /1/quota/settings/mappings
83
Quota resources
Operation
-
POST /1/quota/settings/mappings/
<domain>
PUT /1/quota/settings/mappings/
<domain>
DELETE /1/quota/settings/mappings/
<domain>
DELETE /1/quota/settings/mappings
GET /1/quota/settings/mappings?
describe
Query parameters
There are no parameters for this resource.
Object properties
Property Type
Description
id
integer Provides the system ID given to the domain. In a POST request, this
is the ID of the created item that refers to the item in the collection
item resource path.
domain
string
mapping string
type
array
Quotas properties
Object properties for quotas.
84
Property
Type
Description
id
string
enforced
Boolean
Quota resources
Property
Type
Description
force
string
include_snapshots
Boolean
linked
Boolean
notifications
array
path
string
ready
Boolean
thresholds_include_overhead Boolean
type
array
persona
persona on
page 85
usage
usage on page
86
thresholds
threshold on
page 86
Persona properties
Object properties for personas.
Property Type
Description
id
name
string
type
string
Persona properties
85
Quota resources
Usage properties
Object properties for quota usage.
Property Type
Description
inodes
logical
physical integer Provides the bytes used for governed data and file system overhead.
Threshold properties
Object properties for quota thresholds.
Property
Type
Description
advisory
integer
86
hard
integer
hard_exceeded
soft
integer
soft_exceeded
soft_grace
integer
CHAPTER 7
Snapshot resources
These resources allow users to retrieve, create, modify, or delete snapshot configurations
and settings.
u
u
u
u
u
u
u
u
u
u
u
Snapshot resources
87
Snapshot resources
GET /platform/1/snapshot/license
GET /platform/1/snapshot/license?
describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
duration
expiration integer Provides the UNIX Epoch time when the license expires.
status
array
name
string
GET /platform/1/snapshot/
snapshots-summary
GET /platform/1/snapshot/
snapshots-summary?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
count
active_count
integer Provides the total number of snapshots that are not aliases or
pending for deletion.
Description
deleting_count integer Provides the total number of snapshots that are pending for
deletion.
88
Snapshot resources
Property
Type
Description
aliases_count
active_size
integer Provides the sum of sizes of snapshots that are not aliases or
pending for deletion.
deleting_size
integer Provides the sum of sizes of snapshots that are pending for
deletion.
Snapshots resource
This resource applies the standard collection pattern to file system snapshots.
Operation
-
GET /platform/1/snapshot/snapshots/<id|
snapshot name>
GET /platform/1/snapshot/snapshots
Create a snapshot
POST /platform/1/snapshot/snapshots
Modify a snapshot
PUT /platform/1/snapshot/snapshots/<id|
snapshot name>
Delete a snapshot
DELETE /platform/1/snapshot/snapshots/<id|
snapshot name>
DELETE /platform/1/snapshot/snapshots
GET /platform/1/snapshot/snapshots/<id|
snapshot name>?describe
GET /platform/1/snapshot/snapshots?describe
Query parameters
sort
Order results by this field; options consist of id, name, path, created, expires, size,
has_locks, schedule, alias_target, alias_target_name, pct_filesystem, pct_reserve,
and state. The default value is id.
dir
Directions for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
schedule
Only list snapshots that were created by this schedule.
type
Only list snapshots that match this type.
state
Snapshots resource
89
Snapshot resources
Type
Description
total
integer
resume
string
GET /platform/1/snapshot/schedules/<id|
schedule name>
GET /platform/1/snapshot/schedules
POST /platform/1/snapshot/schedules
PUT /platform/1/snapshot/schedules/<id|
schedule name>
DELETE /platform/1/snapshot/schedules/<id|
schedule name>
DELETE /platform/1/snapshot/schedules
GET /platform/1/snapshot/schedules/<id|
schedule name>?describe
GET /platform/1/snapshot/schedules?describe
Query parameters
sort
Order results by this field; options consist of id, name, path, pattern, schedule,
duration, alias, next_run, and next_snapshot. The default option is id.
dir
Directions for the sort order are ascending (ASC) or descending (DESC). The default
setting is ascending.
limit
Return no more than this many results at one time (see resume).
90
Snapshot resources
resume
Continue returning results from previous request (cannot be used with other options).
Object properties
Property
Type
Description
total
integer
resume
string
GET /platform/1/snapshot/snapshots/<snapshotname|id>/locks/<lock-id>
GET /platform/1/snapshot/snapshots/<id|
snapshot name>/locks
POST /platform/1/snapshot/snapshots/<snapshotname|id>/locks
PUT /platform/1/snapshot/snapshots/<snapshotname|id>/locks/<lock-id>
DELETE /platform/1/snapshot/snapshots/<lockid>/locks
GET /platform/1/snapshot/snapshots/<snapshotname|id>/locks/<lock-id>?describe
GET /platform/1/snapshot/snapshots/<id|
snapshot name>/locks?describe
Query parameters
sort
Order results by this field; options consist of id, expires, and comment. The default
option is id.
dir
Directions for the sort order are ascending (ASC) or descending (DESC). The default
option is ascending.
limit
Return no more than this many results at one time (see resume).
resume
Continue returning results from previous request (cannot be used with other
parameters).
Snapshot locks resource
91
Snapshot resources
Object properties
Property Type
Description
total
integer
resume
string
locks
locks on page 95
GET /platform/1/snapshot/pending
GET /platform/1/snapshot/pending?
describe
Query parameters
schedule
Limit output only to the named schedule.
begin
UNIX Epoch time to start generating matches. The default option is now.
end
UNIX Epoch time to end generating matches. The default option is forever.
limit
Return no more than this many results at once (see resume).
resume
Continue returning results from a previous request (cannot be used with other
parameters.)
Object properties
resume
Property Type
Description
resume
string
92
Snapshot resources
GET /platform/1/snapshot/settings
PUT /platform/1/snapshot/settings
GET /platform/1/snapshot/
settings?describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
service
autocreate
autodelete
reserve
integer
nfs_root_visible
nfs_subdir_accessible
local_root_accessible
local_root_visible
local_subdir_accessible
smb_root_accessible
smb_root_visible
93
Snapshot resources
Property
Type
Description
smb_subdir_accessible
Snapshot properties
Object properties for snapshots.
Property
Type
Description
id
integer
name
string
shadow_bytes
integer
schedule
string
created
integer
expires
integer
path
string
size
integer
pct_filesystem
integer
pct_reserve
integer
alias_target
integer
alias_target_name string
94
has_locks
Boolean True if the snapshot has one or more locks present. See
the locks resource of a snapshot for a list of locks.
state
string
Snapshot resources
Schedules properties
Object properties for schedules.
Property
Type
id
name
string
pattern
string
path
string
schedule
string
duration
alias
string
next_run
next_snapshot string
Description
Lock properties
Object properties for locks.
Property
Type
id
integer Provides the system generated lock ID. In a POST request, this value
refers to the item in the collection item resource path.
comment string
expires
Description
integer Provides the UNIX Epoch time the snapshot lock expires and is
eligible for automatic deletion.
Pending properties
Object properties for pending snapshots.
Property
Type
Description
id
string
Provides the system supplied unique ID used for sorting and paging.
schedule string
time
integer Provides the UNIX Epoch time the snapshot will be created.
snapshot string
Schedules properties
95
Snapshot resources
96
Property
Type
Description
path
string
CHAPTER 8
Zones resources
These resources allow users to retrieve, create, modify, or delete access zone
configurations and settings.
u
u
u
Zones resources
97
Zones resources
GET /platform/1/zones-summary
GET /platform/1/zones-summary?
describe
Query parameters
There are no parameters for this resource.
Object properties
Property
Type
Description
count
integer
Zones resource
This resource applies the standard collection pattern to access zones.
Operation
-
GET /platform/1/zones/<zone-id>
GET /platform/1/zones
Create a zone
POST /platform/1/zones
Modify a zone
PUT /platform/1/zones/<zone-id>
Delete a zone
DELETE /platform/1/zones/<zoneid>
GET /platform/1/zones?describe
GET /platform/1/zones/<zone-id>?
describe
Query parameters
There are no parameters for this resource.
Object properties
98
Property
Type
Description
id
string
Zones resources
Property
Type
Description
all_auth_providers
Boolean
all_smb_shares
Boolean
alternate_system_provider string
auth_providers
array
cache_size
integer
home_directory_umask
integer
local_provider
Boolean
map_untrusted
string
name
string
netbios_name
string
skeleton_directory
string
smb_shares
array
system
Boolean
system_provider
string
user_mapping_rules
array
zone_id
integer
ifs_restricted
persona on
page 99
Description
id
integer The serialized form of the zone (such as 'UID:0', 'USER:name', 'GID:
0', 'GROUP:wheel', 'SID:S-1-1').
name
string
type
string
99
Zones resources
100