Jump to

• Request
• Response

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).

Body ()

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: additionalProperties

  Defined 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: additionalProperties

  Free-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: additionalProperties

  Not used by File Systems but required for SPLAT tag integration.

{
    "description":"Details for creating the mount target.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain in which to create the mount target. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment in which to create the mount target.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "hostnameLabel":{
            "description":"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 ",
            "type":"string",
            "minLength":"1",
            "maxLength":"63"
        },
        "ipAddress":{
            "type":"string",
            "description":"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 ",
            "minLength":"1",
            "maxLength":"32"
        },
        "subnetId":{
            "description":"The OCID of the subnet in which to create the mount target.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "idmapType":{
            "description":"Describes whether Idmapping is turned on or off. If on, describes method used to perform ID Mapping",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/MountTarget/idmapType"
        },
        "ldapIdmap":{
            "$ref":"#/definitions/CreateLdapIdmapDetails"
        },
        "nsgIds":{
            "type":"array",
            "description":"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.",
            "items":{
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "maxItems":"5",
            "uniqueItems":true
        },
        "kerberos":{
            "$ref":"#/definitions/CreateKerberosDetails"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair  with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            }
        },
        "systemTags":{
            "description":"Not used by File Systems but required for SPLAT tag integration.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string type is supported."
                }
            }
        }
    },
    "required":[
        "availabilityDomain",
        "compartmentId",
        "subnetId"
    ],
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    }
}

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

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair  with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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.

{
    "description":"Kerberos details needed to create configuration.",
    "properties":{
        "kerberosRealm":{
            "description":"The realm of the kerberos server Mount Target interacts with.",
            "type":"string",
            "maxLength":"255",
            "minLength":"1"
        },
        "kerberosKeyLifeSeconds":{
            "description":"Describes how long to keep keytab entries(in seconds) after they have been rotated.",
            "minimum":"300",
            "default":"86400",
            "type":"integer"
        },
        "keyTabSecretId":{
            "description":"The OCID of the KeyTab Secret in the Vault.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "currentKeyTabSecretVersion":{
            "description":"Version of the KeyTab Secret in the Vault to use.",
            "type":"integer"
        },
        "backupKeyTabSecretVersion":{
            "description":"Version of the KeyTab Secret in the Vault to use as a backup.",
            "type":"integer"
        },
        "isKerberosEnabled":{
            "description":"Specifies whether to Enable or Disbale Kerberos.",
            "type":"boolean"
        },
        "isWeakCiphersAllowed":{
            "description":"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.",
            "type":"boolean"
        }
    },
    "required":[
        "kerberosRealm"
    ],
    "type":"object"
}

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.

{
    "description":"Mount Target details about the LDAP ID Map configuration.",
    "properties":{
        "schemaType":{
            "description":"Schema type of LDAP account.",
            "enum":[
                "RFC2307"
            ],
            "type":"string",
            "default":"RFC2307"
        },
        "cacheRefreshIntervalSeconds":{
            "description":"Integer for how often the mount target should recheck LDAP for updates.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "cacheLifetimeSeconds":{
            "description":"Integer for how long cached entries may be used.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "negativeCacheLifetimeSeconds":{
            "description":"Integer for how long to cache if idmap information is missing.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "baseDistinguishedUserName":{
            "description":"All LDAP searches are recursive starting at this Base Distinguished user name.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "baseDistinguishedGroupName":{
            "description":"All LDAP searches are recursive starting at this Base Distinguished group name.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "outboundConnector1Id":{
            "description":"OCID of the first LDAP Account",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "outboundConnector2Id":{
            "description":"OCID of the second LDAP Account",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "baseDistinguishedUserName",
        "baseDistinguishedGroupName"
    ],
    "type":"object"
}

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

{
    "type":"array",
    "description":"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.",
    "items":{
        "type":"string",
        "minLength":"1",
        "maxLength":"255"
    },
    "maxItems":"5",
    "uniqueItems":true
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}

{
    "description":"Not used by File Systems but required for SPLAT tag integration.",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string type is supported."
        }
    }
}

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.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"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.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"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.

Back to Top

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.

Body ()

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: additionalProperties

  Defined 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: additionalProperties

  Free-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
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the associated share set. Controls what file systems will be shared through SMB protocol on this mount target.
• 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: additionalProperties

  Not 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

