MountTargetSummary¶
-
class
oci.file_storage.models.
MountTargetSummary
(**kwargs)¶ Bases:
object
Summary information for the specified mount target.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a MountTargetSummary. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a MountTargetSummary. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a MountTargetSummary. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a MountTargetSummary. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a MountTargetSummary. availability_domain
Gets the availability_domain of this MountTargetSummary. compartment_id
[Required] Gets the compartment_id of this MountTargetSummary. defined_tags
Gets the defined_tags of this MountTargetSummary. display_name
[Required] Gets the display_name of this MountTargetSummary. export_set_id
Gets the export_set_id of this MountTargetSummary. freeform_tags
Gets the freeform_tags of this MountTargetSummary. id
[Required] Gets the id of this MountTargetSummary. lifecycle_state
[Required] Gets the lifecycle_state of this MountTargetSummary. nsg_ids
Gets the nsg_ids of this MountTargetSummary. private_ip_ids
[Required] Gets the private_ip_ids of this MountTargetSummary. subnet_id
[Required] Gets the subnet_id of this MountTargetSummary. time_created
[Required] Gets the time_created of this MountTargetSummary. Methods
__init__
(**kwargs)Initializes a new MountTargetSummary object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a MountTargetSummary. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a MountTargetSummary. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a MountTargetSummary. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a MountTargetSummary. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a MountTargetSummary. This constant has a value of “FAILED”
-
__init__
(**kwargs)¶ Initializes a new MountTargetSummary 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 MountTargetSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this MountTargetSummary.
- display_name (str) – The value to assign to the display_name property of this MountTargetSummary.
- export_set_id (str) – The value to assign to the export_set_id property of this MountTargetSummary.
- id (str) – The value to assign to the id property of this MountTargetSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this MountTargetSummary. 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’.
- private_ip_ids (list[str]) – The value to assign to the private_ip_ids property of this MountTargetSummary.
- subnet_id (str) – The value to assign to the subnet_id property of this MountTargetSummary.
- nsg_ids (list[str]) – The value to assign to the nsg_ids property of this MountTargetSummary.
- time_created (datetime) – The value to assign to the time_created property of this MountTargetSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MountTargetSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MountTargetSummary.
-
availability_domain
¶ Gets the availability_domain of this MountTargetSummary. The availability domain the mount target is in. May be unset as a blank or NULL value.
Example: Uocm:PHX-AD-1
Returns: The availability_domain of this MountTargetSummary. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this MountTargetSummary. The OCID of the compartment that contains the mount target.
Returns: The compartment_id of this MountTargetSummary. Return type: str
Gets the defined_tags of this MountTargetSummary. 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 MountTargetSummary. Return type: dict(str, dict(str, object))
-
display_name
¶ [Required] Gets the display_name of this MountTargetSummary. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: My mount target
Returns: The display_name of this MountTargetSummary. Return type: str
-
export_set_id
¶ Gets the export_set_id of this MountTargetSummary. The OCID of the associated export set. Controls what file systems will be exported using Network File System (NFS) protocol on this mount target.
Returns: The export_set_id of this MountTargetSummary. Return type: str
Gets the freeform_tags of this MountTargetSummary. 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 MountTargetSummary. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this MountTargetSummary. The OCID of the mount target.
Returns: The id of this MountTargetSummary. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this MountTargetSummary. The current state of the mount target.
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 MountTargetSummary. Return type: str
-
nsg_ids
¶ Gets the nsg_ids of this MountTargetSummary. A list of Network Security Group OCIDs associated with this mount target. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the mount target from all NSGs. For more information about NSGs, see Security Rules.
Returns: The nsg_ids of this MountTargetSummary. Return type: list[str]
-
private_ip_ids
¶ [Required] Gets the private_ip_ids of this MountTargetSummary. The OCIDs of the private IP addresses associated with this mount target.
Returns: The private_ip_ids of this MountTargetSummary. Return type: list[str]
-