Apache CloudStack 4.20.0.0 Root Admin API Reference
createSharedFileSystem
Create a new Shared File System of specified size and disk offering, attached to the given network
Request parameters
| Parameter Name | Description | Required |
| diskofferingid | the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem. | true |
| filesystem | the filesystem format (XFS / EXT4) which will be installed on the shared filesystem. | true |
| name | the name of the shared filesystem. | true |
| networkid | network to attach the shared filesystem to | true |
| serviceofferingid | the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively | true |
| zoneid | the zone id. | true |
| account | the account associated with the shared filesystem. Must be used with the domainId parameter. | false |
| description | the description for the shared filesystem. | false |
| domainid | the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain. | false |
| maxiops | max iops | false |
| miniops | min iops | false |
| projectid | the project associated with the shared filesystem. Mutually exclusive with account parameter | false |
| provider | the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API. | false |
| size | the size of the shared filesystem in GiB | false |
Response Tags
| Response Name | Description |
| id | ID of the shared filesystem |
| account | the account associated with the shared filesystem |
| description | description of the shared filesystem |
| diskioread | the read (IO) of disk on the shared filesystem |
| diskiowrite | the write (IO) of disk on the shared filesystem |
| diskkbsread | the shared filesystem's disk read in KiB |
| diskkbswrite | the shared filesystem's disk write in KiB |
| diskofferingdisplaytext | disk offering display text for the shared filesystem |
| diskofferingid | disk offering ID for the shared filesystem |
| diskofferingname | disk offering for the shared filesystem |
| domain | the domain associated with the shared filesystem |
| domainid | the ID of the domain associated with the shared filesystem |
| domainpath | path of the domain to which the shared filesystem |
| filesystem | the filesystem format |
| iscustomdiskoffering | disk offering for the shared filesystem has custom size |
| name | name of the shared filesystem |
| networkid | Network ID of the shared filesystem |
| networkname | Network name of the shared filesystem |
| path | path to mount the shared filesystem |
| physicalsize | the bytes actually consumed on disk |
| project | the project name of the shared filesystem |
| projectid | the project ID of the shared filesystem |
| provider | the shared filesystem provider |
| provisioningtype | provisioning type used in the shared filesystem |
| serviceofferingid | service offering ID for the shared filesystem |
| serviceofferingname | service offering for the shared filesystem |
| size | size of the shared filesystem |
| sizegb | size of the shared filesystem in GiB |
| state | the state of the shared filesystem |
| storage | name of the storage pool hosting the data volume |
| storageid | ID of the storage pool hosting the data volume |
| utilization | the disk utilization |
| virtualmachineid | ID of the storage fs vm |
| virtualsize | the bytes allocated |
| vmstate | ID of the storage fs vm |
| volumeid | ID of the storage fs data volume |
| volumename | name of the storage fs data volume |
| zoneid | ID of the availability zone |
| zonename | Name of the availability zone |
| nic(*) | the list of nics associated with the shared filesystem |
| id | the ID of the nic |
| adaptertype | Type of adapter if available |
| broadcasturi | the broadcast uri of the nic |
| deviceid | device id for the network when plugged into the virtual machine |
| extradhcpoption | the extra dhcp options on the nic |
| gateway | the gateway of the nic |
| ip6address | the IPv6 address of network |
| ip6cidr | the cidr of IPv6 network |
| ip6gateway | the gateway of IPv6 network |
| ipaddress | the ip address of the nic |
| ipaddresses | IP addresses associated with NIC found for unmanaged VM |
| isdefault | true if nic is default, false otherwise |
| isolatedpvlan | the isolated private VLAN if available |
| isolatedpvlantype | the isolated private VLAN type if available |
| isolationuri | the isolation uri of the nic |
| macaddress | true if nic is default, false otherwise |
| mtu | MTU configured on the NIC |
| netmask | the netmask of the nic |
| networkid | the ID of the corresponding network |
| networkname | the name of the corresponding network |
| nsxlogicalswitch | Id of the NSX Logical Switch (if NSX based), null otherwise |
| nsxlogicalswitchport | Id of the NSX Logical Switch Port (if NSX based), null otherwise |
| publicip | public IP address associated with this nic via Static nat rule |
| publicipid | public IP address id associated with this nic via Static nat rule |
| secondaryip | the Secondary ipv4 addr of nic |
| traffictype | the traffic type of the nic |
| type | the type of the nic |
| virtualmachineid | Id of the vm to which the nic belongs |
| vlanid | ID of the VLAN/VNI if available |
| vpcid | Id of the vpc to which the nic belongs |
| vpcname | name of the vpc to which the nic belongs |