{
    "x-obmcs-splat":{
        "resourceKind":"mount-targets",
        "adLocality":"ad-local",
        "taggable":true,
        "activeLifecycleStates":[
            "ACTIVE"
        ],
        "deletedLifecycleStates":[
            "DELETED",
            "FAILED"
        ],
        "getOperationId":"GetMountTarget",
        "listResourcesOperationId":"ListMountTargets",
        "ocidEntityType":"mounttarget",
        "useSurrogateKeyForCreation":true,
        "getBySurrogateKeyUri":"/20171215/mountTargets/splat-request",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"MountTarget",
            "scope":"customer",
            "rvnFromHeader":true
        }
    },
    "description":"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.",
    "x-example":"{   \"availabilityDomain\": \"AD-1\",   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"mount-target-5\",   \"exportSetId\": \"ocid1.exportset.<var>unique_ID</var>\",   \"id\": \"ocid1.mounttarget.<var>unique_ID</var>\",   \"lifecycleDetails\": \"\",   \"lifecycleState\": \"ACTIVE\",   \"privateIpIds\": [   \"ocid1.privateip.<var>unique_ID</var>\"       ],   \"subnetId\": \"ocid1.subnet.<var>unique_ID</var>\",   \"nsgIds\": [   \"ocid1.networksecuritygroup.<var>unique_ID</var>\"       ],   \"timeCreated\": \"2017-12-01T22:13:22.534Z\"  } ",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain the mount target is in. May be unset as a blank or NULL value. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the mount target.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "exportSetId":{
            "description":"The OCID of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "id":{
            "description":"The OCID of the mount target.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleDetails":{
            "description":"Additional information about the current 'lifecycleState'.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the mount target.",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ],
            "type":"string"
        },
        "privateIpIds":{
            "description":"The OCIDs of the private IP addresses associated with this mount target.",
            "type":"array",
            "items":{
                "maxLength":"255",
                "minLength":"1",
                "type":"string"
            }
        },
        "subnetId":{
            "description":"The OCID of the subnet the mount target is in.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "idmapType":{
            "description":"Describes whether Idmapping is turned on or off. If on, describes method used to perform ID Mapping",
            "enum":[
                "LDAP",
                "NONE"
            ],
            "type":"string"
        },
        "ldapIdmap":{
            "$ref":"#/definitions/LdapIdmap"
        },
        "nsgIds":{
            "type":"array",
            "description":"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.",
            "items":{
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "maxItems":"5",
            "uniqueItems":true
        },
        "kerberos":{
            "$ref":"#/definitions/Kerberos"
        },
        "shareSetId":{
            "description":"The OCID of the associated share set. Controls what file systems will be shared through SMB protocol on this mount target.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair  with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            }
        },
        "systemTags":{
            "description":"Not used by File Systems but required for SPLAT tag integration.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string type is supported."
                }
            }
        }
    },
    "required":[
        "compartmentId",
        "displayName",
        "id",
        "lifecycleState",
        "lifecycleDetails",
        "subnetId",
        "timeCreated",
        "privateIpIds"
    ],
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    }
}

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

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair  with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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.

{
    "description":"Allows administrator to configure a mount target to interact with the administrator's Kerberos Infrastructure.",
    "properties":{
        "kerberosRealm":{
            "description":"The realm of the kerberos server a mount target interacts with.",
            "type":"string",
            "maxLength":"255",
            "minLength":"1"
        },
        "kerberosKeyLifeSeconds":{
            "description":"Describes how long to keep keytab entries(in seconds) after they have been rotated.",
            "minimum":"300",
            "default":"86400",
            "type":"integer"
        },
        "keyTabSecretId":{
            "description":"The OCID of the KeyTab secret in the Vault.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "currentKeyTabSecretVersion":{
            "description":"Version of the KeyTab secret in the Vault to use.",
            "type":"integer"
        },
        "backupKeyTabSecretVersion":{
            "description":"Version of the KeyTab secert in the Vault to use as a backup.",
            "type":"integer"
        },
        "isKerberosEnabled":{
            "description":"Specifies whether to Enable or Disbale Kerberos.",
            "type":"boolean"
        },
        "isWeakCiphersAllowed":{
            "description":"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.",
            "type":"boolean"
        }
    },
    "required":[
        "kerberosRealm"
    ],
    "type":"object"
}

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.

{
    "description":"Mount Target details about the LDAP ID Map configuration.",
    "properties":{
        "schemaType":{
            "description":"Schema type of LDAP account.",
            "enum":[
                "RFC2307"
            ],
            "type":"string",
            "default":"RFC2307"
        },
        "cacheRefreshIntervalSeconds":{
            "description":"Integer for how often the mount target should recheck LDAP for updates.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "cacheLifetimeSeconds":{
            "description":"Integer for how long cached entries may be used.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "negativeCacheLifetimeSeconds":{
            "description":"Integer for how long to cache if idmap information is missing.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "baseDistinguishedUserName":{
            "description":"All LDAP searches are recursive starting at this Base Distinguished user name.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "baseDistinguishedGroupName":{
            "description":"All LDAP searches are recursive starting at this Base Distinguished group name.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "outboundConnector1Id":{
            "description":"OCID of the first LDAP Account",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "outboundConnector2Id":{
            "description":"OCID of the second LDAP Account",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "baseDistinguishedUserName",
        "baseDistinguishedGroupName"
    ],
    "type":"object"
}

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

{
    "type":"array",
    "description":"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.",
    "items":{
        "type":"string",
        "minLength":"1",
        "maxLength":"255"
    },
    "maxItems":"5",
    "uniqueItems":true
}

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

{
    "description":"The OCIDs of the private IP addresses associated with this mount target.",
    "type":"array",
    "items":{
        "maxLength":"255",
        "minLength":"1",
        "type":"string"
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}

{
    "description":"Not used by File Systems but required for SPLAT tag integration.",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string type is supported."
        }
    }
}

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.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"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.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top