UpdateExport
put
/20171215/exports/{export_id}
Updates the specified export's information.
Request
Supported Media Types
- application/json
Path Parameters
-
exportId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the export.
Header Parameters
-
if-match: string
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Details object for updating an export.
Root Schema : UpdateExportDetails
Type:
object
Details for updating the export.
Show Source
-
exportMode:
string
Default Value:
ENABLED
Allowed Values:[ "ENABLED", "DISABLED" ]
Export can be set in 'ENABLED' or 'DISABLED' mode. Attempt to mount the filesystem will fail if the export is in 'DISABLED' mode. -
exportOptions:
array exportOptions
Minimum Number of Items:
0
Maximum Number of Items:100
New export options for the export. Note: Setting to the empty array will make the export invisible to all clients. Leaving unset will leave the exportOptions unchanged. -
isIdmapGroupsForSysAuth:
boolean
The export is modified to include a boolean to use ID mapping for Unix Groups rather than the group list provided within an NFS Request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable or cannot be used to determine a list of secondary groups then the data path uses an empty secondary group list for authorization. If the number of groups exceeds the current limit of 256 groups the list retrieved from LDAP is truncated to the first 256 groups read.
Nested Schema : exportOptions
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
100
New export options for the export. Note: Setting to the empty array will make the export invisible to all clients. Leaving unset will leave the exportOptions unchanged.
Show Source
-
Array of:
object ClientOptions
NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.
Nested Schema : ClientOptions
Type:
object
NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.
Show Source
-
access:
string
Allowed Values:
[ "READ_WRITE", "READ_ONLY" ]
Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY. -
allowedAuth:
array allowedAuth
Unique Items Required:
true
Array of allowed NFS authentication types. -
anonymousGid:
integer(int64)
Minimum Value:
0
GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534. -
anonymousUid:
integer(int64)
Minimum Value:
0
UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534. -
identitySquash:
string
Allowed Values:
[ "NONE", "ROOT", "ALL" ]
Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT. -
isAnonymousAccessAllowed:
boolean
Allow principals with no entry in ID mapping to access this export with SquashUID and SquashGID privileges.
-
requirePrivilegedSourcePort:
boolean
If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
-
source(required):
string
Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block. Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.
Nested Schema : allowedAuth
Type:
array
Unique Items Required:
true
Array of allowed NFS authentication types.
Show Source
-
Array of:
string
Allowed Values:
[ "SYS", "KRB5", "KRB5I", "KRB5P" ]
Response
Supported Media Types
- application/json
200 Response
The export was updated.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Export
Type:
object
A file system and the path that you can use to mount it. Each export resource belongs to exactly one export set. The export's path attribute is not a path in the referenced file system, but the value used by clients for the path component of the remotetarget argument when mounting the file system. The path must start with a slash (/) followed by a sequence of zero or more slash-separated path elements. For any two export resources associated with the same export set, except those in a 'DELETED' state, the path element sequence for the first export resource can't contain the complete path element sequence of the second export resource. For example, the following are acceptable: - /example and /path - /example1 and /example2 - /example and /example1 The following examples are not acceptable: - /example and /example/path - / and /example Paths may not end in a slash (/). No path element can be a period (.) or two periods in sequence (..). All path elements must be 255 bytes or less. No two non-'DELETED' export resources in the same export set can reference the same file system. Use exportOptions to control access to an export.
Show Source
-
exportMode:
string
Allowed Values:
[ "ENABLED", "DISABLED" ]
Export can be created in 'ENABLED' or 'DISABLED' mode. Attempt to mount the filesystem will fail if the export is in 'DISABLED' mode. -
exportOptions(required):
array exportOptions
Minimum Number of Items:
0
Maximum Number of Items:100
Policies that apply to NFS requests made through this export. exportOptions contains a sequential list of ClientOptions. Each ClientOptions item defines the export options that are applied to a specified set of clients. For each NFS request, the first ClientOptions option in the list whose source attribute matches the source IP address of the request is applied. If a client source IP address does not match the source property of any ClientOptions in the list, then the export will be invisible to that client. This export will not be returned by MOUNTPROC_EXPORT calls made by the client and any attempt to mount or access the file system through this export will result in an error. Exports without defined ClientOptions are invisible to all clients. If one export is invisible to a particular client, associated file systems may still be accessible through other exports on the same or different mount targets. To completely deny client access to a file system, be sure that the client source IP address is not included in any export for any mount target associated with the file system. -
exportSetId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of this export's export set. -
fileSystemId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of this export's file system. -
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of this export. -
isIdmapGroupsForSysAuth:
boolean
The export is modified to include a boolean to use ID mapping for Unix Groups rather than the group list provided within an NFS Request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable or cannot be used to determine a list of secondary groups then the data path uses an empty secondary group list for authorization. If the number of groups exceeds the current limit of 256 groups the list retrieved from LDAP is truncated to the first 256 groups read.
-
lifecycleState(required):
string
Allowed Values:
[ "CREATING", "ACTIVE", "DELETING", "DELETED" ]
The current state of this export. -
path(required):
string
Minimum Length:
1
Maximum Length:1024
Path used to access the associated file system. Avoid entering confidential information. Example: /accounting -
timeCreated(required):
string(date-time)
The date and time the export was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z
Nested Schema : exportOptions
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
100
Policies that apply to NFS requests made through this export. exportOptions contains a sequential list of ClientOptions. Each ClientOptions item defines the export options that are applied to a specified set of clients. For each NFS request, the first ClientOptions option in the list whose source attribute matches the source IP address of the request is applied. If a client source IP address does not match the source property of any ClientOptions in the list, then the export will be invisible to that client. This export will not be returned by MOUNTPROC_EXPORT calls made by the client and any attempt to mount or access the file system through this export will result in an error. Exports without defined ClientOptions are invisible to all clients. If one export is invisible to a particular client, associated file systems may still be accessible through other exports on the same or different mount targets. To completely deny client access to a file system, be sure that the client source IP address is not included in any export for any mount target associated with the file system.
Show Source
-
Array of:
object ClientOptions
NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.
Nested Schema : ClientOptions
Type:
object
NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.
Show Source
-
access:
string
Allowed Values:
[ "READ_WRITE", "READ_ONLY" ]
Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY. -
allowedAuth:
array allowedAuth
Unique Items Required:
true
Array of allowed NFS authentication types. -
anonymousGid:
integer(int64)
Minimum Value:
0
GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534. -
anonymousUid:
integer(int64)
Minimum Value:
0
UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534. -
identitySquash:
string
Allowed Values:
[ "NONE", "ROOT", "ALL" ]
Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT. -
isAnonymousAccessAllowed:
boolean
Allow principals with no entry in ID mapping to access this export with SquashUID and SquashGID privileges.
-
requirePrivilegedSourcePort:
boolean
If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
-
source(required):
string
Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block. Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.
Nested Schema : allowedAuth
Type:
array
Unique Items Required:
true
Array of allowed NFS authentication types.
Show Source
-
Array of:
string
Allowed Values:
[ "SYS", "KRB5", "KRB5I", "KRB5P" ]
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
412 Response
Precondition Failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload