File Storage Functions

CHANGE_FILE_SYSTEM_COMPARTMENT Function

Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment

Syntax

FUNCTION change_file_system_compartment (
  file_system_id varchar2,
  change_file_system_compartment_details dbms_cloud_oci_file_storage_change_file_system_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_change_file_system_compartment_response_t;

Parameters

Parameter	Description
`file_system_id`	(required) The OCID of the file system.
`change_file_system_compartment_details`	(required) Details for changing the compartment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_FILESYSTEM_SNAPSHOT_POLICY_COMPARTMENT Function

Moves a file system snapshot policy into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_filesystem_snapshot_policy_compartment (
  filesystem_snapshot_policy_id varchar2,
  change_filesystem_snapshot_policy_compartment_details dbms_cloud_oci_file_storage_change_filesystem_snapshot_policy_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_change_filesystem_snapshot_policy_compartment_response_t;

Parameters

Parameter	Description
`filesystem_snapshot_policy_id`	(required) The OCID of the file system snapshot policy.
`change_filesystem_snapshot_policy_compartment_details`	(required) Details for changing the compartment of a file system snapshot policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MOUNT_TARGET_COMPARTMENT Function

Moves a mount target and its associated export set or share set into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment

Syntax

FUNCTION change_mount_target_compartment (
  mount_target_id varchar2,
  change_mount_target_compartment_details dbms_cloud_oci_file_storage_change_mount_target_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_change_mount_target_compartment_response_t;

Parameters

Parameter	Description
`mount_target_id`	(required) The OCID of the mount target.
`change_mount_target_compartment_details`	(required) Details for changing the compartment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_OUTBOUND_CONNECTOR_COMPARTMENT Function

Moves an outbound connector into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment

Syntax

FUNCTION change_outbound_connector_compartment (
  outbound_connector_id varchar2,
  change_outbound_connector_compartment_details dbms_cloud_oci_file_storage_change_outbound_connector_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_change_outbound_connector_compartment_response_t;

Parameters

Parameter	Description
`outbound_connector_id`	(required) The OCID of the outbound connector.
`change_outbound_connector_compartment_details`	(required) Details for changing the compartment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_REPLICATION_COMPARTMENT Function

Moves a replication and its replication target into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_replication_compartment (
  replication_id varchar2,
  change_replication_compartment_details dbms_cloud_oci_file_storage_change_replication_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_change_replication_compartment_response_t;

Parameters

Parameter	Description
`replication_id`	(required) The OCID of the replication.
`change_replication_compartment_details`	(required) Details for changing the compartment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EXPORT Function

Creates a new export in the specified export set, path, and file system.

Syntax

FUNCTION create_export (
  create_export_details dbms_cloud_oci_file_storage_create_export_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_create_export_response_t;

Parameters

Parameter	Description
`create_export_details`	(required) Details for creating a new export.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_FILE_SYSTEM Function

Creates a new file system in the specified compartment and availability domain. Instances can mount file systems in another availability domain, but doing so might increase latency when compared to mounting instances in the same availability domain. After you create a file system, you can associate it with a mount target. Instances can then mount the file system by connecting to the mount target's IP address. You can associate a file system with more than one mount target at a time. For information about access control and compartments, see Overview of the IAM Service. For information about Network Security Groups access control, see Network Security Groups. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including file systems, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type or by viewing the resource in the Console.

Syntax

FUNCTION create_file_system (
  create_file_system_details dbms_cloud_oci_file_storage_create_file_system_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_create_file_system_response_t;

Parameters

Parameter	Description
`create_file_system_details`	(required) Details for creating a new file system.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_FILESYSTEM_SNAPSHOT_POLICY Function

Creates a new file system snapshot policy in the specified compartment and availability domain. After you create a file system snapshot policy, you can associate it with file systems.

Syntax

FUNCTION create_filesystem_snapshot_policy (
  create_filesystem_snapshot_policy_details dbms_cloud_oci_file_storage_create_filesystem_snapshot_policy_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_create_filesystem_snapshot_policy_response_t;

Parameters

Parameter	Description
`create_filesystem_snapshot_policy_details`	(required) Details for creating a new file system snapshot policy.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MOUNT_TARGET Function

Creates a new mount target in the specified compartment and subnet. You can associate a file system with a mount target only when they exist in the same availability domain. Instances can connect to mount targets in another availablity domain, but you might see higher latency than with instances in the same availability domain as the mount target. Mount targets have one or more private IP addresses that you can provide as the host portion of remote target parameters in client mount commands. These private IP addresses are listed in the privateIpIds property of the mount target and are highly available. Mount targets also consume additional IP addresses in their subnet. Do not use /30 or smaller subnets for mount target creation because they do not have sufficient available IP addresses. Allow at least three IP addresses for each mount target. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure Services resources, including mount targets, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

Syntax

FUNCTION create_mount_target (
  create_mount_target_details dbms_cloud_oci_file_storage_create_mount_target_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_create_mount_target_response_t;

Parameters

Parameter	Description
`create_mount_target_details`	(required) Details for creating a new mount target.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_OUTBOUND_CONNECTOR Function

Creates a new outbound connector in the specified compartment. You can associate an outbound connector with a mount target only when they exist in the same availability domain. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure Services resources, including outbound connectors, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

Syntax

FUNCTION create_outbound_connector (
  create_outbound_connector_details dbms_cloud_oci_file_storage_create_outbound_connector_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_create_outbound_connector_response_t;

Parameters

Parameter	Description
`create_outbound_connector_details`	(required) Details for creating a new outbound connector.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_REPLICATION Function

Creates a new replication in the specified compartment. 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 REPLICATION_TARGET Type located in another availability domain. The associated replication target resource is automatically created along with the replication resource. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated `ReplicationTarget`, which retrieves the delta and applies it to the target file system. Only unexported file systems can be used as target file systems. For more information, see Using Replication. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure Services resources, including replications, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

Syntax

FUNCTION create_replication (
  create_replication_details dbms_cloud_oci_file_storage_create_replication_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_create_replication_response_t;

Parameters

Parameter	Description
`create_replication_details`	(required) Details for creating a new replication.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SNAPSHOT Function

Creates a new snapshot of the specified file system. You can access the snapshot at `.snapshot/<name>`.

Syntax

FUNCTION create_snapshot (
  create_snapshot_details dbms_cloud_oci_file_storage_create_snapshot_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_create_snapshot_response_t;

Parameters

Parameter	Description
`create_snapshot_details`	(required) Details for creating a new snapshot.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EXPORT Function

Deletes the specified export.

Syntax

FUNCTION delete_export (
  export_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_export_response_t;

Parameters

Parameter	Description
`export_id`	(required) The OCID of the export.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_FILE_SYSTEM Function

Deletes the specified file system. Before you delete the file system, verify that no remaining export resources still reference it. Deleting a file system also deletes all of its snapshots.

Syntax

FUNCTION delete_file_system (
  file_system_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_file_system_response_t;

Parameters

Parameter	Description
`file_system_id`	(required) The OCID of the file system.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_FILESYSTEM_SNAPSHOT_POLICY Function

Deletes the specified file system snapshot policy.

Syntax

FUNCTION delete_filesystem_snapshot_policy (
  filesystem_snapshot_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_filesystem_snapshot_policy_response_t;

Parameters

Parameter	Description
`filesystem_snapshot_policy_id`	(required) The OCID of the file system snapshot policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MOUNT_TARGET Function

Deletes the specified mount target. This operation also deletes the mount target's VNICs.

Syntax

FUNCTION delete_mount_target (
  mount_target_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_mount_target_response_t;

Parameters

Parameter	Description
`mount_target_id`	(required) The OCID of the mount target.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_OUTBOUND_CONNECTOR Function

Deletes the specified outbound connector.

Syntax

FUNCTION delete_outbound_connector (
  outbound_connector_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_outbound_connector_response_t;

Parameters

Parameter	Description
`outbound_connector_id`	(required) The OCID of the outbound connector.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REPLICATION Function

Deletes the specified replication and the the associated replication target.

Syntax

FUNCTION delete_replication (
  replication_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  delete_mode varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_replication_response_t;

Parameters

Parameter	Description
`replication_id`	(required) The OCID of the replication.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`delete_mode`	(optional) You can choose a mode for deleting the replication resource. - `FINISH_CYCLE_IF_CAPTURING_OR_APPLYING` Before deleting, complete the current delta cycle. If cycle is idle, delete immediately. Safest option. - `ONE_MORE_CYCLE` Before deleting, complete the current delta cycle, and initiate one more cycle. If cycle is idle, initiate one more cycle. Use for lossless failover. - `FINISH_CYCLE_IF_APPLYING` Before deleting, finish applying. If cycle is idle or capturing, delete immediately. Fastest option. Allowed values are: 'FINISH_CYCLE_IF_CAPTURING_OR_APPLYING', 'ONE_MORE_CYCLE', 'FINISH_CYCLE_IF_APPLYING'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REPLICATION_TARGET Function

Deletes the specified replication target. This operation causes the immediate release of the target file system if there are currently no delta application operations. If there is any current delta being applied the delete operation is blocked until the current delta has been completely applied.

Syntax

FUNCTION delete_replication_target (
  replication_target_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_replication_target_response_t;

Parameters

Parameter	Description
`replication_target_id`	(required) The OCID of the replication target.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SNAPSHOT Function

Deletes the specified snapshot.

Syntax

FUNCTION delete_snapshot (
  snapshot_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_delete_snapshot_response_t;

Parameters

Parameter	Description
`snapshot_id`	(required) The OCID of the snapshot.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ESTIMATE_REPLICATION Function

Provides estimates for replication created using specific file system.

Syntax

FUNCTION estimate_replication (
  file_system_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  change_rate_in_m_bps number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_estimate_replication_response_t;

Parameters

Parameter	Description
`file_system_id`	(required) The OCID of the file system.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`change_rate_in_m_bps`	(optional) The rate of change of data on source file system in MegaBytes per second.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXPORT Function

Gets the specified export's information.

Syntax

FUNCTION get_export (
  export_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_export_response_t;

Parameters

Parameter	Description
`export_id`	(required) The OCID of the export.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXPORT_SET Function

Gets the specified export set's information.

Syntax

FUNCTION get_export_set (
  export_set_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_export_set_response_t;

Parameters

Parameter	Description
`export_set_id`	(required) The OCID of the export set.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_FILE_SYSTEM Function

Gets the specified file system's information.

Syntax

FUNCTION get_file_system (
  file_system_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_file_system_response_t;

Parameters

Parameter	Description
`file_system_id`	(required) The OCID of the file system.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_FILESYSTEM_SNAPSHOT_POLICY Function

Gets the specified file system snapshot policy's information.

Syntax

FUNCTION get_filesystem_snapshot_policy (
  filesystem_snapshot_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_filesystem_snapshot_policy_response_t;

Parameters

Parameter	Description
`filesystem_snapshot_policy_id`	(required) The OCID of the file system snapshot policy.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MOUNT_TARGET Function

Gets the specified mount target's information.

Syntax

FUNCTION get_mount_target (
  mount_target_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_mount_target_response_t;

Parameters

Parameter	Description
`mount_target_id`	(required) The OCID of the mount target.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OUTBOUND_CONNECTOR Function

Gets the specified outbound connector's information.

Syntax

FUNCTION get_outbound_connector (
  outbound_connector_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_outbound_connector_response_t;

Parameters

Parameter	Description
`outbound_connector_id`	(required) The OCID of the outbound connector.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REPLICATION Function

Gets the specified replication's information.

Syntax

FUNCTION get_replication (
  replication_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_replication_response_t;

Parameters

Parameter	Description
`replication_id`	(required) The OCID of the replication.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REPLICATION_TARGET Function

Gets the specified replication target's information.

Syntax

FUNCTION get_replication_target (
  replication_target_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_replication_target_response_t;

Parameters

Parameter	Description
`replication_target_id`	(required) The OCID of the replication target.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SNAPSHOT Function

Gets the specified snapshot's information.

Syntax

FUNCTION get_snapshot (
  snapshot_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_get_snapshot_response_t;

Parameters

Parameter	Description
`snapshot_id`	(required) The OCID of the snapshot.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXPORT_SETS Function

Lists the export set resources in the specified compartment.

Syntax

FUNCTION list_export_sets (
  compartment_id varchar2,
  availability_domain varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_export_sets_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource`
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`sort_by`	(optional) The field to sort by. You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXPORTS Function

Lists export resources by compartment, file system, or export set. You must specify an export set ID, a file system ID, and / or a compartment ID.

Syntax

FUNCTION list_exports (
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  export_set_id varchar2 DEFAULT NULL,
  file_system_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_exports_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`export_set_id`	(optional) The OCID of the export set.
`file_system_id`	(optional) The OCID of the file system.
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`sort_by`	(optional) The field to sort by. You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by path, results are shown in ascending alphanumeric order. Allowed values are: 'TIMECREATED', 'PATH'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_FILE_SYSTEMS Function

Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.

Syntax

FUNCTION list_file_systems (
  compartment_id varchar2,
  availability_domain varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  source_snapshot_id varchar2 DEFAULT NULL,
  parent_file_system_id varchar2 DEFAULT NULL,
  filesystem_snapshot_policy_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_file_systems_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource`
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`source_snapshot_id`	(optional) The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
`parent_file_system_id`	(optional) The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
`filesystem_snapshot_policy_id`	(optional) The OCID of the file system snapshot policy that is associated with the file systems.
`sort_by`	(optional) The field to sort by. You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_FILESYSTEM_SNAPSHOT_POLICIES Function

Lists file system snapshot policies in the specified compartment.

Syntax

FUNCTION list_filesystem_snapshot_policies (
  compartment_id varchar2,
  availability_domain varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_filesystem_snapshot_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource`
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE'
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`sort_by`	(optional) The field to sort by. You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by displayName, results are shown in ascending alphanumeric order. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MOUNT_TARGETS Function

Lists the mount target resources in the specified compartment.

Syntax

FUNCTION list_mount_targets (
  compartment_id varchar2,
  availability_domain varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  export_set_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_mount_targets_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`display_name`	(optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource`
`export_set_id`	(optional) The OCID of the export set.
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`sort_by`	(optional) The field to sort by. You can choose either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OUTBOUND_CONNECTORS Function

Lists the outbound connector resources in the specified compartment.

Syntax

FUNCTION list_outbound_connectors (
  compartment_id varchar2,
  availability_domain varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_outbound_connectors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource`
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`sort_by`	(optional) The field to sort by. You can choose either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REPLICATION_TARGETS Function

Lists the replication target resources in the specified compartment.

Syntax

FUNCTION list_replication_targets (
  compartment_id varchar2,
  availability_domain varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_replication_targets_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource`
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`sort_by`	(optional) The field to sort by. You can choose either value, but not both. By default, when you sort by `timeCreated`, results are shown in descending order. When you sort by `displayName`, results are shown in ascending order. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REPLICATIONS Function

Lists the replication resources in the specified compartment.

Syntax

FUNCTION list_replications (
  compartment_id varchar2,
  availability_domain varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  file_system_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_replications_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`availability_domain`	(required) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: `500`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource`
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`sort_by`	(optional) The field to sort by. You can choose either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`file_system_id`	(optional) The OCID of the source file system.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SNAPSHOTS Function

Lists snapshots of the specified file system, or by file system snapshot policy and compartment, or by file system snapshot policy and file system. If file system ID is not specified, a file system snapshot policy ID and compartment ID must be specified. Users can only sort by time created when listing snapshots by file system snapshot policy ID and compartment ID (sort by name is NOT supported for listing snapshots by policy and compartment).

Syntax

FUNCTION list_snapshots (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  filesystem_snapshot_policy_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  file_system_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_list_snapshots_response_t;

Parameters

Parameter	Description
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 100 is the maximum. For important details about how pagination works, see List Pagination. Example: `100`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) Filter results by the specified lifecycle state. Must be a valid state for the resource type. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`id`	(optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
`filesystem_snapshot_policy_id`	(optional) The OCID of the file system snapshot policy that is used to create the snapshots.
`compartment_id`	(optional) The OCID of the compartment.
`file_system_id`	(optional) The OCID of the file system.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PAUSE_FILESYSTEM_SNAPSHOT_POLICY Function

This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system snapshot policy from ACTIVE to INACTIVE. When a file system snapshot policy is paused, file systems that are associated with the policy will not have scheduled snapshots created or deleted. If the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can't pause a policy that is in a DELETING, DELETED, FAILED, CREATING or INACTIVE state; attempts to pause a policy in these states result in a 409 conflict error.

Syntax

FUNCTION pause_filesystem_snapshot_policy (
  filesystem_snapshot_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_pause_filesystem_snapshot_policy_response_t;

Parameters

Parameter	Description
`filesystem_snapshot_policy_id`	(required) The OCID of the file system snapshot policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UNPAUSE_FILESYSTEM_SNAPSHOT_POLICY Function

This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE. By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the policy will have snapshots created and deleted according to the schedules defined in the policy. If the policy is already in the ACTIVE state, you cannot unpause it. You can't unpause a policy that is in a DELETING, DELETED, FAILED, CREATING, or ACTIVE state; attempts to unpause a policy in these states result in a 409 conflict error.

Syntax

FUNCTION unpause_filesystem_snapshot_policy (
  filesystem_snapshot_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_unpause_filesystem_snapshot_policy_response_t;

Parameters

Parameter	Description
`filesystem_snapshot_policy_id`	(required) The OCID of the file system snapshot policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXPORT Function

Updates the specified export's information.

Syntax

FUNCTION update_export (
  export_id varchar2,
  update_export_details dbms_cloud_oci_file_storage_update_export_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_export_response_t;

Parameters

Parameter	Description
`export_id`	(required) The OCID of the export.
`update_export_details`	(required) Details object for updating an export.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXPORT_SET Function

Updates the specified export set's information.

Syntax

FUNCTION update_export_set (
  export_set_id varchar2,
  update_export_set_details dbms_cloud_oci_file_storage_update_export_set_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_export_set_response_t;

Parameters

Parameter	Description
`export_set_id`	(required) The OCID of the export set.
`update_export_set_details`	(required) Details object for updating an export set.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_FILE_SYSTEM Function

Updates the specified file system's information. You can use this operation to rename a file system.

Syntax

FUNCTION update_file_system (
  file_system_id varchar2,
  update_file_system_details dbms_cloud_oci_file_storage_update_file_system_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_file_system_response_t;

Parameters

Parameter	Description
`file_system_id`	(required) The OCID of the file system.
`update_file_system_details`	(required) Details object for updating a file system.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_FILESYSTEM_SNAPSHOT_POLICY Function

Updates the specified file system snapshot policy's information.

Syntax

FUNCTION update_filesystem_snapshot_policy (
  filesystem_snapshot_policy_id varchar2,
  update_filesystem_snapshot_policy_details dbms_cloud_oci_file_storage_update_filesystem_snapshot_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_filesystem_snapshot_policy_response_t;

Parameters

Parameter	Description
`filesystem_snapshot_policy_id`	(required) The OCID of the file system snapshot policy.
`update_filesystem_snapshot_policy_details`	(required) Details object for updating a file system snapshot policy.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MOUNT_TARGET Function

Updates the specified mount target's information.

Syntax

FUNCTION update_mount_target (
  mount_target_id varchar2,
  update_mount_target_details dbms_cloud_oci_file_storage_update_mount_target_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_mount_target_response_t;

Parameters

Parameter	Description
`mount_target_id`	(required) The OCID of the mount target.
`update_mount_target_details`	(required) Details object for updating a mount target.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_OUTBOUND_CONNECTOR Function

Updates the specified outbound connector's information.

Syntax

FUNCTION update_outbound_connector (
  outbound_connector_id varchar2,
  update_outbound_connector_details dbms_cloud_oci_file_storage_update_outbound_connector_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_outbound_connector_response_t;

Parameters

Parameter	Description
`outbound_connector_id`	(required) The OCID of the outbound connector.
`update_outbound_connector_details`	(required) Details object for updating a outbound connector.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_REPLICATION Function

Updates the information for the specified replication and its associated replication target.

Syntax

FUNCTION update_replication (
  replication_id varchar2,
  update_replication_details dbms_cloud_oci_file_storage_update_replication_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_replication_response_t;

Parameters

Parameter	Description
`replication_id`	(required) The OCID of the replication.
`update_replication_details`	(required) Details object for updating a replication.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SNAPSHOT Function

Updates the specified snapshot's information.

Syntax

FUNCTION update_snapshot (
  snapshot_id varchar2,
  update_snapshot_details dbms_cloud_oci_file_storage_update_snapshot_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_update_snapshot_response_t;

Parameters

Parameter	Description
`snapshot_id`	(required) The OCID of the snapshot.
`update_snapshot_details`	(required) Details object for updating a snapshot.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

VALIDATE_KEY_TABS Function

Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request. The keytabs are deserialized, the contents are validated for compatibility and the principal, key version number and encryption type of each entry is provided as part of the response.

Syntax

FUNCTION validate_key_tabs (
  validate_key_tabs_details dbms_cloud_oci_file_storage_validate_key_tabs_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fs_file_storage_validate_key_tabs_response_t;

Parameters

Parameter	Description
`validate_key_tabs_details`	(required) Keytab secret details or mount target ID for validating keytabs.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://filestorage.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_FILE_SYSTEM_COMPARTMENT Function 🔗

CHANGE_FILESYSTEM_SNAPSHOT_POLICY_COMPARTMENT Function 🔗

CHANGE_MOUNT_TARGET_COMPARTMENT Function 🔗

CHANGE_OUTBOUND_CONNECTOR_COMPARTMENT Function 🔗

CHANGE_REPLICATION_COMPARTMENT Function 🔗

CREATE_EXPORT Function 🔗

CREATE_FILE_SYSTEM Function 🔗

CREATE_FILESYSTEM_SNAPSHOT_POLICY Function 🔗

CREATE_MOUNT_TARGET Function 🔗

CREATE_OUTBOUND_CONNECTOR Function 🔗

CREATE_REPLICATION Function 🔗

CREATE_SNAPSHOT Function 🔗

DELETE_EXPORT Function 🔗

DELETE_FILE_SYSTEM Function 🔗

DELETE_FILESYSTEM_SNAPSHOT_POLICY Function 🔗

DELETE_MOUNT_TARGET Function 🔗

DELETE_OUTBOUND_CONNECTOR Function 🔗

DELETE_REPLICATION Function 🔗

DELETE_REPLICATION_TARGET Function 🔗

DELETE_SNAPSHOT Function 🔗

ESTIMATE_REPLICATION Function 🔗

GET_EXPORT Function 🔗

GET_EXPORT_SET Function 🔗

GET_FILE_SYSTEM Function 🔗

GET_FILESYSTEM_SNAPSHOT_POLICY Function 🔗

GET_MOUNT_TARGET Function 🔗

GET_OUTBOUND_CONNECTOR Function 🔗

GET_REPLICATION Function 🔗

GET_REPLICATION_TARGET Function 🔗

GET_SNAPSHOT Function 🔗

LIST_EXPORT_SETS Function 🔗

LIST_EXPORTS Function 🔗

LIST_FILE_SYSTEMS Function 🔗

LIST_FILESYSTEM_SNAPSHOT_POLICIES Function 🔗

LIST_MOUNT_TARGETS Function 🔗

LIST_OUTBOUND_CONNECTORS Function 🔗

LIST_REPLICATION_TARGETS Function 🔗

LIST_REPLICATIONS Function 🔗

LIST_SNAPSHOTS Function 🔗

PAUSE_FILESYSTEM_SNAPSHOT_POLICY Function 🔗

UNPAUSE_FILESYSTEM_SNAPSHOT_POLICY Function 🔗

UPDATE_EXPORT Function 🔗

UPDATE_EXPORT_SET Function 🔗

UPDATE_FILE_SYSTEM Function 🔗

UPDATE_FILESYSTEM_SNAPSHOT_POLICY Function 🔗

UPDATE_MOUNT_TARGET Function 🔗

UPDATE_OUTBOUND_CONNECTOR Function 🔗

UPDATE_REPLICATION Function 🔗

UPDATE_SNAPSHOT Function 🔗

VALIDATE_KEY_TABS Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_FILE_SYSTEM_COMPARTMENT Function

CHANGE_FILESYSTEM_SNAPSHOT_POLICY_COMPARTMENT Function

CHANGE_MOUNT_TARGET_COMPARTMENT Function

CHANGE_OUTBOUND_CONNECTOR_COMPARTMENT Function

CHANGE_REPLICATION_COMPARTMENT Function

CREATE_EXPORT Function

CREATE_FILE_SYSTEM Function

CREATE_FILESYSTEM_SNAPSHOT_POLICY Function

CREATE_MOUNT_TARGET Function

CREATE_OUTBOUND_CONNECTOR Function

CREATE_REPLICATION Function

CREATE_SNAPSHOT Function

DELETE_EXPORT Function

DELETE_FILE_SYSTEM Function

DELETE_FILESYSTEM_SNAPSHOT_POLICY Function

DELETE_MOUNT_TARGET Function

DELETE_OUTBOUND_CONNECTOR Function

DELETE_REPLICATION Function

DELETE_REPLICATION_TARGET Function

DELETE_SNAPSHOT Function

ESTIMATE_REPLICATION Function

GET_EXPORT Function

GET_EXPORT_SET Function

GET_FILE_SYSTEM Function

GET_FILESYSTEM_SNAPSHOT_POLICY Function

GET_MOUNT_TARGET Function

GET_OUTBOUND_CONNECTOR Function

GET_REPLICATION Function

GET_REPLICATION_TARGET Function

GET_SNAPSHOT Function

LIST_EXPORT_SETS Function

LIST_EXPORTS Function

LIST_FILE_SYSTEMS Function

LIST_FILESYSTEM_SNAPSHOT_POLICIES Function

LIST_MOUNT_TARGETS Function

LIST_OUTBOUND_CONNECTORS Function

LIST_REPLICATION_TARGETS Function

LIST_REPLICATIONS Function

LIST_SNAPSHOTS Function

PAUSE_FILESYSTEM_SNAPSHOT_POLICY Function

UNPAUSE_FILESYSTEM_SNAPSHOT_POLICY Function

UPDATE_EXPORT Function

UPDATE_EXPORT_SET Function

UPDATE_FILE_SYSTEM Function

UPDATE_FILESYSTEM_SNAPSHOT_POLICY Function

UPDATE_MOUNT_TARGET Function

UPDATE_OUTBOUND_CONNECTOR Function

UPDATE_REPLICATION Function

UPDATE_SNAPSHOT Function

VALIDATE_KEY_TABS Function