NAME

DESCRIPTION

USAGE

oci fs file-system list [OPTIONS]

REQUIRED PARAMETERS

The name of the availability domain.

Example:

Uocm:PHX-AD-1

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the compartment.

OPTIONAL PARAMETERS

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

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

Example:

My resource

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

Filter results by OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. Must be an OCID of the correct type for the resouce type.

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

Accepted values are:

ACTIVE, CREATING, DELETED, DELETING, FAILED

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 <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.

Example:

500

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 <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the file system that contains the source snapshot of a cloned file system. See Cloning a File System <https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm>.

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.

Accepted values are:

DISPLAYNAME, TIMECREATED

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.

Accepted values are:

ASC, DESC

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the snapshot used to create a cloned file system. See Cloning a File System <https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningafilesystem.htm>.

GLOBAL PARAMETERS

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

EXAMPLES

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/fs/file-system/list.html#cmdoption-availability-domain
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/fs/file-system/list.html#cmdoption-compartment-id
    oci fs file-system list --availability-domain $availability_domain --compartment-id $compartment_id

AUTHOR

COPYRIGHT