CreateMountTarget
post
/20171215/mountTargets
Creates a new mount target in the specified compartment and subnet. Mount targets have one or more private IP addresses that you can provide as the host portion of remote target parameters in client mount commands. These private IP addresses are listed in the privateIpIds property of the mount target and are highly available. Mount targets also consume additional IP addresses in their subnet. Do not use /30 or smaller subnets for mount target creation because they do not have sufficient available IP addresses. Allow at least three IP addresses for each mount target. When you create a resource, the OCID of the resource is in the response. You can also retrieve the OCID of the resource by using a List API operation on that resource type, or by viewing the resource in the Compute Web UI.
Request
Supported Media Types
- application/json
Header Parameters
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
-
opc-retry-token: string
Minimum Length:
1
Maximum Length:64
A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
Details for creating a new mount target.
Root Schema : CreateMountTargetDetails
Type:
object
Details for creating the mount target.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain in which to create the mount target. Example: AD-1 -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment in which to create the mount target. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
displayName:
string
Minimum Length:
1
Maximum Length:255
A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
hostnameLabel:
string
Minimum Length:
1
Maximum Length:63
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](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). Note: 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. Example: files-1 -
idmapType:
string
Describes whether Idmapping is turned on or off. If on, describes method used to perform ID Mapping
-
ipAddress:
string
Minimum Length:
1
Maximum Length:32
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. Note: This attribute value is stored in the PrivateIp resource, not in the mountTarget resource. To update the ipAddress, use GetMountTarget to obtain the OCIDs of the mount target's private IPs (privateIpIds). Then, you can use UpdatePrivateIp to update the ipAddress value. Example: 10.0.3.3 -
kerberos:
object CreateKerberosDetails
Kerberos details needed to create configuration.
-
ldapIdmap:
object CreateLdapIdmapDetails
Mount Target details about the LDAP ID Map configuration.
-
nsgIds:
array nsgIds
Maximum Number of Items:
5
Unique Items Required:true
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. -
subnetId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the subnet in which to create the mount target. -
systemTags:
object systemTags
Additional Properties Allowed: additionalPropertiesNot used by File Systems but required for SPLAT tag integration.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : CreateKerberosDetails
Type:
object
Kerberos details needed to create configuration.
Show Source
-
backupKeyTabSecretVersion:
integer
Version of the KeyTab Secret in the Vault to use as a backup.
-
currentKeyTabSecretVersion:
integer
Version of the KeyTab Secret in the Vault to use.
-
isKerberosEnabled:
boolean
Specifies whether to Enable or Disbale Kerberos.
-
isWeakCiphersAllowed:
boolean
Specifies to allow the use of weaker ciphers if true. If false only aes256-cts-hmac-sha384-192, aes128-cts-hmac-sha256-128 are allowed.
-
kerberosKeyLifeSeconds:
integer
Minimum Value:
300
Default Value:86400
Describes how long to keep keytab entries(in seconds) after they have been rotated. -
kerberosRealm(required):
string
Minimum Length:
1
Maximum Length:255
The realm of the kerberos server Mount Target interacts with. -
keyTabSecretId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the KeyTab Secret in the Vault.
Nested Schema : CreateLdapIdmapDetails
Type:
object
Mount Target details about the LDAP ID Map configuration.
Show Source
-
baseDistinguishedGroupName(required):
string
Minimum Length:
1
Maximum Length:255
All LDAP searches are recursive starting at this Base Distinguished group name. -
baseDistinguishedUserName(required):
string
Minimum Length:
1
Maximum Length:255
All LDAP searches are recursive starting at this Base Distinguished user name. -
cacheLifetimeSeconds:
integer
Minimum Value:
300
Maximum Value:1000
Default Value:300
Integer for how long cached entries may be used. -
cacheRefreshIntervalSeconds:
integer
Minimum Value:
300
Maximum Value:1000
Default Value:300
Integer for how often the mount target should recheck LDAP for updates. -
negativeCacheLifetimeSeconds:
integer
Minimum Value:
300
Maximum Value:1000
Default Value:300
Integer for how long to cache if idmap information is missing. -
outboundConnector1Id:
string
Minimum Length:
1
Maximum Length:255
OCID of the first LDAP Account -
outboundConnector2Id:
string
Minimum Length:
1
Maximum Length:255
OCID of the second LDAP Account -
schemaType:
string
Default Value:
RFC2307
Allowed Values:[ "RFC2307" ]
Schema type of LDAP account.
Nested Schema : nsgIds
Type:
array
Maximum Number of Items:
5
Unique Items Required:
true
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.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:255
Nested Schema : systemTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
Not used by File Systems but required for SPLAT tag integration.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only the String type is supported.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only string type is supported.
Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only string type is supported.
Response
Supported Media Types
- application/json
200 Response
The mount target was created.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : MountTarget
Type:
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.
Show Source
-
availabilityDomain:
string
Minimum Length:
1
Maximum Length:255
The availability domain the mount target is in. May be unset as a blank or NULL value. Example: AD-1 -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment that contains the mount target. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
displayName(required):
string
Minimum Length:
1
Maximum Length:255
A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information. -
exportSetId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the mount target. -
idmapType:
string
Allowed Values:
[ "LDAP", "NONE" ]
Describes whether Idmapping is turned on or off. If on, describes method used to perform ID Mapping -
kerberos:
object Kerberos
Allows administrator to configure a mount target to interact with the administrator's Kerberos Infrastructure.
-
ldapIdmap:
object LdapIdmap
Mount Target details about the LDAP ID Map configuration.
-
lifecycleDetails(required):
string
Additional information about the current 'lifecycleState'.
-
lifecycleState(required):
string
Allowed Values:
[ "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]
The current state of the mount target. -
nsgIds:
array nsgIds
Maximum Number of Items:
5
Unique Items Required:true
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. -
privateIpIds(required):
array privateIpIds
The OCIDs of the private IP addresses associated with this mount target.
- shareSetId: string
-
subnetId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the subnet the mount target is in. -
systemTags:
object systemTags
Additional Properties Allowed: additionalPropertiesNot used by File Systems but required for SPLAT tag integration.
-
timeCreated(required):
string(date-time)
The date and time the mount target was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : Kerberos
Type:
object
Allows administrator to configure a mount target to interact with the administrator's Kerberos Infrastructure.
Show Source
-
backupKeyTabSecretVersion:
integer
Version of the KeyTab secert in the Vault to use as a backup.
-
currentKeyTabSecretVersion:
integer
Version of the KeyTab secret in the Vault to use.
-
isKerberosEnabled:
boolean
Specifies whether to Enable or Disbale Kerberos.
-
isWeakCiphersAllowed:
boolean
Specifies to allow the use of weaker ciphers if true. If false only aes256-cts-hmac-sha384-192, aes128-cts-hmac-sha256-128 are allowed.
-
kerberosKeyLifeSeconds:
integer
Minimum Value:
300
Default Value:86400
Describes how long to keep keytab entries(in seconds) after they have been rotated. -
kerberosRealm(required):
string
Minimum Length:
1
Maximum Length:255
The realm of the kerberos server a mount target interacts with. -
keyTabSecretId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the KeyTab secret in the Vault.
Nested Schema : LdapIdmap
Type:
object
Mount Target details about the LDAP ID Map configuration.
Show Source
-
baseDistinguishedGroupName(required):
string
Minimum Length:
1
Maximum Length:255
All LDAP searches are recursive starting at this Base Distinguished group name. -
baseDistinguishedUserName(required):
string
Minimum Length:
1
Maximum Length:255
All LDAP searches are recursive starting at this Base Distinguished user name. -
cacheLifetimeSeconds:
integer
Minimum Value:
300
Maximum Value:1000
Default Value:300
Integer for how long cached entries may be used. -
cacheRefreshIntervalSeconds:
integer
Minimum Value:
300
Maximum Value:1000
Default Value:300
Integer for how often the mount target should recheck LDAP for updates. -
negativeCacheLifetimeSeconds:
integer
Minimum Value:
300
Maximum Value:1000
Default Value:300
Integer for how long to cache if idmap information is missing. -
outboundConnector1Id:
string
Minimum Length:
1
Maximum Length:255
OCID of the first LDAP Account -
outboundConnector2Id:
string
Minimum Length:
1
Maximum Length:255
OCID of the second LDAP Account -
schemaType:
string
Default Value:
RFC2307
Allowed Values:[ "RFC2307" ]
Schema type of LDAP account.
Nested Schema : nsgIds
Type:
array
Maximum Number of Items:
5
Unique Items Required:
true
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.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:255
Nested Schema : privateIpIds
Type:
array
The OCIDs of the private IP addresses associated with this mount target.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:255
Nested Schema : systemTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
Not used by File Systems but required for SPLAT tag integration.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only the String type is supported.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only string type is supported.
Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only string type is supported.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
409 Response
Conflict
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload