# Huawei Driver

Huawei NAS Driver is a plugin based the OpenStack manila service. The Huawei NAS Driver can be used to provide functions such as the share and snapshot for virtual machines(instances) in OpenStack. Huawei NAS Driver enables the OceanStor V3 series V300R002 storage system to provide only network filesystems for OpenStack.

## Requirements

- The OceanStor V3 series V300R002 storage system.

- The following licenses should be activated on V3 for File:

  - CIFS

  - NFS

  - HyperSnap License (for snapshot)

## Supported Operations

The following operations is supported on V3 storage:

- Create CIFS/NFS Share

- Delete CIFS/NFS Share

- Allow CIFS/NFS Share access

  - IP and USER access types are supported for NFS(ro/rw).

  - Only USER access type is supported for CIFS(ro/rw).

- Deny CIFS/NFS Share access

- Create snapshot

- Delete snapshot

- Manage CIFS/NFS share

- Support pools in one backend

- Extend share

- Shrink share

- Support multi RestURLs(<RestURL>)

- Support multi-tenancy

- Ensure share

- Create share from snapshot

- Support QoS

## Pre-Configurations on Huawei

1. Create a driver configuration file. The driver configuration file name must be the same as the manila_huawei_conf_file item in the manila_conf configuration file.

2. Configure Product. Product indicates the storage system type. For the OceanStor V3 series V300R002 storage systems, the driver configuration file is as follows:

    <?xml version='1.0' encoding='UTF-8'?>
    <Config>
        <Storage>
            <Product>V3</Product>
            <LogicalPortIP>x.x.x.x</LogicalPortIP>
            <Port>abc;CTE0.A.H1</Port>
            <RestURL>https://x.x.x.x:8088/deviceManager/rest/;
            https://x.x.x.x:8088/deviceManager/rest/</RestURL>
            <UserName>xxxxxxxxx</UserName>
            <UserPassword>xxxxxxxxx</UserPassword>
        </Storage>
        <Filesystem>
            <StoragePool>xxxxxxxxx</StoragePool>
            <SectorSize>64</SectorSize>
            <WaitInterval>3</WaitInterval>
            <Timeout>60</Timeout>
            <NFSClient>
                <IP>x.x.x.x</IP>
            </NFSClient>
            <CIFSClient>
                <UserName>xxxxxxxxx</UserName>
                <UserPassword>xxxxxxxxx</UserPassword>
            </CIFSClient>
        </Filesystem>
    </Config>

- Product is a type of a storage product. Set it to V3.

- LogicalPortIP is an IP address of the logical port.

- Port is a port name list of bond port or ETH port, used to create vlan and logical port. Multi Ports can be configured in <Port>(separated by “;”). If <Port> is not configured, then will choose an online port on the array.

- RestURL is an access address of the REST interface. Multi RestURLs can be configured in <RestURL>(separated by “;”). When one of the RestURL failed to connect, driver will retry another automatically.

- UserName is a user name of an administrator.

- UserPassword is a password of an administrator.

- StoragePool is a name of a storage pool to be used.

- SectorSize is the size of the disk blocks, optional value can be “4”, “8”, “16”, “32” or “64”, and the units is KB. If “sectorsize” is configured in both share_type and xml file, the value of sectorsize in the share_type will be used. If “sectorsize” is configured in neither share_type nor xml file, huawei storage backends will provide a default value(64) when creating a new share.

- WaitInterval is the interval time of querying the file system status.

- Timeout is the timeout period for waiting command execution of a device to complete.

- NFSClientIP is the backend IP in admin network to use for mounting NFS share.

- CIFSClientUserName is the backend user name in admin network to use for mounting CIFS share.

- CIFSClientUserPassword is the backend password in admin network to use for mounting CIFS share.

## Backend Configuration

Modify the manila.conf manila configuration file and add share_driver and manila_huawei_conf_file items. Example for configuring a storage system:

- share_driver = manila.share.drivers.huawei.huawei_nas.HuaweiNasDriver

- manila_huawei_conf_file = /etc/manila/manila_huawei_conf.xml

- driver_handles_share_servers = True or False

Note

- If driver_handles_share_servers is True, the driver will choose a port in <Port> to create vlan and logical port for each tenant network. And the share type with the DHSS extra spec should be set to True when creating shares.

- If driver_handles_share_servers is False, then will use the IP in <LogicalPortIP>. Also the share type with the DHSS extra spec should be set to False when creating shares.

Restart of manila-share service is needed for the configuration changes to take effect.

## Share Types

When creating a share, a share type can be specified to determine where and how the share will be created. If a share type is not specified, the default_share_type set in the manila configuration file is used.

Manila requires that the share type includes the driver_handles_share_servers extra-spec. This ensures that the share will be created on a backend that supports the requested driver_handles_share_servers (share networks) capability. For the Huawei driver, this must be set to False.

To create a share on a backend with a specific type of disks, include the huawei_disk_type extra-spec in the share type. Valid values for this extra-spec are ‘ssd’, ‘sas’, ‘nl_sas’ or ‘mix’. This share will be created on a backend with a matching disk type.

Another common manila extra-spec used to determine where a share is created is share_backend_name. When this extra-spec is defined in the share type, the share will be created on a backend with a matching share_backend_name.

Manila “share types” may contain qualified extra-specs, -extra-specs that have significance for the backend driver and the CapabilityFilter. This commit makes the Huawei driver report the following boolean capabilities:

- capabilities:dedupe

- capabilities:compression

- capabilities:thin_provisioning

- capabilities:huawei_smartcache

  - huawei_smartcache:cachename

- capabilities:huawei_smartpartition

  - huawei_smartpartition:partitionname

- capabilities:qos

  - qos:maxIOPS

  - qos:minIOPS

  - qos:minbandwidth

  - qos:maxbandwidth

  - qos:latency

  - qos:iotype

