Export¶

class oci.file_storage.models.Export(**kwargs)¶

Bases: 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

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Export.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Export.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Export.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Export.
`export_options`	[Required] Gets the export_options of this Export.
`export_set_id`	[Required] Gets the export_set_id of this Export.
`file_system_id`	[Required] Gets the file_system_id of this Export.
`id`	[Required] Gets the id of this Export.
`is_idmap_groups_for_sys_auth`	Gets the is_idmap_groups_for_sys_auth of this Export.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Export.
`locks`	Gets the locks of this Export.
`path`	[Required] Gets the path of this Export.
`time_created`	[Required] Gets the time_created of this Export.

Methods

__init__(**kwargs) Initializes a new Export object with values from keyword arguments.

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. For more information, see Export Options.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Export. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Export. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Export. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Export. This constant has a value of “DELETING”

__init__(**kwargs)¶

Initializes a new Export object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

export_options (list[oci.file_storage.models.ClientOptions]) – The value to assign to the export_options property of this Export.
export_set_id (str) – The value to assign to the export_set_id property of this Export.
file_system_id (str) – The value to assign to the file_system_id property of this Export.
id (str) – The value to assign to the id property of this Export.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Export. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
path (str) – The value to assign to the path property of this Export.
is_idmap_groups_for_sys_auth (bool) – The value to assign to the is_idmap_groups_for_sys_auth property of this Export.
time_created (datetime) – The value to assign to the time_created property of this Export.
locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this Export.

export_options¶

[Required] Gets the export_options of this Export. 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.

Returns:	The export_options of this Export.
Return type:	list[oci.file_storage.models.ClientOptions]

export_set_id¶

[Required] Gets the export_set_id of this Export. The OCID of this export’s export set.

Returns:	The export_set_id of this Export.
Return type:	str

file_system_id¶

[Required] Gets the file_system_id of this Export. The OCID of this export’s file system.

Returns:	The file_system_id of this Export.
Return type:	str

id¶

[Required] Gets the id of this Export. The OCID of this export.

Returns:	The id of this Export.
Return type:	str

is_idmap_groups_for_sys_auth¶

Gets the is_idmap_groups_for_sys_auth of this Export. Whether or not the export should 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 an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.

Returns:	The is_idmap_groups_for_sys_auth of this Export.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this Export. The current state of this export.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Export.
Return type:	str

locks¶

Gets the locks of this Export. Locks associated with this resource.

Returns:	The locks of this Export.
Return type:	list[oci.file_storage.models.ResourceLock]

path¶

[Required] Gets the path of this Export. Path used to access the associated file system.

Avoid entering confidential information.

Example: /accounting

Returns:	The path of this Export.
Return type:	str

time_created¶

[Required] Gets the time_created of this Export. The date and time the export was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this Export.
Return type:	datetime