Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

The availability domain the file system is in. May be unset as a blank or NULL value.

Example: {@code Uocm:PHX-AD-1}

compartmentId

compartmentId: string

The OCID of the compartment that contains the file system.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

displayName

displayName: string

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: {@code My file system}

Optional filesystemSnapshotPolicyId

filesystemSnapshotPolicyId: undefined | string

The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

id

id: string

The OCID of the file system.

Optional isCloneParent

isCloneParent: undefined | false | true

Specifies whether the file system has been cloned. See Cloning a File System.

Optional isHydrated

isHydrated: undefined | false | true

Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.

Optional isTargetable

isTargetable: undefined | false | true

Specifies whether the file system can be used as a target file system for replication. The system sets this value to {@code true} if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to {@code false}. For more information, see Using Replication.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the KMS key which is the master encryption key for the file system.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current 'lifecycleState'.

lifecycleState

lifecycleState: LifecycleState

The current state of the file system.

meteredBytes

meteredBytes: number

The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional replicationTargetId

replicationTargetId: undefined | string

The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.

Optional sourceDetails

sourceDetails: model.SourceDetails

timeCreated

timeCreated: Date

The date and time the file system was created, expressed in RFC 3339 timestamp format.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj