LustreFileSystemSummary¶

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

Bases: object

Summary information about a Lustre file system.

Attributes

`PERFORMANCE_TIER_MBPS_PER_TB_1000`	A constant which can be used with the performance_tier property of a LustreFileSystemSummary.
`PERFORMANCE_TIER_MBPS_PER_TB_125`	A constant which can be used with the performance_tier property of a LustreFileSystemSummary.
`PERFORMANCE_TIER_MBPS_PER_TB_250`	A constant which can be used with the performance_tier property of a LustreFileSystemSummary.
`PERFORMANCE_TIER_MBPS_PER_TB_500`	A constant which can be used with the performance_tier property of a LustreFileSystemSummary.
`availability_domain`	[Required] Gets the availability_domain of this LustreFileSystemSummary.
`capacity_in_gbs`	[Required] Gets the capacity_in_gbs of this LustreFileSystemSummary.
`cluster_placement_group_id`	Gets the cluster_placement_group_id of this LustreFileSystemSummary.
`compartment_id`	[Required] Gets the compartment_id of this LustreFileSystemSummary.
`defined_tags`	[Required] Gets the defined_tags of this LustreFileSystemSummary.
`display_name`	[Required] Gets the display_name of this LustreFileSystemSummary.
`file_system_description`	[Required] Gets the file_system_description of this LustreFileSystemSummary.
`file_system_name`	[Required] Gets the file_system_name of this LustreFileSystemSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this LustreFileSystemSummary.
`id`	[Required] Gets the id of this LustreFileSystemSummary.
`kms_key_id`	Gets the kms_key_id of this LustreFileSystemSummary.
`lifecycle_details`	Gets the lifecycle_details of this LustreFileSystemSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this LustreFileSystemSummary.
`lnet`	[Required] Gets the lnet of this LustreFileSystemSummary.
`major_version`	[Required] Gets the major_version of this LustreFileSystemSummary.
`management_service_address`	[Required] Gets the management_service_address of this LustreFileSystemSummary.
`nsg_ids`	Gets the nsg_ids of this LustreFileSystemSummary.
`performance_tier`	[Required] Gets the performance_tier of this LustreFileSystemSummary.
`root_squash_configuration`	[Required] Gets the root_squash_configuration of this LustreFileSystemSummary.
`subnet_id`	[Required] Gets the subnet_id of this LustreFileSystemSummary.
`system_tags`	[Required] Gets the system_tags of this LustreFileSystemSummary.
`time_billing_cycle_end`	[Required] Gets the time_billing_cycle_end of this LustreFileSystemSummary.
`time_created`	[Required] Gets the time_created of this LustreFileSystemSummary.
`time_updated`	[Required] Gets the time_updated of this LustreFileSystemSummary.

Methods

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

PERFORMANCE_TIER_MBPS_PER_TB_1000 = 'MBPS_PER_TB_1000'¶: A constant which can be used with the performance_tier property of a LustreFileSystemSummary. 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 LustreFileSystemSummary. 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 LustreFileSystemSummary. 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 LustreFileSystemSummary. This constant has a value of “MBPS_PER_TB_500”

__init__(**kwargs)¶

Initializes a new LustreFileSystemSummary 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 LustreFileSystemSummary.
compartment_id (str) – The value to assign to the compartment_id property of this LustreFileSystemSummary.
availability_domain (str) – The value to assign to the availability_domain property of this LustreFileSystemSummary.
display_name (str) – The value to assign to the display_name property of this LustreFileSystemSummary.
file_system_description (str) – The value to assign to the file_system_description property of this LustreFileSystemSummary.
time_created (datetime) – The value to assign to the time_created property of this LustreFileSystemSummary.
time_updated (datetime) – The value to assign to the time_updated property of this LustreFileSystemSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LustreFileSystemSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this LustreFileSystemSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LustreFileSystemSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LustreFileSystemSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this LustreFileSystemSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this LustreFileSystemSummary.
file_system_name (str) – The value to assign to the file_system_name property of this LustreFileSystemSummary.
kms_key_id (str) – The value to assign to the kms_key_id property of this LustreFileSystemSummary.
capacity_in_gbs (int) – The value to assign to the capacity_in_gbs property of this LustreFileSystemSummary.
subnet_id (str) – The value to assign to the subnet_id property of this LustreFileSystemSummary.
performance_tier (str) – The value to assign to the performance_tier property of this LustreFileSystemSummary. 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’.
time_billing_cycle_end (datetime) – The value to assign to the time_billing_cycle_end property of this LustreFileSystemSummary.
management_service_address (str) – The value to assign to the management_service_address property of this LustreFileSystemSummary.
lnet (str) – The value to assign to the lnet property of this LustreFileSystemSummary.
cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this LustreFileSystemSummary.
major_version (str) – The value to assign to the major_version property of this LustreFileSystemSummary.
root_squash_configuration (oci.lustre_file_storage.models.RootSquashConfiguration) – The value to assign to the root_squash_configuration property of this LustreFileSystemSummary.

availability_domain¶

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

capacity_in_gbs¶

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

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

cluster_placement_group_id¶

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

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

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

file_system_description¶

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

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

file_system_name¶

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

freeform_tags¶

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

id¶

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

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

kms_key_id¶

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

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

lifecycle_details¶

Gets the lifecycle_details of this LustreFileSystemSummary. 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 LustreFileSystemSummary.
Return type:	str

lifecycle_state¶

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

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

lnet¶

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

Example: tcp

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

major_version¶

[Required] Gets the major_version of this LustreFileSystemSummary. Major version of Lustre running in the Lustre file system.

Example: 2.15

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

management_service_address¶

[Required] Gets the management_service_address of this LustreFileSystemSummary. The IPv4 address of MGS (Lustre Management Service) used by clients to mount the file system.

Example: 10.0.0.4

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

nsg_ids¶

Gets the nsg_ids of this LustreFileSystemSummary. 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 LustreFileSystemSummary.
Return type:	list[str]

performance_tier¶

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

root_squash_configuration¶

[Required] Gets the root_squash_configuration of this LustreFileSystemSummary.

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

subnet_id¶

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

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

system_tags¶

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

time_billing_cycle_end¶

[Required] Gets the time_billing_cycle_end of this LustreFileSystemSummary. The date and time the LustreFileSystem current billing cycle will end, expressed in RFC 3339 timestamp format. Once a cycle ends, it is updated automatically to next timestamp which is after 30 days. File systems deleted earlier will still incur charges till this date.

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

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

time_created¶

[Required] Gets the time_created of this LustreFileSystemSummary. 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 LustreFileSystemSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this LustreFileSystemSummary. 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 LustreFileSystemSummary.
Return type:	datetime