FileStorageClient

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

The API for the File Storage Service.

__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 is that the client never times out. 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.

change_file_system_compartment(file_system_id, change_file_system_compartment_details, **kwargs)

ChangeFileSystemCompartment 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_mount_target_compartment(mount_target_id, change_mount_target_compartment_details, **kwargs)

ChangeMountTargetCompartment Moves a mount target and its associated export 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_export(create_export_details, **kwargs)

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

Parameters:
  • create_export_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Export

Return type:

Response

create_file_system(create_file_system_details, **kwargs)

CreateFileSystem 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 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FileSystem

Return type:

Response

create_mount_target(create_mount_target_details, **kwargs)

CreateMountTarget 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MountTarget

Return type:

Response

create_snapshot(create_snapshot_details, **kwargs)

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

Parameters:
  • create_snapshot_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Snapshot

Return type:

Response

delete_export(export_id, **kwargs)

DeleteExport 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_file_system(file_system_id, **kwargs)

DeleteFileSystem 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_mount_target(mount_target_id, **kwargs)

DeleteMountTarget 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_snapshot(snapshot_id, **kwargs)

DeleteSnapshot 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

get_export(export_id, **kwargs)

GetExport 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Export

Return type:

Response

get_export_set(export_set_id, **kwargs)

GetExportSet 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExportSet

Return type:

Response

get_file_system(file_system_id, **kwargs)

GetFileSystem 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FileSystem

Return type:

Response

get_mount_target(mount_target_id, **kwargs)

GetMountTarget 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MountTarget

Return type:

Response

get_snapshot(snapshot_id, **kwargs)

GetSnapshot 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Snapshot

Return type:

Response

list_export_sets(compartment_id, availability_domain, **kwargs)

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

    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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExportSetSummary

Return type:

Response

list_exports(**kwargs)

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

    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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ExportSummary

Return type:

Response

list_file_systems(compartment_id, availability_domain, **kwargs)

ListFileSystems Lists the file system 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.

    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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of FileSystemSummary

Return type:

Response

list_mount_targets(compartment_id, availability_domain, **kwargs)

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

    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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of MountTargetSummary

Return type:

Response

list_snapshots(file_system_id, **kwargs)

ListSnapshots Lists snapshots of the specified file system.

Parameters:
  • file_system_id (str) -- (required) The OCID of the file system.
  • 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"

  • id (str) -- (optional) Filter results by OCID. Must be an OCID of the correct type for the resouce type.
  • sort_order (str) --

    (optional) The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending.

    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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of SnapshotSummary

Return type:

Response

update_export(export_id, update_export_details, **kwargs)

UpdateExport Updates the specified export's information.

Parameters:
  • export_id (str) -- (required) The OCID of the export.
  • update_export_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Export

Return type:

Response

update_export_set(export_set_id, update_export_set_details, **kwargs)

UpdateExportSet Updates the specified export set's information.

Parameters:
  • export_set_id (str) -- (required) The OCID of the export set.
  • update_export_set_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ExportSet

Return type:

Response

update_file_system(file_system_id, update_file_system_details, **kwargs)

UpdateFileSystem 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FileSystem

Return type:

Response

update_mount_target(mount_target_id, update_mount_target_details, **kwargs)

UpdateMountTarget Updates the specified mount target's information.

Parameters:
  • mount_target_id (str) -- (required) The OCID of the mount target.
  • update_mount_target_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MountTarget

Return type:

Response

update_snapshot(snapshot_id, update_snapshot_details, **kwargs)

UpdateSnapshot Updates the specified snapshot's information.

Parameters:
  • snapshot_id (str) -- (required) The OCID of the snapshot.
  • update_snapshot_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Snapshot

Return type:

Response