File System:Get File System

Search (SHIFT+S)

API Reference


Modified since last release

Get File System

GET /file/filesystems/{id}

Get info for file system

idthe URN of a ViPR File system

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

File system details

Field Description Type Notes
<filesystem>
<native_id> File system's actual path on the array. String
<capacity_gb> Total capacity of the file system in GB String
<used_capacity_gb> Used capacity of the file system in GB String
<soft_limit> Long
<soft_grace> Integer
<notification_limit> Long
<soft_limit_exceeded> Boolean
<vpool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vpool>      
<data_protection> Not currently used String
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<storage_pool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<protocols>
<protocol> String 0-* Elements
</protocols>
<storage_system>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_system>      
<storage_port>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_port>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<thinly_provisioned> Is the storage for the file system thinly provisioned? If thinly provisioned, only a portion of the total capacity is initially allocated. Additional storage is allocated later as needed. Boolean
<virtual_nas>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</virtual_nas>      
<file_replication>    
<personality> SOURCE TARGET String
<access_state> String
<mirror_status> String
<parent_file_system>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</parent_file_system>      
<target_file_systems>
<file_system>     0-* Elements
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</file_system>      
</target_file_systems>
</file_replication>      
<mount_path> String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</filesystem>

Examples

Request
GET  https://192.168.0.0:4443/file/filesystems/urn:storageos:FileShare:02fd3421-5124-417e-a859-53f92d4e4e64: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<filesystem>
    <creation_time>1379401332892</creation_time>
    <id>urn:storageos:FileShare:02fd3421-5124-417e-a859-53f92d4e4e64:</id>
    <inactive>false</inactive>
    <link href="/file/filesystems/urn:storageos:FileShare:02fd3421-5124-417e-a859-53f92d4e4e64:" rel="self"/>
    <name>MST_Vol_coke_0300dd2a-82d4-4cec-b421-387204219c2e</name>
    <tags/>
    <mount_path>/ifs/sos/ProviderTenan_MSTVolcoke030_02fd3421-5124-417e-a859-53f92d4e4e64</mount_path>
    <capacity_gb>1.00</capacity_gb>
    <native_id>/ifs/sos/ProviderTenan_MSTVolcoke030_02fd3421-5124-417e-a859-53f92d4e4e64</native_id>
    <storage_pool>
        <id>urn:storageos:StoragePool:e6692a4d-8ce3-4b83-881a-0da8163804aa:</id>
        <link href="/vdc/storage-systems/urn:storageos:StorageSystem:b8017683-e5b7-492b-92ce-063d3acc1eb4:/storage-pools/urn:storageos:StoragePool:e6692a4d-8ce3-4b83-881a-0da8163804aa:" rel="self"/>
    </storage_pool>
    <project>
        <id>urn:storageos:Project:403946c1-029f-4f40-8159-87be97dbe2d0:</id>
        <link href="/projects/urn:storageos:Project:403946c1-029f-4f40-8159-87be97dbe2d0:" rel="self"/>
    </project>
    <protocols>
        <protocol>CIFS</protocol>
    </protocols>
    <storage_system>
        <id>urn:storageos:StorageSystem:b8017683-e5b7-492b-92ce-063d3acc1eb4:</id>
        <link href="/vdc/storage-systems/urn:storageos:StorageSystem:b8017683-e5b7-492b-92ce-063d3acc1eb4:" rel="self"/>
    </storage_system>
    <tenant>
        <id>urn:storageos:TenantOrg:c3f022ff-5e3a-49ca-a5ef-b0aaa74cebb3:</id>
        <link href="/tenants/urn:storageos:TenantOrg:c3f022ff-5e3a-49ca-a5ef-b0aaa74cebb3:" rel="self"/>
    </tenant>
    <thinly_provisioned>true</thinly_provisioned>
    <varray>
        <id>urn:storageos:VirtualArray:b8f947af-a149-4192-846d-cbbaca4968cb:</id>
        <link href="/vdc/varrays/urn:storageos:VirtualArray:b8f947af-a149-4192-846d-cbbaca4968cb:" rel="self"/>
    </varray>
    <vpool>
        <id>urn:storageos:VirtualPool:51575f8d-e51d-4c77-a741-a66534cb62ed:</id>
        <link href="/file/vpools/urn:storageos:VirtualPool:51575f8d-e51d-4c77-a741-a66534cb62ed:" rel="self"/>
    </vpool>
</filesystem>
Notes: