CreateMountTargetDetails¶
- class oci.file_storage.models.CreateMountTargetDetails(**kwargs)¶
Bases:
objectDetails for creating the mount target.
Methods:
__init__(**kwargs)Initializes a new CreateMountTargetDetails object with values from keyword arguments.
Attributes:
[Required] Gets the availability_domain of this CreateMountTargetDetails.
[Required] Gets the compartment_id of this CreateMountTargetDetails.
Gets the defined_tags of this CreateMountTargetDetails.
Gets the display_name of this CreateMountTargetDetails.
Gets the freeform_tags of this CreateMountTargetDetails. 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"}.
Gets the hostname_label of this CreateMountTargetDetails.
Gets the idmap_type of this CreateMountTargetDetails.
Gets the ip_address of this CreateMountTargetDetails.
Gets the kerberos of this CreateMountTargetDetails.
Gets the ldap_idmap of this CreateMountTargetDetails.
Gets the locks of this CreateMountTargetDetails.
Gets the nsg_ids of this CreateMountTargetDetails.
Gets the requested_throughput of this CreateMountTargetDetails.
Gets the security_attributes of this CreateMountTargetDetails.
[Required] Gets the subnet_id of this CreateMountTargetDetails.
- __init__(**kwargs)¶
Initializes a new CreateMountTargetDetails 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 CreateMountTargetDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateMountTargetDetails.
display_name (str) – The value to assign to the display_name property of this CreateMountTargetDetails.
hostname_label (str) – The value to assign to the hostname_label property of this CreateMountTargetDetails.
ip_address (str) – The value to assign to the ip_address property of this CreateMountTargetDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateMountTargetDetails.
idmap_type (str) – The value to assign to the idmap_type property of this CreateMountTargetDetails.
ldap_idmap (oci.file_storage.models.CreateLdapIdmapDetails) – The value to assign to the ldap_idmap property of this CreateMountTargetDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateMountTargetDetails.
kerberos (oci.file_storage.models.CreateKerberosDetails) – The value to assign to the kerberos property of this CreateMountTargetDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMountTargetDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMountTargetDetails.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateMountTargetDetails.
locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this CreateMountTargetDetails.
requested_throughput (int) – The value to assign to the requested_throughput property of this CreateMountTargetDetails.
- property availability_domain¶
[Required] Gets the availability_domain of this CreateMountTargetDetails. The availability domain in which to create the mount target.
Example: Uocm:PHX-AD-1
- Returns
The availability_domain of this CreateMountTargetDetails.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this CreateMountTargetDetails. The `OCID`__ of the compartment in which to create the mount target.
- Returns
The compartment_id of this CreateMountTargetDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateMountTargetDetails. 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 CreateMountTargetDetails.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this CreateMountTargetDetails. 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 CreateMountTargetDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateMountTargetDetails. 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 CreateMountTargetDetails.
- Return type
dict(str, str)
- property hostname_label¶
Gets the hostname_label of this CreateMountTargetDetails. The hostname for the mount target’s IP address, used for DNS resolution. The value is the hostname portion of the private IP address’s fully qualified domain name (FQDN). For example, files-1 in the FQDN files-1.subnet123.vcn1.oraclevcn.com. Must be unique across all VNICs in the subnet and comply with `RFC 952`__ and `RFC 1123`__.
Note:
If the IP address is IPv4, this attribute value is stored in the `PrivateIp`__ resource, not in the mountTarget resource. To update the hostnameLabel, use GetMountTarget to obtain the `OCIDs`__ of the mount target’s private IPs (privateIpIds). Then, you can use `UpdatePrivateIp`__ to update the hostnameLabel value.
If the IP address is IPv6, it is stored in the `Ipv6]`__ resource To update the hostnameLabel, use GetMountTarget to obtain the `OCIDs`__ of the mount target’s IPv6 address (mountTargetIpv6Ids). Then, you can use `UpdateIpv6`__ to update the hostnameLabel value.
For more information, see `DNS in Your Virtual Cloud Network`__.
Example: files-1
- Returns
The hostname_label of this CreateMountTargetDetails.
- Return type
str
- property idmap_type¶
Gets the idmap_type of this CreateMountTargetDetails. The method used to map a Unix UID to secondary groups, if any.
- Returns
The idmap_type of this CreateMountTargetDetails.
- Return type
str
- property ip_address¶
Gets the ip_address of this CreateMountTargetDetails. A private IP address of your choice. Must be an available IP address within the subnet’s CIDR. If you don’t specify a value, Oracle automatically assigns a private IP address from the subnet.
Example: 10.0.3.3
- Returns
The ip_address of this CreateMountTargetDetails.
- Return type
str
- property kerberos¶
Gets the kerberos of this CreateMountTargetDetails.
- Returns
The kerberos of this CreateMountTargetDetails.
- Return type
- property ldap_idmap¶
Gets the ldap_idmap of this CreateMountTargetDetails.
- Returns
The ldap_idmap of this CreateMountTargetDetails.
- Return type
- property locks¶
Gets the locks of this CreateMountTargetDetails. Locks associated with this resource.
- Returns
The locks of this CreateMountTargetDetails.
- Return type
- property nsg_ids¶
Gets the nsg_ids of this CreateMountTargetDetails. 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 CreateMountTargetDetails.
- Return type
list[str]
- property requested_throughput¶
Gets the requested_throughput of this CreateMountTargetDetails. Throughput for mount target in Gbps. Currently only 1 Gbps of requestedThroughput is supported during create MountTarget. Available shapes and corresponding throughput are listed at `Mount Target Performance`__.
- Returns
The requested_throughput of this CreateMountTargetDetails.
- Return type
int
- property security_attributes¶
Gets the security_attributes of this CreateMountTargetDetails. `Security attributes`__ are labels for a resource that can be referenced in a `Zero Trust Packet Routing`__ (ZPR) policy to control access to ZPR-supported resources.
Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}
- Returns
The security_attributes of this CreateMountTargetDetails.
- Return type
dict(str, dict(str, object))