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.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

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"

__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", '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.
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
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
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_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", '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.

Returns:The metered_bytes of this FileSystem.
Return type:int
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