FileSystems

class zos_files.zowe.zos_files_for_zowe_sdk.FileSystems(connection: dict[str, Any], log: bool = True)

Class used to represent the base z/OSMF FileSystems API.

It includes all operations related to file systems.

Parameters:

connection (dict[str, Any]) – A profile for connection in dict (json) format
log (bool) – Flag to disable logger

create(file_system_name: str, options: dict[str, Any] = {}) → None

Create a z/OS UNIX zFS Filesystem.

Parameters:

Raises:

MaxAllocationQuantityExceeded – Thrown when file system exceeds max allocation quantity
InvalidPermsOption – Thrown when invalid permission option is provided

delete(file_system_name: str) → None

Delete a zFS Filesystem.

list(file_path_name: str | None = None, file_system_name: str | None = None) → FileSystemListResponse

List all mounted filesystems.

It could also list the specific filesystem mounted at a given path, or the filesystem with a given Filesystem name.

Parameters:

file_path_name (Optional[str]) – USS directory that contains the files and directories to be listed
file_system_name (Optional[str]) – Name of the file system to be listed

Returns:

A JSON containing the result of the operation

Return type:

FileSystemListResponse

mount(file_system_name: str, mount_point: str, options: dict[str, Any] = {}, encoding: str = 'utf-8') → None

Mount a z/OS UNIX file system on a specified directory.

Parameters:

file_system_name (str) – Name for the file system
mount_point (str) – Mount point to be used for mounting the UNIX file system
options (dict[str, Any]) – A JSON of request body options
encoding (str) – Specifies optional encoding name (e.g. IBM-1047)

unmount(file_system_name: str, options: dict[str, Any] = {}, encoding: str = 'utf-8') → None

Unmount a z/OS UNIX file system on a specified directory.

Parameters: