FileSystem¶

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

Bases: object

An NFS file system. To allow access to a file system, add it to an export set and associate the export set with a mount target. The same file system can be in multiple export sets and associated with multiple mount targets.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a FileSystem.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a FileSystem.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a FileSystem.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a FileSystem.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a FileSystem.
`availability_domain`	Gets the availability_domain of this FileSystem.
`compartment_id`	[Required] Gets the compartment_id of this FileSystem.
`defined_tags`	Gets the defined_tags of this FileSystem.
`display_name`	[Required] Gets the display_name of this FileSystem.
`filesystem_snapshot_policy_id`	Gets the filesystem_snapshot_policy_id of this FileSystem.
`freeform_tags`	Gets the freeform_tags of this FileSystem.
`id`	[Required] Gets the id of this FileSystem.
`is_clone_parent`	Gets the is_clone_parent of this FileSystem.
`is_hydrated`	Gets the is_hydrated of this FileSystem.
`is_targetable`	Gets the is_targetable of this FileSystem.
`kms_key_id`	Gets the kms_key_id of this FileSystem.
`lifecycle_details`	Gets the lifecycle_details of this FileSystem.
`lifecycle_state`	[Required] Gets the lifecycle_state of this FileSystem.
`metered_bytes`	[Required] Gets the metered_bytes of this FileSystem.
`replication_target_id`	Gets the replication_target_id of this FileSystem.
`source_details`	Gets the source_details of this FileSystem.
`time_created`	[Required] Gets the time_created of this FileSystem.

Methods

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

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

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a FileSystem. This constant has a value of “FAILED”

__init__(**kwargs)¶

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

Parameters:

availability_domain (str) – The value to assign to the availability_domain property of this FileSystem.
metered_bytes (int) – The value to assign to the metered_bytes property of this FileSystem.
compartment_id (str) – The value to assign to the compartment_id property of this FileSystem.
display_name (str) – The value to assign to the display_name property of this FileSystem.
id (str) – The value to assign to the id property of this FileSystem.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this FileSystem. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this FileSystem.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this FileSystem.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this FileSystem.
kms_key_id (str) – The value to assign to the kms_key_id property of this FileSystem.
source_details (oci.file_storage.models.SourceDetails) – The value to assign to the source_details property of this FileSystem.
is_clone_parent (bool) – The value to assign to the is_clone_parent property of this FileSystem.
is_hydrated (bool) – The value to assign to the is_hydrated property of this FileSystem.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this FileSystem.
is_targetable (bool) – The value to assign to the is_targetable property of this FileSystem.
replication_target_id (str) – The value to assign to the replication_target_id property of this FileSystem.
filesystem_snapshot_policy_id (str) – The value to assign to the filesystem_snapshot_policy_id property of this FileSystem.

availability_domain¶

Gets the availability_domain of this FileSystem. The availability domain the file system is in. May be unset as a blank or NULL value.

Example: Uocm:PHX-AD-1

Returns:	The availability_domain of this FileSystem.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this FileSystem. The OCID of the compartment that contains the file system.

Returns:	The compartment_id of this FileSystem.
Return type:	str

defined_tags¶

Gets the defined_tags of this FileSystem. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this FileSystem.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this FileSystem. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: My file system

Returns:	The display_name of this FileSystem.
Return type:	str

filesystem_snapshot_policy_id¶

Gets the filesystem_snapshot_policy_id of this FileSystem. The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

Returns:	The filesystem_snapshot_policy_id of this FileSystem.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this FileSystem. Free-form tags for this resource. Each tag is a simple key-value pair

with no predefined name, type, or namespace.

For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this FileSystem.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this FileSystem. The OCID of the file system.

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

is_clone_parent¶

Gets the is_clone_parent of this FileSystem. Specifies whether the file system has been cloned. See Cloning a File System.

Returns:	The is_clone_parent of this FileSystem.
Return type:	bool

is_hydrated¶

Gets the is_hydrated of this FileSystem. Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.

Returns:	The is_hydrated of this FileSystem.
Return type:	bool

is_targetable¶

Gets the is_targetable of this FileSystem. Specifies whether the file system can be used as a target file system for replication. The system sets this value to true if the file system is unexported, hasn’t yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to false. For more information, see Using Replication.

Returns:	The is_targetable of this FileSystem.
Return type:	bool

kms_key_id¶

Gets the kms_key_id of this FileSystem. The OCID of the KMS key which is the master encryption key for the file system.

Returns:	The kms_key_id of this FileSystem.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this FileSystem. Additional information about the current ‘lifecycleState’.

Returns:	The lifecycle_details of this FileSystem.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this FileSystem. The current state of the file system.

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

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

metered_bytes¶

[Required] Gets the metered_bytes of this FileSystem. The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.

Returns:	The metered_bytes of this FileSystem.
Return type:	int

replication_target_id¶

Gets the replication_target_id of this FileSystem. The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.

Returns:	The replication_target_id of this FileSystem.
Return type:	str

source_details¶

Gets the source_details of this FileSystem.

Returns:	The source_details of this FileSystem.
Return type:	oci.file_storage.models.SourceDetails

time_created¶

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

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

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