MountTarget¶
-
class
oci.file_storage.models.
MountTarget
(**kwargs)¶ Bases:
object
Provides access to a collection of file systems through one or more VNICs on a specified subnet. The set of file systems is controlled through the referenced export set.
Attributes
IDMAP_TYPE_LDAP
A constant which can be used with the idmap_type property of a MountTarget. IDMAP_TYPE_NONE
A constant which can be used with the idmap_type property of a MountTarget. LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a MountTarget. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a MountTarget. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a MountTarget. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a MountTarget. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a MountTarget. availability_domain
Gets the availability_domain of this MountTarget. compartment_id
[Required] Gets the compartment_id of this MountTarget. defined_tags
Gets the defined_tags of this MountTarget. display_name
[Required] Gets the display_name of this MountTarget. export_set_id
Gets the export_set_id of this MountTarget. freeform_tags
Gets the freeform_tags of this MountTarget. id
[Required] Gets the id of this MountTarget. idmap_type
Gets the idmap_type of this MountTarget. kerberos
Gets the kerberos of this MountTarget. ldap_idmap
Gets the ldap_idmap of this MountTarget. lifecycle_details
[Required] Gets the lifecycle_details of this MountTarget. lifecycle_state
[Required] Gets the lifecycle_state of this MountTarget. nsg_ids
Gets the nsg_ids of this MountTarget. private_ip_ids
[Required] Gets the private_ip_ids of this MountTarget. subnet_id
[Required] Gets the subnet_id of this MountTarget. time_created
[Required] Gets the time_created of this MountTarget. Methods
__init__
(**kwargs)Initializes a new MountTarget object with values from keyword arguments. -
IDMAP_TYPE_LDAP
= 'LDAP'¶ A constant which can be used with the idmap_type property of a MountTarget. This constant has a value of “LDAP”
-
IDMAP_TYPE_NONE
= 'NONE'¶ A constant which can be used with the idmap_type property of a MountTarget. This constant has a value of “NONE”
-
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a MountTarget. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a MountTarget. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a MountTarget. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a MountTarget. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a MountTarget. This constant has a value of “FAILED”
-
__init__
(**kwargs)¶ Initializes a new MountTarget 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 MountTarget.
- compartment_id (str) – The value to assign to the compartment_id property of this MountTarget.
- display_name (str) – The value to assign to the display_name property of this MountTarget.
- export_set_id (str) – The value to assign to the export_set_id property of this MountTarget.
- id (str) – The value to assign to the id property of this MountTarget.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this MountTarget.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this MountTarget. 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 MountTarget.
- subnet_id (str) – The value to assign to the subnet_id property of this MountTarget.
- idmap_type (str) – The value to assign to the idmap_type property of this MountTarget. Allowed values for this property are: “LDAP”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- ldap_idmap (oci.file_storage.models.LdapIdmap) – The value to assign to the ldap_idmap property of this MountTarget.
- nsg_ids (list[str]) – The value to assign to the nsg_ids property of this MountTarget.
- kerberos (oci.file_storage.models.Kerberos) – The value to assign to the kerberos property of this MountTarget.
- time_created (datetime) – The value to assign to the time_created property of this MountTarget.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MountTarget.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MountTarget.
-
availability_domain
¶ Gets the availability_domain of this MountTarget. 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 MountTarget. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this MountTarget. The OCID of the compartment that contains the mount target.
Returns: The compartment_id of this MountTarget. Return type: str
Gets the defined_tags of this MountTarget. 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 MountTarget. Return type: dict(str, dict(str, object))
-
display_name
¶ [Required] Gets the display_name of this MountTarget. 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 MountTarget. Return type: str
-
export_set_id
¶ Gets the export_set_id of this MountTarget. The OCID of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target.
Returns: The export_set_id of this MountTarget. Return type: str
Gets the freeform_tags of this MountTarget. 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 MountTarget. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this MountTarget. The OCID of the mount target.
Returns: The id of this MountTarget. Return type: str
-
idmap_type
¶ Gets the idmap_type of this MountTarget. The method used to map a Unix UID to secondary groups. If NONE, the mount target will not use the Unix UID for ID mapping.
Allowed values for this property are: “LDAP”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The idmap_type of this MountTarget. Return type: str
-
kerberos
¶ Gets the kerberos of this MountTarget.
Returns: The kerberos of this MountTarget. Return type: oci.file_storage.models.Kerberos
-
ldap_idmap
¶ Gets the ldap_idmap of this MountTarget.
Returns: The ldap_idmap of this MountTarget. Return type: oci.file_storage.models.LdapIdmap
-
lifecycle_details
¶ [Required] Gets the lifecycle_details of this MountTarget. Additional information about the current ‘lifecycleState’.
Returns: The lifecycle_details of this MountTarget. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this MountTarget. 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 MountTarget. Return type: str
-
nsg_ids
¶ Gets the nsg_ids of this MountTarget. 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 MountTarget. Return type: list[str]
-
private_ip_ids
¶ [Required] Gets the private_ip_ids of this MountTarget. The OCIDs of the private IP addresses associated with this mount target.
Returns: The private_ip_ids of this MountTarget. Return type: list[str]
-