- capabilities:huawei_sectorsize

The scheduler will choose a host that supports the needed capability when the CapabilityFilter is used and a share type uses one or more of the following extra-specs:

- capabilities:dedupe=’<is> True’ or ‘<is> False’

- capabilities:compression=’<is> True’ or ‘<is> False’

- capabilities:thin_provisioning=’<is> True’ or ‘<is> False’

- capabilities:huawei_smartcache=’<is> True’ or ‘<is> False’

  - huawei_smartcache:cachename=test_cache_name

- capabilities:huawei_smartpartition=’<is> True’ or ‘<is> False’

  - huawei_smartpartition:partitionname=test_partition_name

- capabilities:qos=’<is> True’ or ‘<is> False’

  - qos:maxIOPS=100

  - qos:minIOPS=10

  - qos:maxbandwidth=100

  - qos:minbandwidth=10

  - qos:latency=10

  - qos:iotype=0

- capabilities:huawei_sectorsize=’<is> True’ or ‘<is> False’

  - huawei_sectorsize:sectorsize=4

- huawei_disk_type=’ssd’ or ‘sas’ or ‘nl_sas’ or ‘mix’

thin_provisioning will be reported as [True, False] for Huawei backends.

dedupe will be reported as [True, False] for Huawei backends.

compression will be reported as [True, False] for Huawei backends.

huawei_smartcache will be reported as [True, False] for Huawei backends. Adds SSDs into a high-speed cache pool and divides the pool into multiple cache partitions to cache hotspot data in random and small read I/Os.

huawei_smartpartition will be reported as [True, False] for Huawei backends. Add share to the smartpartition named ‘test_partition_name’. Allocates cache resources based on service characteristics, ensuring the quality of critical services.

qos will be reported as True for backends that use QoS (Quality of Service) specification.

huawei_sectorsize will be reported as [True, False] for Huawei backends.

huawei_disk_type will be reported as “ssd”, “sas”, “nl_sas” or “mix” for Huawei backends.

## Restrictions

The Huawei driver has the following restrictions:

- IP and USER access types are supported for NFS.

- Only LDAP domain is supported for NFS.

- Only USER access type is supported for CIFS.

- Only AD domain is supported for CIFS.

### The `manila.share.drivers.huawei.huawei_nas` Module

Huawei Nas Driver for Huawei storage arrays.

class HuaweiNasDriver(*args, **kwargs)

  Bases: `ShareDriver`

  Huawei Share Driver.

  Executes commands relating to Shares. Driver version history:

      1.0 - Initial version.
      1.1 - Add shrink share.
            Add extend share.
            Add manage share.
            Add share level(ro).
            Add smartx capabilities.
            Support multi pools in one backend.
      1.2 - Add share server support.
            Add ensure share.
            Add QoS support.
            Add create share from snapshot.
      1.3 - Add manage snapshot.
            Support reporting disk type of pool.
            Add replication support.

  allow_access(context, share, access, share_server=None)

    Allow access to the share.

  check_for_setup_error()

    Returns an error if prerequisites aren’t met.

  create_replica(context, replica_list, new_replica, access_rules, replica_snapshots, share_server=None)

    Replicate the active replica to a new replica on this backend.

  create_share(context, share, share_server=None)

    Create a share.

  create_share_from_snapshot(context, share, snapshot, share_server=None, parent_share=None)

    Create a share from snapshot.

  create_snapshot(context, snapshot, share_server=None)

    Create a snapshot.

  delete_replica(context, replica_list, replica_snapshots, replica, share_server=None)

    Delete a replica.

  delete_share(context, share, share_server=None)

    Delete a share.

  delete_snapshot(context, snapshot, share_server=None)

    Delete a snapshot.

  deny_access(context, share, access, share_server=None)

    Deny access to the share.

  do_setup(context)

    Any initialization the huawei nas driver does while starting.

  ensure_share(context, share, share_server=None)

    Ensure that share is exported.

  extend_share(share, new_size, share_server=None)

    Extends size of existing share.

    Parameters:

      - share – Share model

      - new_size – New size of share (new_size > share[‘size’])

      - share_server – Optional – Share server model

  get_backend_driver()
  get_network_allocations_number()

    Get number of network interfaces to be created.

  get_pool(share)

    Return pool name where the share resides on.

  manage_existing(share, driver_options)

    Manage existing share.

  manage_existing_snapshot(snapshot, driver_options)

    Manage existing snapshot.

  promote_replica(context, replica_list, replica, access_rules, share_server=None, quiesce_wait_time=None)

    Promote a replica to ‘active’ replica state..

  revert_to_snapshot(context, snapshot, share_access_rules, snapshot_access_rules, share_server=None)

    Reverts a share (in place) to the specified snapshot.

    Does not delete the share snapshot. The share and snapshot must both be ‘available’ for the restore to be attempted. The snapshot must be the most recent one taken by Manila; the API layer performs this check so the driver doesn’t have to.

    The share must be reverted in place to the contents of the snapshot. Application admins should quiesce or otherwise prepare the application for the shared file system contents to change suddenly.

    Parameters:

      - context – Current context

      - snapshot – The snapshot to be restored

      - share_access_rules – List of all access rules for the affected share

      - snapshot_access_rules – List of all access rules for the affected snapshot

      - share_server – Optional – Share server model or None

  shrink_share(share, new_size, share_server=None)

    Shrinks size of existing share.

  update_access(context, share, access_rules, add_rules, delete_rules, update_rules, share_server=None)

    Update access rules list.

  update_replica_state(context, replica_list, replica, access_rules, replica_snapshots, share_server=None)

    Update the replica_state of a replica.

this page last updated: 2026-04-22 07:00:00

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug