Filesystem class

The Filesystem class represents network attached storage (NAS) formatted with a file system.

Filesystem class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the Filesystem class.

Basic APIs

Name	HTTP method	URI	Description
create	`POST`	`csm/Filesystem`	Creates a `Filesystem` object.
delete	`DELETE`	`csm/Filesystem/guid`	Deletes a `Filesystem` object.
get	`GET`	`csm/Filesystem/guid`	Retrieves a `Filesystem` object.
create	`POST`	`csm/Filesystem`	Creates a `Filesystem` object.
search	`POST`	`csm/Filesystem/search`	Searches for `Filesystem` objects.

Operation APIs

Name	HTTP method	URI	Description
decommission	`POST`	`csm/Filesystem/decommission`

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/Filesystem/guid/contractLine`	Retrieves the `contractLine` relationship.
relation	`GET`	`csm/Filesystem/guid/resourceSet`	Retrieves the `resourceSet` relationship.
relation	`GET`	`csm/Filesystem/guid/serviceOfferingContractLine`	Retrieves the `serviceOfferingContractLine` relationship.
relation	`GET`	`csm/Filesystem/guid/storageConnection`	Retrieves the `storageConnection` relationship.
relation	`GET`	`csm/Filesystem/guid/tenant`	Retrieves the `tenant` relationship.
relation	`GET`	`csm/Filesystem/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/Filesystem/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/Filesystem/guid/tags`	Retrieves the `tags` relationship.

Filesystem class relationships and attributes

The following tables list the relationships and attributes of the Filesystem class.

Relationships

Name	Type	Multi- plicity	Description
`contractLine`	`ContractLine`	0..1	Referenced contract line
`resourceSet`	`ResourceSet`	0..1	Resource set associated with the storage resource
`serviceOfferingContractLine`	`ServiceOfferingContractLine`	0..1	Contract line of the associated service offering
`storageConnection`	`StorageConnection`	0..*	Storage connection associated with the storage resource
`tenant`	`Organization`	1	Tenant for whom the storage resource is deployed
`tickets`	`Ticket`	0..*
`cloudClass`	`CloudClass`	1	Fully-qualified name of the class to which the object belongs
`provider`	`Provider`	1	Provider that created the object
`tags`	`Tag`	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
`allocatedFromName`	`String`	0..1	Holds the name of the component in the storage system from which the storage has been allocated. In NetApp, this would be a filer or vFiler. In EMC, it would be a Storage Group.
`capacity`	`Integer`	1	Capacity of the storage resource
`capacityUnit`	`String`	0..1	Units used for the capacity. Valid values are MB, GB, or TB.
`containerResource`	`String`	0..1	Name of the resource (for example, NetApp dataset) managed by the storage container from which the storage has been allocated
`osType`	`String`	0..1	Operating system for which the storage is targeted.
`path`	`String`	0..1	Path that is the root of the allocated storage on the storage container. This could be a LUN path or a filesystem path.
`serviceRequestID`	`String`	0..1	Identifier of the service request that caused the storage to be allocated
`state`	`ProvisionedResourceState`	1	Resource state
`storageContainerID`	`String`	1	Identifier of the storage container hosting the allocated storage
`storageOfferingID`	`String`	1	Storage offering identifier from the storage offering tables
`externalID`	`String`	0..1	Identifier used for the object by an external provider
`owner`	`String`	0..1	Name of the owner of the object
`reconciliationID`	`String`	0..1	Reconciliation identity value for the object from the BMC Atrium CMDB
`tokenID`	`String`	0..1	Token identifier
`description`	`String`	0..1	Text that describes the object
`guid`	`String`	1	Globally unique identifier for the object
`labels`	`String`	0..*
`modifiedDate`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object