DataSync / Client / describe_location_fsx_open_zfs

describe_location_fsx_open_zfs

DataSync.Client.describe_location_fsx_open_zfs(**kwargs)

Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.

Note

Response elements related to SMB aren’t supported with the DescribeLocationFsxOpenZfs operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_fsx_open_zfs(
    LocationArn='string'
)

Parameters:

LocationArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'SecurityGroupArns': [
        'string',
    ],
    'Protocol': {
        'NFS': {
            'MountOptions': {
                'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
            }
        },
        'SMB': {
            'Domain': 'string',
            'MountOptions': {
                'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
            },
            'Password': 'string',
            'User': 'string'
        }
    },
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • LocationArn (string) –

    The ARN of the FSx for OpenZFS location that was described.

  • LocationUri (string) –

    The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.

    Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder

  • SecurityGroupArns (list) –

    The ARNs of the security groups that are configured for the FSx for OpenZFS file system.

    • (string) –

  • Protocol (dict) –

    The type of protocol that DataSync uses to access your file system.

    • NFS (dict) –

      Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system’s storage virtual machine (SVM).

      • MountOptions (dict) –

        Specifies how DataSync can access a location using the NFS protocol.

        • Version (string) –

          Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

          You can specify the following options:

          • AUTOMATIC (default): DataSync chooses NFS version 4.1.

          • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

          • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

          • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

          Note

          DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

    • SMB (dict) –

      Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s SVM.

      • Domain (string) –

        Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

      • MountOptions (dict) –

        Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

        • Version (string) –

          By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

          These are the following options for configuring the SMB version:

          • AUTOMATIC (default): DataSync and the SMB file server negotiate a protocol version that they mutually support. (DataSync supports SMB versions 1.0 and later.) This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error.

          • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

          • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

          • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

          • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

          Note

          The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location.

      • Password (string) –

        Specifies the password of a user who has permission to access your SVM.

      • User (string) –

        Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.

        If you provide a user in your Active Directory, note the following:

        • If you’re using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.

        • If you’re using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.

        Make sure that the user has the permissions it needs to copy the data you want:

        • SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).

        • SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.

  • CreationTime (datetime) –

    The time that the FSx for OpenZFS location was created.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException

• DataSync.Client.exceptions.InternalException