FileStorageClient¶

class oci.file_storage.FileStorageClient(config, **kwargs)¶

Use the File Storage service API to manage file systems, mount targets, and snapshots. For more information, see [Overview of File Storage](/iaas/Content/File/Concepts/filestorageoverview.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_file_system_compartment`(…)	Moves a file system and its associated snapshots into a different compartment within the same tenancy.
`change_filesystem_snapshot_policy_compartment`(…)	Moves a file system snapshot policy into a different compartment within the same tenancy.
`change_mount_target_compartment`(…)	Moves a mount target and its associated export set or share set into a different compartment within the same tenancy.
`change_outbound_connector_compartment`(…)	Moves an outbound connector into a different compartment within the same tenancy.
`change_replication_compartment`(…)	Moves a replication and its replication target into a different compartment within the same tenancy.
`create_export`(create_export_details, **kwargs)	Creates a new export in the specified export set, path, and file system.
`create_file_system`(…)	Creates a new file system in the specified compartment and availability domain.
`create_filesystem_snapshot_policy`(…)	Creates a new file system snapshot policy in the specified compartment and availability domain.
`create_mount_target`(…)	Creates a new mount target in the specified compartment and subnet.
`create_outbound_connector`(…)	Creates a new outbound connector in the specified compartment.
`create_replication`(…)	Creates a new replication in the specified compartment.
`create_snapshot`(create_snapshot_details, …)	Creates a new snapshot of the specified file system.
`delete_export`(export_id, **kwargs)	Deletes the specified export.
`delete_file_system`(file_system_id, **kwargs)	Deletes the specified file system.
`delete_filesystem_snapshot_policy`(…)	Deletes the specified file system snapshot policy.
`delete_mount_target`(mount_target_id, **kwargs)	Deletes the specified mount target.
`delete_outbound_connector`(…)	Deletes the specified outbound connector.
`delete_replication`(replication_id, **kwargs)	Deletes the specified replication and the the associated replication target.
`delete_replication_target`(…)	Deletes the specified replication target.
`delete_snapshot`(snapshot_id, **kwargs)	Deletes the specified snapshot.
`estimate_replication`(file_system_id, **kwargs)	Provides estimates for replication created using specific file system.
`get_export`(export_id, **kwargs)	Gets the specified export’s information.
`get_export_set`(export_set_id, **kwargs)	Gets the specified export set’s information.
`get_file_system`(file_system_id, **kwargs)	Gets the specified file system’s information.
`get_filesystem_snapshot_policy`(…)	Gets the specified file system snapshot policy’s information.
`get_mount_target`(mount_target_id, **kwargs)	Gets the specified mount target’s information.
`get_outbound_connector`(…)	Gets the specified outbound connector’s information.
`get_replication`(replication_id, **kwargs)	Gets the specified replication’s information.
`get_replication_target`(…)	Gets the specified replication target’s information.
`get_snapshot`(snapshot_id, **kwargs)	Gets the specified snapshot’s information.
`list_export_sets`(compartment_id, …)	Lists the export set resources in the specified compartment.
`list_exports`(**kwargs)	Lists export resources by compartment, file system, or export set.
`list_file_systems`(compartment_id, …)	Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.
`list_filesystem_snapshot_policies`(…)	Lists file system snapshot policies in the specified compartment.
`list_mount_targets`(compartment_id, …)	Lists the mount target resources in the specified compartment.
`list_outbound_connectors`(compartment_id, …)	Lists the outbound connector resources in the specified compartment.
`list_replication_targets`(compartment_id, …)	Lists the replication target resources in the specified compartment.
`list_replications`(compartment_id, …)	Lists the replication resources in the specified compartment.
`list_snapshots`(**kwargs)	Lists snapshots of the specified file system, or by file system snapshot policy and compartment, or by file system snapshot policy and file system.
`pause_filesystem_snapshot_policy`(…)	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.
`unpause_filesystem_snapshot_policy`(…)	This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE.
`update_export`(export_id, …)	Updates the specified export’s information.
`update_export_set`(export_set_id, …)	Updates the specified export set’s information.
`update_file_system`(file_system_id, …)	Updates the specified file system’s information.
`update_filesystem_snapshot_policy`(…)	Updates the specified file system snapshot policy’s information.
`update_mount_target`(mount_target_id, …)	Updates the specified mount target’s information.
`update_outbound_connector`(…)	Updates the specified outbound connector’s information.
`update_replication`(replication_id, …)	Updates the information for the specified replication and its associated replication target.
`update_snapshot`(snapshot_id, …)	Updates the specified snapshot’s information.
`validate_key_tabs`(validate_key_tabs_details, …)	Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_file_system_compartment(file_system_id, change_file_system_compartment_details, **kwargs)¶

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

Parameters:	file_system_id (str) – (required) The OCID of the file system. change_file_system_compartment_details (oci.file_storage.models.ChangeFileSystemCompartmentDetails) – (required) Details for changing the compartment. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_file_system_compartment API.

change_filesystem_snapshot_policy_compartment(filesystem_snapshot_policy_id, change_filesystem_snapshot_policy_compartment_details, **kwargs)¶

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.

Parameters:	filesystem_snapshot_policy_id (str) – (required) The OCID of the file system snapshot policy. change_filesystem_snapshot_policy_compartment_details (oci.file_storage.models.ChangeFilesystemSnapshotPolicyCompartmentDetails) – (required) Details for changing the compartment of a file system snapshot policy. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_filesystem_snapshot_policy_compartment API.

change_mount_target_compartment(mount_target_id, change_mount_target_compartment_details, **kwargs)¶

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

Parameters:	mount_target_id (str) – (required) The OCID of the mount target. change_mount_target_compartment_details (oci.file_storage.models.ChangeMountTargetCompartmentDetails) – (required) Details for changing the compartment. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_mount_target_compartment API.

change_outbound_connector_compartment(outbound_connector_id, change_outbound_connector_compartment_details, **kwargs)¶

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

Parameters:	outbound_connector_id (str) – (required) The OCID of the outbound connector. change_outbound_connector_compartment_details (oci.file_storage.models.ChangeOutboundConnectorCompartmentDetails) – (required) Details for changing the compartment. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_outbound_connector_compartment API.

change_replication_compartment(replication_id, change_replication_compartment_details, **kwargs)¶

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.

Parameters:	replication_id (str) – (required) The OCID of the replication. change_replication_compartment_details (oci.file_storage.models.ChangeReplicationCompartmentDetails) – (required) Details for changing the compartment. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_replication_compartment API.

create_export(create_export_details, **kwargs)¶

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

Parameters:	create_export_details (oci.file_storage.models.CreateExportDetails) – (required) Details for creating a new export. opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Export`
Return type:	`Response`
Example:

Click here to see an example of how to use create_export API.

create_file_system(create_file_system_details, **kwargs)¶

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.

Parameters:	create_file_system_details (oci.file_storage.models.CreateFileSystemDetails) – (required) Details for creating a new file system. opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FileSystem`
Return type:	`Response`
Example:

Click here to see an example of how to use create_file_system API.

create_filesystem_snapshot_policy(create_filesystem_snapshot_policy_details, **kwargs)¶

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.

Parameters:	create_filesystem_snapshot_policy_details (oci.file_storage.models.CreateFilesystemSnapshotPolicyDetails) – (required) Details for creating a new file system snapshot policy. opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FilesystemSnapshotPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use create_filesystem_snapshot_policy API.

create_mount_target(create_mount_target_details, **kwargs)¶

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.

Parameters:	create_mount_target_details (oci.file_storage.models.CreateMountTargetDetails) – (required) Details for creating a new mount target. opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MountTarget`
Return type:	`Response`
Example:

Click here to see an example of how to use create_mount_target API.

create_outbound_connector(create_outbound_connector_details, **kwargs)¶

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.

Parameters:	create_outbound_connector_details (oci.file_storage.models.CreateOutboundConnectorDetails) – (required) Details for creating a new outbound connector. opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OutboundConnector`
Return type:	`Response`
Example:

Click here to see an example of how to use create_outbound_connector API.

create_replication(create_replication_details, **kwargs)¶

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

Parameters:	create_replication_details (oci.file_storage.models.CreateReplicationDetails) – (required) Details for creating a new replication. opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Replication`
Return type:	`Response`
Example:

Click here to see an example of how to use create_replication API.

create_snapshot(create_snapshot_details, **kwargs)¶

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

Parameters:	create_snapshot_details (oci.file_storage.models.CreateSnapshotDetails) – (required) Details for creating a new snapshot. opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Snapshot`
Return type:	`Response`
Example:

Click here to see an example of how to use create_snapshot API.

delete_export(export_id, **kwargs)¶

Deletes the specified export.

Parameters:	export_id (str) – (required) The OCID of the export. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_export API.

delete_file_system(file_system_id, **kwargs)¶

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.

Parameters:	file_system_id (str) – (required) The OCID of the file system. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_file_system API.

delete_filesystem_snapshot_policy(filesystem_snapshot_policy_id, **kwargs)¶

Deletes the specified file system snapshot policy.

Parameters:	filesystem_snapshot_policy_id (str) – (required) The OCID of the file system snapshot policy. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_filesystem_snapshot_policy API.

delete_mount_target(mount_target_id, **kwargs)¶

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

Parameters:	mount_target_id (str) – (required) The OCID of the mount target. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_mount_target API.

delete_outbound_connector(outbound_connector_id, **kwargs)¶

Deletes the specified outbound connector.

Parameters:	outbound_connector_id (str) – (required) The OCID of the outbound connector. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_outbound_connector API.

delete_replication(replication_id, **kwargs)¶

Deletes the specified replication and the the associated replication target.

Parameters:	replication_id (str) – (required) The OCID of the replication. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. delete_mode (str) – (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” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_replication API.

delete_replication_target(replication_target_id, **kwargs)¶

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.

Parameters:	replication_target_id (str) – (required) The OCID of the replication target. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_replication_target API.

delete_snapshot(snapshot_id, **kwargs)¶

Deletes the specified snapshot.

Parameters:	snapshot_id (str) – (required) The OCID of the snapshot. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_snapshot API.

estimate_replication(file_system_id, **kwargs)¶

Provides estimates for replication created using specific file system.

Parameters:	file_system_id (str) – (required) The OCID of the file system. if_match (str) – (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 (str) – (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 (int) – (optional) The rate of change of data on source file system in MegaBytes per second. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ReplicationEstimate`
Return type:	`Response`
Example:

Click here to see an example of how to use estimate_replication API.

get_export(export_id, **kwargs)¶

Gets the specified export’s information.

Parameters:	export_id (str) – (required) The OCID of the export. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Export`
Return type:	`Response`
Example:

Click here to see an example of how to use get_export API.

get_export_set(export_set_id, **kwargs)¶

Gets the specified export set’s information.

Parameters:	export_set_id (str) – (required) The OCID of the export set. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExportSet`
Return type:	`Response`
Example:

Click here to see an example of how to use get_export_set API.

get_file_system(file_system_id, **kwargs)¶

Gets the specified file system’s information.

Parameters:	file_system_id (str) – (required) The OCID of the file system. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FileSystem`
Return type:	`Response`
Example:

Click here to see an example of how to use get_file_system API.

get_filesystem_snapshot_policy(filesystem_snapshot_policy_id, **kwargs)¶

Gets the specified file system snapshot policy’s information.

Parameters:	filesystem_snapshot_policy_id (str) – (required) The OCID of the file system snapshot policy. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FilesystemSnapshotPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use get_filesystem_snapshot_policy API.

get_mount_target(mount_target_id, **kwargs)¶

Gets the specified mount target’s information.

Parameters:	mount_target_id (str) – (required) The OCID of the mount target. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MountTarget`
Return type:	`Response`
Example:

Click here to see an example of how to use get_mount_target API.

get_outbound_connector(outbound_connector_id, **kwargs)¶

Gets the specified outbound connector’s information.

Parameters:	outbound_connector_id (str) – (required) The OCID of the outbound connector. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OutboundConnector`
Return type:	`Response`
Example:

Click here to see an example of how to use get_outbound_connector API.

get_replication(replication_id, **kwargs)¶

Gets the specified replication’s information.

Parameters:	replication_id (str) – (required) The OCID of the replication. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Replication`
Return type:	`Response`
Example:

Click here to see an example of how to use get_replication API.

get_replication_target(replication_target_id, **kwargs)¶

Gets the specified replication target’s information.

Parameters:	replication_target_id (str) – (required) The OCID of the replication target. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ReplicationTarget`
Return type:	`Response`
Example:

Click here to see an example of how to use get_replication_target API.

get_snapshot(snapshot_id, **kwargs)¶

Gets the specified snapshot’s information.

Parameters:	snapshot_id (str) – (required) The OCID of the snapshot. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Snapshot`
Return type:	`Response`
Example:

Click here to see an example of how to use get_snapshot API.

list_export_sets(compartment_id, availability_domain, **kwargs)¶

Lists the export set resources in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (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 (str) – (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 (str) – (optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource lifecycle_state (str) – (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 (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ExportSetSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_export_sets API.

list_exports(**kwargs)¶

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.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. limit (int) – (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 (str) – (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 (str) – (optional) The OCID of the export set. file_system_id (str) – (optional) The OCID of the file system. lifecycle_state (str) – (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 (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ExportSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_exports API.

list_file_systems(compartment_id, availability_domain, **kwargs)¶

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

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (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 (str) – (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 (str) – (optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource lifecycle_state (str) – (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 (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. source_snapshot_id (str) – (optional) The OCID of the snapshot used to create a cloned file system. See Cloning a File System. parent_file_system_id (str) – (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 (str) – (optional) The OCID of the file system snapshot policy that is associated with the file systems. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `FileSystemSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_file_systems API.

list_filesystem_snapshot_policies(compartment_id, availability_domain, **kwargs)¶

Lists file system snapshot policies in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (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 (str) – (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 (str) – (optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource lifecycle_state (str) – (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 (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `FilesystemSnapshotPolicySummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_filesystem_snapshot_policies API.

list_mount_targets(compartment_id, availability_domain, **kwargs)¶

Lists the mount target resources in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (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 (str) – (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 (str) – (optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource export_set_id (str) – (optional) The OCID of the export set. lifecycle_state (str) – (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 (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `MountTargetSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_mount_targets API.

list_outbound_connectors(compartment_id, availability_domain, **kwargs)¶

Lists the outbound connector resources in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (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 (str) – (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 (str) – (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 (str) – (optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource id (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `OutboundConnectorSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_outbound_connectors API.

list_replication_targets(compartment_id, availability_domain, **kwargs)¶

Lists the replication target resources in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (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 (str) – (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 (str) – (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 (str) – (optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource id (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ReplicationTargetSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_replication_targets API.

list_replications(compartment_id, availability_domain, **kwargs)¶

Lists the replication resources in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (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 (str) – (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 (str) – (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 (str) – (optional) A user-friendly name. It does not have to be unique, and it is changeable. Example: My resource id (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. sort_by (str) – (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 (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. file_system_id (str) – (optional) The OCID of the source file system. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ReplicationSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_replications API.

list_snapshots(**kwargs)¶

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

Parameters:	limit (int) – (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 (str) – (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 (str) – (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 (str) – (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type. filesystem_snapshot_policy_id (str) – (optional) The OCID of the file system snapshot policy that is used to create the snapshots. compartment_id (str) – (optional) The OCID of the compartment. file_system_id (str) – (optional) The OCID of the file system. sort_order (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SnapshotSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_snapshots API.

pause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, **kwargs)¶

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.

Parameters:	filesystem_snapshot_policy_id (str) – (required) The OCID of the file system snapshot policy. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FilesystemSnapshotPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use pause_filesystem_snapshot_policy API.

unpause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, **kwargs)¶

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.

Parameters:	filesystem_snapshot_policy_id (str) – (required) The OCID of the file system snapshot policy. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FilesystemSnapshotPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use unpause_filesystem_snapshot_policy API.

update_export(export_id, update_export_details, **kwargs)¶

Updates the specified export’s information.

Parameters:	export_id (str) – (required) The OCID of the export. update_export_details (oci.file_storage.models.UpdateExportDetails) – (required) Details object for updating an export. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Export`
Return type:	`Response`
Example:

Click here to see an example of how to use update_export API.

update_export_set(export_set_id, update_export_set_details, **kwargs)¶

Updates the specified export set’s information.

Parameters:	export_set_id (str) – (required) The OCID of the export set. update_export_set_details (oci.file_storage.models.UpdateExportSetDetails) – (required) Details object for updating an export set. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExportSet`
Return type:	`Response`
Example:

Click here to see an example of how to use update_export_set API.

update_file_system(file_system_id, update_file_system_details, **kwargs)¶

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

Parameters:	file_system_id (str) – (required) The OCID of the file system. update_file_system_details (oci.file_storage.models.UpdateFileSystemDetails) – (required) Details object for updating a file system. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FileSystem`
Return type:	`Response`
Example:

Click here to see an example of how to use update_file_system API.

update_filesystem_snapshot_policy(filesystem_snapshot_policy_id, update_filesystem_snapshot_policy_details, **kwargs)¶

Updates the specified file system snapshot policy’s information.

Parameters:	filesystem_snapshot_policy_id (str) – (required) The OCID of the file system snapshot policy. update_filesystem_snapshot_policy_details (oci.file_storage.models.UpdateFilesystemSnapshotPolicyDetails) – (required) Details object for updating a file system snapshot policy. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FilesystemSnapshotPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use update_filesystem_snapshot_policy API.

update_mount_target(mount_target_id, update_mount_target_details, **kwargs)¶

Updates the specified mount target’s information.

Parameters:	mount_target_id (str) – (required) The OCID of the mount target. update_mount_target_details (oci.file_storage.models.UpdateMountTargetDetails) – (required) Details object for updating a mount target. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MountTarget`
Return type:	`Response`
Example:

Click here to see an example of how to use update_mount_target API.

update_outbound_connector(outbound_connector_id, update_outbound_connector_details, **kwargs)¶

Updates the specified outbound connector’s information.

Parameters:	outbound_connector_id (str) – (required) The OCID of the outbound connector. update_outbound_connector_details (oci.file_storage.models.UpdateOutboundConnectorDetails) – (required) Details object for updating a outbound connector. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OutboundConnector`
Return type:	`Response`
Example:

Click here to see an example of how to use update_outbound_connector API.

update_replication(replication_id, update_replication_details, **kwargs)¶

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

Parameters:	replication_id (str) – (required) The OCID of the replication. update_replication_details (oci.file_storage.models.UpdateReplicationDetails) – (required) Details object for updating a replication. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Replication`
Return type:	`Response`
Example:

Click here to see an example of how to use update_replication API.

update_snapshot(snapshot_id, update_snapshot_details, **kwargs)¶

Updates the specified snapshot’s information.

Parameters:	snapshot_id (str) – (required) The OCID of the snapshot. update_snapshot_details (oci.file_storage.models.UpdateSnapshotDetails) – (required) Details object for updating a snapshot. if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Snapshot`
Return type:	`Response`
Example:

Click here to see an example of how to use update_snapshot API.

validate_key_tabs(validate_key_tabs_details, **kwargs)¶

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.

Parameters:	validate_key_tabs_details (oci.file_storage.models.ValidateKeyTabsDetails) – (required) Keytab secret details or mount target ID for validating keytabs. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ValidateKeyTabsResponseDetails`
Return type:	`Response`
Example:

Click here to see an example of how to use validate_key_tabs API.