filestorage.oracle.com/v1beta1¶
APIVersion: filestorage.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes filestorage.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Export | Namespaced | Sample | - |
| FileSystem | Namespaced | Sample | - |
| FilesystemSnapshotPolicy | Namespaced | Sample | - |
| MountTarget | Namespaced | Sample | - |
| OutboundConnector | Namespaced | Sample | - |
| QuotaRule | Namespaced | Sample | - |
| Replication | Namespaced | Sample | - |
| Snapshot | Namespaced | Sample | - |
Export¶
Export is the Schema for the exports API.
Plural:exportsScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_export.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ExportSpec defines the desired state of Export.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
exportOptions |
Export options for the new export. For exports of mount targets with IPv4 address, if client options are left unspecified, client options would default to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ] For exports of mount targets with IPv6 address, if client options are left unspecified, client options would be an empty array, i.e. export would not be visible to any clients. Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0. If set to the empty array then the export will not be visible to any clients. The export's exportOptions can be changed after creation using the UpdateExport operation. |
list[object] |
No | - | - |
exportSetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's export set. | string |
Yes | - | - |
fileSystemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's file system. | string |
Yes | - | - |
isIdmapGroupsForSysAuth |
Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read. | boolean |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
path |
Path used to access the associated file system. Avoid entering confidential information. Example: /mediafiles |
string |
Yes | - | - |
Spec.exportOptions[]¶
ExportOption defines nested fields for Export.ExportOption.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
access |
Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE. |
string |
No | - | - |
allowedAuth |
Array of allowed NFS authentication types. | list[string] |
No | - | - |
anonymousGid |
GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534. |
integer (int64) |
No | - | - |
anonymousUid |
UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534. |
integer (int64) |
No | - | - |
identitySquash |
Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT. |
string |
No | - | - |
isAnonymousAccessAllowed |
Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID. | boolean |
No | - | - |
requirePrivilegedSourcePort |
If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true. |
boolean |
No | - | - |
source |
Clients these options should apply to. Must be a either single IPv4/IPv6 address or single IPv4/IPv6 CIDR block. Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses. | string |
Yes | - | - |
Spec.locks[]¶
ExportLock defines nested fields for Export.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status¶
ExportStatus defines the observed state of Export.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
exportOptions |
Policies that apply to NFS requests made through this export. exportOptions contains a sequential list of ClientOptions. Each ClientOptions item defines the export options that are applied to a specified set of clients. For each NFS request, the first ClientOptions option in the list whose source attribute matches the source IP address of the request is applied. If a client source IP address does not match the source property of any ClientOptions in the list, then the export will be invisible to that client. This export will not be returned by MOUNTPROC_EXPORT calls made by the client and any attempt to mount or access the file system through this export will result in an error. Exports without defined ClientOptions are invisible to all clients. If one export is invisible to a particular client, associated file systems may still be accessible through other exports on the same or different mount targets. To completely deny client access to a file system, be sure that the client source IP address is not included in any export for any mount target associated with the file system. |
list[object] |
No | - | - |
exportSetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's export set. | string |
No | - | - |
fileSystemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export's file system. | string |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this export. | string |
No | - | - |
isIdmapGroupsForSysAuth |
Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read. | boolean |
No | - | - |
lifecycleState |
The current state of this export. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
path |
Path used to access the associated file system. Avoid entering confidential information. Example: /accounting |
string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The date and time the export was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.exportOptions[]¶
ExportOption defines nested fields for Export.ExportOption.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
access |
Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE. |
string |
No | - | - |
allowedAuth |
Array of allowed NFS authentication types. | list[string] |
No | - | - |
anonymousGid |
GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534. |
integer (int64) |
No | - | - |
anonymousUid |
UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534. |
integer (int64) |
No | - | - |
identitySquash |
Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT. |
string |
No | - | - |
isAnonymousAccessAllowed |
Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID. | boolean |
No | - | - |
requirePrivilegedSourcePort |
If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true. |
boolean |
No | - | - |
source |
Clients these options should apply to. Must be a either single IPv4/IPv6 address or single IPv4/IPv6 CIDR block. Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses. | string |
Yes | - | - |
Status.locks[]¶
ExportLock defines nested fields for Export.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
FileSystem¶
FileSystem is the Schema for the filesystems API.
Plural:filesystemsScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_filesystem.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
FileSystemSpec defines the desired state of FileSystem.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areQuotaRulesEnabled |
Specifies the enforcement of quota rules on the file system. | boolean |
No | - | - |
availabilityDomain |
The availability domain to create the file system in. Example: Uocm:PHX-AD-1 |
string |
Yes | - | - |
cloneAttachStatus |
Specifies whether the clone file system is attached to its parent file system. If the value is set to 'DETACH', then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the file system in. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system |
string |
No | - | - |
filesystemSnapshotPolicyId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots. May be unset as a blank value. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
kmsKeyId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
sourceSnapshotId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). | string |
No | - | - |
Spec.locks[]¶
FileSystemLock defines nested fields for FileSystem.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status¶
FileSystemStatus defines the observed state of FileSystem.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areQuotaRulesEnabled |
Specifies the enforcement of quota rules on the file system. | boolean |
No | - | - |
availabilityDomain |
The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 |
string |
No | - | - |
cloneAttachStatus |
Specifies whether the file system is attached to its parent file system. | string |
No | - | - |
cloneCount |
Specifies the total number of children of a file system. | integer |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My file system |
string |
No | - | - |
filesystemSnapshotPolicyId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system. | string |
No | - | - |
isCloneParent |
Specifies whether the file system has been cloned. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). | boolean |
No | - | - |
isHydrated |
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 (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm#hydration). | boolean |
No | - | - |
isTargetable |
Specifies whether the file system can be used as a target file system for replication. The system sets this value to 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 false. For more information, see Using Replication (https://docs.oracle.com/iaas/Content/File/Tasks/using-replication.htm). |
boolean |
No | - | - |
kmsKeyId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key which is the master encryption key for the file system. | string |
No | - | - |
lifecycleDetails |
Additional information about the current 'lifecycleState'. | string |
No | - | - |
lifecycleState |
The current state of the file system. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
meteredBytes |
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 (https://docs.oracle.com/iaas/Content/File/Concepts/FSutilization.htm). | integer (int64) |
No | - | - |
quotaEnforcementState |
Displays the state of enforcement of quota rules on the file system. | string |
No | - | - |
replicationSourceCount |
Specifies the total number of replications for which this file system is a source. | integer |
No | - | - |
replicationTargetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication target associated with the file system. Empty if the file system is not being used as target in a replication. | string |
No | - | - |
sourceDetails |
FileSystemSourceDetails defines nested fields for FileSystem.SourceDetails. | object |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. System tags are applied to resources by internal OCI services. | map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time the file system was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.locks[]¶
FileSystemLock defines nested fields for FileSystem.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.sourceDetails¶
FileSystemSourceDetails defines nested fields for FileSystem.SourceDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
parentFileSystemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). | string |
No | - | - |
sourceSnapshotId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source snapshot used to create a cloned file system. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). | string |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
FilesystemSnapshotPolicy¶
FilesystemSnapshotPolicy is the Schema for the filesystemsnapshotpolicies API.
Plural:filesystemsnapshotpoliciesScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_filesystemsnapshotpolicy.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
FilesystemSnapshotPolicySpec defines the desired state of FilesystemSnapshotPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availabilityDomain |
The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1 |
string |
Yes | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1 |
string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
policyPrefix |
The prefix to apply to all snapshots created by this policy. Example: acme |
string |
No | - | - |
schedules |
The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy. If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in quotation marks, i.e. --schedules '[{"timeZone":"UTC","period":"DAILY","hourOfDay":18},{"timeZone":"UTC","period":"HOURLY"}]' |
list[object] |
No | - | - |
Spec.locks[]¶
Back to FilesystemSnapshotPolicy spec
FilesystemSnapshotPolicyLock defines nested fields for FilesystemSnapshotPolicy.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Spec.schedules[]¶
Back to FilesystemSnapshotPolicy spec
FilesystemSnapshotPolicySchedule defines nested fields for FilesystemSnapshotPolicy.Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dayOfMonth |
The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time. | integer |
No | - | - |
dayOfWeek |
The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time. | string |
No | - | - |
hourOfDay |
The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time. | integer |
No | - | - |
month |
The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time. | string |
No | - | - |
period |
The frequency of scheduled snapshots. | string |
Yes | - | - |
retentionDurationInSeconds |
The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty. | integer (int64) |
No | - | - |
schedulePrefix |
A name prefix to be applied to snapshots created by this schedule. Example: compliance1 |
string |
No | - | - |
timeScheduleStart |
The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created. |
string |
No | - | - |
timeZone |
Time zone used for scheduling the snapshot. | string |
Yes | - | - |
Status¶
FilesystemSnapshotPolicyStatus defines the observed state of FilesystemSnapshotPolicy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availabilityDomain |
The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value. Example: Uocm:PHX-AD-2 |
string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: policy1 |
string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy. | string |
No | - | - |
lifecycleState |
The current state of the file system snapshot policy. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
policyPrefix |
The prefix to apply to all snapshots created by this policy. Example: acme |
string |
No | - | - |
schedules |
The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy. | list[object] |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. System tags are applied to resources by internal OCI services. | map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time the file system snapshot policy was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.locks[]¶
Back to FilesystemSnapshotPolicy status
FilesystemSnapshotPolicyLock defines nested fields for FilesystemSnapshotPolicy.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.schedules[]¶
Back to FilesystemSnapshotPolicy status
FilesystemSnapshotPolicySchedule defines nested fields for FilesystemSnapshotPolicy.Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dayOfMonth |
The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time. | integer |
No | - | - |
dayOfWeek |
The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time. | string |
No | - | - |
hourOfDay |
The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time. | integer |
No | - | - |
month |
The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time. | string |
No | - | - |
period |
The frequency of scheduled snapshots. | string |
Yes | - | - |
retentionDurationInSeconds |
The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty. | integer (int64) |
No | - | - |
schedulePrefix |
A name prefix to be applied to snapshots created by this schedule. Example: compliance1 |
string |
No | - | - |
timeScheduleStart |
The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created. |
string |
No | - | - |
timeZone |
Time zone used for scheduling the snapshot. | string |
Yes | - | - |
Status.status¶
Back to FilesystemSnapshotPolicy status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to FilesystemSnapshotPolicy status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to FilesystemSnapshotPolicy status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to FilesystemSnapshotPolicy status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
MountTarget¶
MountTarget is the Schema for the mounttargets API.
Plural:mounttargetsScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_mounttarget.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
MountTargetSpec defines the desired state of MountTarget.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availabilityDomain |
The availability domain in which to create the mount target. Example: Uocm:PHX-AD-1 |
string |
Yes | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to create the mount target. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My mount target |
string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
hostnameLabel |
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: If the IP address is IPv4, this attribute value is stored in the PrivateIp (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/PrivateIp/) resource, not in the mountTarget resource. To update the hostnameLabel, use GetMountTarget to obtain the OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target's private IPs (privateIpIds). Then, you can use UpdatePrivateIp (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/PrivateIp/UpdatePrivateIp) to update the hostnameLabel value. If the IP address is IPv6, it is stored in the Ipv6 (https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Ipv6) resource To update the hostnameLabel, use GetMountTarget to obtain the OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target's IPv6 address (mountTargetIpv6Ids). Then, you can use UpdateIpv6 (https://docs.oracle.com/iaas/en-us/iaas/api/#/en/iaas/20160918/Ipv6/UpdateIpv6) to update the hostnameLabel value. For more information, see DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm). Example: files-1 |
string |
No | - | - |
idmapType |
The method used to map a Unix UID to secondary groups, if any. | string |
No | - | - |
ipAddress |
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. Example: 10.0.3.3 |
string |
No | - | - |
kerberos |
MountTargetKerberos defines nested fields for MountTarget.Kerberos. | object |
No | - | - |
ldapIdmap |
MountTargetLdapIdmap defines nested fields for MountTarget.LdapIdmap. | object |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
nsgIds |
A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). | list[string] |
No | - | - |
requestedThroughput |
Throughput for mount target in Gbps. Currently only 1 Gbps of requestedThroughput is supported during create MountTarget. Available shapes and corresponding throughput are listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance). | integer (int64) |
No | - | - |
securityAttributes |
Security attributes (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a Zero Trust Packet Routing (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} |
map[string, map[string, string]] |
No | - | - |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which to create the mount target. | string |
Yes | - | - |
Spec.kerberos¶
MountTargetKerberos defines nested fields for MountTarget.Kerberos.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backupKeyTabSecretVersion |
Version of the keytab Secret in the Vault to use as a backup. | integer |
No | - | - |
currentKeyTabSecretVersion |
Version of the keytab Secret in the Vault to use. | integer |
No | - | - |
isKerberosEnabled |
Specifies whether to enable or disable Kerberos. | boolean |
No | - | - |
kerberosRealm |
The Kerberos realm that the mount target will join. | string |
Yes | - | - |
keyTabSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab Secret in the Vault. | string |
No | - | - |
Spec.ldapIdmap¶
MountTargetLdapIdmap defines nested fields for MountTarget.LdapIdmap.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cacheLifetimeSeconds |
The maximum amount of time the mount target is allowed to use a cached entry. | integer |
No | - | - |
cacheRefreshIntervalSeconds |
The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry. | integer |
No | - | - |
groupSearchBase |
All LDAP searches are recursive starting at this group. Example: CN=Group,DC=domain,DC=com |
string |
No | - | - |
negativeCacheLifetimeSeconds |
The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration. | integer |
No | - | - |
outboundConnector1Id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server. | string |
No | - | - |
outboundConnector2Id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server. | string |
No | - | - |
schemaType |
Schema type of the LDAP account. | string |
No | - | - |
userSearchBase |
All LDAP searches are recursive starting at this user. Example: CN=User,DC=domain,DC=com |
string |
No | - | - |
Spec.locks[]¶
MountTargetLock defines nested fields for MountTarget.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status¶
MountTargetStatus defines the observed state of MountTarget.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availabilityDomain |
The availability domain the mount target is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 |
string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the mount target. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My mount target |
string |
No | - | - |
exportSetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the mount target. | string |
No | - | - |
idmapType |
The method used to map a Unix UID to secondary groups. If NONE, the mount target will not use the Unix UID for ID mapping. | string |
No | - | - |
kerberos |
MountTargetKerberos defines nested fields for MountTarget.Kerberos. | object |
No | - | - |
ldapIdmap |
MountTargetLdapIdmap defines nested fields for MountTarget.LdapIdmap. | object |
No | - | - |
lifecycleDetails |
Additional information about the current 'lifecycleState'. | string |
No | - | - |
lifecycleState |
The current state of the mount target. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
mountTargetIpv6Ids |
The OCIDs of the IPv6 addresses associated with this mount target. | list[string] |
No | - | - |
nsgIds |
A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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. For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). | list[string] |
No | - | - |
observedThroughput |
Current billed throughput for mount target in Gbps. This corresponds to shape of mount target. Available shapes and corresponding throughput are listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance). | integer (int64) |
No | - | - |
privateIpIds |
The OCIDs of the private IP addresses associated with this mount target. | list[string] |
No | - | - |
requestedThroughput |
- New throughput for mount target at the end of billing cycle in Gbps. | integer (int64) |
No | - | - |
reservedStorageCapacity |
- Reserved capacity (GB) associated with this mount target. Reserved capacity depends on observedThroughput value of mount target. Value is listed at Mount Target Performance (https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance). | integer (int64) |
No | - | - |
securityAttributes |
Security attributes (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a Zero Trust Packet Routing (https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} |
map[string, map[string, string]] |
No | - | - |
status |
- | object |
Yes | - | - |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in. | string |
No | - | - |
systemTags |
System tags for this resource. System tags are applied to resources by internal OCI services. | map[string, map[string, string]] |
No | - | - |
timeBillingCycleEnd |
The date and time the mount target current billing cycle will end and next one starts, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeCreated |
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 |
string |
No | - | - |
Status.kerberos¶
MountTargetKerberos defines nested fields for MountTarget.Kerberos.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
backupKeyTabSecretVersion |
Version of the keytab Secret in the Vault to use as a backup. | integer |
No | - | - |
currentKeyTabSecretVersion |
Version of the keytab Secret in the Vault to use. | integer |
No | - | - |
isKerberosEnabled |
Specifies whether to enable or disable Kerberos. | boolean |
No | - | - |
kerberosRealm |
The Kerberos realm that the mount target will join. | string |
Yes | - | - |
keyTabSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab Secret in the Vault. | string |
No | - | - |
Status.ldapIdmap¶
MountTargetLdapIdmap defines nested fields for MountTarget.LdapIdmap.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cacheLifetimeSeconds |
The maximum amount of time the mount target is allowed to use a cached entry. | integer |
No | - | - |
cacheRefreshIntervalSeconds |
The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry. | integer |
No | - | - |
groupSearchBase |
All LDAP searches are recursive starting at this group. Example: CN=Group,DC=domain,DC=com |
string |
No | - | - |
negativeCacheLifetimeSeconds |
The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration. | integer |
No | - | - |
outboundConnector1Id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server. | string |
No | - | - |
outboundConnector2Id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server. | string |
No | - | - |
schemaType |
Schema type of the LDAP account. | string |
No | - | - |
userSearchBase |
All LDAP searches are recursive starting at this user. Example: CN=User,DC=domain,DC=com |
string |
No | - | - |
Status.locks[]¶
MountTargetLock defines nested fields for MountTarget.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
OutboundConnector¶
OutboundConnector is the Schema for the outboundconnectors API.
Plural:outboundconnectorsScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_outboundconnector.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
OutboundConnectorSpec defines the desired state of OutboundConnector.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availabilityDomain |
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 |
string |
Yes | - | - |
bindDistinguishedName |
The LDAP Distinguished Name of the bind account. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector. | string |
Yes | - | - |
connectorType |
- | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector |
string |
No | - | - |
endpoints |
Array of server endpoints to use when connecting with the LDAP bind account. | list[object] |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
jsonData |
- | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
passwordSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the password for the LDAP bind account in the Vault. | string |
No | - | - |
passwordSecretVersion |
Version of the password secret in the Vault to use. | integer |
No | - | - |
trustedCertificateSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the trusted certificate for the LDAP server in the Vault. | string |
No | - | - |
trustedCertificateSecretVersion |
Version of the trusted certificate secret in the Vault to use. | integer |
No | - | - |
Spec.endpoints[]¶
Back to OutboundConnector spec
OutboundConnectorEndpoint defines nested fields for OutboundConnector.Endpoint.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
hostname |
Name of the DNS server. | string |
Yes | - | - |
port |
Port of the DNS server. | integer (int64) |
Yes | - | - |
Spec.locks[]¶
Back to OutboundConnector spec
OutboundConnectorLock defines nested fields for OutboundConnector.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status¶
OutboundConnectorStatus defines the observed state of OutboundConnector.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availabilityDomain |
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 |
string |
No | - | - |
bindDistinguishedName |
The LDAP Distinguished Name of the account. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector. | string |
No | - | - |
connectorType |
- | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector |
string |
No | - | - |
endpoints |
Array of server endpoints to use when connecting with the LDAP bind account. | list[object] |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the outbound connector. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
lifecycleState |
The current state of this outbound connector. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
passwordSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the password for the LDAP bind account in the Vault. | string |
No | - | - |
passwordSecretVersion |
Version of the password secret in the Vault to use. | integer |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. System tags are applied to resources by internal OCI services. | map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time the outbound connector was created in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
trustedCertificateSecretId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the trusted certificate for the LDAP server in the Vault . | string |
No | - | - |
trustedCertificateSecretVersion |
Version of the trusted certificate secret in the Vault to use. | integer |
No | - | - |
Status.endpoints[]¶
Back to OutboundConnector status
OutboundConnectorEndpoint defines nested fields for OutboundConnector.Endpoint.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
hostname |
Name of the DNS server. | string |
Yes | - | - |
port |
Port of the DNS server. | integer (int64) |
Yes | - | - |
Status.locks[]¶
Back to OutboundConnector status
OutboundConnectorLock defines nested fields for OutboundConnector.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.status¶
Back to OutboundConnector status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to OutboundConnector status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to OutboundConnector status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to OutboundConnector status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
QuotaRule¶
QuotaRule is the Schema for the quotarules API.
Plural:quotarulesScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_quotarule.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
QuotaRuleSpec defines the desired state of QuotaRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota |
string |
No | - | - |
isHardQuota |
Whether the quota rule will be enforced. If isHardQuota is true, the quota rule is enforced so that the write is blocked if usage exceeds the hard quota limit. If isHardQuota is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated. |
boolean |
Yes | - | - |
principalId |
An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to identify a user or group to manage access control. | integer |
No | - | - |
principalType |
The type of the owner of this quota rule and usage. | string |
Yes | - | - |
quotaLimitInGigabytes |
The value of the quota rule in gigabytes. | integer |
Yes | - | - |
Status¶
QuotaRuleStatus defines the observed state of QuotaRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areViolatorsOnly |
An option to display only the users or groups that violate their quota rules. If areViolatorsOnly is false, results report all the quota and usage. If areViolatorsOnly is true, results only report the quota and usage for the users or groups that violate their quota rules. |
boolean |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota |
string |
No | - | - |
fileSystemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file System. | string |
No | - | - |
id |
The identifier of the quota rule. It is the base64 encoded string of the tuple |
string |
No | - | - |
isHardQuota |
Whether the quota rule will be enforced. If isHardQuota is true, the quota rule is enforced so that the write is blocked if usage exceeds the hard quota limit. If isHardQuota is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated. |
boolean |
No | - | - |
principalId |
An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to identify a user or group to manage access control. | integer |
No | - | - |
principalType |
The type of the owner of this quota rule and usage. | string |
No | - | - |
quotaLimitInGigabytes |
The value of the quota rule in gigabytes. | integer |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The date and time the quota rule was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the quota rule was last updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
usageInBytes |
The usage value corresponding to this principal in bytes. | integer (int64) |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Replication¶
Replication is the Schema for the replications API.
Plural:replicationsScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_replication.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ReplicationSpec defines the desired state of Replication.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. An associated replication target will also created with the same displayName. Example: My replication |
string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
replicationInterval |
Duration in minutes between replication snapshots. | integer (int64) |
No | - | - |
sourceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source file system. | string |
Yes | - | - |
targetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target file system. | string |
Yes | - | - |
Spec.locks[]¶
ReplicationLock defines nested fields for Replication.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status¶
ReplicationStatus defines the observed state of Replication.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availabilityDomain |
The availability domain that contains the replication. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-2 |
string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
deltaProgress |
Percentage progress of the current replication cycle. | integer (int64) |
No | - | - |
deltaStatus |
The current state of the snapshot during replication operations. | string |
No | - | - |
displayName |
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My replication |
string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication. | string |
No | - | - |
lastSnapshotId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete. | string |
No | - | - |
lifecycleDetails |
Additional information about the current 'lifecycleState'. | string |
No | - | - |
lifecycleState |
The current lifecycle state of the replication. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
recoveryPointTime |
The snapshotTime of the most recent recoverable replication snapshot in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2021-04-04T20:01:29.100Z |
string |
No | - | - |
replicationInterval |
Duration in minutes between replication snapshots. | integer (int64) |
No | - | - |
replicationTargetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ReplicationTarget. | string |
No | - | - |
sourceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source file system. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. System tags are applied to resources by internal OCI services. | map[string, map[string, string]] |
No | - | - |
targetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target file system. | string |
No | - | - |
timeCreated |
The date and time the replication was created in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2021-01-04T20:01:29.100Z |
string |
No | - | - |
Status.locks[]¶
ReplicationLock defines nested fields for Replication.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Snapshot¶
Snapshot is the Schema for the snapshots API.
Plural:snapshotsScope:NamespacedAPIVersion:filestorage.oracle.com/v1beta1Sample: Sample (config/samples/filestorage_v1beta1_snapshot.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
SnapshotSpec defines the desired state of Snapshot.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
expirationTime |
The time when this snapshot will be deleted. | string |
No | - | - |
fileSystemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system to take a snapshot of. | string |
Yes | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
name |
Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system. Avoid entering confidential information. Example: Sunday |
string |
Yes | - | - |
Spec.locks[]¶
SnapshotLock defines nested fields for Snapshot.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status¶
SnapshotStatus defines the observed state of Snapshot.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
expirationTime |
The time when this snapshot will be deleted. | string |
No | - | - |
fileSystemId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system from which the snapshot was created. | string |
No | - | - |
filesystemSnapshotPolicyId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy that created this snapshot. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot. | string |
No | - | - |
isCloneSource |
Specifies whether the snapshot has been cloned. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). | boolean |
No | - | - |
lifecycleDetails |
Additional information about the current lifecycleState. |
string |
No | - | - |
lifecycleState |
The current state of the snapshot. | string |
No | - | - |
locks |
Locks associated with this resource. | list[object] |
No | - | - |
name |
Name of the snapshot. This value is immutable. Avoid entering confidential information. Example: Sunday |
string |
No | - | - |
provenanceId |
An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent's provenanceId. See Cloning a File System (https://docs.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). |
string |
No | - | - |
snapshotTime |
The date and time the snapshot was taken, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. This value might be the same or different from timeCreated depending on the following factors: - If the snapshot is created in the original file system directory. - If the snapshot is cloned from a file system. - If the snapshot is replicated from a file system. Example: 2020-08-25T21:10:29.600Z |
string |
No | - | - |
snapshotType |
Specifies generation type of the snapshot. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. System tags are applied to resources by internal OCI services. | map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time the snapshot was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.locks[]¶
SnapshotLock defines nested fields for Snapshot.Lock.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. | string |
No | - | - |
relatedResourceId |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. | string |
No | - | - |
timeCreated |
When the lock was created. | string |
No | - | - |
type |
Type of the lock. | string |
Yes | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |