Skip to content

export.host

Manage allowed hosts

Create

Path
POST /v7.0/exports/{export_id}/hosts
Description
Add a new host
Authentication required
yes
Scope
export.host#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
host
ParameterTypeRequiredDetails
ip_address
IpAddress
 Resource yes
rw
Read-write
 Boolean no

Allow the export to be mounted as read-write.

Default: null
sync
Sync
 Boolean no

Determines whether the server replies to requests only after the changes have been committed to stable storage.

Default: null
subtree_check
Subtree check
 Boolean no

See man exports(5).

Default: null
root_squash
Root squash
 Boolean no

Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.

Default: null

Output parameters

Layout
object
Namespace
host
ParameterTypeDescription
id
Id
 Integer
ip_address
IpAddress
 Resource
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.

Delete

Path
DELETE /v7.0/exports/{export_id}/hosts/{host_id}
Description
Delete host
Authentication required
yes
Scope
export.host#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/exports/{export_id}/hosts
Description
List hosts
Authentication required
yes
Scope
export.host#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
host
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
hosts
ParameterTypeDescription
id
Id
 Integer
ip_address
IpAddress
 Resource
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.

Show

Path
GET /v7.0/exports/{export_id}/hosts/{host_id}
Description
Authentication required
yes
Scope
export.host#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
host
ParameterTypeDescription
id
Id
 Integer
ip_address
IpAddress
 Resource
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.

Update

Path
PUT /v7.0/exports/{export_id}/hosts/{host_id}
Description
Edit host options
Authentication required
yes
Scope
export.host#update
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
host
ParameterTypeRequiredDetails
rw
Read-write
 Boolean no

Allow the export to be mounted as read-write.

Default: null
sync
Sync
 Boolean no

Determines whether the server replies to requests only after the changes have been committed to stable storage.

Default: null
subtree_check
Subtree check
 Boolean no

See man exports(5).

Default: null
root_squash
Root squash
 Boolean no

Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.

Default: null

Output parameters

Layout
object
Namespace
host
ParameterTypeDescription
id
Id
 Integer
ip_address
IpAddress
 Resource
rw
Read-write
 Boolean Allow the export to be mounted as read-write.
sync
Sync
 Boolean Determines whether the server replies to requests only after the changes have been committed to stable storage.
subtree_check
Subtree check
 Boolean See man exports(5).
root_squash
Root squash
 Boolean Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does not apply to any other uids or gids that might be equally sensitive.