• Scalable File Service

sfs
  1. Help Center
  2. Scalable File Service
  3. API Reference(cli)
  4. API Description
  5. File Sharing
  6. Modifying a Shared File System

Modifying a Shared File System

Function

This interface is used to modify the name and description of a shared file system.

Command

  • Usage
    manila update [--name <name>] [--description <description>]
                  [--is-public <is_public>]
                  <share>
  • Parameter description

    Name

    Mandatory

    Type

    Description

    share

    Yes

    string

    Specifies the UUID or name of the shared file system.

    name

    No

    string

    Specifies the new name of the shared file system. The value consists of 1 to 255 characters.

    description

    No

    string

    Describes the shared file system. The value contains 0 to 255 characters. The default value is None.

    is_public

    No

    boolean

    (Since API v2.8) Specifies the level of visibility for the shared file system. If this parameter is set to true, the share can be queried by other tenants using interfaces such as the one in Querying Details About a Shared File System. If this parameter is set to false, the share is visible only to the tenant who creates it. The default value is false.

    NOTE:

    Share access rules added for different tenants are isolated from each other. Therefore, even if a share is set to be visible to other tenants, the share can only be queried by other tenants using the interface in Querying Details About a Shared File System. Other tenants are not allowed to mount or use the share.

  • Example command
    manila update --name sample1 416112b6-e5c9-4a46-8dd1-80749fc0933

Response

  • Parameter description

    None

  • Example response

    None