UpdateMountTarget
put
/20171215/mountTargets/{mount_target_id}
Updates the specified mount target's information.
Request
Supported Media Types
- application/json
Path Parameters
-
mountTargetId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the mount target.
Header Parameters
-
if-match: string
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Details object for updating a mount target.
Root Schema : UpdateMountTargetDetails
Type:
object
Details for updating the mount target.
Show Source
-
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. 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"}
-
idmapType:
string
Describes whether Idmapping is turned on or off. If on, describes method used to perform ID Mapping
-
kerberos:
object UpdateKerberosDetails
Kerberos details needed to update configuration.
-
ldapIdmap:
object UpdateLdapIdmapDetails
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. -
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 : UpdateKerberosDetails
Type:
object
Kerberos details needed to update configuration.
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:
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 : UpdateLdapIdmapDetails
Type:
object
Mount Target details about the LDAP ID Map configuration.
Show Source
-
baseDistinguishedGroupName:
string
Minimum Length:
1
Maximum Length:255
All LDAP searches are recursive starting at this Base Distinguished group name. -
baseDistinguishedUserName:
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 updated.
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.
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
412 Response
Precondition Failed
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