LustreFileSystem¶

class oci.lustre_file_storage.models.LustreFileSystem(**kwargs)¶

Bases: object

A Lustre file system is a parallel file system that is used as a storage solution for HPC/AI/ML workloads. For more information, see File Storage with Lustre.

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 LustreFileSystem.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a LustreFileSystem.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a LustreFileSystem.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a LustreFileSystem.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a LustreFileSystem.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a LustreFileSystem.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a LustreFileSystem.
`PERFORMANCE_TIER_MBPS_PER_TB_1000`	A constant which can be used with the performance_tier property of a LustreFileSystem.
`PERFORMANCE_TIER_MBPS_PER_TB_125`	A constant which can be used with the performance_tier property of a LustreFileSystem.
`PERFORMANCE_TIER_MBPS_PER_TB_250`	A constant which can be used with the performance_tier property of a LustreFileSystem.
`PERFORMANCE_TIER_MBPS_PER_TB_500`	A constant which can be used with the performance_tier property of a LustreFileSystem.
`availability_domain`	[Required] Gets the availability_domain of this LustreFileSystem.
`capacity_in_gbs`	[Required] Gets the capacity_in_gbs of this LustreFileSystem.
`cluster_placement_group_id`	Gets the cluster_placement_group_id of this LustreFileSystem.
`compartment_id`	[Required] Gets the compartment_id of this LustreFileSystem.
`defined_tags`	[Required] Gets the defined_tags of this LustreFileSystem.
`display_name`	[Required] Gets the display_name of this LustreFileSystem.
`file_system_description`	[Required] Gets the file_system_description of this LustreFileSystem.
`file_system_name`	[Required] Gets the file_system_name of this LustreFileSystem.
`freeform_tags`	[Required] Gets the freeform_tags of this LustreFileSystem.
`id`	[Required] Gets the id of this LustreFileSystem.
`kms_key_id`	Gets the kms_key_id of this LustreFileSystem.
`lifecycle_details`	Gets the lifecycle_details of this LustreFileSystem.
`lifecycle_state`	[Required] Gets the lifecycle_state of this LustreFileSystem.
`lnet`	[Required] Gets the lnet of this LustreFileSystem.
`maintenance_window`	[Required] Gets the maintenance_window of this LustreFileSystem.
`major_version`	[Required] Gets the major_version of this LustreFileSystem.
`management_service_address`	[Required] Gets the management_service_address of this LustreFileSystem.
`nsg_ids`	Gets the nsg_ids of this LustreFileSystem.
`performance_tier`	[Required] Gets the performance_tier of this LustreFileSystem.
`root_squash_configuration`	[Required] Gets the root_squash_configuration of this LustreFileSystem.
`subnet_id`	[Required] Gets the subnet_id of this LustreFileSystem.
`system_tags`	[Required] Gets the system_tags of this LustreFileSystem.
`time_billing_cycle_end`	Gets the time_billing_cycle_end of this LustreFileSystem.
`time_created`	[Required] Gets the time_created of this LustreFileSystem.
`time_updated`	[Required] Gets the time_updated of this LustreFileSystem.

Methods

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

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a LustreFileSystem. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a LustreFileSystem. This constant has a value of “UPDATING”

PERFORMANCE_TIER_MBPS_PER_TB_1000 = 'MBPS_PER_TB_1000'¶: A constant which can be used with the performance_tier property of a LustreFileSystem. This constant has a value of “MBPS_PER_TB_1000”

PERFORMANCE_TIER_MBPS_PER_TB_125 = 'MBPS_PER_TB_125'¶: A constant which can be used with the performance_tier property of a LustreFileSystem. This constant has a value of “MBPS_PER_TB_125”

PERFORMANCE_TIER_MBPS_PER_TB_250 = 'MBPS_PER_TB_250'¶: A constant which can be used with the performance_tier property of a LustreFileSystem. This constant has a value of “MBPS_PER_TB_250”

PERFORMANCE_TIER_MBPS_PER_TB_500 = 'MBPS_PER_TB_500'¶: A constant which can be used with the performance_tier property of a LustreFileSystem. This constant has a value of “MBPS_PER_TB_500”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this LustreFileSystem.
compartment_id (str) – The value to assign to the compartment_id property of this LustreFileSystem.
availability_domain (str) – The value to assign to the availability_domain property of this LustreFileSystem.
display_name (str) – The value to assign to the display_name property of this LustreFileSystem.
file_system_description (str) – The value to assign to the file_system_description property of this LustreFileSystem.
time_created (datetime) – The value to assign to the time_created property of this LustreFileSystem.
time_updated (datetime) – The value to assign to the time_updated property of this LustreFileSystem.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LustreFileSystem. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this LustreFileSystem.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LustreFileSystem.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LustreFileSystem.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this LustreFileSystem.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this LustreFileSystem.
kms_key_id (str) – The value to assign to the kms_key_id property of this LustreFileSystem.
capacity_in_gbs (int) – The value to assign to the capacity_in_gbs property of this LustreFileSystem.
subnet_id (str) – The value to assign to the subnet_id property of this LustreFileSystem.
performance_tier (str) – The value to assign to the performance_tier property of this LustreFileSystem. Allowed values for this property are: “MBPS_PER_TB_125”, “MBPS_PER_TB_250”, “MBPS_PER_TB_500”, “MBPS_PER_TB_1000”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
management_service_address (str) – The value to assign to the management_service_address property of this LustreFileSystem.
file_system_name (str) – The value to assign to the file_system_name property of this LustreFileSystem.
lnet (str) – The value to assign to the lnet property of this LustreFileSystem.
major_version (str) – The value to assign to the major_version property of this LustreFileSystem.
cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this LustreFileSystem.
time_billing_cycle_end (datetime) – The value to assign to the time_billing_cycle_end property of this LustreFileSystem.
maintenance_window (oci.lustre_file_storage.models.MaintenanceWindow) – The value to assign to the maintenance_window property of this LustreFileSystem.
root_squash_configuration (oci.lustre_file_storage.models.RootSquashConfiguration) – The value to assign to the root_squash_configuration property of this LustreFileSystem.

availability_domain¶

[Required] Gets the availability_domain of this LustreFileSystem. 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 LustreFileSystem.
Return type:	str

capacity_in_gbs¶

[Required] Gets the capacity_in_gbs of this LustreFileSystem. Capacity of the Lustre file system in GB.

Returns:	The capacity_in_gbs of this LustreFileSystem.
Return type:	int

cluster_placement_group_id¶

Gets the cluster_placement_group_id of this LustreFileSystem. The OCID of the cluster placement group in which the Lustre file system exists.

Returns:	The cluster_placement_group_id of this LustreFileSystem.
Return type:	str

compartment_id¶

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

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

defined_tags¶

[Required] Gets the defined_tags of this LustreFileSystem. 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 LustreFileSystem.
Return type:	dict(str, dict(str, object))

display_name¶

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

Example: My Lustre file system

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

file_system_description¶

[Required] Gets the file_system_description of this LustreFileSystem. Short description of the Lustre file system. Avoid entering confidential information.

Returns:	The file_system_description of this LustreFileSystem.
Return type:	str

file_system_name¶

[Required] Gets the file_system_name of this LustreFileSystem. The Lustre file system name. This is used in mount commands and other aspects of the client command line interface. The default file system name is ‘lustre’. The file system name is limited to 8 characters. Allowed characters are lower and upper case English letters, numbers, and ‘_’.

Returns:	The file_system_name of this LustreFileSystem.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this LustreFileSystem. 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 LustreFileSystem.
Return type:	dict(str, str)

id¶

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

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

kms_key_id¶

Gets the kms_key_id of this LustreFileSystem. The OCID of the KMS key used to encrypt the encryption keys associated with this file system.

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

lifecycle_details¶

Gets the lifecycle_details of this LustreFileSystem. A message that describes the current state of the Lustre file system in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

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

lifecycle_state¶

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

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 LustreFileSystem.
Return type:	str

lnet¶

[Required] Gets the lnet of this LustreFileSystem. Type of network used by clients to mount the file system.

Example: tcp

Returns:	The lnet of this LustreFileSystem.
Return type:	str

maintenance_window¶

[Required] Gets the maintenance_window of this LustreFileSystem.

Returns:	The maintenance_window of this LustreFileSystem.
Return type:	oci.lustre_file_storage.models.MaintenanceWindow

major_version¶

[Required] Gets the major_version of this LustreFileSystem. Major version of Lustre running in the Lustre file system. Example: 2.15

Returns:	The major_version of this LustreFileSystem.
Return type:	str

management_service_address¶

[Required] Gets the management_service_address of this LustreFileSystem. The IPv4 address of MGS (Lustre Management Service) used by clients to mount the file system. For example ‘10.0.0.4’.

Returns:	The management_service_address of this LustreFileSystem.
Return type:	str

nsg_ids¶

Gets the nsg_ids of this LustreFileSystem. A list of Network Security Group OCIDs associated with this lustre file system. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the lustre file system from all NSGs. For more information about NSGs, see Security Rules.

Returns:	The nsg_ids of this LustreFileSystem.
Return type:	list[str]

performance_tier¶

[Required] Gets the performance_tier of this LustreFileSystem. The Lustre file system performance tier. A value of MBPS_PER_TB_125 represents 125 megabytes per second per terabyte.

Allowed values for this property are: “MBPS_PER_TB_125”, “MBPS_PER_TB_250”, “MBPS_PER_TB_500”, “MBPS_PER_TB_1000”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The performance_tier of this LustreFileSystem.
Return type:	str

root_squash_configuration¶

[Required] Gets the root_squash_configuration of this LustreFileSystem.

Returns:	The root_squash_configuration of this LustreFileSystem.
Return type:	oci.lustre_file_storage.models.RootSquashConfiguration

subnet_id¶

[Required] Gets the subnet_id of this LustreFileSystem. The OCID of the subnet the Lustre file system is in.

Returns:	The subnet_id of this LustreFileSystem.
Return type:	str

system_tags¶

[Required] Gets the system_tags of this LustreFileSystem. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this LustreFileSystem.
Return type:	dict(str, dict(str, object))

time_billing_cycle_end¶

Gets the time_billing_cycle_end of this LustreFileSystem. The date and time that the current billing cycle for the file system will end, expressed in RFC 3339 timestamp format. After the current cycle ends, this date is updated automatically to the next timestamp, which is 30 days later. File systems deleted earlier than this time will still incur charges until the billing cycle ends.

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

Returns:	The time_billing_cycle_end of this LustreFileSystem.
Return type:	datetime

time_created¶

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

Example: 2024-04-25T21:10:29.600Z

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

time_updated¶

[Required] Gets the time_updated of this LustreFileSystem. The date and time the Lustre file system was updated, in the format defined by RFC 3339.

Example: 2024-04-25T21:10:29.600Z

Returns:	The time_updated of this LustreFileSystem.
Return type:	datetime