Show / Hide Table of Contents

Namespace Oci.FilestorageService.Models

Classes

ChangeFileSystemCompartmentDetails

Details for changing the compartment.

ChangeFilesystemSnapshotPolicyCompartmentDetails

Details for changing the compartment of a file system snapshot policy.

ChangeMountTargetCompartmentDetails

Details for changing the compartment.

ChangeOutboundConnectorCompartmentDetails

Details for changing the compartment of the outbound connector.

ChangeReplicationCompartmentDetails

Details for changing the compartment of both replication and replication target.

ClientOptions

NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export's export options.

CreateExportDetails

Details for creating the export.

CreateFileSystemDetails

Details for creating the file system.

CreateFilesystemSnapshotPolicyDetails

Details for creating the file system snapshot policy.

CreateKerberosDetails

Kerberos details needed to create configuration.

CreateLdapBindAccountDetails

Account details for the LDAP bind account to be used by mount targets that use this outbound connector.

CreateLdapIdmapDetails

Mount target details about the LDAP ID mapping configuration.

CreateMountTargetDetails

Details for creating the mount target.

CreateOutboundConnectorDetails

Details for creating the outbound connector.

CreateOutboundConnectorDetailsModelConverter

CreateQuotaRuleDetails

Details for creating a quota rule in the file system.

CreateReplicationDetails

Details for creating the replication and replication target.

CreateSnapshotDetails

Details for creating the snapshot.

Endpoint

Combination of DNS server name and port.

Export

A file system and the path that you can use to mount it. Each export resource belongs to exactly one export set.
The export's path attribute is not a path in the referenced file system, but the value used by clients for the path component of the remotetarget argument when mounting the file system.
The path must start with a slash (/) followed by a sequence of zero or more slash-separated path elements. For any two export resources associated with the same export set, except those in a 'DELETED' state, the path element sequence for the first export resource can't contain the complete path element sequence of the second export resource.

For example, the following are acceptable:

  • /example and /path
  • /example1 and /example2
  • /example and /example1
    The following examples are not acceptable:
  • /example and /example/path
  • / and /example
    Paths may not end in a slash (/). No path element can be a period (.) or two periods in sequence (..). All path elements must be 255 bytes or less.
    No two non-'DELETED' export resources in the same export set can reference the same file system.
    Use exportOptions to control access to an export. For more information, see Export Options.

ExportSet

A set of file systems to export through one or more mount targets. Composed of zero or more export resources.

ExportSetSummary

Summary information for an export set.

ExportSummary

Summary information for an export.

FileSystem

An NFS file system. To allow access to a file system, add it to an export set and associate the export set with a mount target. The same file system can be in multiple export sets and associated with multiple mount targets.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

FileSystemSummary

Summary information for a file system.

FilesystemSnapshotPolicy

A file system snapshot policy is used to automate snapshot creation and deletion. It contains a list of snapshot schedules that define the frequency of snapshot creation for the associated file systems and the retention period of snapshots taken on schedule.
For more information, see Snapshot Scheduling.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

FilesystemSnapshotPolicySummary

Summary information for a file system snapshot policy.

Kerberos

Allows administrator to configure a mount target to interact with the administrator's Kerberos infrastructure.

KerberosKeytabEntry

Details of each keytab entry read from the keytab file.

KeyTabSecretDetails

Secret details of keytabs in Vault.

LdapBindAccount

Account details for the LDAP bind account used by the outbound connector.

LdapBindAccountSummary

Summary information for the LDAP bind account used by the outbound connector.

LdapIdmap

Mount target details about the LDAP ID mapping configuration.

MountTarget

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.

MountTargetSummary

Summary information for the specified mount target.

OutboundConnector

Outbound connectors are used to help File Storage communicate with an external server, such as an LDAP server. An outbound connector contains all the information needed to connect, authenticate, and gain authorization to perform the account's required functions.

OutboundConnectorModelConverter

OutboundConnectorSummary

Summary information for an outbound connector.

OutboundConnectorSummaryModelConverter

QuotaRule

A rule that can restrict the logical space that a user or group can consume in a file system.

QuotaRuleSummary

Summary information for a principal's usage and quota rule.

Replication

Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a {@link ReplicationTarget} located in another availability domain in the same or different region. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated ReplicationTarget, which applies it to the target file system. For more information, see File System Replication.

ReplicationEstimate

Details for response from replication estimation.

ReplicationSummary

Summary information for a replication.

ReplicationTarget

Replication targets are associated with a primary resource called a {@link Replication} located in another availability domain in the same or different region. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated ReplicationTarget, which applies it to the target file system. All operations (except DELETE) must be done using the associated replication resource. Deleting a ReplicationTarget allows the target file system to be exported. Deleting a ReplicationTarget does not delete the associated Replication resource, but places it in a FAILED state. For more information, see File System Replication.

ReplicationTargetSummary

Summary information for replication target.

ResourceLock

Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

ScheduleDowngradeShapeMountTargetDetails

Shape details about the Mount Target.

Snapshot

A point-in-time snapshot of a specified file system.

SnapshotSchedule

The snapshot schedule is a structure within a parent file system snapshot policy. It contains data about the frequency of snapshot creation and the retention time of the taken snapshots.

SnapshotSummary

Summary information for a snapshot.

SourceDetails

Source information for the file system.

ToggleQuotaRulesDetails

Details for enabling or disabling quota enforcement in the file system.

UpdateExportDetails

Details for updating the export.

UpdateExportSetDetails

Details for updating the export set.

UpdateFileSystemDetails

Details for updating the file system.

UpdateFilesystemSnapshotPolicyDetails

Details for updating the file system snapshot policy.

UpdateKerberosDetails

Kerberos details needed to update configuration.

UpdateLdapIdmapDetails

Mount target details about the LDAP ID mapping configuration.

UpdateMountTargetDetails

Details for updating the mount target.

UpdateOutboundConnectorDetails

Details for updating the outbound connector.

UpdateQuotaRuleDetails

Details for updating a quota rule in the file system.

UpdateReplicationDetails

Details for updating the replication and replication target.

UpdateSnapshotDetails

Details for updating the snapshot.

UpgradeShapeMountTargetDetails

Shape details about the Mount Target.

ValidateKeyTabsDetails

Validate keytabs request details.

ValidateKeyTabsResponseDetails

Validate keytabs response details.

Enums

ClientOptions.AccessEnum

ClientOptions.AllowedAuthEnum

ClientOptions.IdentitySquashEnum

CreateFileSystemDetails.CloneAttachStatusEnum

CreateLdapIdmapDetails.SchemaTypeEnum

CreateQuotaRuleDetails.PrincipalTypeEnum

Export.LifecycleStateEnum

ExportSet.LifecycleStateEnum

ExportSetSummary.LifecycleStateEnum

ExportSummary.LifecycleStateEnum

FileSystem.CloneAttachStatusEnum

FileSystem.LifecycleStateEnum

FileSystem.QuotaEnforcementStateEnum

FileSystemSummary.CloneAttachStatusEnum

FileSystemSummary.LifecycleStateEnum

FileSystemSummary.QuotaEnforcementStateEnum

FilesystemSnapshotPolicy.LifecycleStateEnum

FilesystemSnapshotPolicySummary.LifecycleStateEnum

KerberosKeytabEntry.EncryptionTypeEnum

LdapIdmap.SchemaTypeEnum

MountTarget.IdmapTypeEnum

MountTarget.LifecycleStateEnum

MountTargetSummary.LifecycleStateEnum

OutboundConnector.ConnectorTypeEnum

OutboundConnector.LifecycleStateEnum

OutboundConnectorSummary.LifecycleStateEnum

QuotaRule.PrincipalTypeEnum

QuotaRuleSummary.PrincipalTypeEnum

Replication.DeltaStatusEnum

Replication.LifecycleStateEnum

ReplicationSummary.LifecycleStateEnum

ReplicationTarget.DeltaStatusEnum

ReplicationTarget.LifecycleStateEnum

ReplicationTargetSummary.LifecycleStateEnum

ResourceLock.TypeEnum

Snapshot.LifecycleStateEnum

Snapshot.SnapshotTypeEnum

SnapshotSchedule.DayOfWeekEnum

SnapshotSchedule.MonthEnum

SnapshotSchedule.PeriodEnum

SnapshotSchedule.TimeZoneEnum

SnapshotSummary.LifecycleStateEnum

SnapshotSummary.SnapshotTypeEnum

UpdateLdapIdmapDetails.SchemaTypeEnum

In this article
Back to top